types

package
v1.21.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 29, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ApplicationDetail 

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 (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 (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 (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 (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html)
	// .
	ReferenceDataSourceDescriptions []ReferenceDataSourceDescription
	// contains filtered or unexported fields
}

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 ApplicationStatus 

type ApplicationStatus string
const (
	ApplicationStatusDeleting ApplicationStatus = "DELETING"
	ApplicationStatusStarting ApplicationStatus = "STARTING"
	ApplicationStatusStopping ApplicationStatus = "STOPPING"
	ApplicationStatusReady    ApplicationStatus = "READY"
	ApplicationStatusRunning  ApplicationStatus = "RUNNING"
	ApplicationStatusUpdating ApplicationStatus = "UPDATING"
)

Enum values for ApplicationStatus

func (ApplicationStatus) Values added in v0.29.0 

func (ApplicationStatus) Values() []ApplicationStatus

Values returns all known values for ApplicationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ApplicationSummary 

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
	// contains filtered or unexported fields
}

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 ApplicationUpdate 

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
	// contains filtered or unexported fields
}

Describes updates to apply to an existing Amazon Kinesis Analytics application.

type CSVMappingParameters 

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
	// contains filtered or unexported fields
}

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 CloudWatchLoggingOption 

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
	// contains filtered or unexported fields
}

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

type CloudWatchLoggingOptionDescription 

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
	// contains filtered or unexported fields
}

Description of the CloudWatch logging option.

type CloudWatchLoggingOptionUpdate 

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
	// contains filtered or unexported fields
}

Describes CloudWatch logging option updates.

type CodeValidationException 

type CodeValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

User-provided application code (query) is invalid. This can be a simple syntax error.

func (*CodeValidationException) Error 

func (e *CodeValidationException) Error() string

func (*CodeValidationException) ErrorCode 

func (e *CodeValidationException) ErrorCode() string

func (*CodeValidationException) ErrorFault 

func (e *CodeValidationException) ErrorFault() smithy.ErrorFault

func (*CodeValidationException) ErrorMessage 

func (e *CodeValidationException) ErrorMessage() string

type ConcurrentModificationException 

type ConcurrentModificationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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.

func (*ConcurrentModificationException) Error 

func (e *ConcurrentModificationException) Error() string

func (*ConcurrentModificationException) ErrorCode 

func (e *ConcurrentModificationException) ErrorCode() string

func (*ConcurrentModificationException) ErrorFault 

func (e *ConcurrentModificationException) ErrorFault() smithy.ErrorFault

func (*ConcurrentModificationException) ErrorMessage 

func (e *ConcurrentModificationException) ErrorMessage() string

type DestinationSchema 

type DestinationSchema struct {

	// Specifies the format of the records on the output stream.
	//
	// This member is required.
	RecordFormatType RecordFormatType
	// contains filtered or unexported fields
}

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

type Input 

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 (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html)
	// .
	InputParallelism *InputParallelism

	// The InputProcessingConfiguration (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html)
	// 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 (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
	// contains filtered or unexported fields
}

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 (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html) .

type InputConfiguration 

type InputConfiguration struct {

	// Input source ID. You can get this ID by calling the DescribeApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html)
	// operation.
	//
	// 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
	// contains filtered or unexported fields
}

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 InputDescription 

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
	// contains filtered or unexported fields
}

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

type InputLambdaProcessor 

type InputLambdaProcessor struct {

	// The ARN of the AWS Lambda (https://docs.aws.amazon.com/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
	//
	// 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
	// contains filtered or unexported fields
}

