kinesisanalytics

package
v1.4.20 Latest Latest
Warning

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

Go to latest
Published: Oct 21, 2016 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package kinesisanalytics provides a client for Amazon Kinesis Analytics.

Index

Examples

Constants

View Source
const (
	// ApplicationStatusDeleting is a ApplicationStatus enum value
	ApplicationStatusDeleting = "DELETING"

	// ApplicationStatusStarting is a ApplicationStatus enum value
	ApplicationStatusStarting = "STARTING"

	// ApplicationStatusStopping is a ApplicationStatus enum value
	ApplicationStatusStopping = "STOPPING"

	// ApplicationStatusReady is a ApplicationStatus enum value
	ApplicationStatusReady = "READY"

	// ApplicationStatusRunning is a ApplicationStatus enum value
	ApplicationStatusRunning = "RUNNING"

	// ApplicationStatusUpdating is a ApplicationStatus enum value
	ApplicationStatusUpdating = "UPDATING"
)
View Source
const (
	// InputStartingPositionNow is a InputStartingPosition enum value
	InputStartingPositionNow = "NOW"

	// InputStartingPositionTrimHorizon is a InputStartingPosition enum value
	InputStartingPositionTrimHorizon = "TRIM_HORIZON"

	// InputStartingPositionLastStoppedPoint is a InputStartingPosition enum value
	InputStartingPositionLastStoppedPoint = "LAST_STOPPED_POINT"
)
View Source
const (
	// RecordFormatTypeJson is a RecordFormatType enum value
	RecordFormatTypeJson = "JSON"

	// RecordFormatTypeCsv is a RecordFormatType enum value
	RecordFormatTypeCsv = "CSV"
)
View Source
const ServiceName = "kinesisanalytics"

A ServiceName is the name of the service the client will make API calls to.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddApplicationInputInput

type AddApplicationInputInput struct {

	// Name of your existing Amazon Kinesis Analytics application to which you want
	// to add the streaming source.
	//
	// ApplicationName is a required field
	ApplicationName *string `min:"1" type:"string" required:"true"`

	// Current version of your Amazon Kinesis Analytics application. You can use
	// the DescribeApplication operation to find the current application version.
	//
	// CurrentApplicationVersionId is a required field
	CurrentApplicationVersionId *int64 `min:"1" type:"long" required:"true"`

	// 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 (http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html).
	//
	// Input is a required field
	Input *Input `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (AddApplicationInputInput) GoString

func (s AddApplicationInputInput) GoString() string

GoString returns the string representation

func (AddApplicationInputInput) String

func (s AddApplicationInputInput) String() string

String returns the string representation

func (*AddApplicationInputInput) Validate

func (s *AddApplicationInputInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AddApplicationInputOutput

type AddApplicationInputOutput struct {
	// contains filtered or unexported fields
}

func (AddApplicationInputOutput) GoString

func (s AddApplicationInputOutput) GoString() string

GoString returns the string representation

func (AddApplicationInputOutput) String

func (s AddApplicationInputOutput) String() string

String returns the string representation

type AddApplicationOutputInput

type AddApplicationOutputInput struct {

	// Name of the application to which you want to add the output configuration.
	//
	// ApplicationName is a required field
	ApplicationName *string `min:"1" type:"string" required:"true"`

	// Version of the application to which you want add the output configuration.
	// You can use the DescribeApplication operation to get the current application
	// version. If the version specified is not the current version, the ConcurrentModificationException
	// is returned.
	//
	// CurrentApplicationVersionId is a required field
	CurrentApplicationVersionId *int64 `min:"1" type:"long" required:"true"`

	// An array of objects, each describing one output configuration. In the output
	// configuration, you specify the name of an in-application stream, a destination
	// (that is, an Amazon Kinesis stream or an Amazon Kinesis Firehose delivery
	// stream), and record the formation to use when writing to the destination.
	//
	// Output is a required field
	Output *Output `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (AddApplicationOutputInput) GoString

func (s AddApplicationOutputInput) GoString() string

GoString returns the string representation

func (AddApplicationOutputInput) String

func (s AddApplicationOutputInput) String() string

String returns the string representation

func (*AddApplicationOutputInput) Validate

func (s *AddApplicationOutputInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AddApplicationOutputOutput

type AddApplicationOutputOutput struct {
	// contains filtered or unexported fields
}

func (AddApplicationOutputOutput) GoString

func (s AddApplicationOutputOutput) GoString() string

GoString returns the string representation

func (AddApplicationOutputOutput) String

String returns the string representation

type AddApplicationReferenceDataSourceInput

type AddApplicationReferenceDataSourceInput struct {

	// Name of an existing application.
	//
	// ApplicationName is a required field
	ApplicationName *string `min:"1" type:"string" required:"true"`

	// Version of the application for which you are adding the reference data source.
	// You can use the DescribeApplication operation to get the current application
	// version. If the version specified is not the current version, the ConcurrentModificationException
	// is returned.
	//
	// CurrentApplicationVersionId is a required field
	CurrentApplicationVersionId *int64 `min:"1" type:"long" required:"true"`

	// The reference data source can be an object in your Amazon S3 bucket. Amazon
	// Kinesis Analytics reads the object and copies the data into the in-application
	// table that is created. You provide an S3 bucket, object key name, and the
	// resulting in-application table that is created. You must also provide an
	// IAM role with the necessary permissions that Amazon Kinesis Analytics can
	// assume to read the object from your S3 bucket on your behalf.
	//
	// ReferenceDataSource is a required field
	ReferenceDataSource *ReferenceDataSource `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (AddApplicationReferenceDataSourceInput) GoString

GoString returns the string representation

func (AddApplicationReferenceDataSourceInput) String

String returns the string representation

func (*AddApplicationReferenceDataSourceInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type AddApplicationReferenceDataSourceOutput

type AddApplicationReferenceDataSourceOutput struct {
	// contains filtered or unexported fields
}

func (AddApplicationReferenceDataSourceOutput) GoString

GoString returns the string representation

func (AddApplicationReferenceDataSourceOutput) String

String returns the string representation

type ApplicationDetail

type ApplicationDetail struct {

	// ARN of the application.
	//
	// ApplicationARN is a required field
	ApplicationARN *string `min:"1" type:"string" required:"true"`

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

	// Description of the application.
	ApplicationDescription *string `type:"string"`

	// Name of the application.
	//
	// ApplicationName is a required field
	ApplicationName *string `min:"1" type:"string" required:"true"`

	// Status of the application.
	//
	// ApplicationStatus is a required field
	ApplicationStatus *string `type:"string" required:"true" enum:"ApplicationStatus"`

	// Provides the current application version.
	//
	// ApplicationVersionId is a required field
	ApplicationVersionId *int64 `min:"1" type:"long" required:"true"`

	// Timestamp when the application version was created.
	CreateTimestamp *time.Time `type:"timestamp" timestampFormat:"unix"`

	// Describes the application input configuration. For more information, see
	// Configuring Application Input (http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html).
	InputDescriptions []*InputDescription `type:"list"`

	// Timestamp when the application was last updated.
	LastUpdateTimestamp *time.Time `type:"timestamp" timestampFormat:"unix"`

	// Describes the application output configuration. For more information, see
	// Configuring Application Output (http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html).
	OutputDescriptions []*OutputDescription `type:"list"`

	// Describes reference data sources configured for the application. For more
	// information, see Configuring Application Input (http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html).
	ReferenceDataSourceDescriptions []*ReferenceDataSourceDescription `type:"list"`
	// contains filtered or unexported fields
}

Provides a description of the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configuration.

func (ApplicationDetail) GoString

func (s ApplicationDetail) GoString() string

GoString returns the string representation

func (ApplicationDetail) String

func (s ApplicationDetail) String() string

String returns the string representation

type ApplicationSummary

type ApplicationSummary struct {

	// ARN of the application.
	//
	// ApplicationARN is a required field
	ApplicationARN *string `min:"1" type:"string" required:"true"`

	// Name of the application.
	//
	// ApplicationName is a required field
	ApplicationName *string `min:"1" type:"string" required:"true"`

	// Status of the application.
	//
	// ApplicationStatus is a required field
	ApplicationStatus *string `type:"string" required:"true" enum:"ApplicationStatus"`
	// contains filtered or unexported fields
}

Provides application summary information, including the application Amazon Resource Name (ARN), name, and status.

func (ApplicationSummary) GoString

func (s ApplicationSummary) GoString() string

GoString returns the string representation

func (ApplicationSummary) String

func (s ApplicationSummary) String() string

String returns the string representation

type ApplicationUpdate

type ApplicationUpdate struct {

	// Describes application code updates.
	ApplicationCodeUpdate *string `type:"string"`

	// Describes application input configuration updates.
	InputUpdates []*InputUpdate `type:"list"`

	// Describes application output configuration updates.
	OutputUpdates []*OutputUpdate `type:"list"`

	// Describes application reference data source updates.
	ReferenceDataSourceUpdates []*ReferenceDataSourceUpdate `type:"list"`
	// contains filtered or unexported fields
}

Describes updates to apply to an existing Kinesis Analytics application.

func (ApplicationUpdate) GoString

func (s ApplicationUpdate) GoString() string

GoString returns the string representation

func (ApplicationUpdate) String

func (s ApplicationUpdate) String() string

String returns the string representation

func (*ApplicationUpdate) Validate

func (s *ApplicationUpdate) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CSVMappingParameters

type CSVMappingParameters struct {

	// Column delimiter. For example, in a CSV format, a comma (",") is the typical
	// column delimiter.
	//
	// RecordColumnDelimiter is a required field
	RecordColumnDelimiter *string `type:"string" required:"true"`

	// Row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.
	//
	// RecordRowDelimiter is a required field
	RecordRowDelimiter *string `type:"string" required:"true"`
	// 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"

func (CSVMappingParameters) GoString

func (s CSVMappingParameters) GoString() string

GoString returns the string representation

func (CSVMappingParameters) String

func (s CSVMappingParameters) String() string

String returns the string representation

func (*CSVMappingParameters) Validate

func (s *CSVMappingParameters) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateApplicationInput

type CreateApplicationInput struct {

	// One or more SQL statements that read input data, transform it, and generate
	// output. For example, you can write a SQL statement that reads input data
	// and generates a running average of the number of advertisement clicks by
	// vendor.
	//
	// You can also provide a series of SQL statements, where output of one statement
	// can be used as the input for the next statement.
	//
	// Note that the application code must create the streams with names specified
	// in the Outputs. For example, if your Outputs defines output streams named
	// ExampleOutputStream1 and ExampleOutputStream2, then your application code
	// must create these streams.
	ApplicationCode *string `type:"string"`

	// Summary description of the application.
	ApplicationDescription *string `type:"string"`

	// Name of your Amazon Kinesis Analytics application (for example, sample-app).
	//
	// ApplicationName is a required field
	ApplicationName *string `min:"1" type:"string" required:"true"`

	// Use this parameter to configure the application input.
	//
	// You can configure your application to receive input from a single streaming
	// source. In this configuration, you map this streaming source to an in-application
	// stream that is created. Your application code can then query the in-application
	// stream like a table (you can think of it as a constantly updating table).
	//
	// For the streaming source, you provide its Amazon Resource Name (ARN) and
	// format of data on the stream (for example, JSON, CSV, etc). You also must
	// provide an IAM role that Amazon Kinesis Analytics can assume to read this
	// stream on your behalf.
	//
	// To create the in-application stream, you need to specify a schema to transform
	// your data into a schematized version used in SQL. In the schema, you provide
	// the necessary mapping of the data elements in the streaming source to record
	// columns in the in-app stream.
	Inputs []*Input `type:"list"`

	// You can configure application output to write data from any of the in-application
	// streams to up to five destinations.
	//
	// These destinations can be Amazon Kinesis streams, Amazon Kinesis Firehose
	// delivery streams, or both.
	//
	// In the configuration, you specify the in-application stream name, the destination
	// stream Amazon Resource Name (ARN), and the format to use when writing data.
	// You must also provide an IAM role that Amazon Kinesis Analytics can assume
	// to write to the destination stream on your behalf.
	//
	// In the output configuration, you also provide the output stream Amazon Resource
	// Name (ARN) and the format of data in the stream (for example, JSON, CSV).
	// You also must provide an IAM role that Amazon Kinesis Analytics can assume
	// to write to this stream on your behalf.
	Outputs []*Output `type:"list"`
	// contains filtered or unexported fields
}

TBD

func (CreateApplicationInput) GoString

func (s CreateApplicationInput) GoString() string

GoString returns the string representation

func (CreateApplicationInput) String

func (s CreateApplicationInput) String() string

String returns the string representation

func (*CreateApplicationInput) Validate

func (s *CreateApplicationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateApplicationOutput

type CreateApplicationOutput struct {

	// In response to your CreateApplication request, Amazon Kinesis Analytics returns
	// a response with a summary of the application it created, including the application
	// Amazon Resource Name (ARN), name, and status.
	//
	// ApplicationSummary is a required field
	ApplicationSummary *ApplicationSummary `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

TBD

func (CreateApplicationOutput) GoString

func (s CreateApplicationOutput) GoString() string

GoString returns the string representation

func (CreateApplicationOutput) String

func (s CreateApplicationOutput) String() string

String returns the string representation

type DeleteApplicationInput

type DeleteApplicationInput struct {

	// Name of the Amazon Kinesis Analytics application to delete.
	//
	// ApplicationName is a required field
	ApplicationName *string `min:"1" type:"string" required:"true"`

	// You can use the DescribeApplication operation to get this value.
	//
	// CreateTimestamp is a required field
	CreateTimestamp *time.Time `type:"timestamp" timestampFormat:"unix" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteApplicationInput) GoString

func (s DeleteApplicationInput) GoString() string

GoString returns the string representation

func (DeleteApplicationInput) String

func (s DeleteApplicationInput) String() string

String returns the string representation

func (*DeleteApplicationInput) Validate

func (s *DeleteApplicationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteApplicationOutput

type DeleteApplicationOutput struct {
	// contains filtered or unexported fields
}

func (DeleteApplicationOutput) GoString

func (s DeleteApplicationOutput) GoString() string

GoString returns the string representation

func (DeleteApplicationOutput) String

func (s DeleteApplicationOutput) String() string

String returns the string representation

type DeleteApplicationOutputInput

type DeleteApplicationOutputInput struct {

	// Amazon Kinesis Analytics application name.
	//
	// ApplicationName is a required field
	ApplicationName *string `min:"1" type:"string" required:"true"`

	// Amazon Kinesis Analytics application version. You can use the DescribeApplication
	// operation to get the current application version. If the version specified
	// is not the current version, the ConcurrentModificationException is returned.
	//
	// CurrentApplicationVersionId is a required field
	CurrentApplicationVersionId *int64 `min:"1" type:"long" required:"true"`

	// The ID of the configuration to delete. Each output configuration that is
	// added to the application, either when the application is created or later
	// using the AddApplicationOutput operation, has a unique ID. You need to provide
	// the ID to uniquely identify the output configuration that you want to delete
	// from the application configuration. You can use the DescribeApplication operation
	// to get the specific OutputId.
	//
	// OutputId is a required field
	OutputId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteApplicationOutputInput) GoString

func (s DeleteApplicationOutputInput) GoString() string

GoString returns the string representation

func (DeleteApplicationOutputInput) String

String returns the string representation

func (*DeleteApplicationOutputInput) Validate

func (s *DeleteApplicationOutputInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteApplicationOutputOutput

type DeleteApplicationOutputOutput struct {
	// contains filtered or unexported fields
}

func (DeleteApplicationOutputOutput) GoString

GoString returns the string representation

func (DeleteApplicationOutputOutput) String

String returns the string representation

type DeleteApplicationReferenceDataSourceInput

type DeleteApplicationReferenceDataSourceInput struct {

	// Name of an existing application.
	//
	// ApplicationName is a required field
	ApplicationName *string `min:"1" type:"string" required:"true"`

	// Version of the application. You can use the DescribeApplication operation
	// to get the current application version. If the version specified is not the
	// current version, the ConcurrentModificationException is returned.
	//
	// CurrentApplicationVersionId is a required field
	CurrentApplicationVersionId *int64 `min:"1" type:"long" required:"true"`

	// ID of the reference data source. When you add a reference data source to
	// your application using the AddApplicationReferenceDataSource, Amazon Kinesis
	// Analytics assigns an ID. You can use the DescribeApplication operation to
	// get the reference ID.
	//
	// ReferenceId is a required field
	ReferenceId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteApplicationReferenceDataSourceInput) GoString

GoString returns the string representation

func (DeleteApplicationReferenceDataSourceInput) String

String returns the string representation

func (*DeleteApplicationReferenceDataSourceInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type DeleteApplicationReferenceDataSourceOutput

type DeleteApplicationReferenceDataSourceOutput struct {
	// contains filtered or unexported fields
}

func (DeleteApplicationReferenceDataSourceOutput) GoString

GoString returns the string representation

func (DeleteApplicationReferenceDataSourceOutput) String

String returns the string representation

type DescribeApplicationInput

type DescribeApplicationInput struct {

	// Name of the application.
	//
	// ApplicationName is a required field
	ApplicationName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeApplicationInput) GoString

func (s DescribeApplicationInput) GoString() string

GoString returns the string representation

func (DescribeApplicationInput) String

func (s DescribeApplicationInput) String() string

String returns the string representation

func (*DescribeApplicationInput) Validate

func (s *DescribeApplicationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeApplicationOutput

type DescribeApplicationOutput struct {

	// Provides a description of the application, such as the application Amazon
	// Resource Name (ARN), status, latest version, and input and output configuration
	// details.
	//
	// ApplicationDetail is a required field
	ApplicationDetail *ApplicationDetail `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeApplicationOutput) GoString

func (s DescribeApplicationOutput) GoString() string

GoString returns the string representation

func (DescribeApplicationOutput) String

func (s DescribeApplicationOutput) String() string

String returns the string representation

type DestinationSchema

type DestinationSchema struct {

	// Specifies the format of the records on the output stream.
	RecordFormatType *string `type:"string" enum:"RecordFormatType"`
	// contains filtered or unexported fields
}

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

func (DestinationSchema) GoString

func (s DestinationSchema) GoString() string

GoString returns the string representation

func (DestinationSchema) String

func (s DestinationSchema) String() string

String returns the string representation

type DiscoverInputSchemaInput

type DiscoverInputSchemaInput struct {

	// Point at which you want Amazon Kinesis Analytics to start reading records
	// from the specified streaming source discovery purposes.
	//
	// InputStartingPositionConfiguration is a required field
	InputStartingPositionConfiguration *InputStartingPositionConfiguration `type:"structure" required:"true"`

	// Amazon Resource Name (ARN) of the streaming source.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// ARN of the IAM role that Amazon Kinesis Analytics can assume to access the
	// stream on your behalf.
	//
	// RoleARN is a required field
	RoleARN *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DiscoverInputSchemaInput) GoString

func (s DiscoverInputSchemaInput) GoString() string

GoString returns the string representation

func (DiscoverInputSchemaInput) String

func (s DiscoverInputSchemaInput) String() string

String returns the string representation

func (*DiscoverInputSchemaInput) Validate

func (s *DiscoverInputSchemaInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DiscoverInputSchemaOutput

type DiscoverInputSchemaOutput struct {

	// Schema inferred from the streaming source. It identifies the format of the
	// data in the streaming source and how each data element maps to corresponding
	// columns in the in-application stream that you can create.
	InputSchema *SourceSchema `type:"structure"`

	// An array of elements, where each element corresponds to a row in a stream
	// record (a stream record can have more than one row).
	ParsedInputRecords [][]*string `type:"list"`

	// Raw stream data that was sampled to infer the schema.
	RawInputRecords []*string `type:"list"`
	// contains filtered or unexported fields
}

func (DiscoverInputSchemaOutput) GoString

func (s DiscoverInputSchemaOutput) GoString() string

GoString returns the string representation

func (DiscoverInputSchemaOutput) String

func (s DiscoverInputSchemaOutput) String() string

String returns the string representation

type Input

type Input struct {

	// Describes the number of in-application streams to create.
	//
	// Data from your source will be routed to these in-application input streams.
	//
	//  (see Configuring Application Input (http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html).
	InputParallelism *InputParallelism `type:"structure"`

	// 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.
	//
	// InputSchema is a required field
	InputSchema *SourceSchema `type:"structure" required:"true"`

	// If the streaming source is an Amazon Kinesis Firehose delivery stream, identifies
	// the Firehose delivery stream's ARN and an IAM role that enables Amazon Kinesis
	// Analytics to access the stream on your behalf.
	KinesisFirehoseInput *KinesisFirehoseInput `type:"structure"`

	// 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.
	KinesisStreamsInput *KinesisStreamsInput `type:"structure"`

	// Name prefix to use when creating in-application stream. Suppose you specify
	// a prefix "MyInApplicationStream". Kinesis Analytics will then create one
	// or more (as per the InputParallelism count you specified) in-application
	// streams with names "MyInApplicationStream_001", "MyInApplicationStream_002"
	// and so on.
	//
	// NamePrefix is a required field
	NamePrefix *string `min:"1" type:"string" required:"true"`
	// 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 (http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html).

func (Input) GoString

func (s Input) GoString() string

GoString returns the string representation

func (Input) String

func (s Input) String() string

String returns the string representation

func (*Input) Validate

func (s *Input) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InputConfiguration

type InputConfiguration struct {

	// Input source ID. You can get this ID by calling the DescribeApplication operation.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// Point at which you want the application to start processing records from
	// the streaming source.
	//
	// InputStartingPositionConfiguration is a required field
	InputStartingPositionConfiguration *InputStartingPositionConfiguration `type:"structure" required:"true"`
	// 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.

func (InputConfiguration) GoString

func (s InputConfiguration) GoString() string

GoString returns the string representation

func (InputConfiguration) String

func (s InputConfiguration) String() string

String returns the string representation

func (*InputConfiguration) Validate

func (s *InputConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InputDescription

type InputDescription struct {

	// Returns the in-application stream names that are mapped to the stream source.
	InAppStreamNames []*string `type:"list"`

	// 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 `min:"1" type:"string"`

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

	// 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.
	InputSchema *SourceSchema `type:"structure"`

	// Point at which the application is configured to read from the input stream.
	InputStartingPositionConfiguration *InputStartingPositionConfiguration `type:"structure"`

	// If an Amazon Kinesis Firehose delivery stream is configured as a streaming
	// source, provides the Firehose delivery stream's Amazon Resource Name (ARN)
	// and an IAM role that enables Amazon Kinesis Analytics to access the stream
	// on your behalf.
	KinesisFirehoseInputDescription *KinesisFirehoseInputDescription `type:"structure"`

	// If an Amazon Kinesis stream is configured as streaming source, provides Amazon
	// Kinesis stream's ARN and an IAM role that enables Amazon Kinesis Analytics
	// to access the stream on your behalf.
	KinesisStreamsInputDescription *KinesisStreamsInputDescription `type:"structure"`

	// In-application name prefix.
	NamePrefix *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (InputDescription) GoString

func (s InputDescription) GoString() string

GoString returns the string representation

func (InputDescription) String

func (s InputDescription) String() string

String returns the string representation

type InputParallelism

type InputParallelism struct {

	// Number of in-application streams to create. For more information, see Limits
	// (http://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html).
	Count *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

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

func (InputParallelism) GoString

func (s InputParallelism) GoString() string

GoString returns the string representation

func (InputParallelism) String

func (s InputParallelism) String() string

String returns the string representation

func (*InputParallelism) Validate

func (s *InputParallelism) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InputParallelismUpdate

type InputParallelismUpdate struct {

	// Number of in-application streams to create for the specified streaming source.
	CountUpdate *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

Provides updates to the parallelism count.

func (InputParallelismUpdate) GoString

func (s InputParallelismUpdate) GoString() string

GoString returns the string representation

func (InputParallelismUpdate) String

func (s InputParallelismUpdate) String() string

String returns the string representation

func (*InputParallelismUpdate) Validate

func (s *InputParallelismUpdate) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 `min:"1" type:"list"`

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

	// Specifies the format of the records on the streaming source.
	RecordFormatUpdate *RecordFormat `type:"structure"`
	// contains filtered or unexported fields
}

Describes updates for the application's input schema.

func (InputSchemaUpdate) GoString

func (s InputSchemaUpdate) GoString() string

GoString returns the string representation

func (InputSchemaUpdate) String

func (s InputSchemaUpdate) String() string

String returns the string representation

func (*InputSchemaUpdate) Validate

func (s *InputSchemaUpdate) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InputStartingPositionConfiguration

type InputStartingPositionConfiguration struct {

	// The starting position on the stream.
	//
	//    LATEST - Start reading just after the most recent record in the stream.
	//
	//    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 *string `type:"string" enum:"InputStartingPosition"`
	// contains filtered or unexported fields
}

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

func (InputStartingPositionConfiguration) GoString

GoString returns the string representation

func (InputStartingPositionConfiguration) String

String returns the string representation

type InputUpdate

type InputUpdate struct {

	// Input ID of the application input to be updated.
	//
	// InputId is a required field
	InputId *string `min:"1" type:"string" required:"true"`

	// Describes the parallelism updates (the number in-application streams Kinesis
	// Analytics creates for the specific streaming source).
	InputParallelismUpdate *InputParallelismUpdate `type:"structure"`

	// 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 `type:"structure"`

	// If an Amazon Kinesis Firehose delivery stream is the streaming source to
	// be updated, provides an updated stream Amazon Resource Name (ARN) and IAM
	// role ARN.
	KinesisFirehoseInputUpdate *KinesisFirehoseInputUpdate `type:"structure"`

	// If a Amazon Kinesis stream is the streaming source to be updated, provides
	// an updated stream ARN and IAM role ARN.
	KinesisStreamsInputUpdate *KinesisStreamsInputUpdate `type:"structure"`

	// Name prefix for in-application stream(s) that Kinesis Analytics creates for
	// the specific streaming source.
	NamePrefixUpdate *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (InputUpdate) GoString

func (s InputUpdate) GoString() string

GoString returns the string representation

func (InputUpdate) String

func (s InputUpdate) String() string

String returns the string representation

func (*InputUpdate) Validate

func (s *InputUpdate) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type JSONMappingParameters

type JSONMappingParameters struct {

	// Path to the top-level parent that contains the records.
	//
	// For example, consider the following JSON record:
	//
	// In the RecordRowPath, "$" refers to the root and path "$.vehicle.Model"
	// refers to the specific "Model" key in the JSON.
	//
	// RecordRowPath is a required field
	RecordRowPath *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (JSONMappingParameters) GoString

func (s JSONMappingParameters) GoString() string

GoString returns the string representation

func (JSONMappingParameters) String

func (s JSONMappingParameters) String() string

String returns the string representation

func (*JSONMappingParameters) Validate

func (s *JSONMappingParameters) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type KinesisAnalytics

type KinesisAnalytics struct {
	*client.Client
}

KinesisAnalytics is a client for Kinesis Analytics. The service client's operations are safe to be used concurrently. It is not safe to mutate any of the client's properties though.

func New

New creates a new instance of the KinesisAnalytics client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

// Create a KinesisAnalytics client from just a session.
svc := kinesisanalytics.New(mySession)

// Create a KinesisAnalytics client with additional configuration
svc := kinesisanalytics.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*KinesisAnalytics) AddApplicationInput

func (c *KinesisAnalytics) AddApplicationInput(input *AddApplicationInputInput) (*AddApplicationInputOutput, error)

AddApplicationInput API operation for Amazon Kinesis Analytics.

Adds a streaming source to your Amazon Kinesis application. For conceptual information, see Configuring Application Input (http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html).

You can add a streaming source either when you create an application or you can use this operation to add a streaming source after you create an application. For more information, see CreateApplication.

Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Analytics's API operation AddApplicationInput for usage and error information.

Returned Error Codes:

  • ResourceNotFoundException Specified application can't be found.

  • ResourceInUseException Application is not available for this operation.

  • InvalidArgumentException Specified input parameter value is invalid.

  • ConcurrentModificationException Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/kinesisanalytics"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := kinesisanalytics.New(sess)

	params := &kinesisanalytics.AddApplicationInputInput{
		ApplicationName:             aws.String("ApplicationName"), // Required
		CurrentApplicationVersionId: aws.Int64(1),                  // Required
		Input: &kinesisanalytics.Input{ // Required
			InputSchema: &kinesisanalytics.SourceSchema{ // Required
				RecordColumns: []*kinesisanalytics.RecordColumn{ // Required
					{ // Required
						Name:    aws.String("RecordColumnName"),    // Required
						SqlType: aws.String("RecordColumnSqlType"), // Required
						Mapping: aws.String("RecordColumnMapping"),
					},
					// More values...
				},
				RecordFormat: &kinesisanalytics.RecordFormat{ // Required
					RecordFormatType: aws.String("RecordFormatType"), // Required
					MappingParameters: &kinesisanalytics.MappingParameters{
						CSVMappingParameters: &kinesisanalytics.CSVMappingParameters{
							RecordColumnDelimiter: aws.String("RecordColumnDelimiter"), // Required
							RecordRowDelimiter:    aws.String("RecordRowDelimiter"),    // Required
						},
						JSONMappingParameters: &kinesisanalytics.JSONMappingParameters{
							RecordRowPath: aws.String("RecordRowPath"), // Required
						},
					},
				},
				RecordEncoding: aws.String("RecordEncoding"),
			},
			NamePrefix: aws.String("InAppStreamName"), // Required
			InputParallelism: &kinesisanalytics.InputParallelism{
				Count: aws.Int64(1),
			},
			KinesisFirehoseInput: &kinesisanalytics.KinesisFirehoseInput{
				ResourceARN: aws.String("ResourceARN"), // Required
				RoleARN:     aws.String("RoleARN"),     // Required
			},
			KinesisStreamsInput: &kinesisanalytics.KinesisStreamsInput{
				ResourceARN: aws.String("ResourceARN"), // Required
				RoleARN:     aws.String("RoleARN"),     // Required
			},
		},
	}
	resp, err := svc.AddApplicationInput(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*KinesisAnalytics) AddApplicationInputRequest

func (c *KinesisAnalytics) AddApplicationInputRequest(input *AddApplicationInputInput) (req *request.Request, output *AddApplicationInputOutput)

AddApplicationInputRequest generates a "aws/request.Request" representing the client's request for the AddApplicationInput operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See AddApplicationInput for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the AddApplicationInput method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the AddApplicationInputRequest method.
req, resp := client.AddApplicationInputRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*KinesisAnalytics) AddApplicationOutput

func (c *KinesisAnalytics) AddApplicationOutput(input *AddApplicationOutputInput) (*AddApplicationOutputOutput, error)

AddApplicationOutput API operation for Amazon Kinesis Analytics.

Adds an external destination to your Amazon Kinesis Analytics application.

If you want Amazon Kinesis Analytics to deliver data from an in-application stream within your application to an external destination (such as an Amazon Kinesis stream or a Firehose delivery stream), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination.

You can use one of the output configurations to deliver data from your

in-application error stream to an external destination so that you can analyze the errors. For conceptual information, see Understanding Application Output (Destination) (http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html).

Note that any configuration update, including adding a streaming source

using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version.

For the limits on the number of application inputs and outputs you can configure, see Limits (http://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Analytics's API operation AddApplicationOutput for usage and error information.

Returned Error Codes:

  • ResourceNotFoundException Specified application can't be found.

  • ResourceInUseException Application is not available for this operation.

  • InvalidArgumentException Specified input parameter value is invalid.

  • ConcurrentModificationException Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/kinesisanalytics"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := kinesisanalytics.New(sess)

	params := &kinesisanalytics.AddApplicationOutputInput{
		ApplicationName:             aws.String("ApplicationName"), // Required
		CurrentApplicationVersionId: aws.Int64(1),                  // Required
		Output: &kinesisanalytics.Output{ // Required
			DestinationSchema: &kinesisanalytics.DestinationSchema{ // Required
				RecordFormatType: aws.String("RecordFormatType"),
			},
			Name: aws.String("InAppStreamName"), // Required
			KinesisFirehoseOutput: &kinesisanalytics.KinesisFirehoseOutput{
				ResourceARN: aws.String("ResourceARN"), // Required
				RoleARN:     aws.String("RoleARN"),     // Required
			},
			KinesisStreamsOutput: &kinesisanalytics.KinesisStreamsOutput{
				ResourceARN: aws.String("ResourceARN"), // Required
				RoleARN:     aws.String("RoleARN"),     // Required
			},
		},
	}
	resp, err := svc.AddApplicationOutput(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*KinesisAnalytics) AddApplicationOutputRequest

func (c *KinesisAnalytics) AddApplicationOutputRequest(input *AddApplicationOutputInput) (req *request.Request, output *AddApplicationOutputOutput)

AddApplicationOutputRequest generates a "aws/request.Request" representing the client's request for the AddApplicationOutput operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See AddApplicationOutput for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the AddApplicationOutput method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the AddApplicationOutputRequest method.
req, resp := client.AddApplicationOutputRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*KinesisAnalytics) AddApplicationReferenceDataSource

AddApplicationReferenceDataSource API operation for Amazon Kinesis Analytics.

Adds a reference data source to an existing application.

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

For conceptual information, see Configuring Application Input (http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html).

For the limits on data sources you can add to your application, see Limits (http://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html).

This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput

action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Analytics's API operation AddApplicationReferenceDataSource for usage and error information.

Returned Error Codes:

  • ResourceNotFoundException Specified application can't be found.

  • ResourceInUseException Application is not available for this operation.

  • InvalidArgumentException Specified input parameter value is invalid.

  • ConcurrentModificationException Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/kinesisanalytics"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := kinesisanalytics.New(sess)

	params := &kinesisanalytics.AddApplicationReferenceDataSourceInput{
		ApplicationName:             aws.String("ApplicationName"), // Required
		CurrentApplicationVersionId: aws.Int64(1),                  // Required
		ReferenceDataSource: &kinesisanalytics.ReferenceDataSource{ // Required
			ReferenceSchema: &kinesisanalytics.SourceSchema{ // Required
				RecordColumns: []*kinesisanalytics.RecordColumn{ // Required
					{ // Required
						Name:    aws.String("RecordColumnName"),    // Required
						SqlType: aws.String("RecordColumnSqlType"), // Required
						Mapping: aws.String("RecordColumnMapping"),
					},
					// More values...
				},
				RecordFormat: &kinesisanalytics.RecordFormat{ // Required
					RecordFormatType: aws.String("RecordFormatType"), // Required
					MappingParameters: &kinesisanalytics.MappingParameters{
						CSVMappingParameters: &kinesisanalytics.CSVMappingParameters{
							RecordColumnDelimiter: aws.String("RecordColumnDelimiter"), // Required
							RecordRowDelimiter:    aws.String("RecordRowDelimiter"),    // Required
						},
						JSONMappingParameters: &kinesisanalytics.JSONMappingParameters{
							RecordRowPath: aws.String("RecordRowPath"), // Required
						},
					},
				},
				RecordEncoding: aws.String("RecordEncoding"),
			},
			TableName: aws.String("InAppTableName"), // Required
			S3ReferenceDataSource: &kinesisanalytics.S3ReferenceDataSource{
				BucketARN:        aws.String("BucketARN"), // Required
				FileKey:          aws.String("FileKey"),   // Required
				ReferenceRoleARN: aws.String("RoleARN"),   // Required
			},
		},
	}
	resp, err := svc.AddApplicationReferenceDataSource(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*KinesisAnalytics) AddApplicationReferenceDataSourceRequest

func (c *KinesisAnalytics) AddApplicationReferenceDataSourceRequest(input *AddApplicationReferenceDataSourceInput) (req *request.Request, output *AddApplicationReferenceDataSourceOutput)

AddApplicationReferenceDataSourceRequest generates a "aws/request.Request" representing the client's request for the AddApplicationReferenceDataSource operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See AddApplicationReferenceDataSource for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the AddApplicationReferenceDataSource method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the AddApplicationReferenceDataSourceRequest method.
req, resp := client.AddApplicationReferenceDataSourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*KinesisAnalytics) CreateApplication

func (c *KinesisAnalytics) CreateApplication(input *CreateApplicationInput) (*CreateApplicationOutput, error)

CreateApplication API operation for Amazon Kinesis Analytics.

Creates an Amazon Kinesis Analytics application. You can configure each application with one streaming source as input, application code to process the input, and up to five streaming destinations where you want Amazon Kinesis Analytics to write the output data from your application. For an overview, see How it Works (http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works.html).

In the input configuration, you map the streaming source to an in-application stream, which you can think of as a constantly updating table. In the mapping, you must provide a schema for the in-application stream and map each data column in the in-application stream to a data element in the streaming source, with the option of renaming, casting and dropping columns as desired.

Your application code is one or more SQL statements that read input data, transform it, and generate output. Your application code can create one or more SQL artifacts like SQL streams or pumps.

In the output configuration, you can configure the application to write data from in-application streams created in your applications to up to five streaming destinations.

To read data from your source stream or write data to destination streams,

Amazon Kinesis Analytics needs your permissions. You grant these permissions by creating IAM roles. This operation requires permissions to perform the kinesisanalytics:CreateApplication action.

For introductory exercises to create an Amazon Kinesis Analytics application,

see Getting Started (http://docs.aws.amazon.com/kinesisanalytics/latest/dev/getting-started.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Analytics's API operation CreateApplication for usage and error information.

Returned Error Codes:

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

  • ResourceInUseException Application is not available for this operation.

  • LimitExceededException Exceeded the number of applications allowed.

  • InvalidArgumentException Specified input parameter value is invalid.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/kinesisanalytics"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := kinesisanalytics.New(sess)

	params := &kinesisanalytics.CreateApplicationInput{
		ApplicationName:        aws.String("ApplicationName"), // Required
		ApplicationCode:        aws.String("ApplicationCode"),
		ApplicationDescription: aws.String("ApplicationDescription"),
		Inputs: []*kinesisanalytics.Input{
			{ // Required
				InputSchema: &kinesisanalytics.SourceSchema{ // Required
					RecordColumns: []*kinesisanalytics.RecordColumn{ // Required
						{ // Required
							Name:    aws.String("RecordColumnName"),    // Required
							SqlType: aws.String("RecordColumnSqlType"), // Required
							Mapping: aws.String("RecordColumnMapping"),
						},
						// More values...
					},
					RecordFormat: &kinesisanalytics.RecordFormat{ // Required
						RecordFormatType: aws.String("RecordFormatType"), // Required
						MappingParameters: &kinesisanalytics.MappingParameters{
							CSVMappingParameters: &kinesisanalytics.CSVMappingParameters{
								RecordColumnDelimiter: aws.String("RecordColumnDelimiter"), // Required
								RecordRowDelimiter:    aws.String("RecordRowDelimiter"),    // Required
							},
							JSONMappingParameters: &kinesisanalytics.JSONMappingParameters{
								RecordRowPath: aws.String("RecordRowPath"), // Required
							},
						},
					},
					RecordEncoding: aws.String("RecordEncoding"),
				},
				NamePrefix: aws.String("InAppStreamName"), // Required
				InputParallelism: &kinesisanalytics.InputParallelism{
					Count: aws.Int64(1),
				},
				KinesisFirehoseInput: &kinesisanalytics.KinesisFirehoseInput{
					ResourceARN: aws.String("ResourceARN"), // Required
					RoleARN:     aws.String("RoleARN"),     // Required
				},
				KinesisStreamsInput: &kinesisanalytics.KinesisStreamsInput{
					ResourceARN: aws.String("ResourceARN"), // Required
					RoleARN:     aws.String("RoleARN"),     // Required
				},
			},
			// More values...
		},
		Outputs: []*kinesisanalytics.Output{
			{ // Required
				DestinationSchema: &kinesisanalytics.DestinationSchema{ // Required
					RecordFormatType: aws.String("RecordFormatType"),
				},
				Name: aws.String("InAppStreamName"), // Required
				KinesisFirehoseOutput: &kinesisanalytics.KinesisFirehoseOutput{
					ResourceARN: aws.String("ResourceARN"), // Required
					RoleARN:     aws.String("RoleARN"),     // Required
				},
				KinesisStreamsOutput: &kinesisanalytics.KinesisStreamsOutput{
					ResourceARN: aws.String("ResourceARN"), // Required
					RoleARN:     aws.String("RoleARN"),     // Required
				},
			},
			// More values...
		},
	}
	resp, err := svc.CreateApplication(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*KinesisAnalytics) CreateApplicationRequest

func (c *KinesisAnalytics) CreateApplicationRequest(input *CreateApplicationInput) (req *request.Request, output *CreateApplicationOutput)

CreateApplicationRequest generates a "aws/request.Request" representing the client's request for the CreateApplication operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See CreateApplication for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateApplication method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the CreateApplicationRequest method.
req, resp := client.CreateApplicationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*KinesisAnalytics) DeleteApplication

func (c *KinesisAnalytics) DeleteApplication(input *DeleteApplicationInput) (*DeleteApplicationOutput, error)

DeleteApplication API operation for Amazon Kinesis Analytics.

Deletes the specified application. Amazon Kinesis Analytics halts application execution and deletes the application, including any application artifacts (such as in-application streams, reference table, and application code).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Analytics's API operation DeleteApplication for usage and error information.

Returned Error Codes:

  • ConcurrentModificationException Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.

  • ResourceNotFoundException Specified application can't be found.

  • ResourceInUseException Application is not available for this operation.

Example
package main

import (
	"fmt"
	"time"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/kinesisanalytics"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := kinesisanalytics.New(sess)

	params := &kinesisanalytics.DeleteApplicationInput{
		ApplicationName: aws.String("ApplicationName"), // Required
		CreateTimestamp: aws.Time(time.Now()),          // Required
	}
	resp, err := svc.DeleteApplication(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*KinesisAnalytics) DeleteApplicationOutput

DeleteApplicationOutput API operation for Amazon Kinesis Analytics.

Deletes output destination configuration from your application configuration. Amazon Kinesis Analytics will no longer write data from the corresponding in-application stream to the external output destination.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Analytics's API operation DeleteApplicationOutput for usage and error information.

Returned Error Codes:

  • ResourceNotFoundException Specified application can't be found.

  • ResourceInUseException Application is not available for this operation.

  • ConcurrentModificationException Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/kinesisanalytics"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := kinesisanalytics.New(sess)

	params := &kinesisanalytics.DeleteApplicationOutputInput{
		ApplicationName:             aws.String("ApplicationName"), // Required
		CurrentApplicationVersionId: aws.Int64(1),                  // Required
		OutputId:                    aws.String("Id"),              // Required
	}
	resp, err := svc.DeleteApplicationOutput(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*KinesisAnalytics) DeleteApplicationOutputRequest

func (c *KinesisAnalytics) DeleteApplicationOutputRequest(input *DeleteApplicationOutputInput) (req *request.Request, output *DeleteApplicationOutputOutput)

DeleteApplicationOutputRequest generates a "aws/request.Request" representing the client's request for the DeleteApplicationOutput operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DeleteApplicationOutput for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteApplicationOutput method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DeleteApplicationOutputRequest method.
req, resp := client.DeleteApplicationOutputRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*KinesisAnalytics) DeleteApplicationReferenceDataSource

DeleteApplicationReferenceDataSource API operation for Amazon Kinesis Analytics.

Deletes a reference data source configuration from the specified application configuration.

If the application is running, Amazon Kinesis Analytics immediately removes the in-application table that you created using the AddApplicationReferenceDataSource operation.

This operation requires permissions to perform the kinesisanalytics.DeleteApplicationReferenceDataSource action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Analytics's API operation DeleteApplicationReferenceDataSource for usage and error information.

Returned Error Codes:

  • ResourceNotFoundException Specified application can't be found.

  • ResourceInUseException Application is not available for this operation.

  • InvalidArgumentException Specified input parameter value is invalid.

  • ConcurrentModificationException Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/kinesisanalytics"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := kinesisanalytics.New(sess)

	params := &kinesisanalytics.DeleteApplicationReferenceDataSourceInput{
		ApplicationName:             aws.String("ApplicationName"), // Required
		CurrentApplicationVersionId: aws.Int64(1),                  // Required
		ReferenceId:                 aws.String("Id"),              // Required
	}
	resp, err := svc.DeleteApplicationReferenceDataSource(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*KinesisAnalytics) DeleteApplicationReferenceDataSourceRequest

func (c *KinesisAnalytics) DeleteApplicationReferenceDataSourceRequest(input *DeleteApplicationReferenceDataSourceInput) (req *request.Request, output *DeleteApplicationReferenceDataSourceOutput)

DeleteApplicationReferenceDataSourceRequest generates a "aws/request.Request" representing the client's request for the DeleteApplicationReferenceDataSource operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DeleteApplicationReferenceDataSource for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteApplicationReferenceDataSource method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DeleteApplicationReferenceDataSourceRequest method.
req, resp := client.DeleteApplicationReferenceDataSourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*KinesisAnalytics) DeleteApplicationRequest

func (c *KinesisAnalytics) DeleteApplicationRequest(input *DeleteApplicationInput) (req *request.Request, output *DeleteApplicationOutput)

DeleteApplicationRequest generates a "aws/request.Request" representing the client's request for the DeleteApplication operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DeleteApplication for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteApplication method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DeleteApplicationRequest method.
req, resp := client.DeleteApplicationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*KinesisAnalytics) DescribeApplication

func (c *KinesisAnalytics) DescribeApplication(input *DescribeApplicationInput) (*DescribeApplicationOutput, error)

DescribeApplication API operation for Amazon Kinesis Analytics.

Returns information about a specific Amazon Kinesis Analytics application.

If you want to retrieve a list of all applications in your account, use the ListApplications operation.

This operation requires permissions to perform the kinesisanalytics:DescribeApplication action. You can use DescribeApplication to get the current application versionId, which you need to call other operations such as Update.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Analytics's API operation DescribeApplication for usage and error information.

Returned Error Codes:

  • ResourceNotFoundException Specified application can't be found.
Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/kinesisanalytics"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := kinesisanalytics.New(sess)

	params := &kinesisanalytics.DescribeApplicationInput{
		ApplicationName: aws.String("ApplicationName"), // Required
	}
	resp, err := svc.DescribeApplication(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*KinesisAnalytics) DescribeApplicationRequest

func (c *KinesisAnalytics) DescribeApplicationRequest(input *DescribeApplicationInput) (req *request.Request, output *DescribeApplicationOutput)

DescribeApplicationRequest generates a "aws/request.Request" representing the client's request for the DescribeApplication operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DescribeApplication for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeApplication method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DescribeApplicationRequest method.
req, resp := client.DescribeApplicationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*KinesisAnalytics) DiscoverInputSchema

func (c *KinesisAnalytics) DiscoverInputSchema(input *DiscoverInputSchemaInput) (*DiscoverInputSchemaOutput, error)

DiscoverInputSchema API operation for Amazon Kinesis Analytics.

Infers a schema by evaluating sample records on the specified streaming source (Amazon Kinesis stream or Amazon Kinesis Firehose delivery stream). In the response, the operation returns the inferred schema and also the sample records that the operation used to infer the schema.

You can use the inferred schema when configuring a streaming source for

your application. For conceptual information, see Configuring Application Input (http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html). Note that when you create an application using the Amazon Kinesis Analytics console, the console uses this operation to infer a schema and show it in the console user interface.

This operation requires permissions to perform the kinesisanalytics:DiscoverInputSchema

action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Analytics's API operation DiscoverInputSchema for usage and error information.

Returned Error Codes:

  • InvalidArgumentException Specified input parameter value is invalid.

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

  • ResourceProvisionedThroughputExceededException Discovery failed to get a record from the streaming source because of the Kinesis Streams ProvisionedThroughputExceededException.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/kinesisanalytics"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := kinesisanalytics.New(sess)

	params := &kinesisanalytics.DiscoverInputSchemaInput{
		InputStartingPositionConfiguration: &kinesisanalytics.InputStartingPositionConfiguration{ // Required
			InputStartingPosition: aws.String("InputStartingPosition"),
		},
		ResourceARN: aws.String("ResourceARN"), // Required
		RoleARN:     aws.String("RoleARN"),     // Required
	}
	resp, err := svc.DiscoverInputSchema(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*KinesisAnalytics) DiscoverInputSchemaRequest

func (c *KinesisAnalytics) DiscoverInputSchemaRequest(input *DiscoverInputSchemaInput) (req *request.Request, output *DiscoverInputSchemaOutput)

DiscoverInputSchemaRequest generates a "aws/request.Request" representing the client's request for the DiscoverInputSchema operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DiscoverInputSchema for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DiscoverInputSchema method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the DiscoverInputSchemaRequest method.
req, resp := client.DiscoverInputSchemaRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*KinesisAnalytics) ListApplications

func (c *KinesisAnalytics) ListApplications(input *ListApplicationsInput) (*ListApplicationsOutput, error)

ListApplications API operation for Amazon Kinesis Analytics.

Returns a list of Amazon Kinesis Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status. If the response returns the HasMoreApplications value as true, you can send another request by adding the ExclusiveStartApplicationName in the request body, and set the value of this to the last application name from the previous response.

If you want detailed information about a specific application, use DescribeApplication.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Analytics's API operation ListApplications for usage and error information.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/kinesisanalytics"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := kinesisanalytics.New(sess)

	params := &kinesisanalytics.ListApplicationsInput{
		ExclusiveStartApplicationName: aws.String("ApplicationName"),
		Limit:                         aws.Int64(1),
	}
	resp, err := svc.ListApplications(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*KinesisAnalytics) ListApplicationsRequest

func (c *KinesisAnalytics) ListApplicationsRequest(input *ListApplicationsInput) (req *request.Request, output *ListApplicationsOutput)

ListApplicationsRequest generates a "aws/request.Request" representing the client's request for the ListApplications operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ListApplications for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListApplications method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the ListApplicationsRequest method.
req, resp := client.ListApplicationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*KinesisAnalytics) StartApplication

func (c *KinesisAnalytics) StartApplication(input *StartApplicationInput) (*StartApplicationOutput, error)

StartApplication API operation for Amazon Kinesis Analytics.

Starts the specified Amazon Kinesis Analytics application. After creating an application, you must exclusively call this operation to start your application.

After the application starts, it begins consuming the input data, processes it, and writes the output to the configured destination.

The application status must be READY for you to start an application. You

can get the application status in the console or using the DescribeApplication operation.

After you start the application, you can stop the application from processing the input by calling the StopApplication operation.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Analytics's API operation StartApplication for usage and error information.

Returned Error Codes:

  • ResourceNotFoundException Specified application can't be found.

  • ResourceInUseException Application is not available for this operation.

  • InvalidArgumentException Specified input parameter value is invalid.

  • InvalidApplicationConfigurationException User-provided application configuration is not valid.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/kinesisanalytics"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := kinesisanalytics.New(sess)

	params := &kinesisanalytics.StartApplicationInput{
		ApplicationName: aws.String("ApplicationName"), // Required
		InputConfigurations: []*kinesisanalytics.InputConfiguration{ // Required
			{ // Required
				Id: aws.String("Id"), // Required
				InputStartingPositionConfiguration: &kinesisanalytics.InputStartingPositionConfiguration{ // Required
					InputStartingPosition: aws.String("InputStartingPosition"),
				},
			},
			// More values...
		},
	}
	resp, err := svc.StartApplication(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*KinesisAnalytics) StartApplicationRequest

func (c *KinesisAnalytics) StartApplicationRequest(input *StartApplicationInput) (req *request.Request, output *StartApplicationOutput)

StartApplicationRequest generates a "aws/request.Request" representing the client's request for the StartApplication operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See StartApplication for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the StartApplication method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the StartApplicationRequest method.
req, resp := client.StartApplicationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*KinesisAnalytics) StopApplication

func (c *KinesisAnalytics) StopApplication(input *StopApplicationInput) (*StopApplicationOutput, error)

StopApplication API operation for Amazon Kinesis Analytics.

Stops the application from processing input data. You can stop an application only if it is in the running state. You can use the DescribeApplication operation to find the application state. After the application is stopped, Amazon Kinesis Analytics stops reading data from the input, the application stops processing data, and there is no output written to the destination.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Analytics's API operation StopApplication for usage and error information.

Returned Error Codes:

  • ResourceNotFoundException Specified application can't be found.

  • ResourceInUseException Application is not available for this operation.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/kinesisanalytics"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := kinesisanalytics.New(sess)

	params := &kinesisanalytics.StopApplicationInput{
		ApplicationName: aws.String("ApplicationName"), // Required
	}
	resp, err := svc.StopApplication(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*KinesisAnalytics) StopApplicationRequest

func (c *KinesisAnalytics) StopApplicationRequest(input *StopApplicationInput) (req *request.Request, output *StopApplicationOutput)

StopApplicationRequest generates a "aws/request.Request" representing the client's request for the StopApplication operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See StopApplication for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the StopApplication method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the StopApplicationRequest method.
req, resp := client.StopApplicationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*KinesisAnalytics) UpdateApplication

func (c *KinesisAnalytics) UpdateApplication(input *UpdateApplicationInput) (*UpdateApplicationOutput, error)

UpdateApplication API operation for Amazon Kinesis Analytics.

Updates an existing Kinesis Analytics application. Using this API, you can update application code, input configuration, and output configuration.

Note that Kinesis Analytics updates the CurrentApplicationVersionId each time you update your application.

This opeation requires permission for the kinesisanalytics:UpdateApplication action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Kinesis Analytics's API operation UpdateApplication for usage and error information.

Returned Error Codes:

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

  • ResourceNotFoundException Specified application can't be found.

  • ResourceInUseException Application is not available for this operation.

  • InvalidArgumentException Specified input parameter value is invalid.

  • ConcurrentModificationException Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/kinesisanalytics"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := kinesisanalytics.New(sess)

	params := &kinesisanalytics.UpdateApplicationInput{
		ApplicationName: aws.String("ApplicationName"), // Required
		ApplicationUpdate: &kinesisanalytics.ApplicationUpdate{ // Required
			ApplicationCodeUpdate: aws.String("ApplicationCode"),
			InputUpdates: []*kinesisanalytics.InputUpdate{
				{ // Required
					InputId: aws.String("Id"), // Required
					InputParallelismUpdate: &kinesisanalytics.InputParallelismUpdate{
						CountUpdate: aws.Int64(1),
					},
					InputSchemaUpdate: &kinesisanalytics.InputSchemaUpdate{
						RecordColumnUpdates: []*kinesisanalytics.RecordColumn{
							{ // Required
								Name:    aws.String("RecordColumnName"),    // Required
								SqlType: aws.String("RecordColumnSqlType"), // Required
								Mapping: aws.String("RecordColumnMapping"),
							},
							// More values...
						},
						RecordEncodingUpdate: aws.String("RecordEncoding"),
						RecordFormatUpdate: &kinesisanalytics.RecordFormat{
							RecordFormatType: aws.String("RecordFormatType"), // Required
							MappingParameters: &kinesisanalytics.MappingParameters{
								CSVMappingParameters: &kinesisanalytics.CSVMappingParameters{
									RecordColumnDelimiter: aws.String("RecordColumnDelimiter"), // Required
									RecordRowDelimiter:    aws.String("RecordRowDelimiter"),    // Required
								},
								JSONMappingParameters: &kinesisanalytics.JSONMappingParameters{
									RecordRowPath: aws.String("RecordRowPath"), // Required
								},
							},
						},
					},
					KinesisFirehoseInputUpdate: &kinesisanalytics.KinesisFirehoseInputUpdate{
						ResourceARNUpdate: aws.String("ResourceARN"),
						RoleARNUpdate:     aws.String("RoleARN"),
					},
					KinesisStreamsInputUpdate: &kinesisanalytics.KinesisStreamsInputUpdate{
						ResourceARNUpdate: aws.String("ResourceARN"),
						RoleARNUpdate:     aws.String("RoleARN"),
					},
					NamePrefixUpdate: aws.String("InAppStreamName"),
				},
				// More values...
			},
			OutputUpdates: []*kinesisanalytics.OutputUpdate{
				{ // Required
					OutputId: aws.String("Id"), // Required
					DestinationSchemaUpdate: &kinesisanalytics.DestinationSchema{
						RecordFormatType: aws.String("RecordFormatType"),
					},
					KinesisFirehoseOutputUpdate: &kinesisanalytics.KinesisFirehoseOutputUpdate{
						ResourceARNUpdate: aws.String("ResourceARN"),
						RoleARNUpdate:     aws.String("RoleARN"),
					},
					KinesisStreamsOutputUpdate: &kinesisanalytics.KinesisStreamsOutputUpdate{
						ResourceARNUpdate: aws.String("ResourceARN"),
						RoleARNUpdate:     aws.String("RoleARN"),
					},
					NameUpdate: aws.String("InAppStreamName"),
				},
				// More values...
			},
			ReferenceDataSourceUpdates: []*kinesisanalytics.ReferenceDataSourceUpdate{
				{ // Required
					ReferenceId: aws.String("Id"), // Required
					ReferenceSchemaUpdate: &kinesisanalytics.SourceSchema{
						RecordColumns: []*kinesisanalytics.RecordColumn{ // Required
							{ // Required
								Name:    aws.String("RecordColumnName"),    // Required
								SqlType: aws.String("RecordColumnSqlType"), // Required
								Mapping: aws.String("RecordColumnMapping"),
							},
							// More values...
						},
						RecordFormat: &kinesisanalytics.RecordFormat{ // Required
							RecordFormatType: aws.String("RecordFormatType"), // Required
							MappingParameters: &kinesisanalytics.MappingParameters{
								CSVMappingParameters: &kinesisanalytics.CSVMappingParameters{
									RecordColumnDelimiter: aws.String("RecordColumnDelimiter"), // Required
									RecordRowDelimiter:    aws.String("RecordRowDelimiter"),    // Required
								},
								JSONMappingParameters: &kinesisanalytics.JSONMappingParameters{
									RecordRowPath: aws.String("RecordRowPath"), // Required
								},
							},
						},
						RecordEncoding: aws.String("RecordEncoding"),
					},
					S3ReferenceDataSourceUpdate: &kinesisanalytics.S3ReferenceDataSourceUpdate{
						BucketARNUpdate:        aws.String("BucketARN"),
						FileKeyUpdate:          aws.String("FileKey"),
						ReferenceRoleARNUpdate: aws.String("RoleARN"),
					},
					TableNameUpdate: aws.String("InAppTableName"),
				},
				// More values...
			},
		},
		CurrentApplicationVersionId: aws.Int64(1), // Required
	}
	resp, err := svc.UpdateApplication(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*KinesisAnalytics) UpdateApplicationRequest

func (c *KinesisAnalytics) UpdateApplicationRequest(input *UpdateApplicationInput) (req *request.Request, output *UpdateApplicationOutput)

UpdateApplicationRequest generates a "aws/request.Request" representing the client's request for the UpdateApplication operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See UpdateApplication for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateApplication method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// Example sending a request using the UpdateApplicationRequest method.
req, resp := client.UpdateApplicationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

type KinesisFirehoseInput

type KinesisFirehoseInput struct {

	// ARN of the input Firehose delivery stream.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// ARN of the IAM role that Amazon Kinesis Analytics can assume to access the
	// stream on your behalf. You need to make sure the role has necessary permissions
	// to access the stream.
	//
	// RoleARN is a required field
	RoleARN *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (KinesisFirehoseInput) GoString

func (s KinesisFirehoseInput) GoString() string

GoString returns the string representation

func (KinesisFirehoseInput) String

func (s KinesisFirehoseInput) String() string

String returns the string representation

func (*KinesisFirehoseInput) Validate

func (s *KinesisFirehoseInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type KinesisFirehoseInputDescription

type KinesisFirehoseInputDescription struct {

	// Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream.
	ResourceARN *string `min:"1" type:"string"`

	// ARN of the IAM role that Amazon Kinesis Analytics assumes to access the stream.
	RoleARN *string `min:"1" type:"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.

func (KinesisFirehoseInputDescription) GoString

GoString returns the string representation

func (KinesisFirehoseInputDescription) String

String returns the string representation

type KinesisFirehoseInputUpdate

type KinesisFirehoseInputUpdate struct {

	// ARN of the input Amazon Kinesis Firehose delivery stream to read.
	ResourceARNUpdate *string `min:"1" type:"string"`

	// Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Analytics
	// can assume to access the stream on your behalf. You need to grant necessary
	// permissions to this role.
	RoleARNUpdate *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (KinesisFirehoseInputUpdate) GoString

func (s KinesisFirehoseInputUpdate) GoString() string

GoString returns the string representation

func (KinesisFirehoseInputUpdate) String

String returns the string representation

func (*KinesisFirehoseInputUpdate) Validate

func (s *KinesisFirehoseInputUpdate) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type KinesisFirehoseOutput

type KinesisFirehoseOutput struct {

	// ARN of the destination Amazon Kinesis Firehose delivery stream to write to.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// 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.
	//
	// RoleARN is a required field
	RoleARN *string `min:"1" type:"string" required:"true"`
	// 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.

func (KinesisFirehoseOutput) GoString

func (s KinesisFirehoseOutput) GoString() string

GoString returns the string representation

func (KinesisFirehoseOutput) String

func (s KinesisFirehoseOutput) String() string

String returns the string representation

func (*KinesisFirehoseOutput) Validate

func (s *KinesisFirehoseOutput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type KinesisFirehoseOutputDescription

type KinesisFirehoseOutputDescription struct {

	// Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream.
	ResourceARN *string `min:"1" type:"string"`

	// ARN of the IAM role that Amazon Kinesis Analytics can assume to access the
	// stream.
	RoleARN *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (KinesisFirehoseOutputDescription) GoString

GoString returns the string representation

func (KinesisFirehoseOutputDescription) String

String returns the string representation

type KinesisFirehoseOutputUpdate

type KinesisFirehoseOutputUpdate struct {

	// Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream
	// to write to.
	ResourceARNUpdate *string `min:"1" type:"string"`

	// ARN of the IAM role that Amazon Kinesis Analytics can assume to access the
	// stream on your behalf. You need to grant necessary permissions to this role.
	RoleARNUpdate *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

When updating an output configuration using the UpdateApplication operation, provides information about an Amazon Kinesis Firehose delivery stream configured as the destination.

func (KinesisFirehoseOutputUpdate) GoString

func (s KinesisFirehoseOutputUpdate) GoString() string

GoString returns the string representation

func (KinesisFirehoseOutputUpdate) String

String returns the string representation

func (*KinesisFirehoseOutputUpdate) Validate

func (s *KinesisFirehoseOutputUpdate) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type KinesisStreamsInput

type KinesisStreamsInput struct {

	// ARN of the input Amazon Kinesis stream to read.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// 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.
	//
	// RoleARN is a required field
	RoleARN *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Identifies an Amazon Kinesis stream as the streaming source. You provide the stream's ARN and an IAM role ARN that enables Amazon Kinesis Analytics to access the stream on your behalf.

func (KinesisStreamsInput) GoString

func (s KinesisStreamsInput) GoString() string

GoString returns the string representation

func (KinesisStreamsInput) String

func (s KinesisStreamsInput) String() string

String returns the string representation

func (*KinesisStreamsInput) Validate

func (s *KinesisStreamsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type KinesisStreamsInputDescription

type KinesisStreamsInputDescription struct {

	// Amazon Resource Name (ARN) of the Amazon Kinesis stream.
	ResourceARN *string `min:"1" type:"string"`

	// ARN of the IAM role that Amazon Kinesis Analytics can assume to access the
	// stream.
	RoleARN *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (KinesisStreamsInputDescription) GoString

GoString returns the string representation

func (KinesisStreamsInputDescription) String

String returns the string representation

type KinesisStreamsInputUpdate

type KinesisStreamsInputUpdate struct {

	// Amazon Resource Name (ARN) of the input Amazon Kinesis stream to read.
	ResourceARNUpdate *string `min:"1" type:"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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (KinesisStreamsInputUpdate) GoString

func (s KinesisStreamsInputUpdate) GoString() string

GoString returns the string representation

func (KinesisStreamsInputUpdate) String

func (s KinesisStreamsInputUpdate) String() string

String returns the string representation

func (*KinesisStreamsInputUpdate) Validate

func (s *KinesisStreamsInputUpdate) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type KinesisStreamsOutput

type KinesisStreamsOutput struct {

	// ARN of the destination Amazon Kinesis stream to write to.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// 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.
	//
	// RoleARN is a required field
	RoleARN *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

When configuring application output, identifies a 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.

func (KinesisStreamsOutput) GoString

func (s KinesisStreamsOutput) GoString() string

GoString returns the string representation

func (KinesisStreamsOutput) String

func (s KinesisStreamsOutput) String() string

String returns the string representation

func (*KinesisStreamsOutput) Validate

func (s *KinesisStreamsOutput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type KinesisStreamsOutputDescription

type KinesisStreamsOutputDescription struct {

	// Amazon Resource Name (ARN) of the Amazon Kinesis stream.
	ResourceARN *string `min:"1" type:"string"`

	// ARN of the IAM role that Amazon Kinesis Analytics can assume to access the
	// stream.
	RoleARN *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (KinesisStreamsOutputDescription) GoString

GoString returns the string representation

func (KinesisStreamsOutputDescription) String

String returns the string representation

type KinesisStreamsOutputUpdate

type KinesisStreamsOutputUpdate struct {

	// Amazon Resource Name (ARN) of the Amazon Kinesis stream where you want to
	// write the output.
	ResourceARNUpdate *string `min:"1" type:"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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

When updating an output configuration using the UpdateApplication operation, provides information about an Amazon Kinesis stream configured as the destination.

func (KinesisStreamsOutputUpdate) GoString

func (s KinesisStreamsOutputUpdate) GoString() string

GoString returns the string representation

func (KinesisStreamsOutputUpdate) String

String returns the string representation

func (*KinesisStreamsOutputUpdate) Validate

func (s *KinesisStreamsOutputUpdate) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListApplicationsInput

type ListApplicationsInput struct {

	// Name of the application to start the list with. When using pagination to
	// retrieve the list, you don't need to specify this parameter in the first
	// request. However, in subsequent requests, you add the last application name
	// from the previous response to get the next page of applications.
	ExclusiveStartApplicationName *string `min:"1" type:"string"`

	// Maximum number of applications to list.
	Limit *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

func (ListApplicationsInput) GoString

func (s ListApplicationsInput) GoString() string

GoString returns the string representation

func (ListApplicationsInput) String

func (s ListApplicationsInput) String() string

String returns the string representation

func (*ListApplicationsInput) Validate

func (s *ListApplicationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListApplicationsOutput

type ListApplicationsOutput struct {

	// List of ApplicationSummary objects.
	//
	// ApplicationSummaries is a required field
	ApplicationSummaries []*ApplicationSummary `type:"list" required:"true"`

	// Returns true if there are more applications to retrieve.
	//
	// HasMoreApplications is a required field
	HasMoreApplications *bool `type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

func (ListApplicationsOutput) GoString

func (s ListApplicationsOutput) GoString() string

GoString returns the string representation

func (ListApplicationsOutput) String

func (s ListApplicationsOutput) String() string

String returns the string representation

type MappingParameters

type MappingParameters struct {

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

	// Provides additional mapping information when JSON is the record format on
	// the streaming source.
	JSONMappingParameters *JSONMappingParameters `type:"structure"`
	// 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.

func (MappingParameters) GoString

func (s MappingParameters) GoString() string

GoString returns the string representation

func (MappingParameters) String

func (s MappingParameters) String() string

String returns the string representation

func (*MappingParameters) Validate

func (s *MappingParameters) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Output

type Output struct {

	// Describes the data format when records are written to the destination. For
	// more information, see Configuring Application Output (http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html).
	//
	// DestinationSchema is a required field
	DestinationSchema *DestinationSchema `type:"structure" required:"true"`

	// Identifies an Amazon Kinesis Firehose delivery stream as the destination.
	KinesisFirehoseOutput *KinesisFirehoseOutput `type:"structure"`

	// Identifies an Amazon Kinesis stream as the destination.
	KinesisStreamsOutput *KinesisStreamsOutput `type:"structure"`

	// Name of the in-application stream.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// 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.

You can configure your application to write output to up to five destinations.

func (Output) GoString

func (s Output) GoString() string

GoString returns the string representation

func (Output) String

func (s Output) String() string

String returns the string representation

func (*Output) Validate

func (s *Output) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type OutputDescription

type OutputDescription struct {

	// Data format used for writing data to the destination.
	DestinationSchema *DestinationSchema `type:"structure"`

	// Describes the Amazon Kinesis Firehose delivery stream configured as the destination
	// where output is written.
	KinesisFirehoseOutputDescription *KinesisFirehoseOutputDescription `type:"structure"`

	// Describes Amazon Kinesis stream configured as the destination where output
	// is written.
	KinesisStreamsOutputDescription *KinesisStreamsOutputDescription `type:"structure"`

	// Name of the in-application stream configured as output.
	Name *string `min:"1" type:"string"`

	// A unique identifier for the output configuration.
	OutputId *string `min:"1" type:"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.

func (OutputDescription) GoString

func (s OutputDescription) GoString() string

GoString returns the string representation

func (OutputDescription) String

func (s OutputDescription) String() string

String returns the string representation

type OutputUpdate

type OutputUpdate struct {

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

	// Describes a Amazon Kinesis Firehose delivery stream as the destination for
	// the output.
	KinesisFirehoseOutputUpdate *KinesisFirehoseOutputUpdate `type:"structure"`

	// Describes an Amazon Kinesis stream as the destination for the output.
	KinesisStreamsOutputUpdate *KinesisStreamsOutputUpdate `type:"structure"`

	// 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 `min:"1" type:"string"`

	// Identifies the specific output configuration that you want to update.
	//
	// OutputId is a required field
	OutputId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes updates to the output configuration identified by the OutputId.

func (OutputUpdate) GoString

func (s OutputUpdate) GoString() string

GoString returns the string representation

func (OutputUpdate) String

func (s OutputUpdate) String() string

String returns the string representation

func (*OutputUpdate) Validate

func (s *OutputUpdate) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RecordColumn

type RecordColumn struct {

	// Reference to the data element in the streaming input of the reference data
	// source.
	Mapping *string `type:"string"`

	// Name of the column created in the in-application input stream or reference
	// table.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// Type of column created in the in-application input stream or reference table.
	//
	// SqlType is a required field
	SqlType *string `type:"string" required:"true"`
	// 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.

func (RecordColumn) GoString

func (s RecordColumn) GoString() string

GoString returns the string representation

func (RecordColumn) String

func (s RecordColumn) String() string

String returns the string representation

func (*RecordColumn) Validate

func (s *RecordColumn) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RecordFormat

type RecordFormat struct {

	// 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 `type:"structure"`

	// The type of record format.
	//
	// RecordFormatType is a required field
	RecordFormatType *string `type:"string" required:"true" enum:"RecordFormatType"`
	// contains filtered or unexported fields
}

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

func (RecordFormat) GoString

func (s RecordFormat) GoString() string

GoString returns the string representation

func (RecordFormat) String

func (s RecordFormat) String() string

String returns the string representation

func (*RecordFormat) Validate

func (s *RecordFormat) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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.
	//
	// ReferenceSchema is a required field
	ReferenceSchema *SourceSchema `type:"structure" required:"true"`

	// 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 `type:"structure"`

	// Name of the in-application table to create.
	//
	// TableName is a required field
	TableName *string `min:"1" type:"string" required:"true"`
	// 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.

func (ReferenceDataSource) GoString

func (s ReferenceDataSource) GoString() string

GoString returns the string representation

func (ReferenceDataSource) String

func (s ReferenceDataSource) String() string

String returns the string representation

func (*ReferenceDataSource) Validate

func (s *ReferenceDataSource) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 operation.
	//
	// ReferenceId is a required field
	ReferenceId *string `min:"1" type:"string" required:"true"`

	// 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 `type:"structure"`

	// 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.
	//
	// S3ReferenceDataSourceDescription is a required field
	S3ReferenceDataSourceDescription *S3ReferenceDataSourceDescription `type:"structure" required:"true"`

	// The in-application table name created by the specific reference data source
	// configuration.
	//
	// TableName is a required field
	TableName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes the reference data source configured for an application.

func (ReferenceDataSourceDescription) GoString

GoString returns the string representation

func (ReferenceDataSourceDescription) String

String returns the string representation

type ReferenceDataSourceUpdate

type ReferenceDataSourceUpdate struct {

	// ID of the reference data source being updated. You can use the DescribeApplication
	// operation to get this value.
	//
	// ReferenceId is a required field
	ReferenceId *string `min:"1" type:"string" required:"true"`

	// 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 `type:"structure"`

	// 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 `type:"structure"`

	// In-application table name that is created by this update.
	TableNameUpdate *string `min:"1" type:"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.

func (ReferenceDataSourceUpdate) GoString

func (s ReferenceDataSourceUpdate) GoString() string

GoString returns the string representation

func (ReferenceDataSourceUpdate) String

func (s ReferenceDataSourceUpdate) String() string

String returns the string representation

func (*ReferenceDataSourceUpdate) Validate

func (s *ReferenceDataSourceUpdate) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type S3ReferenceDataSource

type S3ReferenceDataSource struct {

	// Amazon Resource Name (ARN) of the S3 bucket.
	//
	// BucketARN is a required field
	BucketARN *string `min:"1" type:"string" required:"true"`

	// Object key name containing reference data.
	//
	// FileKey is a required field
	FileKey *string `type:"string" required:"true"`

	// 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.
	//
	// ReferenceRoleARN is a required field
	ReferenceRoleARN *string `min:"1" type:"string" required:"true"`
	// 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 operation to trigger reloading of data into your application.

func (S3ReferenceDataSource) GoString

func (s S3ReferenceDataSource) GoString() string

GoString returns the string representation

func (S3ReferenceDataSource) String

func (s S3ReferenceDataSource) String() string

String returns the string representation

func (*S3ReferenceDataSource) Validate

func (s *S3ReferenceDataSource) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type S3ReferenceDataSourceDescription

type S3ReferenceDataSourceDescription struct {

	// Amazon Resource Name (ARN) of the S3 bucket.
	//
	// BucketARN is a required field
	BucketARN *string `min:"1" type:"string" required:"true"`

	// Amazon S3 object key name.
	//
	// FileKey is a required field
	FileKey *string `type:"string" required:"true"`

	// 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.
	//
	// ReferenceRoleARN is a required field
	ReferenceRoleARN *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (S3ReferenceDataSourceDescription) GoString

GoString returns the string representation

func (S3ReferenceDataSourceDescription) String

String returns the string representation

type S3ReferenceDataSourceUpdate

type S3ReferenceDataSourceUpdate struct {

	// Amazon Resource Name (ARN) of the S3 bucket.
	BucketARNUpdate *string `min:"1" type:"string"`

	// Object key name.
	FileKeyUpdate *string `type:"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 `min:"1" type:"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.

func (S3ReferenceDataSourceUpdate) GoString

func (s S3ReferenceDataSourceUpdate) GoString() string

GoString returns the string representation

func (S3ReferenceDataSourceUpdate) String

String returns the string representation

func (*S3ReferenceDataSourceUpdate) Validate

func (s *S3ReferenceDataSourceUpdate) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SourceSchema

type SourceSchema struct {

	// A list of RecordColumn objects.
	//
	// RecordColumns is a required field
	RecordColumns []*RecordColumn `min:"1" type:"list" required:"true"`

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

	// Specifies the format of the records on the streaming source.
	//
	// RecordFormat is a required field
	RecordFormat *RecordFormat `type:"structure" required:"true"`
	// 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.

func (SourceSchema) GoString

func (s SourceSchema) GoString() string

GoString returns the string representation

func (SourceSchema) String

func (s SourceSchema) String() string

String returns the string representation

func (*SourceSchema) Validate

func (s *SourceSchema) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartApplicationInput

type StartApplicationInput struct {

	// Name of the application.
	//
	// ApplicationName is a required field
	ApplicationName *string `min:"1" type:"string" required:"true"`

	// Identifies the specific input, by ID, that the application starts consuming.
	// Amazon Kinesis Analytics starts reading the streaming source associated with
	// the input. You can also specify where in the streaming source you want Amazon
	// Kinesis Analytics to start reading.
	//
	// InputConfigurations is a required field
	InputConfigurations []*InputConfiguration `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (StartApplicationInput) GoString

func (s StartApplicationInput) GoString() string

GoString returns the string representation

func (StartApplicationInput) String

func (s StartApplicationInput) String() string

String returns the string representation

func (*StartApplicationInput) Validate

func (s *StartApplicationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartApplicationOutput

type StartApplicationOutput struct {
	// contains filtered or unexported fields
}

func (StartApplicationOutput) GoString

func (s StartApplicationOutput) GoString() string

GoString returns the string representation

func (StartApplicationOutput) String

func (s StartApplicationOutput) String() string

String returns the string representation

type StopApplicationInput

type StopApplicationInput struct {

	// Name of the running application to stop.
	//
	// ApplicationName is a required field
	ApplicationName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopApplicationInput) GoString

func (s StopApplicationInput) GoString() string

GoString returns the string representation

func (StopApplicationInput) String

func (s StopApplicationInput) String() string

String returns the string representation

func (*StopApplicationInput) Validate

func (s *StopApplicationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopApplicationOutput

type StopApplicationOutput struct {
	// contains filtered or unexported fields
}

func (StopApplicationOutput) GoString

func (s StopApplicationOutput) GoString() string

GoString returns the string representation

func (StopApplicationOutput) String

func (s StopApplicationOutput) String() string

String returns the string representation

type UpdateApplicationInput

type UpdateApplicationInput struct {

	// Name of the Kinesis Analytics application to update.
	//
	// ApplicationName is a required field
	ApplicationName *string `min:"1" type:"string" required:"true"`

	// Describes application updates.
	//
	// ApplicationUpdate is a required field
	ApplicationUpdate *ApplicationUpdate `type:"structure" required:"true"`

	// The current application version ID. You can use the DescribeApplication operation
	// to get this value.
	//
	// CurrentApplicationVersionId is a required field
	CurrentApplicationVersionId *int64 `min:"1" type:"long" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateApplicationInput) GoString

func (s UpdateApplicationInput) GoString() string

GoString returns the string representation

func (UpdateApplicationInput) String

func (s UpdateApplicationInput) String() string

String returns the string representation

func (*UpdateApplicationInput) Validate

func (s *UpdateApplicationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateApplicationOutput

type UpdateApplicationOutput struct {
	// contains filtered or unexported fields
}

func (UpdateApplicationOutput) GoString

func (s UpdateApplicationOutput) GoString() string

GoString returns the string representation

func (UpdateApplicationOutput) String

func (s UpdateApplicationOutput) String() string

String returns the string representation

Directories

Path Synopsis
Package kinesisanalyticsiface provides an interface to enable mocking the Amazon Kinesis Analytics service client for testing your code.
Package kinesisanalyticsiface provides an interface to enable mocking the Amazon Kinesis Analytics service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL