// Code generated by smithy-go-codegen DO NOT EDIT.

package types

import (
	smithydocument "github.com/aws/smithy-go/document"
	"time"
)

// 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.
//
// Provides a description of the application, including the application Amazon
// Resource Name (ARN), status, latest version, and input and output configuration.
type ApplicationDetail struct {

	// ARN of the application.
	//
	// This member is required.
	ApplicationARN *string

	// Name of the application.
	//
	// This member is required.
	ApplicationName *string

	// Status of the application.
	//
	// This member is required.
	ApplicationStatus ApplicationStatus

	// Provides the current application version.
	//
	// This member is required.
	ApplicationVersionId *int64

	// Returns the application code that you provided to perform data analysis on any
	// of the in-application streams in your application.
	ApplicationCode *string

	// Description of the application.
	ApplicationDescription *string

	// Describes the CloudWatch log streams that are configured to receive application
	// messages. For more information about using CloudWatch log streams with Amazon
	// Kinesis Analytics applications, see [Working with Amazon CloudWatch Logs].
	//
	// [Working with Amazon CloudWatch Logs]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html
	CloudWatchLoggingOptionDescriptions []CloudWatchLoggingOptionDescription

	// Time stamp when the application version was created.
	CreateTimestamp *time.Time

	// Describes the application input configuration. For more information, see [Configuring Application Input].
	//
	// [Configuring Application Input]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html
	InputDescriptions []InputDescription

	// Time stamp when the application was last updated.
	LastUpdateTimestamp *time.Time

	// Describes the application output configuration. For more information, see [Configuring Application Output].
	//
	// [Configuring Application Output]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html
	OutputDescriptions []OutputDescription

	// Describes reference data sources configured for the application.
	//
	// For more information, see [Configuring Application Input].
	//
	// [Configuring Application Input]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html
	ReferenceDataSourceDescriptions []ReferenceDataSourceDescription

	noSmithyDocumentSerde
}

// 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.
//
// Provides application summary information, including the application Amazon
// Resource Name (ARN), name, and status.
type ApplicationSummary struct {

	// ARN of the application.
	//
	// This member is required.
	ApplicationARN *string

	// Name of the application.
	//
	// This member is required.
	ApplicationName *string

	// Status of the application.
	//
	// This member is required.
	ApplicationStatus ApplicationStatus

	noSmithyDocumentSerde
}

// Describes updates to apply to an existing Amazon Kinesis Analytics application.
type ApplicationUpdate struct {

	// Describes application code updates.
	ApplicationCodeUpdate *string

	// Describes application CloudWatch logging option updates.
	CloudWatchLoggingOptionUpdates []CloudWatchLoggingOptionUpdate

	// Describes application input configuration updates.
	InputUpdates []InputUpdate

	// Describes application output configuration updates.
	OutputUpdates []OutputUpdate

	// Describes application reference data source updates.
	ReferenceDataSourceUpdates []ReferenceDataSourceUpdate

	noSmithyDocumentSerde
}

// Provides a description of CloudWatch logging options, including the log stream
// Amazon Resource Name (ARN) and the role ARN.
type CloudWatchLoggingOption struct {

	// ARN of the CloudWatch log to receive application messages.
	//
	// This member is required.
	LogStreamARN *string

	// IAM ARN of the role to use to send application messages. Note: To write
	// application messages to CloudWatch, the IAM role that is used must have the
	// PutLogEvents policy action enabled.
	//
	// This member is required.
	RoleARN *string

	noSmithyDocumentSerde
}

// Description of the CloudWatch logging option.
type CloudWatchLoggingOptionDescription struct {

	// ARN of the CloudWatch log to receive application messages.
	//
	// This member is required.
	LogStreamARN *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.
	//
	// This member is required.
	RoleARN *string

	// ID of the CloudWatch logging option description.
	CloudWatchLoggingOptionId *string

	noSmithyDocumentSerde
}

// Describes CloudWatch logging option updates.
type CloudWatchLoggingOptionUpdate struct {

	// ID of the CloudWatch logging option to update
	//
	// This member is required.
	CloudWatchLoggingOptionId *string

	// ARN of the CloudWatch log to receive application messages.
	LogStreamARNUpdate *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.
	RoleARNUpdate *string

	noSmithyDocumentSerde
}