An object that contains the Amazon Resource Name (ARN) of the AWS Lambda (https://docs.aws.amazon.com/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.

type InputLambdaProcessorDescription 

type InputLambdaProcessorDescription struct {

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

	// The ARN of the IAM role that is used to access the AWS Lambda function.
	RoleARN *string
	// contains filtered or unexported fields
}

An object that contains the Amazon Resource Name (ARN) of the AWS Lambda (https://docs.aws.amazon.com/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.

type InputLambdaProcessorUpdate 

type InputLambdaProcessorUpdate struct {

	// The Amazon Resource Name (ARN) of the new AWS Lambda (https://docs.aws.amazon.com/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
	ResourceARNUpdate *string

	// The ARN of the new IAM role that is used to access the AWS Lambda function.
	RoleARNUpdate *string
	// contains filtered or unexported fields
}

Represents an update to the InputLambdaProcessor (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html) that is used to preprocess the records in the stream.

type InputParallelism 

type InputParallelism struct {

	// Number of in-application streams to create. For more information, see Limits (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html)
	// .
	Count *int32
	// contains filtered or unexported fields
}

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

type InputParallelismUpdate 

type InputParallelismUpdate struct {

	// Number of in-application streams to create for the specified streaming source.
	CountUpdate *int32
	// contains filtered or unexported fields
}

Provides updates to the parallelism count.

type InputProcessingConfiguration 

type InputProcessingConfiguration struct {

	// The InputLambdaProcessor (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html)
	// that is used to preprocess the records in the stream before being processed by
	// your application code.
	//
	// This member is required.
	InputLambdaProcessor *InputLambdaProcessor
	// contains filtered or unexported fields
}

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 (https://docs.aws.amazon.com/lambda/) .

type InputProcessingConfigurationDescription 

type InputProcessingConfigurationDescription struct {

	// Provides configuration information about the associated
	// InputLambdaProcessorDescription (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessorDescription.html)
	// .
	InputLambdaProcessorDescription *InputLambdaProcessorDescription
	// contains filtered or unexported fields
}

Provides configuration information about an input processor. Currently, the only input processor available is AWS Lambda (https://docs.aws.amazon.com/lambda/) .

type InputProcessingConfigurationUpdate 

type InputProcessingConfigurationUpdate struct {

	// Provides update information for an InputLambdaProcessor (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputLambdaProcessor.html)
	// .
	//
	// This member is required.
	InputLambdaProcessorUpdate *InputLambdaProcessorUpdate
	// contains filtered or unexported fields
}

Describes updates to an InputProcessingConfiguration (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html) .

type InputSchemaUpdate 

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
	// contains filtered or unexported fields
}

Describes updates for the application's input schema.

type InputStartingPosition 

type InputStartingPosition string
const (
	InputStartingPositionNow              InputStartingPosition = "NOW"
	InputStartingPositionTrimHorizon      InputStartingPosition = "TRIM_HORIZON"
	InputStartingPositionLastStoppedPoint InputStartingPosition = "LAST_STOPPED_POINT"
)

Enum values for InputStartingPosition

func (InputStartingPosition) Values added in v0.29.0 

func (InputStartingPosition) Values() []InputStartingPosition

Values returns all known values for InputStartingPosition. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type InputStartingPositionConfiguration 

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
	// contains filtered or unexported fields
}

Describes the point at which the application reads from the streaming source.

type InputUpdate 

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
	// contains filtered or unexported fields
}

Describes updates to a specific input configuration (identified by the InputId of an application).

type InvalidApplicationConfigurationException 

type InvalidApplicationConfigurationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

User-provided application configuration is not valid.

func (*InvalidApplicationConfigurationException) Error 

func (e *InvalidApplicationConfigurationException) Error() string

func (*InvalidApplicationConfigurationException) ErrorCode 

func (e *InvalidApplicationConfigurationException) ErrorCode() string

func (*InvalidApplicationConfigurationException) ErrorFault 

func (e *InvalidApplicationConfigurationException) ErrorFault() smithy.ErrorFault

func (*InvalidApplicationConfigurationException) ErrorMessage 

func (e *InvalidApplicationConfigurationException) ErrorMessage() string

type InvalidArgumentException 

type InvalidArgumentException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Specified input parameter value is invalid.

func (*InvalidArgumentException) Error 

func (e *InvalidArgumentException) Error() string

func (*InvalidArgumentException) ErrorCode 

func (e *InvalidArgumentException) ErrorCode() string

func (*InvalidArgumentException) ErrorFault 

func (e *InvalidArgumentException) ErrorFault() smithy.ErrorFault

func (*InvalidArgumentException) ErrorMessage 

func (e *InvalidArgumentException) ErrorMessage() string

type JSONMappingParameters 

type JSONMappingParameters struct {

	// Path to the top-level parent that contains the records.
	//
	// This member is required.
	RecordRowPath *string
	// contains filtered or unexported fields
}

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

type KinesisFirehoseInput 

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
	// contains filtered or unexported fields
}

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 KinesisFirehoseInputDescription 

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
	// contains filtered or unexported fields
}

Describes the Amazon Kinesis Firehose delivery stream that is configured as the streaming source in the application input configuration.

type KinesisFirehoseInputUpdate 

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
	// contains filtered or unexported fields
}

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

type KinesisFirehoseOutput 

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
	// contains filtered or unexported fields
}

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 KinesisFirehoseOutputDescription 

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
	// contains filtered or unexported fields
}

For an application output, describes the Amazon Kinesis Firehose delivery stream configured as its destination.

type KinesisFirehoseOutputUpdate 

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
	// contains filtered or unexported fields
}

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

type KinesisStreamsInput 

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
	// contains filtered or unexported fields
}

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 KinesisStreamsInputDescription 

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
	// contains filtered or unexported fields
}

Describes the Amazon Kinesis stream that is configured as the streaming source in the application input configuration.

type KinesisStreamsInputUpdate 

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
	// contains filtered or unexported fields
}

When updating application input configuration, provides information about an Amazon Kinesis stream as the streaming source.

type KinesisStreamsOutput 

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
	// contains filtered or unexported fields
}

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 KinesisStreamsOutputDescription 

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
	// contains filtered or unexported fields
}

For an application output, describes the Amazon Kinesis stream configured as its destination.

type KinesisStreamsOutputUpdate 

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
	// contains filtered or unexported fields
}

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

type LambdaOutput 

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
	// contains filtered or unexported fields
}

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 LambdaOutputDescription 

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
	// contains filtered or unexported fields
}

For an application output, describes the AWS Lambda function configured as its destination.

type LambdaOutputUpdate 

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
	// contains filtered or unexported fields
}

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

type LimitExceededException 

type LimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Exceeded the number of applications allowed.

func (*LimitExceededException) Error 

func (e *LimitExceededException) Error() string

func (*LimitExceededException) ErrorCode 

func (e *LimitExceededException) ErrorCode() string

func (*LimitExceededException) ErrorFault 

func (e *LimitExceededException) ErrorFault() smithy.ErrorFault

func (*LimitExceededException) ErrorMessage 

func (e *LimitExceededException) ErrorMessage() string

type MappingParameters 

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
	// contains filtered or unexported fields
}

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 Output 

type Output struct {

	// Describes the data format when records are written to the destination. For more
	// information, see 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
	// contains filtered or unexported fields
}

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 (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html) .

type OutputDescription 

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
	// contains filtered or unexported fields
}

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 OutputUpdate 

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 (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
	// contains filtered or unexported fields
}

Describes updates to the output configuration identified by the OutputId .

type RecordColumn 

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 (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_RecordFormat.html#analytics-Type-RecordFormat-RecordFormatTypel)
	// is JSON .
	Mapping *string
	// contains filtered or unexported fields
}

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 RecordFormat 

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
	// contains filtered or unexported fields
}

Describes the record format and relevant mapping information that should be applied to schematize the records on the stream.

type RecordFormatType 

type RecordFormatType string
const (
	RecordFormatTypeJson RecordFormatType = "JSON"
	RecordFormatTypeCsv  RecordFormatType = "CSV"
)

Enum values for RecordFormatType

func (RecordFormatType) Values added in v0.29.0 

func (RecordFormatType) Values() []RecordFormatType

Values returns all known values for RecordFormatType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ReferenceDataSource 

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
	// contains filtered or unexported fields
}

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 ReferenceDataSourceDescription 

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 (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationReferenceDataSource.html)
	// operation.
	//
	// 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
	// contains filtered or unexported fields
}

Describes the reference data source configured for an application.

type ReferenceDataSourceUpdate 

type ReferenceDataSourceUpdate struct {

	// ID of the reference data source being updated. You can use the
	// DescribeApplication (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html)
	// operation to get this value.
	//
	// 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
	// contains filtered or unexported fields
}

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 ResourceInUseException 

type ResourceInUseException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Application is not available for this operation.

func (*ResourceInUseException) Error 

func (e *ResourceInUseException) Error() string

func (*ResourceInUseException) ErrorCode 

func (e *ResourceInUseException) ErrorCode() string

func (*ResourceInUseException) ErrorFault 

func (e *ResourceInUseException) ErrorFault() smithy.ErrorFault

func (*ResourceInUseException) ErrorMessage 

func (e *ResourceInUseException) ErrorMessage() string

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Specified application can't be found.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type ResourceProvisionedThroughputExceededException 

type ResourceProvisionedThroughputExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Discovery failed to get a record from the streaming source because of the Amazon Kinesis Streams ProvisionedThroughputExceededException. For more information, see GetRecords (https://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetRecords.html) in the Amazon Kinesis Streams API Reference.

func (*ResourceProvisionedThroughputExceededException) Error 

func (e *ResourceProvisionedThroughputExceededException) Error() string

func (*ResourceProvisionedThroughputExceededException) ErrorCode 

func (e *ResourceProvisionedThroughputExceededException) ErrorCode() string

func (*ResourceProvisionedThroughputExceededException) ErrorFault 

func (e *ResourceProvisionedThroughputExceededException) ErrorFault() smithy.ErrorFault

func (*ResourceProvisionedThroughputExceededException) ErrorMessage 

func (e *ResourceProvisionedThroughputExceededException) ErrorMessage() string

type S3Configuration 

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
	// contains filtered or unexported fields
}

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 S3ReferenceDataSource 

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
	// contains filtered or unexported fields
}

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 (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_UpdateApplication.html) operation to trigger reloading of data into your application.

type S3ReferenceDataSourceDescription 

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
	// contains filtered or unexported fields
}

Provides the bucket name and object key name that stores the reference data.

type S3ReferenceDataSourceUpdate 

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
	// contains filtered or unexported fields
}

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 ServiceUnavailableException 

type ServiceUnavailableException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The service is unavailable. Back off and retry the operation.

func (*ServiceUnavailableException) Error 

func (e *ServiceUnavailableException) Error() string

func (*ServiceUnavailableException) ErrorCode 

func (e *ServiceUnavailableException) ErrorCode() string

func (*ServiceUnavailableException) ErrorFault 

func (e *ServiceUnavailableException) ErrorFault() smithy.ErrorFault

func (*ServiceUnavailableException) ErrorMessage 

func (e *ServiceUnavailableException) ErrorMessage() string

type SourceSchema 

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
	// contains filtered or unexported fields
}

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 Tag 

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
	// contains filtered or unexported fields
}

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 (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-tagging.html) .

type TooManyTagsException 

type TooManyTagsException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Application created with too many tags, or too many tags added to an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50.

func (*TooManyTagsException) Error 

func (e *TooManyTagsException) Error() string

func (*TooManyTagsException) ErrorCode 

func (e *TooManyTagsException) ErrorCode() string

func (*TooManyTagsException) ErrorFault 

func (e *TooManyTagsException) ErrorFault() smithy.ErrorFault

func (*TooManyTagsException) ErrorMessage 

func (e *TooManyTagsException) ErrorMessage() string

type UnableToDetectSchemaException 

type UnableToDetectSchemaException struct {
	Message *string

	ErrorCodeOverride *string

	RawInputRecords       []string
	ProcessedInputRecords []string
	// contains filtered or unexported fields
}

Data format is not valid. Amazon Kinesis Analytics is not able to detect schema for the given streaming source.

func (*UnableToDetectSchemaException) Error 

func (e *UnableToDetectSchemaException) Error() string

func (*UnableToDetectSchemaException) ErrorCode 

func (e *UnableToDetectSchemaException) ErrorCode() string

func (*UnableToDetectSchemaException) ErrorFault 

func (e *UnableToDetectSchemaException) ErrorFault() smithy.ErrorFault

func (*UnableToDetectSchemaException) ErrorMessage 

func (e *UnableToDetectSchemaException) ErrorMessage() string

type UnsupportedOperationException 

type UnsupportedOperationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.

func (*UnsupportedOperationException) Error 

func (e *UnsupportedOperationException) Error() string

func (*UnsupportedOperationException) ErrorCode 

func (e *UnsupportedOperationException) ErrorCode() string

func (*UnsupportedOperationException) ErrorFault 

func (e *UnsupportedOperationException) ErrorFault() smithy.ErrorFault

func (*UnsupportedOperationException) ErrorMessage 

func (e *UnsupportedOperationException) ErrorMessage() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.