firehose

package
v1.1.15 Latest Latest
Warning

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

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

Documentation

Overview

Package firehose provides a client for Amazon Kinesis Firehose.

Index

Examples

Constants

View Source 
const (
	// @enum CompressionFormat
	CompressionFormatUncompressed = "UNCOMPRESSED"
	// @enum CompressionFormat
	CompressionFormatGzip = "GZIP"
	// @enum CompressionFormat
	CompressionFormatZip = "ZIP"
	// @enum CompressionFormat
	CompressionFormatSnappy = "Snappy"
)
View Source 
const (
	// @enum DeliveryStreamStatus
	DeliveryStreamStatusCreating = "CREATING"
	// @enum DeliveryStreamStatus
	DeliveryStreamStatusDeleting = "DELETING"
	// @enum DeliveryStreamStatus
	DeliveryStreamStatusActive = "ACTIVE"
)
View Source 
const (
	// @enum NoEncryptionConfig
	NoEncryptionConfigNoEncryption = "NoEncryption"
)
View Source 
const ServiceName = "firehose"

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 BufferingHints 

type BufferingHints struct {

	// Buffer incoming data for the specified period of time, in seconds, before
	// delivering it to the destination. The default value is 300.
	IntervalInSeconds *int64 `min:"60" type:"integer"`

	// Buffer incoming data to the specified size, in MBs, before delivering it
	// to the destination. The default value is 5.
	//
	// We recommend setting SizeInMBs to a value greater than the amount of data
	// you typically ingest into the delivery stream in 10 seconds. For example,
	// if you typically ingest data at 1 MB/sec set SizeInMBs to be 10 MB or higher.
	SizeInMBs *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

Describes the buffering to perform before delivering data to the destination.

func (BufferingHints) GoString 

func (s BufferingHints) GoString() string

GoString returns the string representation

func (BufferingHints) String 

func (s BufferingHints) String() string

String returns the string representation

type CopyCommand 

type CopyCommand struct {

	// Optional parameters to use with the Amazon Redshift COPY command. For more
	// information, see the "Optional Parameters" section of Amazon Redshift COPY
	// command (http://docs.aws.amazon.com/redshift/latest/dg/r_COPY.html). Some
	// possible examples that would apply to Amazon Kinesis Firehose are as follows.
	//
	// delimiter '\t' lzop; - fields are delimited with "\t" (TAB character) and
	// compressed using lzop.
	//
	// delimiter '| - fields are delimited with "|" (this is the default delimiter).
	//
	// delimiter '|' escape - the delimiter should be escaped.
	//
	// fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6'
	// - fields are fixed width in the source, with each width specified after every
	// column in the table.
	//
	//  JSON 's3://mybucket/jsonpaths.txt' - data is in JSON format, and the path
	// specified is the format of the data.
	//
	// For more examples, see and Amazon Redshift COPY command exmaples (http://docs.aws.amazon.com/redshift/latest/dg/r_COPY_command_examples.html).
	CopyOptions *string `type:"string"`

	// A comma-separated list of column names.
	DataTableColumns *string `type:"string"`

	// The name of the target table. The table must already exist in the database.
	DataTableName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes a COPY command for Amazon Redshift.

func (CopyCommand) GoString 

func (s CopyCommand) GoString() string

GoString returns the string representation

func (CopyCommand) String 

func (s CopyCommand) String() string

String returns the string representation

type CreateDeliveryStreamInput 

type CreateDeliveryStreamInput struct {

	// The name of the delivery stream.
	DeliveryStreamName *string `min:"1" type:"string" required:"true"`

	// The destination in Amazon Redshift. This value cannot be specified if Amazon
	// S3 is the desired destination (see restrictions listed above).
	RedshiftDestinationConfiguration *RedshiftDestinationConfiguration `type:"structure"`

	// The destination in Amazon S3. This value must be specified if RedshiftDestinationConfiguration
	// is specified (see restrictions listed above).
	S3DestinationConfiguration *S3DestinationConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

Contains the parameters for CreateDeliveryStream.

func (CreateDeliveryStreamInput) GoString 

func (s CreateDeliveryStreamInput) GoString() string

GoString returns the string representation

func (CreateDeliveryStreamInput) String 

func (s CreateDeliveryStreamInput) String() string

String returns the string representation

type CreateDeliveryStreamOutput 

type CreateDeliveryStreamOutput struct {

	// The ARN of the delivery stream.
	DeliveryStreamARN *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the output of CreateDeliveryStream.

func (CreateDeliveryStreamOutput) GoString 

func (s CreateDeliveryStreamOutput) GoString() string

GoString returns the string representation

func (CreateDeliveryStreamOutput) String 

func (s CreateDeliveryStreamOutput) String() string

String returns the string representation

type DeleteDeliveryStreamInput 

type DeleteDeliveryStreamInput struct {

	// The name of the delivery stream.
	DeliveryStreamName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the parameters for DeleteDeliveryStream.

func (DeleteDeliveryStreamInput) GoString 

func (s DeleteDeliveryStreamInput) GoString() string

GoString returns the string representation

func (DeleteDeliveryStreamInput) String 

func (s DeleteDeliveryStreamInput) String() string

String returns the string representation

type DeleteDeliveryStreamOutput 

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

Contains the output of DeleteDeliveryStream.

func (DeleteDeliveryStreamOutput) GoString 

func (s DeleteDeliveryStreamOutput) GoString() string

GoString returns the string representation

func (DeleteDeliveryStreamOutput) String 

func (s DeleteDeliveryStreamOutput) String() string

String returns the string representation

type DeliveryStreamDescription 

type DeliveryStreamDescription struct {

	// The date and time that the delivery stream was created.
	CreateTimestamp *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The Amazon Resource Name (ARN) of the delivery stream.
	DeliveryStreamARN *string `type:"string" required:"true"`

	// The name of the delivery stream.
	DeliveryStreamName *string `min:"1" type:"string" required:"true"`

	// The status of the delivery stream.
	DeliveryStreamStatus *string `type:"string" required:"true" enum:"DeliveryStreamStatus"`

	// The destinations.
	Destinations []*DestinationDescription `type:"list" required:"true"`

	// Indicates whether there are more destinations available to list.
	HasMoreDestinations *bool `type:"boolean" required:"true"`

	// The date and time that the delivery stream was last updated.
	LastUpdateTimestamp *time.Time `type:"timestamp" timestampFormat:"unix"`

	// Used when calling the UpdateDestination operation. Each time the destination
	// is updated for the delivery stream, the VersionId is changed, and the current
	// VersionId is required when updating the destination. This is so that the
	// service knows it is applying the changes to the correct version of the delivery
	// stream.
	VersionId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains information about a delivery stream.

func (DeliveryStreamDescription) GoString 

func (s DeliveryStreamDescription) GoString() string

GoString returns the string representation

func (DeliveryStreamDescription) String 

func (s DeliveryStreamDescription) String() string

String returns the string representation

type DescribeDeliveryStreamInput 

type DescribeDeliveryStreamInput struct {

	// The name of the delivery stream.
	DeliveryStreamName *string `min:"1" type:"string" required:"true"`

	// Specifies the destination ID to start returning the destination information.
	// Currently Amazon Kinesis Firehose supports one destination per delivery stream.
	ExclusiveStartDestinationId *string `min:"1" type:"string"`

	// The limit on the number of destinations to return. Currently, you can have
	// one destination per delivery stream.
	Limit *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

Contains the parameters for DescribeDeliveryStream.

func (DescribeDeliveryStreamInput) GoString 

func (s DescribeDeliveryStreamInput) GoString() string

GoString returns the string representation

func (DescribeDeliveryStreamInput) String 

func (s DescribeDeliveryStreamInput) String() string

String returns the string representation

type DescribeDeliveryStreamOutput 

type DescribeDeliveryStreamOutput struct {

	// Information about the delivery stream.
	DeliveryStreamDescription *DeliveryStreamDescription `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Contains the output of DescribeDeliveryStream.

func (DescribeDeliveryStreamOutput) GoString 

func (s DescribeDeliveryStreamOutput) GoString() string

GoString returns the string representation

func (DescribeDeliveryStreamOutput) String 

func (s DescribeDeliveryStreamOutput) String() string

String returns the string representation

type DestinationDescription 

type DestinationDescription struct {

	// The ID of the destination.
	DestinationId *string `min:"1" type:"string" required:"true"`

	// The destination in Amazon Redshift.
	RedshiftDestinationDescription *RedshiftDestinationDescription `type:"structure"`

	// The Amazon S3 destination.
	S3DestinationDescription *S3DestinationDescription `type:"structure"`
	// contains filtered or unexported fields
}

Describes the destination for a delivery stream.

func (DestinationDescription) GoString 

func (s DestinationDescription) GoString() string

GoString returns the string representation

func (DestinationDescription) String 

func (s DestinationDescription) String() string

String returns the string representation

type EncryptionConfiguration 

type EncryptionConfiguration struct {

	// The encryption key.
	KMSEncryptionConfig *KMSEncryptionConfig `type:"structure"`

	// Specifically override existing encryption information to ensure no encryption
	// is used.
	NoEncryptionConfig *string `type:"string" enum:"NoEncryptionConfig"`
	// contains filtered or unexported fields
}

Describes the encryption for a destination in Amazon S3.

func (EncryptionConfiguration) GoString 

func (s EncryptionConfiguration) GoString() string

GoString returns the string representation

func (EncryptionConfiguration) String 

func (s EncryptionConfiguration) String() string

String returns the string representation

type Firehose 

type Firehose struct {
	*client.Client
}

Amazon Kinesis Firehose is a fully-managed service that delivers real-time streaming data to destinations such as Amazon S3 and Amazon Redshift. 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 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *Firehose

New creates a new instance of the Firehose 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 Firehose client from just a session.
svc := firehose.New(mySession)

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

func (*Firehose) CreateDeliveryStream 

func (c *Firehose) CreateDeliveryStream(input *CreateDeliveryStreamInput) (*CreateDeliveryStreamOutput, error)

Creates a delivery stream.

CreateDeliveryStream is an asynchronous operation that immediately returns. The initial status of the delivery stream is CREATING. After the delivery stream is created, its status is ACTIVE and it now accepts data. Attempts to send data to a delivery stream that is not in the ACTIVE state cause an exception. To check the state of a delivery stream, use DescribeDeliveryStream.

The name of a delivery stream identifies it. You can't have two delivery streams with the same name in the same region. Two delivery streams in different AWS accounts or different regions in the same AWS account can have the same name.

By default, you can create up to 5 delivery streams per region.

A delivery stream can only be configured with a single destination, Amazon S3 or Amazon Redshift. For correct CreateDeliveryStream request syntax, specify only one destination configuration parameter: either RedshiftDestinationConfiguration or S3DestinationConfiguration

As part of S3DestinationConfiguration, optional values BufferingHints, EncryptionConfiguration, and CompressionFormat can be provided. By default, if no BufferingHints value is provided, Amazon Kinesis Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. Note that BufferingHints is a hint, so there are some cases where the service cannot adhere to these conditions strictly; for example, record boundaries are such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3.

A few notes about RedshiftDestinationConfiguration: 

An Amazon Redshift destination requires an S3 bucket as intermediate location,

as Amazon Kinesis Firehose first delivers data to S3 and then uses COPY syntax to load data into an Amazon Redshift table. This is specified in the RedshiftDestinationConfiguration.S3Configuration parameter element. The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats. We strongly recommend that the username and password provided is used exclusively for Amazon Kinesis Firehose purposes, and that the permissions for the account are restricted for Amazon Redshift INSERT permissions. Amazon Kinesis Firehose assumes the IAM role that is configured as part of destinations. The IAM role should allow the Amazon Kinesis Firehose principal to assume the role, and the role should have permissions that allows the service to deliver the data. For more information, see Amazon S3 Bucket Access (http://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3) in the Amazon Kinesis Firehose Developer Guide.

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/firehose"
)

func main() {
	svc := firehose.New(session.New())

	params := &firehose.CreateDeliveryStreamInput{
		DeliveryStreamName: aws.String("DeliveryStreamName"), // Required
		RedshiftDestinationConfiguration: &firehose.RedshiftDestinationConfiguration{
			ClusterJDBCURL: aws.String("ClusterJDBCURL"), // Required
			CopyCommand: &firehose.CopyCommand{ // Required
				DataTableName:    aws.String("DataTableName"), // Required
				CopyOptions:      aws.String("CopyOptions"),
				DataTableColumns: aws.String("DataTableColumns"),
			},
			Password: aws.String("Password"), // Required
			RoleARN:  aws.String("RoleARN"),  // Required
			S3Configuration: &firehose.S3DestinationConfiguration{ // Required
				BucketARN: aws.String("BucketARN"), // Required
				RoleARN:   aws.String("RoleARN"),   // Required
				BufferingHints: &firehose.BufferingHints{
					IntervalInSeconds: aws.Int64(1),
					SizeInMBs:         aws.Int64(1),
				},
				CompressionFormat: aws.String("CompressionFormat"),
				EncryptionConfiguration: &firehose.EncryptionConfiguration{
					KMSEncryptionConfig: &firehose.KMSEncryptionConfig{
						AWSKMSKeyARN: aws.String("AWSKMSKeyARN"), // Required
					},
					NoEncryptionConfig: aws.String("NoEncryptionConfig"),
				},
				Prefix: aws.String("Prefix"),
			},
			Username: aws.String("Username"), // Required
		},
		S3DestinationConfiguration: &firehose.S3DestinationConfiguration{
			BucketARN: aws.String("BucketARN"), // Required
			RoleARN:   aws.String("RoleARN"),   // Required
			BufferingHints: &firehose.BufferingHints{
				IntervalInSeconds: aws.Int64(1),
				SizeInMBs:         aws.Int64(1),
			},
			CompressionFormat: aws.String("CompressionFormat"),
			EncryptionConfiguration: &firehose.EncryptionConfiguration{
				KMSEncryptionConfig: &firehose.KMSEncryptionConfig{
					AWSKMSKeyARN: aws.String("AWSKMSKeyARN"), // Required
				},
				NoEncryptionConfig: aws.String("NoEncryptionConfig"),
			},
			Prefix: aws.String("Prefix"),
		},
	}
	resp, err := svc.CreateDeliveryStream(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 (*Firehose) CreateDeliveryStreamRequest 

func (c *Firehose) CreateDeliveryStreamRequest(input *CreateDeliveryStreamInput) (req *request.Request, output *CreateDeliveryStreamOutput)

CreateDeliveryStreamRequest generates a request for the CreateDeliveryStream operation.

func (*Firehose) DeleteDeliveryStream 

func (c *Firehose) DeleteDeliveryStream(input *DeleteDeliveryStreamInput) (*DeleteDeliveryStreamOutput, error)

Deletes a delivery stream and its data.

You can delete a delivery stream only if it is in ACTIVE or DELETING state, and not in the CREATING state. While the deletion request is in process, the delivery stream is in the DELETING state.

To check the state of a delivery stream, use DescribeDeliveryStream.

While the delivery stream is DELETING state, the service may continue to accept the records, but the service doesn't make any guarantees with respect to delivering the data. Therefore, as a best practice, you should first stop any applications that are sending records before deleting a delivery stream.

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/firehose"
)

func main() {
	svc := firehose.New(session.New())

	params := &firehose.DeleteDeliveryStreamInput{
		DeliveryStreamName: aws.String("DeliveryStreamName"), // Required
	}
	resp, err := svc.DeleteDeliveryStream(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 (*Firehose) DeleteDeliveryStreamRequest 

func (c *Firehose) DeleteDeliveryStreamRequest(input *DeleteDeliveryStreamInput) (req *request.Request, output *DeleteDeliveryStreamOutput)

DeleteDeliveryStreamRequest generates a request for the DeleteDeliveryStream operation.

func (*Firehose) DescribeDeliveryStream 

func (c *Firehose) DescribeDeliveryStream(input *DescribeDeliveryStreamInput) (*DescribeDeliveryStreamOutput, error)

Describes the specified delivery stream and gets the status. For example, after your delivery stream is created, call DescribeDeliveryStream to see if the delivery stream is ACTIVE and therefore ready for data to be sent to it.

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/firehose"
)

func main() {
	svc := firehose.New(session.New())

	params := &firehose.DescribeDeliveryStreamInput{
		DeliveryStreamName:          aws.String("DeliveryStreamName"), // Required
		ExclusiveStartDestinationId: aws.String("DestinationId"),
		Limit:                       aws.Int64(1),
	}
	resp, err := svc.DescribeDeliveryStream(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 (*Firehose) DescribeDeliveryStreamRequest 

func (c *Firehose) DescribeDeliveryStreamRequest(input *DescribeDeliveryStreamInput) (req *request.Request, output *DescribeDeliveryStreamOutput)

DescribeDeliveryStreamRequest generates a request for the DescribeDeliveryStream operation.

func (*Firehose) ListDeliveryStreams 

func (c *Firehose) ListDeliveryStreams(input *ListDeliveryStreamsInput) (*ListDeliveryStreamsOutput, error)

Lists your delivery streams.

The number of delivery streams might be too large to return using a single call to ListDeliveryStreams. You can limit the number of delivery streams returned, using the Limit parameter. To determine whether there are more delivery streams to list, check the value of HasMoreDeliveryStreams in the output. If there are more delivery streams to list, you can request them by specifying the name of the last delivery stream returned in the call in the ExclusiveStartDeliveryStreamName parameter of a subsequent call.

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/firehose"
)

func main() {
	svc := firehose.New(session.New())

	params := &firehose.ListDeliveryStreamsInput{
		ExclusiveStartDeliveryStreamName: aws.String("DeliveryStreamName"),
		Limit:                            aws.Int64(1),
	}
	resp, err := svc.ListDeliveryStreams(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 (*Firehose) ListDeliveryStreamsRequest 

func (c *Firehose) ListDeliveryStreamsRequest(input *ListDeliveryStreamsInput) (req *request.Request, output *ListDeliveryStreamsOutput)

ListDeliveryStreamsRequest generates a request for the ListDeliveryStreams operation.

func (*Firehose) PutRecord 

func (c *Firehose) PutRecord(input *PutRecordInput) (*PutRecordOutput, error)

Writes a single data record into an Amazon Kinesis Firehose delivery stream. To write multiple data records into a delivery stream, use PutRecordBatch. Applications using these operations are referred to as producers.

By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. Note that if you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each delivery stream. For more information about limits and how to request an increase, see Amazon Kinesis Firehose Limits (http://docs.aws.amazon.com/firehose/latest/dev/limits.html).

You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data, for example, a segment from a log file, geographic location data, web site clickstream data, etc.

Amazon Kinesis Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\n) or some other character unique within the data. This allows the consumer application(s) to parse individual data items when reading the data from the destination.

Amazon Kinesis Firehose does not maintain data record ordering. If the destination data needs to be re-ordered by the consumer application, the producer should include some form of sequence number in each data record.

The PutRecord operation returns a RecordId, which is a unique string assigned to each record. Producer applications can use this ID for purposes such as auditability and investigation.

If the PutRecord operation throws a ServiceUnavailableException, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream.

Data records sent to Amazon Kinesis Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.

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/firehose"
)

func main() {
	svc := firehose.New(session.New())

	params := &firehose.PutRecordInput{
		DeliveryStreamName: aws.String("DeliveryStreamName"), // Required
		Record: &firehose.Record{ // Required
			Data: []byte("PAYLOAD"), // Required
		},
	}
	resp, err := svc.PutRecord(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 (*Firehose) PutRecordBatch 

func (c *Firehose) PutRecordBatch(input *PutRecordBatchInput) (*PutRecordBatchOutput, error)

Writes multiple data records into a delivery stream in a single call, which can achieve higher throughput per producer than when writing single records. To write single data records into a delivery stream, use PutRecord. Applications using these operations are referred to as producers.

Each PutRecordBatch request supports up to 500 records. Each record in the request can be as large as 1,000 KB (before 64-bit encoding), up to a limit of 4 MB for the entire request. By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. Note that if you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each delivery stream. For more information about limits and how to request an increase, see Amazon Kinesis Firehose Limits (http://docs.aws.amazon.com/firehose/latest/dev/limits.html).

You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data, for example, a segment from a log file, geographic location data, web site clickstream data, and so on.

Amazon Kinesis Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\n) or some other character unique within the data. This allows the consumer application(s) to parse individual data items when reading the data from the destination.

The PutRecordBatch response includes a count of any failed records, FailedPutCount, and an array of responses, RequestResponses. The FailedPutCount value is a count of records that failed. Each entry in the RequestResponses array gives additional information of the processed record. Each entry in RequestResponses directly correlates with a record in the request array using the same ordering, from the top to the bottom of the request and response. RequestResponses always includes the same number of records as the request array. RequestResponses both successfully and unsuccessfully processed records. Amazon Kinesis Firehose attempts to process all records in each PutRecordBatch request. A single record failure does not stop the processing of subsequent records.

A successfully processed record includes a RecordId value, which is a unique value identified for the record. An unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error and is one of the following values: ServiceUnavailable or InternalFailure. ErrorMessage provides more detailed information about the error.

If FailedPutCount is greater than 0 (zero), retry the request. A retry of the entire batch of records is possible; however, we strongly recommend that you inspect the entire response and resend only those records that failed processing. This minimizes duplicate records and also reduces the total bytes sent (and corresponding charges).

If the PutRecordBatch operation throws a ServiceUnavailableException, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream.

Data records sent to Amazon Kinesis Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.

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/firehose"
)

func main() {
	svc := firehose.New(session.New())

	params := &firehose.PutRecordBatchInput{
		DeliveryStreamName: aws.String("DeliveryStreamName"), // Required
		Records: []*firehose.Record{ // Required
			{ // Required
				Data: []byte("PAYLOAD"), // Required
			},
			// More values...
		},
	}
	resp, err := svc.PutRecordBatch(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 (*Firehose) PutRecordBatchRequest 

func (c *Firehose) PutRecordBatchRequest(input *PutRecordBatchInput) (req *request.Request, output *PutRecordBatchOutput)

PutRecordBatchRequest generates a request for the PutRecordBatch operation.

func (*Firehose) PutRecordRequest 

func (c *Firehose) PutRecordRequest(input *PutRecordInput) (req *request.Request, output *PutRecordOutput)

PutRecordRequest generates a request for the PutRecord operation.

func (*Firehose) UpdateDestination 

func (c *Firehose) UpdateDestination(input *UpdateDestinationInput) (*UpdateDestinationOutput, error)

Updates the specified destination of the specified delivery stream.

This operation can be used to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a given destination (for example, to change the bucket name of the Amazon S3 destination). The update may not occur immediately. The target delivery stream remains active while the configurations are updated, so data writes to the delivery stream can continue during this process. The updated configurations are normally effective within a few minutes.

If the destination type is the same, Amazon Kinesis Firehose merges the configuration parameters specified in the UpdateDestination request with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the update request, then the existing configuration parameters are retained. For example, in the Amazon S3 destination, if EncryptionConfiguration is not specified then the existing EncryptionConfiguration is maintained on the destination.

If the destination type is not the same, for example, changing the destination from Amazon S3 to Amazon Redshift, Amazon Kinesis Firehose does not merge any parameters. In this case, all parameters must be specified.

Amazon Kinesis Firehose uses the CurrentDeliveryStreamVersionId to avoid race conditions and conflicting merges. This is a required field in every request and the service only updates the configuration if the existing configuration matches the VersionId. After the update is applied successfully, the VersionId is updated, which can be retrieved with the DescribeDeliveryStream operation. The new VersionId should be uses to set CurrentDeliveryStreamVersionId in the next UpdateDestination 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/firehose"
)

func main() {
	svc := firehose.New(session.New())

	params := &firehose.UpdateDestinationInput{
		CurrentDeliveryStreamVersionId: aws.String("DeliveryStreamVersionId"), // Required
		DeliveryStreamName:             aws.String("DeliveryStreamName"),      // Required
		DestinationId:                  aws.String("DestinationId"),           // Required
		RedshiftDestinationUpdate: &firehose.RedshiftDestinationUpdate{
			ClusterJDBCURL: aws.String("ClusterJDBCURL"),
			CopyCommand: &firehose.CopyCommand{
				DataTableName:    aws.String("DataTableName"), // Required
				CopyOptions:      aws.String("CopyOptions"),
				DataTableColumns: aws.String("DataTableColumns"),
			},
			Password: aws.String("Password"),
			RoleARN:  aws.String("RoleARN"),
			S3Update: &firehose.S3DestinationUpdate{
				BucketARN: aws.String("BucketARN"),
				BufferingHints: &firehose.BufferingHints{
					IntervalInSeconds: aws.Int64(1),
					SizeInMBs:         aws.Int64(1),
				},
				CompressionFormat: aws.String("CompressionFormat"),
				EncryptionConfiguration: &firehose.EncryptionConfiguration{
					KMSEncryptionConfig: &firehose.KMSEncryptionConfig{
						AWSKMSKeyARN: aws.String("AWSKMSKeyARN"), // Required
					},
					NoEncryptionConfig: aws.String("NoEncryptionConfig"),
				},
				Prefix:  aws.String("Prefix"),
				RoleARN: aws.String("RoleARN"),
			},
			Username: aws.String("Username"),
		},
		S3DestinationUpdate: &firehose.S3DestinationUpdate{
			BucketARN: aws.String("BucketARN"),
			BufferingHints: &firehose.BufferingHints{
				IntervalInSeconds: aws.Int64(1),
				SizeInMBs:         aws.Int64(1),
			},
			CompressionFormat: aws.String("CompressionFormat"),
			EncryptionConfiguration: &firehose.EncryptionConfiguration{
				KMSEncryptionConfig: &firehose.KMSEncryptionConfig{
					AWSKMSKeyARN: aws.String("AWSKMSKeyARN"), // Required
				},
				NoEncryptionConfig: aws.String("NoEncryptionConfig"),
			},
			Prefix:  aws.String("Prefix"),
			RoleARN: aws.String("RoleARN"),
		},
	}
	resp, err := svc.UpdateDestination(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 (*Firehose) UpdateDestinationRequest 

func (c *Firehose) UpdateDestinationRequest(input *UpdateDestinationInput) (req *request.Request, output *UpdateDestinationOutput)

UpdateDestinationRequest generates a request for the UpdateDestination operation.

type KMSEncryptionConfig 

type KMSEncryptionConfig struct {

	// The ARN of the encryption key. Must belong to the same region as the destination
	// Amazon S3 bucket.
	AWSKMSKeyARN *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes an encryption key for a destination in Amazon S3.

func (KMSEncryptionConfig) GoString 

func (s KMSEncryptionConfig) GoString() string

GoString returns the string representation

func (KMSEncryptionConfig) String 

func (s KMSEncryptionConfig) String() string

String returns the string representation

type ListDeliveryStreamsInput 

type ListDeliveryStreamsInput struct {

	// The name of the delivery stream to start the list with.
	ExclusiveStartDeliveryStreamName *string `min:"1" type:"string"`

	// The maximum number of delivery streams to list.
	Limit *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

Contains the parameters for ListDeliveryStreams.

func (ListDeliveryStreamsInput) GoString 

func (s ListDeliveryStreamsInput) GoString() string

GoString returns the string representation

func (ListDeliveryStreamsInput) String 

func (s ListDeliveryStreamsInput) String() string

String returns the string representation

type ListDeliveryStreamsOutput 

type ListDeliveryStreamsOutput struct {

	// The names of the delivery streams.
	DeliveryStreamNames []*string `type:"list" required:"true"`

	// Indicates whether there are more delivery streams available to list.
	HasMoreDeliveryStreams *bool `type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

Contains the output of ListDeliveryStreams.

func (ListDeliveryStreamsOutput) GoString 

func (s ListDeliveryStreamsOutput) GoString() string

GoString returns the string representation

func (ListDeliveryStreamsOutput) String 

func (s ListDeliveryStreamsOutput) String() string

String returns the string representation

type PutRecordBatchInput 

type PutRecordBatchInput struct {

	// The name of the delivery stream.
	DeliveryStreamName *string `min:"1" type:"string" required:"true"`

	// One or more records.
	Records []*Record `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Contains the parameters for PutRecordBatch.

func (PutRecordBatchInput) GoString 

func (s PutRecordBatchInput) GoString() string

GoString returns the string representation

func (PutRecordBatchInput) String 

func (s PutRecordBatchInput) String() string

String returns the string representation

type PutRecordBatchOutput 

type PutRecordBatchOutput struct {

	// The number of unsuccessfully written records.
	FailedPutCount *int64 `type:"integer" required:"true"`

	// The results for the individual records. The index of each element matches
	// the same index in which records were sent.
	RequestResponses []*PutRecordBatchResponseEntry `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Contains the output of PutRecordBatch.

func (PutRecordBatchOutput) GoString 

func (s PutRecordBatchOutput) GoString() string

GoString returns the string representation

func (PutRecordBatchOutput) String 

func (s PutRecordBatchOutput) String() string

String returns the string representation

type PutRecordBatchResponseEntry 

type PutRecordBatchResponseEntry struct {

	// The error code for an individual record result.
	ErrorCode *string `type:"string"`

	// The error message for an individual record result.
	ErrorMessage *string `type:"string"`

	// The ID of the record.
	RecordId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains the result for an individual record from a PutRecordBatch request. If the record is successfully added to your delivery stream, it receives a record ID. If the record fails to be added to your delivery stream, the result includes an error code and an error message.

func (PutRecordBatchResponseEntry) GoString 

func (s PutRecordBatchResponseEntry) GoString() string

GoString returns the string representation

func (PutRecordBatchResponseEntry) String 

func (s PutRecordBatchResponseEntry) String() string

String returns the string representation

type PutRecordInput 

type PutRecordInput struct {

	// The name of the delivery stream.
	DeliveryStreamName *string `min:"1" type:"string" required:"true"`

	// The record.
	Record *Record `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Contains the parameters for PutRecord.

func (PutRecordInput) GoString 

func (s PutRecordInput) GoString() string

GoString returns the string representation

func (PutRecordInput) String 

func (s PutRecordInput) String() string

String returns the string representation

type PutRecordOutput 

type PutRecordOutput struct {

	// The ID of the record.
	RecordId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the output of PutRecord.

func (PutRecordOutput) GoString 

func (s PutRecordOutput) GoString() string

GoString returns the string representation

func (PutRecordOutput) String 

func (s PutRecordOutput) String() string

String returns the string representation

type Record 

type Record struct {

	// The data blob, which is base64-encoded when the blob is serialized. The maximum
	// size of the data blob, before base64-encoding, is 1,000 KB.
	//
	// Data is automatically base64 encoded/decoded by the SDK.
	Data []byte `type:"blob" required:"true"`
	// contains filtered or unexported fields
}

The unit of data in a delivery stream.

func (Record) GoString 

func (s Record) GoString() string

GoString returns the string representation

func (Record) String 

func (s Record) String() string

String returns the string representation

type RedshiftDestinationConfiguration 

type RedshiftDestinationConfiguration struct {

	// The database connection string.
	ClusterJDBCURL *string `min:"1" type:"string" required:"true"`

	// The COPY command.
	CopyCommand *CopyCommand `type:"structure" required:"true"`

	// The user password.
	Password *string `min:"6" type:"string" required:"true"`

	// The ARN of the AWS credentials.
	RoleARN *string `min:"1" type:"string" required:"true"`

	// The S3 configuration for the intermediate location from which Amazon Redshift
	// obtains data. Restrictions are described in the topic for CreateDeliveryStream.
	//
	// The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration
	// because the Amazon Redshift COPY operation that reads from the S3 bucket
	// doesn't support these compression formats.
	S3Configuration *S3DestinationConfiguration `type:"structure" required:"true"`

	// The name of the user.
	Username *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes the configuration of a destination in Amazon Redshift.

func (RedshiftDestinationConfiguration) GoString 

func (s RedshiftDestinationConfiguration) GoString() string

GoString returns the string representation

func (RedshiftDestinationConfiguration) String 

func (s RedshiftDestinationConfiguration) String() string

String returns the string representation

type RedshiftDestinationDescription 

type RedshiftDestinationDescription struct {

	// The database connection string.
	ClusterJDBCURL *string `min:"1" type:"string" required:"true"`

	// The COPY command.
	CopyCommand *CopyCommand `type:"structure" required:"true"`

	// The ARN of the AWS credentials.
	RoleARN *string `min:"1" type:"string" required:"true"`

	// The Amazon S3 destination.
	S3DestinationDescription *S3DestinationDescription `type:"structure" required:"true"`

	// The name of the user.
	Username *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes a destination in Amazon Redshift.

func (RedshiftDestinationDescription) GoString 

func (s RedshiftDestinationDescription) GoString() string

GoString returns the string representation

func (RedshiftDestinationDescription) String 

func (s RedshiftDestinationDescription) String() string

String returns the string representation

type RedshiftDestinationUpdate 

type RedshiftDestinationUpdate struct {

	// The database connection string.
	ClusterJDBCURL *string `min:"1" type:"string"`

	// The COPY command.
	CopyCommand *CopyCommand `type:"structure"`

	// The user password.
	Password *string `min:"6" type:"string"`

	// The ARN of the AWS credentials.
	RoleARN *string `min:"1" type:"string"`

	// The Amazon S3 destination.
	//
	// The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationUpdate.S3Update
	// because the Amazon Redshift COPY operation that reads from the S3 bucket
	// doesn't support these compression formats.
	S3Update *S3DestinationUpdate `type:"structure"`

	// The name of the user.
	Username *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes an update for a destination in Amazon Redshift.

func (RedshiftDestinationUpdate) GoString 

func (s RedshiftDestinationUpdate) GoString() string

GoString returns the string representation

func (RedshiftDestinationUpdate) String 

func (s RedshiftDestinationUpdate) String() string

String returns the string representation

type S3DestinationConfiguration 

type S3DestinationConfiguration struct {

	// The ARN of the S3 bucket.
	BucketARN *string `min:"1" type:"string" required:"true"`

	// The buffering option. If no value is specified, BufferingHints object default
	// values are used.
	BufferingHints *BufferingHints `type:"structure"`

	// The compression format. If no value is specified, the default is UNCOMPRESSED.
	//
	// The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift
	// destinations because they are not supported by the Amazon Redshift COPY operation
	// that reads from the S3 bucket.
	CompressionFormat *string `type:"string" enum:"CompressionFormat"`

	// The encryption configuration. If no value is specified, the default is no
	// encryption.
	EncryptionConfiguration *EncryptionConfiguration `type:"structure"`

	// The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered
	// S3 files. You can specify an extra prefix to be added in front of the time
	// format prefix. Note that if the prefix ends with a slash, it appears as a
	// folder in the S3 bucket. For more information, see Amazon S3 Object Name
	// Format (http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html)
	// in the guide-fh-dev (http://docs.aws.amazon.com/firehose/latest/dev/).
	Prefix *string `type:"string"`

	// The ARN of the AWS credentials.
	RoleARN *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes the configuration of a destination in Amazon S3.

func (S3DestinationConfiguration) GoString 

func (s S3DestinationConfiguration) GoString() string

GoString returns the string representation

func (S3DestinationConfiguration) String 

func (s S3DestinationConfiguration) String() string

String returns the string representation

type S3DestinationDescription 

type S3DestinationDescription struct {

	// The ARN of the S3 bucket.
	BucketARN *string `min:"1" type:"string" required:"true"`

	// The buffering option. If no value is specified, BufferingHints object default
	// values are used.
	BufferingHints *BufferingHints `type:"structure" required:"true"`

	// The compression format. If no value is specified, the default is NOCOMPRESSION.
	CompressionFormat *string `type:"string" required:"true" enum:"CompressionFormat"`

	// The encryption configuration. If no value is specified, the default is no
	// encryption.
	EncryptionConfiguration *EncryptionConfiguration `type:"structure" required:"true"`

	// The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered
	// S3 files. You can specify an extra prefix to be added in front of the time
	// format prefix. Note that if the prefix ends with a slash, it appears as a
	// folder in the S3 bucket. For more information, see Amazon S3 Object Name
	// Format (http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html)
	// in the guide-fh-dev (http://docs.aws.amazon.com/firehose/latest/dev/).
	Prefix *string `type:"string"`

	// The ARN of the AWS credentials.
	RoleARN *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Describes a destination in Amazon S3.

func (S3DestinationDescription) GoString 

func (s S3DestinationDescription) GoString() string

GoString returns the string representation

func (S3DestinationDescription) String 

func (s S3DestinationDescription) String() string

String returns the string representation

type S3DestinationUpdate 

type S3DestinationUpdate struct {

	// The ARN of the S3 bucket.
	BucketARN *string `min:"1" type:"string"`

	// The buffering option. If no value is specified, BufferingHints object default
	// values are used.
	BufferingHints *BufferingHints `type:"structure"`

	// The compression format. If no value is specified, the default is NOCOMPRESSION.
	//
	// The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift
	// destinations because they are not supported by the Amazon Redshift COPY operation
	// that reads from the S3 bucket.
	CompressionFormat *string `type:"string" enum:"CompressionFormat"`

	// The encryption configuration. If no value is specified, the default is no
	// encryption.
	EncryptionConfiguration *EncryptionConfiguration `type:"structure"`

	// The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered
	// S3 files. You can specify an extra prefix to be added in front of the time
	// format prefix. Note that if the prefix ends with a slash, it appears as a
	// folder in the S3 bucket. For more information, see Amazon S3 Object Name
	// Format (http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html)
	// in the guide-fh-dev (http://docs.aws.amazon.com/firehose/latest/dev/).
	Prefix *string `type:"string"`

	// The ARN of the AWS credentials.
	RoleARN *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes an update for a destination in Amazon S3.

func (S3DestinationUpdate) GoString 

func (s S3DestinationUpdate) GoString() string

GoString returns the string representation

func (S3DestinationUpdate) String 

func (s S3DestinationUpdate) String() string

String returns the string representation

type UpdateDestinationInput 

type UpdateDestinationInput struct {

	// Obtain this value from the VersionId result of the DeliveryStreamDescription
	// operation. This value is required, and helps the service to perform conditional
	// operations. For example, if there is a interleaving update and this value
	// is null, then the update destination fails. After the update is successful,
	// the VersionId value is updated. The service then performs a merge of the
	// old configuration with the new configuration.
	CurrentDeliveryStreamVersionId *string `min:"1" type:"string" required:"true"`

	// The name of the delivery stream.
	DeliveryStreamName *string `min:"1" type:"string" required:"true"`

	// The ID of the destination.
	DestinationId *string `min:"1" type:"string" required:"true"`

	// Describes an update for a destination in Amazon Redshift.
	RedshiftDestinationUpdate *RedshiftDestinationUpdate `type:"structure"`

	// Describes an update for a destination in Amazon S3.
	S3DestinationUpdate *S3DestinationUpdate `type:"structure"`
	// contains filtered or unexported fields
}

Contains the parameters for UpdateDestination.

func (UpdateDestinationInput) GoString 

func (s UpdateDestinationInput) GoString() string

GoString returns the string representation

func (UpdateDestinationInput) String 

func (s UpdateDestinationInput) String() string

String returns the string representation

type UpdateDestinationOutput 

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

Contains the output of UpdateDestination.

func (UpdateDestinationOutput) GoString 

func (s UpdateDestinationOutput) GoString() string

GoString returns the string representation

func (UpdateDestinationOutput) String 

func (s UpdateDestinationOutput) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package firehoseiface provides an interface for the Amazon Kinesis Firehose.
 Package firehoseiface provides an interface for the Amazon Kinesis Firehose.

Jump to

Keyboard shortcuts

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