// Provides additional mapping information when the record format uses delimiters,
// such as CSV. For example, the following sample records use CSV format, where the
// records use the '\n' as the row delimiter and a comma (",") as the column
// delimiter:
//
//	"name1", "address1"
//
//	"name2", "address2"
type CSVMappingParameters struct {

	// Column delimiter. For example, in a CSV format, a comma (",") is the typical
	// column delimiter.
	//
	// This member is required.
	RecordColumnDelimiter *string

	// Row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.
	//
	// This member is required.
	RecordRowDelimiter *string

	noSmithyDocumentSerde
}

// Describes the data format when records are written to the destination. For more
// information, see [Configuring Application Output].
//
// [Configuring Application Output]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html
type DestinationSchema struct {

	// Specifies the format of the records on the output stream.
	//
	// This member is required.
	RecordFormatType RecordFormatType

	noSmithyDocumentSerde
}

// 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].
//
// [Configuring Application Input]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html
type Input struct {

	// 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.
	//
	// This member is required.
	InputSchema *SourceSchema

	// 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.
	//
	// This member is required.
	NamePrefix *string

	// Describes the number of in-application streams to create.
	//
	// Data from your source is routed to these in-application input streams.
	//
	// (see [Configuring Application Input].
	//
	// [Configuring Application Input]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html
	InputParallelism *InputParallelism

	// The [InputProcessingConfiguration] for the input. An input processor transforms records as they are received
	// from the stream, before the application's SQL code executes. Currently, the only
	// input processing configuration available is [InputLambdaProcessor].
	//
	// [InputProcessingConfiguration]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html
	// [InputLambdaProcessor]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html
	InputProcessingConfiguration *InputProcessingConfiguration

	// If the streaming source is an Amazon Kinesis Firehose delivery stream,
	// identifies the delivery stream's ARN and an IAM role that enables Amazon Kinesis
	// Analytics to access the stream on your behalf.
	//
	// Note: Either KinesisStreamsInput or KinesisFirehoseInput is required.
	KinesisFirehoseInput *KinesisFirehoseInput

	// 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.
	//
	// Note: Either KinesisStreamsInput or KinesisFirehoseInput is required.
	KinesisStreamsInput *KinesisStreamsInput

	noSmithyDocumentSerde
}

// When you start your application, you provide this configuration, which
// identifies the input source and the point in the input source at which you want
// the application to start processing records.
type InputConfiguration struct {

	// Input source ID. You can get this ID by calling the [DescribeApplication] operation.
	//
	// [DescribeApplication]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html
	//
	// This member is required.
	Id *string

	// Point at which you want the application to start processing records from the
	// streaming source.
	//
	// This member is required.
	InputStartingPositionConfiguration *InputStartingPositionConfiguration

	noSmithyDocumentSerde
}

// Describes the application input configuration. For more information, see [Configuring Application Input].
//
// [Configuring Application Input]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html
type InputDescription struct {

	// Returns the in-application stream names that are mapped to the stream source.
	InAppStreamNames []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.
	InputId *string

	// Describes the configured parallelism (number of in-application streams mapped
	// to the streaming source).
	InputParallelism *InputParallelism

	// The description of the preprocessor that executes on records in this input
	// before the application's code is run.
	InputProcessingConfigurationDescription *InputProcessingConfigurationDescription

	// 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.
	InputSchema *SourceSchema

	// Point at which the application is configured to read from the input stream.
	InputStartingPositionConfiguration *InputStartingPositionConfiguration

	// If an Amazon Kinesis Firehose delivery stream is configured as a streaming
	// source, provides the delivery stream's ARN and an IAM role that enables Amazon
	// Kinesis Analytics to access the stream on your behalf.
	KinesisFirehoseInputDescription *KinesisFirehoseInputDescription

	// If an Amazon Kinesis stream is configured as streaming source, provides Amazon
	// Kinesis stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon
	// Kinesis Analytics to access the stream on your behalf.
	KinesisStreamsInputDescription *KinesisStreamsInputDescription

	// In-application name prefix.
	NamePrefix *string

	noSmithyDocumentSerde
}

// An object that contains the Amazon Resource Name (ARN) of the [AWS Lambda] function that is
// used to preprocess records in the stream, and the ARN of the IAM role that is
// used to access the AWS Lambda function.
//
// [AWS Lambda]: https://docs.aws.amazon.com/lambda/
type InputLambdaProcessor struct {

	// 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
	//
	// [AWS Lambda]: https://docs.aws.amazon.com/lambda/
	//
	// This member is required.
	ResourceARN *string

	// The ARN of the IAM role that is used to access the AWS Lambda function.
	//
	// This member is required.
	RoleARN *string

	noSmithyDocumentSerde
}

// An object that contains the Amazon Resource Name (ARN) of the [AWS Lambda] function that is
// used to preprocess records in the stream, and the ARN of the IAM role that is
// used to access the AWS Lambda expression.
//
// [AWS Lambda]: https://docs.aws.amazon.com/lambda/
type InputLambdaProcessorDescription struct {

	// The ARN of the [AWS Lambda] function that is used to preprocess the records in the stream.
	//
	// [AWS Lambda]: https://docs.aws.amazon.com/lambda/
	ResourceARN *string

	// The ARN of the IAM role that is used to access the AWS Lambda function.
	RoleARN *string

	noSmithyDocumentSerde
}

// Represents an update to the [InputLambdaProcessor] that is used to preprocess the records in the
// stream.
//
// [InputLambdaProcessor]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html
type InputLambdaProcessorUpdate struct {

	// The Amazon Resource Name (ARN) of the new [AWS Lambda] function that is used to preprocess
	// the 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
	//
	// [AWS Lambda]: https://docs.aws.amazon.com/lambda/
	ResourceARNUpdate *string

	// The ARN of the new IAM role that is used to access the AWS Lambda function.
	RoleARNUpdate *string

	noSmithyDocumentSerde
}

// Describes the number of in-application streams to create for a given streaming
// source. For information about parallelism, see [Configuring Application Input].
//
// [Configuring Application Input]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html
type InputParallelism struct {

	// Number of in-application streams to create. For more information, see [Limits].
	//
	// [Limits]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html
	Count *int32

	noSmithyDocumentSerde
}

// Provides updates to the parallelism count.
type InputParallelismUpdate struct {

	// Number of in-application streams to create for the specified streaming source.
	CountUpdate *int32

	noSmithyDocumentSerde
}

// Provides a description of a processor that is used to preprocess the records in
// the stream before being processed by your application code. Currently, the only
// input processor available is [AWS Lambda].
//
// [AWS Lambda]: https://docs.aws.amazon.com/lambda/
type InputProcessingConfiguration struct {

	// The [InputLambdaProcessor] that is used to preprocess the records in the stream before being
	// processed by your application code.
	//
	// [InputLambdaProcessor]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html
	//
	// This member is required.
	InputLambdaProcessor *InputLambdaProcessor

	noSmithyDocumentSerde
}

// Provides configuration information about an input processor. Currently, the
// only input processor available is [AWS Lambda].
//
// [AWS Lambda]: https://docs.aws.amazon.com/lambda/
type InputProcessingConfigurationDescription struct {

	// Provides configuration information about the associated [InputLambdaProcessorDescription].
	//
	// [InputLambdaProcessorDescription]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessorDescription.html
	InputLambdaProcessorDescription *InputLambdaProcessorDescription

	noSmithyDocumentSerde
}

// Describes updates to an [InputProcessingConfiguration].
//
// [InputProcessingConfiguration]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html
type InputProcessingConfigurationUpdate struct {

	// Provides update information for an [InputLambdaProcessor].
	//
	// [InputLambdaProcessor]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html
	//
	// This member is required.
	InputLambdaProcessorUpdate *InputLambdaProcessorUpdate

	noSmithyDocumentSerde
}

// Describes updates for the application's input schema.
type InputSchemaUpdate struct {

	// A list of RecordColumn objects. Each object describes the mapping of the
	// streaming source element to the corresponding column in the in-application
	// stream.
	RecordColumnUpdates []RecordColumn

	// Specifies the encoding of the records in the streaming source. For example,
	// UTF-8.
	RecordEncodingUpdate *string

	// Specifies the format of the records on the streaming source.
	RecordFormatUpdate *RecordFormat

	noSmithyDocumentSerde
}

// Describes the point at which the application reads from the streaming source.
type InputStartingPositionConfiguration struct {

	// 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.
	InputStartingPosition InputStartingPosition

	noSmithyDocumentSerde
}

// Describes updates to a specific input configuration (identified by the InputId
// of an application).
type InputUpdate struct {

	// Input ID of the application input to be updated.
	//
	// This member is required.
	InputId *string

	// Describes the parallelism updates (the number in-application streams Amazon
	// Kinesis Analytics creates for the specific streaming source).
	InputParallelismUpdate *InputParallelismUpdate

	// Describes updates for an input processing configuration.
	InputProcessingConfigurationUpdate *InputProcessingConfigurationUpdate

	// 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.
	InputSchemaUpdate *InputSchemaUpdate

	// If an Amazon Kinesis Firehose delivery stream is the streaming source to be
	// updated, provides an updated stream ARN and IAM role ARN.
	KinesisFirehoseInputUpdate *KinesisFirehoseInputUpdate

	// If an Amazon Kinesis stream is the streaming source to be updated, provides an
	// updated stream Amazon Resource Name (ARN) and IAM role ARN.
	KinesisStreamsInputUpdate *KinesisStreamsInputUpdate

	// Name prefix for in-application streams that Amazon Kinesis Analytics creates
	// for the specific streaming source.
	NamePrefixUpdate *string

	noSmithyDocumentSerde
}

// Provides additional mapping information when JSON is the record format on the
// streaming source.
type JSONMappingParameters struct {

	// Path to the top-level parent that contains the records.
	//
	// This member is required.
	RecordRowPath *string

	noSmithyDocumentSerde
}

//	Identifies an Amazon Kinesis Firehose delivery stream as the streaming source.
//
// You provide the delivery stream's Amazon Resource Name (ARN) and an IAM role ARN
// that enables Amazon Kinesis Analytics to access the stream on your behalf.
type KinesisFirehoseInput struct {

	// ARN of the input delivery stream.
	//
	// This member is required.
	ResourceARN *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.
	//
	// This member is required.
	RoleARN *string

	noSmithyDocumentSerde
}

//	Describes the Amazon Kinesis Firehose delivery stream that is configured as
//
// the streaming source in the application input configuration.
type KinesisFirehoseInputDescription struct {

	// Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream.
	ResourceARN *string

	// ARN of the IAM role that Amazon Kinesis Analytics assumes to access the stream.
	RoleARN *string

	noSmithyDocumentSerde
}

// When updating application input configuration, provides information about an
// Amazon Kinesis Firehose delivery stream as the streaming source.
type KinesisFirehoseInputUpdate struct {

	// Amazon Resource Name (ARN) of the input Amazon Kinesis Firehose delivery stream
	// to read.
	ResourceARNUpdate *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.
	RoleARNUpdate *string

	noSmithyDocumentSerde
}

// When configuring application output, identifies an Amazon Kinesis Firehose
// delivery stream as the destination. You provide the stream Amazon Resource Name
// (ARN) and an IAM role that enables Amazon Kinesis Analytics to write to the
// stream on your behalf.
type KinesisFirehoseOutput struct {

	// ARN of the destination Amazon Kinesis Firehose delivery stream to write to.
	//
	// This member is required.
	ResourceARN *string

	// 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.
	//
	// This member is required.
	RoleARN *string

	noSmithyDocumentSerde
}

//	For an application output, describes the Amazon Kinesis Firehose delivery
//
// stream configured as its destination.
type KinesisFirehoseOutputDescription struct {

	// Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream.
	ResourceARN *string

	// ARN of the IAM role that Amazon Kinesis Analytics can assume to access the
	// stream.
	RoleARN *string

	noSmithyDocumentSerde
}

//	When updating an output configuration using the [UpdateApplication] operation, provides
//
// information about an Amazon Kinesis Firehose delivery stream configured as the
// destination.
//
// [UpdateApplication]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html
type KinesisFirehoseOutputUpdate struct {

	// Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream to
	// write to.
	ResourceARNUpdate *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.
	RoleARNUpdate *string

	noSmithyDocumentSerde
}

//	Identifies an Amazon Kinesis stream as the streaming source. You provide the
//
// stream's Amazon Resource Name (ARN) and an IAM role ARN that enables Amazon
// Kinesis Analytics to access the stream on your behalf.
type KinesisStreamsInput struct {

	// ARN of the input Amazon Kinesis stream to read.
	//
	// This member is required.
	ResourceARN *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.
	//
	// This member is required.
	RoleARN *string

	noSmithyDocumentSerde
}

//	Describes the Amazon Kinesis stream that is configured as the streaming source
//
// in the application input configuration.
type KinesisStreamsInputDescription struct {

	// Amazon Resource Name (ARN) of the Amazon Kinesis stream.
	ResourceARN *string

	// ARN of the IAM role that Amazon Kinesis Analytics can assume to access the
	// stream.
	RoleARN *string

	noSmithyDocumentSerde
}

// When updating application input configuration, provides information about an
// Amazon Kinesis stream as the streaming source.
type KinesisStreamsInputUpdate struct {

	// Amazon Resource Name (ARN) of the input Amazon Kinesis stream to read.
	ResourceARNUpdate *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.
	RoleARNUpdate *string

	noSmithyDocumentSerde
}

// When configuring application output, identifies an Amazon Kinesis stream as the
// destination. You provide the stream Amazon Resource Name (ARN) and also an IAM
// role ARN that Amazon Kinesis Analytics can use to write to the stream on your
// behalf.
type KinesisStreamsOutput struct {

	// ARN of the destination Amazon Kinesis stream to write to.
	//
	// This member is required.
	ResourceARN *string

	// 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.
	//
	// This member is required.
	RoleARN *string

	noSmithyDocumentSerde
}

//	For an application output, describes the Amazon Kinesis stream configured as
//
// its destination.
type KinesisStreamsOutputDescription struct {

	// Amazon Resource Name (ARN) of the Amazon Kinesis stream.
	ResourceARN *string

	// ARN of the IAM role that Amazon Kinesis Analytics can assume to access the
	// stream.
	RoleARN *string

	noSmithyDocumentSerde
}

//	When updating an output configuration using the [UpdateApplication] operation, provides
//
// information about an Amazon Kinesis stream configured as the destination.
//
// [UpdateApplication]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html
type KinesisStreamsOutputUpdate struct {

	// Amazon Resource Name (ARN) of the Amazon Kinesis stream where you want to write
	// the output.
	ResourceARNUpdate *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.
	RoleARNUpdate *string

	noSmithyDocumentSerde
}

// When configuring application output, identifies an AWS Lambda function as the
// destination. You provide the function Amazon Resource Name (ARN) and also an IAM
// role ARN that Amazon Kinesis Analytics can use to write to the function on your
// behalf.
type LambdaOutput struct {

	// Amazon Resource Name (ARN) of the destination Lambda function to write to.
	//
	// 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
	//
	// This member is required.
	ResourceARN *string

	// ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the
	// destination function on your behalf. You need to grant the necessary permissions
	// to this role.
	//
	// This member is required.
	RoleARN *string

	noSmithyDocumentSerde
}

// For an application output, describes the AWS Lambda function configured as its
// destination.
type LambdaOutputDescription struct {

	// Amazon Resource Name (ARN) of the destination Lambda function.
	ResourceARN *string

	// ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the
	// destination function.
	RoleARN *string

	noSmithyDocumentSerde
}

// When updating an output configuration using the [UpdateApplication] operation, provides
// information about an AWS Lambda function configured as the destination.
//
// [UpdateApplication]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html
type LambdaOutputUpdate struct {

	// Amazon Resource Name (ARN) of the destination Lambda function.
	//
	// 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
	ResourceARNUpdate *string

	// ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the
	// destination function on your behalf. You need to grant the necessary permissions
	// to this role.
	RoleARNUpdate *string

	noSmithyDocumentSerde
}

// 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.
type MappingParameters struct {

	// Provides additional mapping information when the record format uses delimiters
	// (for example, CSV).
	CSVMappingParameters *CSVMappingParameters

	// Provides additional mapping information when JSON is the record format on the
	// streaming source.
	JSONMappingParameters *JSONMappingParameters

	noSmithyDocumentSerde
}

//	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].
//
// [Limits]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html
type Output struct {

	// Describes the data format when records are written to the destination. For more
	// information, see [Configuring Application Output].
	//
	// [Configuring Application Output]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html
	//
	// This member is required.
	DestinationSchema *DestinationSchema

	// Name of the in-application stream.
	//
	// This member is required.
	Name *string

	// Identifies an Amazon Kinesis Firehose delivery stream as the destination.
	KinesisFirehoseOutput *KinesisFirehoseOutput

	// Identifies an Amazon Kinesis stream as the destination.
	KinesisStreamsOutput *KinesisStreamsOutput

	// Identifies an AWS Lambda function as the destination.
	LambdaOutput *LambdaOutput

	noSmithyDocumentSerde
}

// 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.
type OutputDescription struct {

	// Data format used for writing data to the destination.
	DestinationSchema *DestinationSchema

	// Describes the Amazon Kinesis Firehose delivery stream configured as the
	// destination where output is written.
	KinesisFirehoseOutputDescription *KinesisFirehoseOutputDescription

	// Describes Amazon Kinesis stream configured as the destination where output is
	// written.
	KinesisStreamsOutputDescription *KinesisStreamsOutputDescription

	// Describes the AWS Lambda function configured as the destination where output is
	// written.
	LambdaOutputDescription *LambdaOutputDescription

	// Name of the in-application stream configured as output.
	Name *string

	// A unique identifier for the output configuration.
	OutputId *string

	noSmithyDocumentSerde
}

// Describes updates to the output configuration identified by the OutputId .
type OutputUpdate struct {

	// Identifies the specific output configuration that you want to update.
	//
	// This member is required.
	OutputId *string

	// Describes the data format when records are written to the destination. For more
	// information, see [Configuring Application Output].
	//
	// [Configuring Application Output]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html
	DestinationSchemaUpdate *DestinationSchema

	// Describes an Amazon Kinesis Firehose delivery stream as the destination for the
	// output.
	KinesisFirehoseOutputUpdate *KinesisFirehoseOutputUpdate

	// Describes an Amazon Kinesis stream as the destination for the output.
	KinesisStreamsOutputUpdate *KinesisStreamsOutputUpdate

	// Describes an AWS Lambda function as the destination for the output.
	LambdaOutputUpdate *LambdaOutputUpdate

	// 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.
	NameUpdate *string

	noSmithyDocumentSerde
}

// 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.
type RecordColumn struct {

	// Name of the column created in the in-application input stream or reference
	// table.
	//
	// This member is required.
	Name *string

	// Type of column created in the in-application input stream or reference table.
	//
	// This member is required.
	SqlType *string

	// Reference to the data element in the streaming input or the reference data
	// source. This element is required if the [RecordFormatType]is JSON .
	//
	// [RecordFormatType]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_RecordFormat.html#analytics-Type-RecordFormat-RecordFormatTypel
	Mapping *string

	noSmithyDocumentSerde
}

//	Describes the record format and relevant mapping information that should be
//
// applied to schematize the records on the stream.
type RecordFormat struct {

	// The type of record format.
	//
	// This member is required.
	RecordFormatType RecordFormatType

	// 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.
	MappingParameters *MappingParameters

	noSmithyDocumentSerde
}

// Describes the reference data source by providing the source information (S3
// bucket name and object key name), the resulting in-application table name that
// is created, and the necessary schema to map the data elements in the Amazon S3
// object to the in-application table.
type ReferenceDataSource struct {

	// 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.
	//
	// This member is required.
	ReferenceSchema *SourceSchema

	// Name of the in-application table to create.
	//
	// This member is required.
	TableName *string

	// Identifies the S3 bucket and object that contains the reference data. Also
	// identifies the IAM role Amazon Kinesis Analytics can assume to read this object
	// on your behalf.
	//
	// An Amazon Kinesis Analytics application loads reference data only once. If the
	// data changes, you call the UpdateApplication operation to trigger reloading of
	// data into your application.
	S3ReferenceDataSource *S3ReferenceDataSource

	noSmithyDocumentSerde
}

// Describes the reference data source configured for an application.
type ReferenceDataSourceDescription struct {

	// 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.
	//
	// [AddApplicationReferenceDataSource]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationReferenceDataSource.html
	//
	// This member is required.
	ReferenceId *string

	// 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.
	//
	// This member is required.
	S3ReferenceDataSourceDescription *S3ReferenceDataSourceDescription

	// The in-application table name created by the specific reference data source
	// configuration.
	//
	// This member is required.
	TableName *string

	// 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.
	ReferenceSchema *SourceSchema

	noSmithyDocumentSerde
}

// 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.
type ReferenceDataSourceUpdate struct {

	// ID of the reference data source being updated. You can use the [DescribeApplication] operation to
	// get this value.
	//
	// [DescribeApplication]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html
	//
	// This member is required.
	ReferenceId *string

	// 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.
	ReferenceSchemaUpdate *SourceSchema

	// 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.
	S3ReferenceDataSourceUpdate *S3ReferenceDataSourceUpdate

	// In-application table name that is created by this update.
	TableNameUpdate *string

	noSmithyDocumentSerde
}

// Provides a description of an Amazon S3 data source, including the Amazon
// Resource Name (ARN) of the S3 bucket, the ARN of the IAM role that is used to
// access the bucket, and the name of the Amazon S3 object that contains the data.
type S3Configuration struct {

	// ARN of the S3 bucket that contains the data.
	//
	// This member is required.
	BucketARN *string

	// The name of the object that contains the data.
	//
	// This member is required.
	FileKey *string

	// IAM ARN of the role used to access the data.
	//
	// This member is required.
	RoleARN *string

	noSmithyDocumentSerde
}

// Identifies the S3 bucket and object that contains the reference data. Also
// identifies the IAM role Amazon Kinesis Analytics can assume to read this object
// on your behalf.
//
// An Amazon Kinesis Analytics application loads reference data only once. If the
// data changes, you call the [UpdateApplication]operation to trigger reloading of data into your
// application.
//
// [UpdateApplication]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html
type S3ReferenceDataSource struct {

	// Amazon Resource Name (ARN) of the S3 bucket.
	//
	// This member is required.
	BucketARN *string

	// Object key name containing reference data.
	//
	// This member is required.
	FileKey *string

	// ARN of the IAM role that the service can assume to read data on your behalf.
	// This role must have permission for the s3:GetObject action on the object and
	// trust policy that allows Amazon Kinesis Analytics service principal to assume
	// this role.
	//
	// This member is required.
	ReferenceRoleARN *string

	noSmithyDocumentSerde
}

// Provides the bucket name and object key name that stores the reference data.
type S3ReferenceDataSourceDescription struct {

	// Amazon Resource Name (ARN) of the S3 bucket.
	//
	// This member is required.
	BucketARN *string

	// Amazon S3 object key name.
	//
	// This member is required.
	FileKey *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.
	//
	// This member is required.
	ReferenceRoleARN *string

	noSmithyDocumentSerde
}

// 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.
type S3ReferenceDataSourceUpdate struct {

	// Amazon Resource Name (ARN) of the S3 bucket.
	BucketARNUpdate *string

	// Object key name.
	FileKeyUpdate *string

	// ARN of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon
	// S3 object and populate the in-application.
	ReferenceRoleARNUpdate *string

	noSmithyDocumentSerde
}

// 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.
type SourceSchema struct {

	// A list of RecordColumn objects.
	//
	// This member is required.
	RecordColumns []RecordColumn

	// Specifies the format of the records on the streaming source.
	//
	// This member is required.
	RecordFormat *RecordFormat

	// Specifies the encoding of the records in the streaming source. For example,
	// UTF-8.
	RecordEncoding *string

	noSmithyDocumentSerde
}

// A key-value pair (the value is optional) that you can define and assign to AWS
// resources. If you specify a tag that already exists, the tag value is replaced
// with the value that you specify in the request. 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].
//
// [Using Tagging]: https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-tagging.html
type Tag struct {

	// The key of the key-value tag.
	//
	// This member is required.
	Key *string

	// The value of the key-value tag. The value is optional.
	Value *string

	noSmithyDocumentSerde
}

type noSmithyDocumentSerde = smithydocument.NoSerde