kinesis

package
v0.24.0 Latest Latest
Warning

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

 Go to latest Published: Jul 22, 2020 License: Apache-2.0 Imports: 9 Imported by: 241

Documentation

Overview

Package kinesis provides the client and types for making API requests to Kinesis.

Amazon Kinesis Data Streams is a managed service that scales elastically for real-time processing of streaming big data.

See https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02 for more information on this service.

See kinesis package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/kinesis/

Using the Client

To use Kinesis with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Kinesis client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/kinesis/#New

Index

Constants

View Source 
const (
	ServiceName = "Kinesis" // Service's name
	ServiceID   = "Kinesis" // Service's identifier
	EndpointsID = "kinesis" // Service's Endpoint identifier
)
View Source 
const (

	// ErrCodeExpiredIteratorException for service response error code
	// "ExpiredIteratorException".
	//
	// The provided iterator exceeds the maximum age allowed.
	ErrCodeExpiredIteratorException = "ExpiredIteratorException"

	// ErrCodeExpiredNextTokenException for service response error code
	// "ExpiredNextTokenException".
	//
	// The pagination token passed to the operation is expired.
	ErrCodeExpiredNextTokenException = "ExpiredNextTokenException"

	// ErrCodeInvalidArgumentException for service response error code
	// "InvalidArgumentException".
	//
	// A specified parameter exceeds its restrictions, is not supported, or can't
	// be used. For more information, see the returned message.
	ErrCodeInvalidArgumentException = "InvalidArgumentException"

	// ErrCodeKMSAccessDeniedException for service response error code
	// "KMSAccessDeniedException".
	//
	// The ciphertext references a key that doesn't exist or that you don't have
	// access to.
	ErrCodeKMSAccessDeniedException = "KMSAccessDeniedException"

	// ErrCodeKMSDisabledException for service response error code
	// "KMSDisabledException".
	//
	// The request was rejected because the specified customer master key (CMK)
	// isn't enabled.
	ErrCodeKMSDisabledException = "KMSDisabledException"

	// ErrCodeKMSInvalidStateException for service response error code
	// "KMSInvalidStateException".
	//
	// The request was rejected because the state of the specified resource isn't
	// valid for this request. For more information, see How Key State Affects Use
	// of a Customer Master Key (http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
	// in the AWS Key Management Service Developer Guide.
	ErrCodeKMSInvalidStateException = "KMSInvalidStateException"

	// ErrCodeKMSNotFoundException for service response error code
	// "KMSNotFoundException".
	//
	// The request was rejected because the specified entity or resource can't be
	// found.
	ErrCodeKMSNotFoundException = "KMSNotFoundException"

	// ErrCodeKMSOptInRequired for service response error code
	// "KMSOptInRequired".
	//
	// The AWS access key ID needs a subscription for the service.
	ErrCodeKMSOptInRequired = "KMSOptInRequired"

	// ErrCodeKMSThrottlingException for service response error code
	// "KMSThrottlingException".
	//
	// The request was denied due to request throttling. For more information about
	// throttling, see Limits (http://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second)
	// in the AWS Key Management Service Developer Guide.
	ErrCodeKMSThrottlingException = "KMSThrottlingException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// The requested resource exceeds the maximum number allowed, or the number
	// of concurrent stream requests exceeds the maximum number allowed.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeProvisionedThroughputExceededException for service response error code
	// "ProvisionedThroughputExceededException".
	//
	// The request rate for the stream is too high, or the requested data is too
	// large for the available throughput. Reduce the frequency or size of your
	// requests. For more information, see Streams Limits (http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html)
	// in the Amazon Kinesis Data Streams Developer Guide, and Error Retries and
	// Exponential Backoff in AWS (http://docs.aws.amazon.com/general/latest/gr/api-retries.html)
	// in the AWS General Reference.
	ErrCodeProvisionedThroughputExceededException = "ProvisionedThroughputExceededException"

	// ErrCodeResourceInUseException for service response error code
	// "ResourceInUseException".
	//
	// The resource is not available for this operation. For successful operation,
	// the resource must be in the ACTIVE state.
	ErrCodeResourceInUseException = "ResourceInUseException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The requested resource could not be found. The stream might not be specified
	// correctly.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AddTagsToStreamInput 

type AddTagsToStreamInput struct {

	// The name of the stream.
	//
	// StreamName is a required field
	StreamName *string `min:"1" type:"string" required:"true"`

	// A set of up to 10 key-value pairs to use to create the tags.
	//
	// Tags is a required field
	Tags map[string]string `min:"1" type:"map" required:"true"`
	// contains filtered or unexported fields
}

Represents the input for AddTagsToStream.

func (AddTagsToStreamInput) String 

func (s AddTagsToStreamInput) String() string

String returns the string representation

func (*AddTagsToStreamInput) Validate 

func (s *AddTagsToStreamInput) Validate() error

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

type AddTagsToStreamOutput 

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

func (AddTagsToStreamOutput) String 

func (s AddTagsToStreamOutput) String() string

String returns the string representation

type AddTagsToStreamRequest 

type AddTagsToStreamRequest struct {
	*aws.Request
	Input *AddTagsToStreamInput
	Copy  func(*AddTagsToStreamInput) AddTagsToStreamRequest
}

AddTagsToStreamRequest is the request type for the AddTagsToStream API operation.

func (AddTagsToStreamRequest) Send 

func (r AddTagsToStreamRequest) Send(ctx context.Context) (*AddTagsToStreamResponse, error)

Send marshals and sends the AddTagsToStream API request.

type AddTagsToStreamResponse added in v0.9.0 

type AddTagsToStreamResponse struct {
	*AddTagsToStreamOutput
	// contains filtered or unexported fields
}

AddTagsToStreamResponse is the response type for the AddTagsToStream API operation.

func (*AddTagsToStreamResponse) SDKResponseMetdata added in v0.9.0 

func (r *AddTagsToStreamResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the AddTagsToStream request.

type Client added in v0.9.0 

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to Kinesis. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := kinesis.New(myConfig)

func (*Client) AddTagsToStreamRequest added in v0.9.0 

func (c *Client) AddTagsToStreamRequest(input *AddTagsToStreamInput) AddTagsToStreamRequest

AddTagsToStreamRequest returns a request value for making API operation for Amazon Kinesis.

Adds or updates tags for the specified Kinesis data stream. Each time you invoke this operation, you can specify up to 10 tags. If you want to add more than 10 tags to your stream, you can invoke this operation multiple times. In total, each stream can have up to 50 tags.

If tags have already been assigned to the stream, AddTagsToStream overwrites any existing tags that correspond to the specified tag keys.

AddTagsToStream has a limit of five transactions per second per account. 

// Example sending a request using AddTagsToStreamRequest.
req := client.AddTagsToStreamRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/AddTagsToStream

func (*Client) CreateStreamRequest added in v0.9.0 

func (c *Client) CreateStreamRequest(input *CreateStreamInput) CreateStreamRequest

CreateStreamRequest returns a request value for making API operation for Amazon Kinesis.

Creates a Kinesis data stream. A stream captures and transports data records that are continuously emitted from different data sources or producers. Scale-out within a stream is explicitly supported by means of shards, which are uniquely identified groups of data records in a stream.

You specify and control the number of shards that a stream is composed of. Each shard can support reads up to five transactions per second, up to a maximum data read total of 2 MB per second. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second. If the amount of data input increases or decreases, you can add or remove shards.

The stream name identifies the stream. The name is scoped to the AWS account used by the application. It is also scoped by AWS Region. That is, two streams in two different accounts can have the same name, and two streams in the same account, but in two different Regions, can have the same name.

CreateStream is an asynchronous operation. Upon receiving a CreateStream request, Kinesis Data Streams immediately returns and sets the stream status to CREATING. After the stream is created, Kinesis Data Streams sets the stream status to ACTIVE. You should perform read and write operations only on an ACTIVE stream.

You receive a LimitExceededException when making a CreateStream request when you try to do one of the following:

  • Have more than five streams in the CREATING state at any point in time.

  • Create more shards than are authorized for your account.

For the default shard limit for an AWS account, see Amazon Kinesis Data Streams Limits (http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, contact AWS Support (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html).

You can use DescribeStream to check the stream status, which is returned in StreamStatus.

CreateStream has a limit of five transactions per second per account. 

// Example sending a request using CreateStreamRequest.
req := client.CreateStreamRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/CreateStream

func (*Client) DecreaseStreamRetentionPeriodRequest added in v0.9.0 

func (c *Client) DecreaseStreamRetentionPeriodRequest(input *DecreaseStreamRetentionPeriodInput) DecreaseStreamRetentionPeriodRequest

DecreaseStreamRetentionPeriodRequest returns a request value for making API operation for Amazon Kinesis.

Decreases the Kinesis data stream's retention period, which is the length of time data records are accessible after they are added to the stream. The minimum value of a stream's retention period is 24 hours.

This operation may result in lost data. For example, if the stream's retention period is 48 hours and is decreased to 24 hours, any data already in the stream that is older than 24 hours is inaccessible. 

// Example sending a request using DecreaseStreamRetentionPeriodRequest.
req := client.DecreaseStreamRetentionPeriodRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DecreaseStreamRetentionPeriod

func (*Client) DeleteStreamRequest added in v0.9.0 

func (c *Client) DeleteStreamRequest(input *DeleteStreamInput) DeleteStreamRequest

DeleteStreamRequest returns a request value for making API operation for Amazon Kinesis.

Deletes a Kinesis data stream and all its shards and data. You must shut down any applications that are operating on the stream before you delete the stream. If an application attempts to operate on a deleted stream, it receives the exception ResourceNotFoundException.

If the stream is in the ACTIVE state, you can delete it. After a DeleteStream request, the specified stream is in the DELETING state until Kinesis Data Streams completes the deletion.

Note: Kinesis Data Streams might continue to accept data read and write operations, such as PutRecord, PutRecords, and GetRecords, on a stream in the DELETING state until the stream deletion is complete.

When you delete a stream, any shards in that stream are also deleted, and any tags are dissociated from the stream.

You can use the DescribeStream operation to check the state of the stream, which is returned in StreamStatus.

DeleteStream has a limit of five transactions per second per account. 

// Example sending a request using DeleteStreamRequest.
req := client.DeleteStreamRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DeleteStream

func (*Client) DeregisterStreamConsumerRequest added in v0.9.0 

func (c *Client) DeregisterStreamConsumerRequest(input *DeregisterStreamConsumerInput) DeregisterStreamConsumerRequest

DeregisterStreamConsumerRequest returns a request value for making API operation for Amazon Kinesis.

To deregister a consumer, provide its ARN. Alternatively, you can provide the ARN of the data stream and the name you gave the consumer when you registered it. You may also provide all three parameters, as long as they don't conflict with each other. If you don't know the name or ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its name and ARN.

This operation has a limit of five transactions per second per account. 

// Example sending a request using DeregisterStreamConsumerRequest.
req := client.DeregisterStreamConsumerRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DeregisterStreamConsumer

func (*Client) DescribeLimitsRequest added in v0.9.0 

func (c *Client) DescribeLimitsRequest(input *DescribeLimitsInput) DescribeLimitsRequest

DescribeLimitsRequest returns a request value for making API operation for Amazon Kinesis.

Describes the shard limits and usage for the account.

If you update your account limits, the old limits might be returned for a few minutes.

This operation has a limit of one transaction per second per account. 

// Example sending a request using DescribeLimitsRequest.
req := client.DescribeLimitsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DescribeLimits

func (*Client) DescribeStreamConsumerRequest added in v0.9.0 

func (c *Client) DescribeStreamConsumerRequest(input *DescribeStreamConsumerInput) DescribeStreamConsumerRequest

DescribeStreamConsumerRequest returns a request value for making API operation for Amazon Kinesis.

To get the description of a registered consumer, provide the ARN of the consumer. Alternatively, you can provide the ARN of the data stream and the name you gave the consumer when you registered it. You may also provide all three parameters, as long as they don't conflict with each other. If you don't know the name or ARN of the consumer that you want to describe, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream.

This operation has a limit of 20 transactions per second per account. 

// Example sending a request using DescribeStreamConsumerRequest.
req := client.DescribeStreamConsumerRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DescribeStreamConsumer

func (*Client) DescribeStreamRequest added in v0.9.0 

func (c *Client) DescribeStreamRequest(input *DescribeStreamInput) DescribeStreamRequest

DescribeStreamRequest returns a request value for making API operation for Amazon Kinesis.

Describes the specified Kinesis data stream.

The information returned includes the stream name, Amazon Resource Name (ARN), creation time, enhanced metric configuration, and shard map. The shard map is an array of shard objects. For each shard object, there is the hash key and sequence number ranges that the shard spans, and the IDs of any earlier shards that played in a role in creating the shard. Every record ingested in the stream is identified by a sequence number, which is assigned when the record is put into the stream.

You can limit the number of shards returned by each call. For more information, see Retrieving Shards from a Stream (http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-retrieve-shards.html) in the Amazon Kinesis Data Streams Developer Guide.

There are no guarantees about the chronological order shards returned. To process shards in chronological order, use the ID of the parent shard to track the lineage to the oldest shard.

This operation has a limit of 10 transactions per second per account. 

// Example sending a request using DescribeStreamRequest.
req := client.DescribeStreamRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DescribeStream

func (*Client) DescribeStreamSummaryRequest added in v0.9.0 

func (c *Client) DescribeStreamSummaryRequest(input *DescribeStreamSummaryInput) DescribeStreamSummaryRequest

DescribeStreamSummaryRequest returns a request value for making API operation for Amazon Kinesis.

Provides a summarized description of the specified Kinesis data stream without the shard list.

The information returned includes the stream name, Amazon Resource Name (ARN), status, record retention period, approximate creation time, monitoring, encryption details, and open shard count. 

// Example sending a request using DescribeStreamSummaryRequest.
req := client.DescribeStreamSummaryRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DescribeStreamSummary

func (*Client) DisableEnhancedMonitoringRequest added in v0.9.0 

func (c *Client) DisableEnhancedMonitoringRequest(input *DisableEnhancedMonitoringInput) DisableEnhancedMonitoringRequest

DisableEnhancedMonitoringRequest returns a request value for making API operation for Amazon Kinesis.

Disables enhanced monitoring. 

// Example sending a request using DisableEnhancedMonitoringRequest.
req := client.DisableEnhancedMonitoringRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DisableEnhancedMonitoring

func (*Client) EnableEnhancedMonitoringRequest added in v0.9.0 

func (c *Client) EnableEnhancedMonitoringRequest(input *EnableEnhancedMonitoringInput) EnableEnhancedMonitoringRequest

EnableEnhancedMonitoringRequest returns a request value for making API operation for Amazon Kinesis.

Enables enhanced Kinesis data stream monitoring for shard-level metrics. 

// Example sending a request using EnableEnhancedMonitoringRequest.
req := client.EnableEnhancedMonitoringRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/EnableEnhancedMonitoring

func (*Client) GetRecordsRequest added in v0.9.0 

func (c *Client) GetRecordsRequest(input *GetRecordsInput) GetRecordsRequest

GetRecordsRequest returns a request value for making API operation for Amazon Kinesis.

Gets data records from a Kinesis data stream's shard.

Specify a shard iterator using the ShardIterator parameter. The shard iterator specifies the position in the shard from which you want to start reading data records sequentially. If there are no records available in the portion of the shard that the iterator points to, GetRecords returns an empty list. It might take multiple calls to get to a portion of the shard that contains records.

You can scale by provisioning multiple shards per stream while considering service limits (for more information, see Amazon Kinesis Data Streams Limits (http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) in the Amazon Kinesis Data Streams Developer Guide). Your application should have one thread per shard, each reading continuously from its stream. To read from a stream continually, call GetRecords in a loop. Use GetShardIterator to get the shard iterator to specify in the first GetRecords call. GetRecords returns a new shard iterator in NextShardIterator. Specify the shard iterator returned in NextShardIterator in subsequent calls to GetRecords. If the shard has been closed, the shard iterator can't return more data and GetRecords returns null in NextShardIterator. You can terminate the loop when the shard is closed, or when the shard iterator reaches the record with the sequence number or other attribute that marks it as the last record to process.

Each data record can be up to 1 MiB in size, and each shard can read up to 2 MiB per second. You can ensure that your calls don't exceed the maximum supported size or throughput by using the Limit parameter to specify the maximum number of records that GetRecords can return. Consider your average record size when determining this limit. The maximum number of records that can be returned per call is 10,000.

The size of the data returned by GetRecords varies depending on the utilization of the shard. The maximum size of data that GetRecords can return is 10 MiB. If a call returns this amount of data, subsequent calls made within the next 5 seconds throw ProvisionedThroughputExceededException. If there is insufficient provisioned throughput on the stream, subsequent calls made within the next 1 second throw ProvisionedThroughputExceededException. GetRecords doesn't return any data when it throws an exception. For this reason, we recommend that you wait 1 second between calls to GetRecords. However, it's possible that the application will get exceptions for longer than 1 second.

To detect whether the application is falling behind in processing, you can use the MillisBehindLatest response attribute. You can also monitor the stream using CloudWatch metrics and other mechanisms (see Monitoring (http://docs.aws.amazon.com/kinesis/latest/dev/monitoring.html) in the Amazon Kinesis Data Streams Developer Guide).

Each Amazon Kinesis record includes a value, ApproximateArrivalTimestamp, that is set when a stream successfully receives and stores a record. This is commonly referred to as a server-side time stamp, whereas a client-side time stamp is set when a data producer creates or sends the record to a stream (a data producer is any data source putting data records into a stream, for example with PutRecords). The time stamp has millisecond precision. There are no guarantees about the time stamp accuracy, or that the time stamp is always increasing. For example, records in a shard or across a stream might have time stamps that are out of order.

This operation has a limit of five transactions per second per account. 

// Example sending a request using GetRecordsRequest.
req := client.GetRecordsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/GetRecords

func (*Client) GetShardIteratorRequest added in v0.9.0 

func (c *Client) GetShardIteratorRequest(input *GetShardIteratorInput) GetShardIteratorRequest

GetShardIteratorRequest returns a request value for making API operation for Amazon Kinesis.

Gets an Amazon Kinesis shard iterator. A shard iterator expires 5 minutes after it is returned to the requester.

A shard iterator specifies the shard position from which to start reading data records sequentially. The position is specified using the sequence number of a data record in a shard. A sequence number is the identifier associated with every record ingested in the stream, and is assigned when a record is put into the stream. Each stream has one or more shards.

You must specify the shard iterator type. For example, you can set the ShardIteratorType parameter to read exactly from the position denoted by a specific sequence number by using the AT_SEQUENCE_NUMBER shard iterator type. Alternatively, the parameter can read right after the sequence number by using the AFTER_SEQUENCE_NUMBER shard iterator type, using sequence numbers returned by earlier calls to PutRecord, PutRecords, GetRecords, or DescribeStream. In the request, you can specify the shard iterator type AT_TIMESTAMP to read records from an arbitrary point in time, TRIM_HORIZON to cause ShardIterator to point to the last untrimmed record in the shard in the system (the oldest data record in the shard), or LATEST so that you always read the most recent data in the shard.

When you read repeatedly from a stream, use a GetShardIterator request to get the first shard iterator for use in your first GetRecords request and for subsequent reads use the shard iterator returned by the GetRecords request in NextShardIterator. A new shard iterator is returned by every GetRecords request in NextShardIterator, which you use in the ShardIterator parameter of the next GetRecords request.

If a GetShardIterator request is made too often, you receive a ProvisionedThroughputExceededException. For more information about throughput limits, see GetRecords, and Streams Limits (http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) in the Amazon Kinesis Data Streams Developer Guide.

If the shard is closed, GetShardIterator returns a valid iterator for the last sequence number of the shard. A shard can be closed as a result of using SplitShard or MergeShards.

GetShardIterator has a limit of five transactions per second per account per open shard. 

// Example sending a request using GetShardIteratorRequest.
req := client.GetShardIteratorRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/GetShardIterator

func (*Client) IncreaseStreamRetentionPeriodRequest added in v0.9.0 

func (c *Client) IncreaseStreamRetentionPeriodRequest(input *IncreaseStreamRetentionPeriodInput) IncreaseStreamRetentionPeriodRequest

IncreaseStreamRetentionPeriodRequest returns a request value for making API operation for Amazon Kinesis.

Increases the Kinesis data stream's retention period, which is the length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 168 hours (7 days).

If you choose a longer stream retention period, this operation increases the time period during which records that have not yet expired are accessible. However, it does not make previous, expired data (older than the stream's previous retention period) accessible after the operation has been called. For example, if a stream's retention period is set to 24 hours and is increased to 168 hours, any data that is older than 24 hours remains inaccessible to consumer applications. 

// Example sending a request using IncreaseStreamRetentionPeriodRequest.
req := client.IncreaseStreamRetentionPeriodRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/IncreaseStreamRetentionPeriod

func (*Client) ListShardsRequest added in v0.9.0 

func (c *Client) ListShardsRequest(input *ListShardsInput) ListShardsRequest

ListShardsRequest returns a request value for making API operation for Amazon Kinesis.

Lists the shards in a stream and provides information about each shard. This operation has a limit of 100 transactions per second per data stream.

This API is a new operation that is used by the Amazon Kinesis Client Library (KCL). If you have a fine-grained IAM policy that only allows specific operations, you must update your policy to allow calls to this API. For more information, see Controlling Access to Amazon Kinesis Data Streams Resources Using IAM (https://docs.aws.amazon.com/streams/latest/dev/controlling-access.html). 

// Example sending a request using ListShardsRequest.
req := client.ListShardsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/ListShards

func (*Client) ListStreamConsumersRequest added in v0.9.0 

func (c *Client) ListStreamConsumersRequest(input *ListStreamConsumersInput) ListStreamConsumersRequest

ListStreamConsumersRequest returns a request value for making API operation for Amazon Kinesis.

Lists the consumers registered to receive data from a stream using enhanced fan-out, and provides information about each consumer.

This operation has a limit of 10 transactions per second per account. 

// Example sending a request using ListStreamConsumersRequest.
req := client.ListStreamConsumersRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/ListStreamConsumers

func (*Client) ListStreamsRequest added in v0.9.0 

func (c *Client) ListStreamsRequest(input *ListStreamsInput) ListStreamsRequest

ListStreamsRequest returns a request value for making API operation for Amazon Kinesis.

Lists your Kinesis data streams.

The number of streams may be too large to return from a single call to ListStreams. You can limit the number of returned streams using the Limit parameter. If you do not specify a value for the Limit parameter, Kinesis Data Streams uses the default limit, which is currently 10.

You can detect if there are more streams available to list by using the HasMoreStreams flag from the returned output. If there are more streams available, you can request more streams by using the name of the last stream returned by the ListStreams request in the ExclusiveStartStreamName parameter in a subsequent request to ListStreams. The group of stream names returned by the subsequent request is then added to the list. You can continue this process until all the stream names have been collected in the list.

ListStreams has a limit of five transactions per second per account. 

// Example sending a request using ListStreamsRequest.
req := client.ListStreamsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/ListStreams

func (*Client) ListTagsForStreamRequest added in v0.9.0 

func (c *Client) ListTagsForStreamRequest(input *ListTagsForStreamInput) ListTagsForStreamRequest

ListTagsForStreamRequest returns a request value for making API operation for Amazon Kinesis.

Lists the tags for the specified Kinesis data stream. This operation has a limit of five transactions per second per account. 

// Example sending a request using ListTagsForStreamRequest.
req := client.ListTagsForStreamRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/ListTagsForStream

func (*Client) MergeShardsRequest added in v0.9.0 

func (c *Client) MergeShardsRequest(input *MergeShardsInput) MergeShardsRequest

MergeShardsRequest returns a request value for making API operation for Amazon Kinesis.

Merges two adjacent shards in a Kinesis data stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data. Two shards are considered adjacent if the union of the hash key ranges for the two shards form a contiguous set with no gaps. For example, if you have two shards, one with a hash key range of 276...381 and the other with a hash key range of 382...454, then you could merge these two shards into a single shard that would have a hash key range of 276...454. After the merge, the single child shard receives data for all hash key values covered by the two parent shards.

MergeShards is called when there is a need to reduce the overall capacity of a stream because of excess capacity that is not being used. You must specify the shard to be merged and the adjacent shard for a stream. For more information about merging shards, see Merge Two Shards (http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-merge.html) in the Amazon Kinesis Data Streams Developer Guide.

If the stream is in the ACTIVE state, you can call MergeShards. If a stream is in the CREATING, UPDATING, or DELETING state, MergeShards returns a ResourceInUseException. If the specified stream does not exist, MergeShards returns a ResourceNotFoundException.

You can use DescribeStream to check the state of the stream, which is returned in StreamStatus.

MergeShards is an asynchronous operation. Upon receiving a MergeShards request, Amazon Kinesis Data Streams immediately returns a response and sets the StreamStatus to UPDATING. After the operation is completed, Kinesis Data Streams sets the StreamStatus to ACTIVE. Read and write operations continue to work while the stream is in the UPDATING state.

You use DescribeStream to determine the shard IDs that are specified in the MergeShards request.

If you try to operate on too many streams in parallel using CreateStream, DeleteStream, MergeShards, or SplitShard, you receive a LimitExceededException.

MergeShards has a limit of five transactions per second per account. 

// Example sending a request using MergeShardsRequest.
req := client.MergeShardsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/MergeShards

func (*Client) PutRecordRequest added in v0.9.0 

func (c *Client) PutRecordRequest(input *PutRecordInput) PutRecordRequest

PutRecordRequest returns a request value for making API operation for Amazon Kinesis.

Writes a single data record into an Amazon Kinesis data stream. Call PutRecord to send data into the stream for real-time ingestion and subsequent processing, one record at a time. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second.

You must specify the name of the stream that captures, stores, and transports the data; a partition key; and the data blob itself.

The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.

The partition key is used by Kinesis Data Streams to distribute data across shards. Kinesis Data Streams segregates the data records that belong to a stream into multiple shards, using the partition key associated with each data record to determine the shard to which a given data record belongs.

Partition keys are Unicode strings, with a maximum length limit of 256 characters for each key. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards using the hash key ranges of the shards. You can override hashing the partition key to determine the shard by explicitly specifying a hash value using the ExplicitHashKey parameter. For more information, see Adding Data to a Stream (http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream) in the Amazon Kinesis Data Streams Developer Guide.

PutRecord returns the shard ID of where the data record was placed and the sequence number that was assigned to the data record.

Sequence numbers increase over time and are specific to a shard within a stream, not across all shards within a stream. To guarantee strictly increasing ordering, write serially to a shard and use the SequenceNumberForOrdering parameter. For more information, see Adding Data to a Stream (http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream) in the Amazon Kinesis Data Streams Developer Guide.

If a PutRecord request cannot be processed because of insufficient provisioned throughput on the shard involved in the request, PutRecord throws ProvisionedThroughputExceededException.

By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period. 

// Example sending a request using PutRecordRequest.
req := client.PutRecordRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/PutRecord

func (*Client) PutRecordsRequest added in v0.9.0 

func (c *Client) PutRecordsRequest(input *PutRecordsInput) PutRecordsRequest

PutRecordsRequest returns a request value for making API operation for Amazon Kinesis.

Writes multiple data records into a Kinesis data stream in a single call (also referred to as a PutRecords request). Use this operation to send data into the stream for data ingestion and processing.

Each PutRecords request can support up to 500 records. Each record in the request can be as large as 1 MB, up to a limit of 5 MB for the entire request, including partition keys. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second.

You must specify the name of the stream that captures, stores, and transports the data; and an array of request Records, with each record in the array requiring a partition key and data blob. The record size limit applies to the total size of the partition key and data blob.

The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.

The partition key is used by Kinesis Data Streams as input to a hash function that maps the partition key and associated data to a specific shard. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream. For more information, see Adding Data to a Stream (http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream) in the Amazon Kinesis Data Streams Developer Guide.

Each record in the Records array may include an optional parameter, ExplicitHashKey, which overrides the partition key to shard mapping. This parameter allows a data producer to determine explicitly the shard where the record is stored. For more information, see Adding Multiple Records with PutRecords (http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-putrecords) in the Amazon Kinesis Data Streams Developer Guide.

The PutRecords response includes an array of response Records. Each record in the response array directly correlates with a record in the request array using natural ordering, from the top to the bottom of the request and response. The response Records array always includes the same number of records as the request array.

The response Records array includes both successfully and unsuccessfully processed records. Kinesis Data Streams attempts to process all records in each PutRecords request. A single record failure does not stop the processing of subsequent records.

A successfully processed record includes ShardId and SequenceNumber values. The ShardId parameter identifies the shard in the stream where the record is stored. The SequenceNumber parameter is an identifier assigned to the put record, unique to all records in the stream.

An unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error and can be one of the following values: ProvisionedThroughputExceededException or InternalFailure. ErrorMessage provides more detailed information about the ProvisionedThroughputExceededException exception including the account ID, stream name, and shard ID of the record that was throttled. For more information about partially successful responses, see Adding Multiple Records with PutRecords (http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-add-data-to-stream.html#kinesis-using-sdk-java-putrecords) in the Amazon Kinesis Data Streams Developer Guide.

By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period. 

// Example sending a request using PutRecordsRequest.
req := client.PutRecordsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/PutRecords

func (*Client) RegisterStreamConsumerRequest added in v0.9.0 

func (c *Client) RegisterStreamConsumerRequest(input *RegisterStreamConsumerInput) RegisterStreamConsumerRequest

RegisterStreamConsumerRequest returns a request value for making API operation for Amazon Kinesis.

Registers a consumer with a Kinesis data stream. When you use this operation, the consumer you register can read data from the stream at a rate of up to 2 MiB per second. This rate is unaffected by the total number of consumers that read from the same stream.

You can register up to 5 consumers per stream. A given consumer can only be registered with one stream.

This operation has a limit of five transactions per second per account. 

// Example sending a request using RegisterStreamConsumerRequest.
req := client.RegisterStreamConsumerRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/RegisterStreamConsumer

func (*Client) RemoveTagsFromStreamRequest added in v0.9.0 

func (c *Client) RemoveTagsFromStreamRequest(input *RemoveTagsFromStreamInput) RemoveTagsFromStreamRequest

RemoveTagsFromStreamRequest returns a request value for making API operation for Amazon Kinesis.

Removes tags from the specified Kinesis data stream. Removed tags are deleted and cannot be recovered after this operation successfully completes.

If you specify a tag that does not exist, it is ignored.

RemoveTagsFromStream has a limit of five transactions per second per account. 

// Example sending a request using RemoveTagsFromStreamRequest.
req := client.RemoveTagsFromStreamRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/RemoveTagsFromStream

func (*Client) SplitShardRequest added in v0.9.0 

func (c *Client) SplitShardRequest(input *SplitShardInput) SplitShardRequest

SplitShardRequest returns a request value for making API operation for Amazon Kinesis.

Splits a shard into two new shards in the Kinesis data stream, to increase the stream's capacity to ingest and transport data. SplitShard is called when there is a need to increase the overall capacity of a stream because of an expected increase in the volume of data records being ingested.

You can also use SplitShard when a shard appears to be approaching its maximum utilization; for example, the producers sending data into the specific shard are suddenly sending more than previously anticipated. You can also call SplitShard to increase stream capacity, so that more Kinesis Data Streams applications can simultaneously read data from the stream for real-time processing.

You must specify the shard to be split and the new hash key, which is the position in the shard where the shard gets split in two. In many cases, the new hash key might be the average of the beginning and ending hash key, but it can be any hash key value in the range being mapped into the shard. For more information, see Split a Shard (http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-split.html) in the Amazon Kinesis Data Streams Developer Guide.

You can use DescribeStream to determine the shard ID and hash key values for the ShardToSplit and NewStartingHashKey parameters that are specified in the SplitShard request.

SplitShard is an asynchronous operation. Upon receiving a SplitShard request, Kinesis Data Streams immediately returns a response and sets the stream status to UPDATING. After the operation is completed, Kinesis Data Streams sets the stream status to ACTIVE. Read and write operations continue to work while the stream is in the UPDATING state.

You can use DescribeStream to check the status of the stream, which is returned in StreamStatus. If the stream is in the ACTIVE state, you can call SplitShard. If a stream is in CREATING or UPDATING or DELETING states, DescribeStream returns a ResourceInUseException.

If the specified stream does not exist, DescribeStream returns a ResourceNotFoundException. If you try to create more shards than are authorized for your account, you receive a LimitExceededException.

For the default shard limit for an AWS account, see Kinesis Data Streams Limits (http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, contact AWS Support (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html).

If you try to operate on too many streams simultaneously using CreateStream, DeleteStream, MergeShards, and/or SplitShard, you receive a LimitExceededException.

SplitShard has a limit of five transactions per second per account. 

// Example sending a request using SplitShardRequest.
req := client.SplitShardRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/SplitShard

func (*Client) StartStreamEncryptionRequest added in v0.9.0 

func (c *Client) StartStreamEncryptionRequest(input *StartStreamEncryptionInput) StartStreamEncryptionRequest

StartStreamEncryptionRequest returns a request value for making API operation for Amazon Kinesis.

Enables or updates server-side encryption using an AWS KMS key for a specified stream.

Starting encryption is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to UPDATING. After the update is complete, Kinesis Data Streams sets the status of the stream back to ACTIVE. Updating or applying encryption normally takes a few seconds to complete, but it can take minutes. You can continue to read and write data to your stream while its status is UPDATING. Once the status of the stream is ACTIVE, encryption begins for records written to the stream.

API Limits: You can successfully apply a new AWS KMS key for server-side encryption 25 times in a rolling 24-hour period.

Note: It can take up to 5 seconds after the stream is in an ACTIVE status before all records written to the stream are encrypted. After you enable encryption, you can verify that encryption is applied by inspecting the API response from PutRecord or PutRecords. 

// Example sending a request using StartStreamEncryptionRequest.
req := client.StartStreamEncryptionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/StartStreamEncryption

func (*Client) StopStreamEncryptionRequest added in v0.9.0 

func (c *Client) StopStreamEncryptionRequest(input *StopStreamEncryptionInput) StopStreamEncryptionRequest

StopStreamEncryptionRequest returns a request value for making API operation for Amazon Kinesis.

Disables server-side encryption for a specified stream.

Stopping encryption is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to UPDATING. After the update is complete, Kinesis Data Streams sets the status of the stream back to ACTIVE. Stopping encryption normally takes a few seconds to complete, but it can take minutes. You can continue to read and write data to your stream while its status is UPDATING. Once the status of the stream is ACTIVE, records written to the stream are no longer encrypted by Kinesis Data Streams.

API Limits: You can successfully disable server-side encryption 25 times in a rolling 24-hour period.

Note: It can take up to 5 seconds after the stream is in an ACTIVE status before all records written to the stream are no longer subject to encryption. After you disabled encryption, you can verify that encryption is not applied by inspecting the API response from PutRecord or PutRecords. 

// Example sending a request using StopStreamEncryptionRequest.
req := client.StopStreamEncryptionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/StopStreamEncryption

func (*Client) UpdateShardCountRequest added in v0.9.0 

func (c *Client) UpdateShardCountRequest(input *UpdateShardCountInput) UpdateShardCountRequest

UpdateShardCountRequest returns a request value for making API operation for Amazon Kinesis.

Updates the shard count of the specified stream to the specified number of shards.

Updating the shard count is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to UPDATING. After the update is complete, Kinesis Data Streams sets the status of the stream back to ACTIVE. Depending on the size of the stream, the scaling action could take a few minutes to complete. You can continue to read and write data to your stream while its status is UPDATING.

To update the shard count, Kinesis Data Streams performs splits or merges on individual shards. This can cause short-lived shards to be created, in addition to the final shards. We recommend that you double or halve the shard count, as this results in the fewest number of splits or merges.

This operation has the following default limits. By default, you cannot do the following:

  • Scale more than twice per rolling 24-hour period per stream

  • Scale up to more than double your current shard count for a stream

  • Scale down below half your current shard count for a stream

  • Scale up to more than 500 shards in a stream

  • Scale a stream with more than 500 shards down unless the result is less than 500 shards

  • Scale up to more than the shard limit for your account

For the default limits for an AWS account, see Streams Limits (http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) in the Amazon Kinesis Data Streams Developer Guide. To request an increase in the call rate limit, the shard limit for this API, or your overall shard limit, use the limits form (https://console.aws.amazon.com/support/v1#/case/create?issueType=service-limit-increase&limitType=service-code-kinesis). 

// Example sending a request using UpdateShardCountRequest.
req := client.UpdateShardCountRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/UpdateShardCount

func (*Client) WaitUntilStreamExists added in v0.9.0 

func (c *Client) WaitUntilStreamExists(ctx context.Context, input *DescribeStreamInput, opts ...aws.WaiterOption) error

WaitUntilStreamExists uses the Kinesis API operation DescribeStream to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Client) WaitUntilStreamNotExists added in v0.9.0 

func (c *Client) WaitUntilStreamNotExists(ctx context.Context, input *DescribeStreamInput, opts ...aws.WaiterOption) error

WaitUntilStreamNotExists uses the Kinesis API operation DescribeStream to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type Consumer added in v0.5.0 

type Consumer struct {

	// When you register a consumer, Kinesis Data Streams generates an ARN for it.
	// You need this ARN to be able to call SubscribeToShard.
	//
	// If you delete a consumer and then create a new one with the same name, it
	// won't have the same ARN. That's because consumer ARNs contain the creation
	// timestamp. This is important to keep in mind if you have IAM policies that
	// reference consumer ARNs.
	//
	// ConsumerARN is a required field
	ConsumerARN *string `min:"1" type:"string" required:"true"`

	// ConsumerCreationTimestamp is a required field
	ConsumerCreationTimestamp *time.Time `type:"timestamp" required:"true"`

	// The name of the consumer is something you choose when you register the consumer.
	//
	// ConsumerName is a required field
	ConsumerName *string `min:"1" type:"string" required:"true"`

	// A consumer can't read data while in the CREATING or DELETING states.
	//
	// ConsumerStatus is a required field
	ConsumerStatus ConsumerStatus `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

An object that represents the details of the consumer you registered.

func (Consumer) String added in v0.5.0 

func (s Consumer) String() string

String returns the string representation

type ConsumerDescription added in v0.5.0 

type ConsumerDescription struct {

	// When you register a consumer, Kinesis Data Streams generates an ARN for it.
	// You need this ARN to be able to call SubscribeToShard.
	//
	// If you delete a consumer and then create a new one with the same name, it
	// won't have the same ARN. That's because consumer ARNs contain the creation
	// timestamp. This is important to keep in mind if you have IAM policies that
	// reference consumer ARNs.
	//
	// ConsumerARN is a required field
	ConsumerARN *string `min:"1" type:"string" required:"true"`

	// ConsumerCreationTimestamp is a required field
	ConsumerCreationTimestamp *time.Time `type:"timestamp" required:"true"`

	// The name of the consumer is something you choose when you register the consumer.
	//
	// ConsumerName is a required field
	ConsumerName *string `min:"1" type:"string" required:"true"`

	// A consumer can't read data while in the CREATING or DELETING states.
	//
	// ConsumerStatus is a required field
	ConsumerStatus ConsumerStatus `type:"string" required:"true" enum:"true"`

	// The ARN of the stream with which you registered the consumer.
	//
	// StreamARN is a required field
	StreamARN *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

An object that represents the details of a registered consumer.

func (ConsumerDescription) String added in v0.5.0 

func (s ConsumerDescription) String() string

String returns the string representation

type ConsumerStatus added in v0.5.0 

type ConsumerStatus string
const (
	ConsumerStatusCreating ConsumerStatus = "CREATING"
	ConsumerStatusDeleting ConsumerStatus = "DELETING"
	ConsumerStatusActive   ConsumerStatus = "ACTIVE"
)

Enum values for ConsumerStatus

func (ConsumerStatus) MarshalValue added in v0.5.0 

func (enum ConsumerStatus) MarshalValue() (string, error)

func (ConsumerStatus) MarshalValueBuf added in v0.5.0 

func (enum ConsumerStatus) MarshalValueBuf(b []byte) ([]byte, error)

type CreateStreamInput 

type CreateStreamInput struct {

	// The number of shards that the stream will use. The throughput of the stream
	// is a function of the number of shards; more shards are required for greater
	// provisioned throughput.
	//
	// DefaultShardLimit;
	//
	// ShardCount is a required field
	ShardCount *int64 `min:"1" type:"integer" required:"true"`

	// A name to identify the stream. The stream name is scoped to the AWS account
	// used by the application that creates the stream. It is also scoped by AWS
	// Region. That is, two streams in two different AWS accounts can have the same
	// name. Two streams in the same AWS account but in two different Regions can
	// also have the same name.
	//
	// StreamName is a required field
	StreamName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input for CreateStream.

func (CreateStreamInput) String 

func (s CreateStreamInput) String() string

String returns the string representation

func (*CreateStreamInput) Validate 

func (s *CreateStreamInput) Validate() error

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

type CreateStreamOutput 

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

func (CreateStreamOutput) String 

func (s CreateStreamOutput) String() string

String returns the string representation

type CreateStreamRequest 

type CreateStreamRequest struct {
	*aws.Request
	Input *CreateStreamInput
	Copy  func(*CreateStreamInput) CreateStreamRequest
}

CreateStreamRequest is the request type for the CreateStream API operation.

func (CreateStreamRequest) Send 

func (r CreateStreamRequest) Send(ctx context.Context) (*CreateStreamResponse, error)

Send marshals and sends the CreateStream API request.

type CreateStreamResponse added in v0.9.0 

type CreateStreamResponse struct {
	*CreateStreamOutput
	// contains filtered or unexported fields
}

CreateStreamResponse is the response type for the CreateStream API operation.

func (*CreateStreamResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateStreamResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateStream request.

type DecreaseStreamRetentionPeriodInput 

type DecreaseStreamRetentionPeriodInput struct {

	// The new retention period of the stream, in hours. Must be less than the current
	// retention period.
	//
	// RetentionPeriodHours is a required field
	RetentionPeriodHours *int64 `min:"1" type:"integer" required:"true"`

	// The name of the stream to modify.
	//
	// StreamName is a required field
	StreamName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input for DecreaseStreamRetentionPeriod.

func (DecreaseStreamRetentionPeriodInput) String 

func (s DecreaseStreamRetentionPeriodInput) String() string

String returns the string representation

func (*DecreaseStreamRetentionPeriodInput) Validate 

func (s *DecreaseStreamRetentionPeriodInput) Validate() error

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

type DecreaseStreamRetentionPeriodOutput 

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

func (DecreaseStreamRetentionPeriodOutput) String 

func (s DecreaseStreamRetentionPeriodOutput) String() string

String returns the string representation

type DecreaseStreamRetentionPeriodRequest 

type DecreaseStreamRetentionPeriodRequest struct {
	*aws.Request
	Input *DecreaseStreamRetentionPeriodInput
	Copy  func(*DecreaseStreamRetentionPeriodInput) DecreaseStreamRetentionPeriodRequest
}

DecreaseStreamRetentionPeriodRequest is the request type for the DecreaseStreamRetentionPeriod API operation.

func (DecreaseStreamRetentionPeriodRequest) Send 

func (r DecreaseStreamRetentionPeriodRequest) Send(ctx context.Context) (*DecreaseStreamRetentionPeriodResponse, error)

Send marshals and sends the DecreaseStreamRetentionPeriod API request.

type DecreaseStreamRetentionPeriodResponse added in v0.9.0 

type DecreaseStreamRetentionPeriodResponse struct {
	*DecreaseStreamRetentionPeriodOutput
	// contains filtered or unexported fields
}

DecreaseStreamRetentionPeriodResponse is the response type for the DecreaseStreamRetentionPeriod API operation.

func (*DecreaseStreamRetentionPeriodResponse) SDKResponseMetdata added in v0.9.0 

func (r *DecreaseStreamRetentionPeriodResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DecreaseStreamRetentionPeriod request.

type DeleteStreamInput 

type DeleteStreamInput struct {

	// If this parameter is unset (null) or if you set it to false, and the stream
	// has registered consumers, the call to DeleteStream fails with a ResourceInUseException.
	EnforceConsumerDeletion *bool `type:"boolean"`

	// The name of the stream to delete.
	//
	// StreamName is a required field
	StreamName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input for DeleteStream.

func (DeleteStreamInput) String 

func (s DeleteStreamInput) String() string

String returns the string representation

func (*DeleteStreamInput) Validate 

func (s *DeleteStreamInput) Validate() error

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

type DeleteStreamOutput 

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

func (DeleteStreamOutput) String 

func (s DeleteStreamOutput) String() string

String returns the string representation

type DeleteStreamRequest 

type DeleteStreamRequest struct {
	*aws.Request
	Input *DeleteStreamInput
	Copy  func(*DeleteStreamInput) DeleteStreamRequest
}

DeleteStreamRequest is the request type for the DeleteStream API operation.

func (DeleteStreamRequest) Send 

func (r DeleteStreamRequest) Send(ctx context.Context) (*DeleteStreamResponse, error)

Send marshals and sends the DeleteStream API request.

type DeleteStreamResponse added in v0.9.0 

type DeleteStreamResponse struct {
	*DeleteStreamOutput
	// contains filtered or unexported fields
}

DeleteStreamResponse is the response type for the DeleteStream API operation.

func (*DeleteStreamResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteStreamResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteStream request.

type DeregisterStreamConsumerInput added in v0.5.0 

type DeregisterStreamConsumerInput struct {

	// The ARN returned by Kinesis Data Streams when you registered the consumer.
	// If you don't know the ARN of the consumer that you want to deregister, you
	// can use the ListStreamConsumers operation to get a list of the descriptions
	// of all the consumers that are currently registered with a given data stream.
	// The description of a consumer contains its ARN.
	ConsumerARN *string `min:"1" type:"string"`

	// The name that you gave to the consumer.
	ConsumerName *string `min:"1" type:"string"`

	// The ARN of the Kinesis data stream that the consumer is registered with.
	// For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces
	// (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams).
	StreamARN *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DeregisterStreamConsumerInput) String added in v0.5.0 

func (s DeregisterStreamConsumerInput) String() string

String returns the string representation

func (*DeregisterStreamConsumerInput) Validate added in v0.5.0 

func (s *DeregisterStreamConsumerInput) Validate() error

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

type DeregisterStreamConsumerOutput added in v0.5.0 

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

func (DeregisterStreamConsumerOutput) String added in v0.5.0 

func (s DeregisterStreamConsumerOutput) String() string

String returns the string representation

type DeregisterStreamConsumerRequest added in v0.5.0 

type DeregisterStreamConsumerRequest struct {
	*aws.Request
	Input *DeregisterStreamConsumerInput
	Copy  func(*DeregisterStreamConsumerInput) DeregisterStreamConsumerRequest
}

DeregisterStreamConsumerRequest is the request type for the DeregisterStreamConsumer API operation.

func (DeregisterStreamConsumerRequest) Send added in v0.5.0 

func (r DeregisterStreamConsumerRequest) Send(ctx context.Context) (*DeregisterStreamConsumerResponse, error)

Send marshals and sends the DeregisterStreamConsumer API request.

type DeregisterStreamConsumerResponse added in v0.9.0 

type DeregisterStreamConsumerResponse struct {
	*DeregisterStreamConsumerOutput
	// contains filtered or unexported fields
}

DeregisterStreamConsumerResponse is the response type for the DeregisterStreamConsumer API operation.

func (*DeregisterStreamConsumerResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeregisterStreamConsumerResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeregisterStreamConsumer request.

type DescribeLimitsInput 

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

func (DescribeLimitsInput) String 

func (s DescribeLimitsInput) String() string

String returns the string representation

type DescribeLimitsOutput 

type DescribeLimitsOutput struct {

	// The number of open shards.
	//
	// OpenShardCount is a required field
	OpenShardCount *int64 `type:"integer" required:"true"`

	// The maximum number of shards.
	//
	// ShardLimit is a required field
	ShardLimit *int64 `type:"integer" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeLimitsOutput) String 

func (s DescribeLimitsOutput) String() string

String returns the string representation

type DescribeLimitsRequest 

type DescribeLimitsRequest struct {
	*aws.Request
	Input *DescribeLimitsInput
	Copy  func(*DescribeLimitsInput) DescribeLimitsRequest
}

DescribeLimitsRequest is the request type for the DescribeLimits API operation.

func (DescribeLimitsRequest) Send 

func (r DescribeLimitsRequest) Send(ctx context.Context) (*DescribeLimitsResponse, error)

Send marshals and sends the DescribeLimits API request.

type DescribeLimitsResponse added in v0.9.0 

type DescribeLimitsResponse struct {
	*DescribeLimitsOutput
	// contains filtered or unexported fields
}

DescribeLimitsResponse is the response type for the DescribeLimits API operation.

func (*DescribeLimitsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeLimitsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeLimits request.

type DescribeStreamConsumerInput added in v0.5.0 

type DescribeStreamConsumerInput struct {

	// The ARN returned by Kinesis Data Streams when you registered the consumer.
	ConsumerARN *string `min:"1" type:"string"`

	// The name that you gave to the consumer.
	ConsumerName *string `min:"1" type:"string"`

	// The ARN of the Kinesis data stream that the consumer is registered with.
	// For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces
	// (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams).
	StreamARN *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeStreamConsumerInput) String added in v0.5.0 

func (s DescribeStreamConsumerInput) String() string

String returns the string representation

func (*DescribeStreamConsumerInput) Validate added in v0.5.0 

func (s *DescribeStreamConsumerInput) Validate() error

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

type DescribeStreamConsumerOutput added in v0.5.0 

type DescribeStreamConsumerOutput struct {

	// An object that represents the details of the consumer.
	//
	// ConsumerDescription is a required field
	ConsumerDescription *ConsumerDescription `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeStreamConsumerOutput) String added in v0.5.0 

func (s DescribeStreamConsumerOutput) String() string

String returns the string representation

type DescribeStreamConsumerRequest added in v0.5.0 

type DescribeStreamConsumerRequest struct {
	*aws.Request
	Input *DescribeStreamConsumerInput
	Copy  func(*DescribeStreamConsumerInput) DescribeStreamConsumerRequest
}

DescribeStreamConsumerRequest is the request type for the DescribeStreamConsumer API operation.

func (DescribeStreamConsumerRequest) Send added in v0.5.0 

func (r DescribeStreamConsumerRequest) Send(ctx context.Context) (*DescribeStreamConsumerResponse, error)

Send marshals and sends the DescribeStreamConsumer API request.

type DescribeStreamConsumerResponse added in v0.9.0 

type DescribeStreamConsumerResponse struct {
	*DescribeStreamConsumerOutput
	// contains filtered or unexported fields
}

DescribeStreamConsumerResponse is the response type for the DescribeStreamConsumer API operation.

func (*DescribeStreamConsumerResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeStreamConsumerResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeStreamConsumer request.

type DescribeStreamInput 

type DescribeStreamInput struct {

	// The shard ID of the shard to start with.
	ExclusiveStartShardId *string `min:"1" type:"string"`

	// The maximum number of shards to return in a single call. The default value
	// is 100. If you specify a value greater than 100, at most 100 shards are returned.
	Limit *int64 `min:"1" type:"integer"`

	// The name of the stream to describe.
	//
	// StreamName is a required field
	StreamName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input for DescribeStream.

func (DescribeStreamInput) String 

func (s DescribeStreamInput) String() string

String returns the string representation

func (*DescribeStreamInput) Validate 

func (s *DescribeStreamInput) Validate() error

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

type DescribeStreamOutput 

type DescribeStreamOutput struct {

	// The current status of the stream, the stream Amazon Resource Name (ARN),
	// an array of shard objects that comprise the stream, and whether there are
	// more shards available.
	//
	// StreamDescription is a required field
	StreamDescription *StreamDescription `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Represents the output for DescribeStream.

func (DescribeStreamOutput) String 

func (s DescribeStreamOutput) String() string

String returns the string representation

type DescribeStreamPaginator added in v0.9.0 

type DescribeStreamPaginator struct {
	aws.Pager
}

DescribeStreamPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeStreamPaginator added in v0.9.0 

func NewDescribeStreamPaginator(req DescribeStreamRequest) DescribeStreamPaginator

NewDescribeStreamRequestPaginator returns a paginator for DescribeStream. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.DescribeStreamRequest(input)
p := kinesis.NewDescribeStreamRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeStreamPaginator) CurrentPage added in v0.9.0 

func (p *DescribeStreamPaginator) CurrentPage() *DescribeStreamOutput

type DescribeStreamRequest 

type DescribeStreamRequest struct {
	*aws.Request
	Input *DescribeStreamInput
	Copy  func(*DescribeStreamInput) DescribeStreamRequest
}

DescribeStreamRequest is the request type for the DescribeStream API operation.

func (DescribeStreamRequest) Send 

func (r DescribeStreamRequest) Send(ctx context.Context) (*DescribeStreamResponse, error)

Send marshals and sends the DescribeStream API request.

type DescribeStreamResponse added in v0.9.0 

type DescribeStreamResponse struct {
	*DescribeStreamOutput
	// contains filtered or unexported fields
}

DescribeStreamResponse is the response type for the DescribeStream API operation.

func (*DescribeStreamResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeStreamResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeStream request.

type DescribeStreamSummaryInput added in v0.2.0 

type DescribeStreamSummaryInput struct {

	// The name of the stream to describe.
	//
	// StreamName is a required field
	StreamName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeStreamSummaryInput) String added in v0.2.0 

func (s DescribeStreamSummaryInput) String() string

String returns the string representation

func (*DescribeStreamSummaryInput) Validate added in v0.2.0 

func (s *DescribeStreamSummaryInput) Validate() error

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

type DescribeStreamSummaryOutput added in v0.2.0 

type DescribeStreamSummaryOutput struct {

	// A StreamDescriptionSummary containing information about the stream.
	//
	// StreamDescriptionSummary is a required field
	StreamDescriptionSummary *StreamDescriptionSummary `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeStreamSummaryOutput) String added in v0.2.0 

func (s DescribeStreamSummaryOutput) String() string

String returns the string representation

type DescribeStreamSummaryRequest added in v0.2.0 

type DescribeStreamSummaryRequest struct {
	*aws.Request
	Input *DescribeStreamSummaryInput
	Copy  func(*DescribeStreamSummaryInput) DescribeStreamSummaryRequest
}

DescribeStreamSummaryRequest is the request type for the DescribeStreamSummary API operation.

func (DescribeStreamSummaryRequest) Send added in v0.2.0 

func (r DescribeStreamSummaryRequest) Send(ctx context.Context) (*DescribeStreamSummaryResponse, error)

Send marshals and sends the DescribeStreamSummary API request.

type DescribeStreamSummaryResponse added in v0.9.0 

type DescribeStreamSummaryResponse struct {
	*DescribeStreamSummaryOutput
	// contains filtered or unexported fields
}

DescribeStreamSummaryResponse is the response type for the DescribeStreamSummary API operation.

func (*DescribeStreamSummaryResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeStreamSummaryResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeStreamSummary request.

type DisableEnhancedMonitoringInput 

type DisableEnhancedMonitoringInput struct {

	// List of shard-level metrics to disable.
	//
	// The following are the valid shard-level metrics. The value "ALL" disables
	// every metric.
	//
	//    * IncomingBytes
	//
	//    * IncomingRecords
	//
	//    * OutgoingBytes
	//
	//    * OutgoingRecords
	//
	//    * WriteProvisionedThroughputExceeded
	//
	//    * ReadProvisionedThroughputExceeded
	//
	//    * IteratorAgeMilliseconds
	//
	//    * ALL
	//
	// For more information, see Monitoring the Amazon Kinesis Data Streams Service
	// with Amazon CloudWatch (http://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html)
	// in the Amazon Kinesis Data Streams Developer Guide.
	//
	// ShardLevelMetrics is a required field
	ShardLevelMetrics []MetricsName `min:"1" type:"list" required:"true"`

	// The name of the Kinesis data stream for which to disable enhanced monitoring.
	//
	// StreamName is a required field
	StreamName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input for DisableEnhancedMonitoring.

func (DisableEnhancedMonitoringInput) String 

func (s DisableEnhancedMonitoringInput) String() string

String returns the string representation

func (*DisableEnhancedMonitoringInput) Validate 

func (s *DisableEnhancedMonitoringInput) Validate() error

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

type DisableEnhancedMonitoringOutput added in v0.9.0 

type DisableEnhancedMonitoringOutput struct {

	// Represents the current state of the metrics that are in the enhanced state
	// before the operation.
	CurrentShardLevelMetrics []MetricsName `min:"1" type:"list"`

	// Represents the list of all the metrics that would be in the enhanced state
	// after the operation.
	DesiredShardLevelMetrics []MetricsName `min:"1" type:"list"`

	// The name of the Kinesis data stream.
	StreamName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents the output for EnableEnhancedMonitoring and DisableEnhancedMonitoring.

func (DisableEnhancedMonitoringOutput) String added in v0.9.0 

func (s DisableEnhancedMonitoringOutput) String() string

String returns the string representation

type DisableEnhancedMonitoringRequest 

type DisableEnhancedMonitoringRequest struct {
	*aws.Request
	Input *DisableEnhancedMonitoringInput
	Copy  func(*DisableEnhancedMonitoringInput) DisableEnhancedMonitoringRequest
}

DisableEnhancedMonitoringRequest is the request type for the DisableEnhancedMonitoring API operation.

func (DisableEnhancedMonitoringRequest) Send 

func (r DisableEnhancedMonitoringRequest) Send(ctx context.Context) (*DisableEnhancedMonitoringResponse, error)

Send marshals and sends the DisableEnhancedMonitoring API request.

type DisableEnhancedMonitoringResponse added in v0.9.0 

type DisableEnhancedMonitoringResponse struct {
	*DisableEnhancedMonitoringOutput
	// contains filtered or unexported fields
}

DisableEnhancedMonitoringResponse is the response type for the DisableEnhancedMonitoring API operation.

func (*DisableEnhancedMonitoringResponse) SDKResponseMetdata added in v0.9.0 

func (r *DisableEnhancedMonitoringResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DisableEnhancedMonitoring request.

type EnableEnhancedMonitoringInput 

type EnableEnhancedMonitoringInput struct {

	// List of shard-level metrics to enable.
	//
	// The following are the valid shard-level metrics. The value "ALL" enables
	// every metric.
	//
	//    * IncomingBytes
	//
	//    * IncomingRecords
	//
	//    * OutgoingBytes
	//
	//    * OutgoingRecords
	//
	//    * WriteProvisionedThroughputExceeded
	//
	//    * ReadProvisionedThroughputExceeded
	//
	//    * IteratorAgeMilliseconds
	//
	//    * ALL
	//
	// For more information, see Monitoring the Amazon Kinesis Data Streams Service
	// with Amazon CloudWatch (http://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html)
	// in the Amazon Kinesis Data Streams Developer Guide.
	//
	// ShardLevelMetrics is a required field
	ShardLevelMetrics []MetricsName `min:"1" type:"list" required:"true"`

	// The name of the stream for which to enable enhanced monitoring.
	//
	// StreamName is a required field
	StreamName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input for EnableEnhancedMonitoring.

func (EnableEnhancedMonitoringInput) String 

func (s EnableEnhancedMonitoringInput) String() string

String returns the string representation

func (*EnableEnhancedMonitoringInput) Validate 

func (s *EnableEnhancedMonitoringInput) Validate() error

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

type EnableEnhancedMonitoringOutput 

type EnableEnhancedMonitoringOutput struct {

	// Represents the current state of the metrics that are in the enhanced state
	// before the operation.
	CurrentShardLevelMetrics []MetricsName `min:"1" type:"list"`

	// Represents the list of all the metrics that would be in the enhanced state
	// after the operation.
	DesiredShardLevelMetrics []MetricsName `min:"1" type:"list"`

	// The name of the Kinesis data stream.
	StreamName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents the output for EnableEnhancedMonitoring and DisableEnhancedMonitoring.

func (EnableEnhancedMonitoringOutput) String 

func (s EnableEnhancedMonitoringOutput) String() string

String returns the string representation

type EnableEnhancedMonitoringRequest 

type EnableEnhancedMonitoringRequest struct {
	*aws.Request
	Input *EnableEnhancedMonitoringInput
	Copy  func(*EnableEnhancedMonitoringInput) EnableEnhancedMonitoringRequest
}

EnableEnhancedMonitoringRequest is the request type for the EnableEnhancedMonitoring API operation.

func (EnableEnhancedMonitoringRequest) Send 

func (r EnableEnhancedMonitoringRequest) Send(ctx context.Context) (*EnableEnhancedMonitoringResponse, error)

Send marshals and sends the EnableEnhancedMonitoring API request.

type EnableEnhancedMonitoringResponse added in v0.9.0 

type EnableEnhancedMonitoringResponse struct {
	*EnableEnhancedMonitoringOutput
	// contains filtered or unexported fields
}

EnableEnhancedMonitoringResponse is the response type for the EnableEnhancedMonitoring API operation.

func (*EnableEnhancedMonitoringResponse) SDKResponseMetdata added in v0.9.0 

func (r *EnableEnhancedMonitoringResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the EnableEnhancedMonitoring request.

type EncryptionType 

type EncryptionType string
const (
	EncryptionTypeNone EncryptionType = "NONE"
	EncryptionTypeKms  EncryptionType = "KMS"
)

Enum values for EncryptionType

func (EncryptionType) MarshalValue added in v0.3.0 

func (enum EncryptionType) MarshalValue() (string, error)

func (EncryptionType) MarshalValueBuf added in v0.3.0 

func (enum EncryptionType) MarshalValueBuf(b []byte) ([]byte, error)

type EnhancedMetrics 

type EnhancedMetrics struct {

	// List of shard-level metrics.
	//
	// The following are the valid shard-level metrics. The value "ALL" enhances
	// every metric.
	//
	//    * IncomingBytes
	//
	//    * IncomingRecords
	//
	//    * OutgoingBytes
	//
	//    * OutgoingRecords
	//
	//    * WriteProvisionedThroughputExceeded
	//
	//    * ReadProvisionedThroughputExceeded
	//
	//    * IteratorAgeMilliseconds
	//
	//    * ALL
	//
	// For more information, see Monitoring the Amazon Kinesis Data Streams Service
	// with Amazon CloudWatch (http://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html)
	// in the Amazon Kinesis Data Streams Developer Guide.
	ShardLevelMetrics []MetricsName `min:"1" type:"list"`
	// contains filtered or unexported fields
}

Represents enhanced metrics types.

func (EnhancedMetrics) String 

func (s EnhancedMetrics) String() string

String returns the string representation

type GetRecordsInput 

type GetRecordsInput struct {

	// The maximum number of records to return. Specify a value of up to 10,000.
	// If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException.
	Limit *int64 `min:"1" type:"integer"`

	// The position in the shard from which you want to start sequentially reading
	// data records. A shard iterator specifies this position using the sequence
	// number of a data record in the shard.
	//
	// ShardIterator is a required field
	ShardIterator *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input for GetRecords.

func (GetRecordsInput) String 

func (s GetRecordsInput) String() string

String returns the string representation

func (*GetRecordsInput) Validate 

func (s *GetRecordsInput) Validate() error

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

type GetRecordsOutput 

type GetRecordsOutput struct {

	// The number of milliseconds the GetRecords response is from the tip of the
	// stream, indicating how far behind current time the consumer is. A value of
	// zero indicates that record processing is caught up, and there are no new
	// records to process at this moment.
	MillisBehindLatest *int64 `type:"long"`

	// The next position in the shard from which to start sequentially reading data
	// records. If set to null, the shard has been closed and the requested iterator
	// does not return any more data.
	NextShardIterator *string `min:"1" type:"string"`

	// The data records retrieved from the shard.
	//
	// Records is a required field
	Records []Record `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Represents the output for GetRecords.

func (GetRecordsOutput) String 

func (s GetRecordsOutput) String() string

String returns the string representation

type GetRecordsRequest 

type GetRecordsRequest struct {
	*aws.Request
	Input *GetRecordsInput
	Copy  func(*GetRecordsInput) GetRecordsRequest
}

GetRecordsRequest is the request type for the GetRecords API operation.

func (GetRecordsRequest) Send 

func (r GetRecordsRequest) Send(ctx context.Context) (*GetRecordsResponse, error)

Send marshals and sends the GetRecords API request.

type GetRecordsResponse added in v0.9.0 

type GetRecordsResponse struct {
	*GetRecordsOutput
	// contains filtered or unexported fields
}

GetRecordsResponse is the response type for the GetRecords API operation.

func (*GetRecordsResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetRecordsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetRecords request.

type GetShardIteratorInput 

type GetShardIteratorInput struct {

	// The shard ID of the Kinesis Data Streams shard to get the iterator for.
	//
	// ShardId is a required field
	ShardId *string `min:"1" type:"string" required:"true"`

	// Determines how the shard iterator is used to start reading data records from
	// the shard.
	//
	// The following are the valid Amazon Kinesis shard iterator types:
	//
	//    * AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific
	//    sequence number, provided in the value StartingSequenceNumber.
	//
	//    * AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted
	//    by a specific sequence number, provided in the value StartingSequenceNumber.
	//
	//    * AT_TIMESTAMP - Start reading from the position denoted by a specific
	//    time stamp, provided in the value Timestamp.
	//
	//    * TRIM_HORIZON - Start reading at the last untrimmed record in the shard
	//    in the system, which is the oldest data record in the shard.
	//
	//    * LATEST - Start reading just after the most recent record in the shard,
	//    so that you always read the most recent data in the shard.
	//
	// ShardIteratorType is a required field
	ShardIteratorType ShardIteratorType `type:"string" required:"true" enum:"true"`

	// The sequence number of the data record in the shard from which to start reading.
	// Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.
	StartingSequenceNumber *string `type:"string"`

	// The name of the Amazon Kinesis data stream.
	//
	// StreamName is a required field
	StreamName *string `min:"1" type:"string" required:"true"`

	// The time stamp of the data record from which to start reading. Used with
	// shard iterator type AT_TIMESTAMP. A time stamp is the Unix epoch date with
	// precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or
	// 1459799926.480. If a record with this exact time stamp does not exist, the
	// iterator returned is for the next (later) record. If the time stamp is older
	// than the current trim horizon, the iterator returned is for the oldest untrimmed
	// data record (TRIM_HORIZON).
	Timestamp *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Represents the input for GetShardIterator.

func (GetShardIteratorInput) String 

func (s GetShardIteratorInput) String() string

String returns the string representation

func (*GetShardIteratorInput) Validate 

func (s *GetShardIteratorInput) Validate() error

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

type GetShardIteratorOutput 

type GetShardIteratorOutput struct {

	// The position in the shard from which to start reading data records sequentially.
	// A shard iterator specifies this position using the sequence number of a data
	// record in a shard.
	ShardIterator *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents the output for GetShardIterator.

func (GetShardIteratorOutput) String 

func (s GetShardIteratorOutput) String() string

String returns the string representation

type GetShardIteratorRequest 

type GetShardIteratorRequest struct {
	*aws.Request
	Input *GetShardIteratorInput
	Copy  func(*GetShardIteratorInput) GetShardIteratorRequest
}

GetShardIteratorRequest is the request type for the GetShardIterator API operation.

func (GetShardIteratorRequest) Send 

func (r GetShardIteratorRequest) Send(ctx context.Context) (*GetShardIteratorResponse, error)

Send marshals and sends the GetShardIterator API request.

type GetShardIteratorResponse added in v0.9.0 

type GetShardIteratorResponse struct {
	*GetShardIteratorOutput
	// contains filtered or unexported fields
}

GetShardIteratorResponse is the response type for the GetShardIterator API operation.

func (*GetShardIteratorResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetShardIteratorResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetShardIterator request.

type HashKeyRange 

type HashKeyRange struct {

	// The ending hash key of the hash key range.
	//
	// EndingHashKey is a required field
	EndingHashKey *string `type:"string" required:"true"`

	// The starting hash key of the hash key range.
	//
	// StartingHashKey is a required field
	StartingHashKey *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.

func (HashKeyRange) String 

func (s HashKeyRange) String() string

String returns the string representation

type IncreaseStreamRetentionPeriodInput 

type IncreaseStreamRetentionPeriodInput struct {

	// The new retention period of the stream, in hours. Must be more than the current
	// retention period.
	//
	// RetentionPeriodHours is a required field
	RetentionPeriodHours *int64 `min:"1" type:"integer" required:"true"`

	// The name of the stream to modify.
	//
	// StreamName is a required field
	StreamName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input for IncreaseStreamRetentionPeriod.

func (IncreaseStreamRetentionPeriodInput) String 

func (s IncreaseStreamRetentionPeriodInput) String() string

String returns the string representation

func (*IncreaseStreamRetentionPeriodInput) Validate 

func (s *IncreaseStreamRetentionPeriodInput) Validate() error

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

type IncreaseStreamRetentionPeriodOutput 

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

func (IncreaseStreamRetentionPeriodOutput) String 

func (s IncreaseStreamRetentionPeriodOutput) String() string

String returns the string representation

type IncreaseStreamRetentionPeriodRequest 

type IncreaseStreamRetentionPeriodRequest struct {
	*aws.Request
	Input *IncreaseStreamRetentionPeriodInput
	Copy  func(*IncreaseStreamRetentionPeriodInput) IncreaseStreamRetentionPeriodRequest
}

IncreaseStreamRetentionPeriodRequest is the request type for the IncreaseStreamRetentionPeriod API operation.

func (IncreaseStreamRetentionPeriodRequest) Send 

func (r IncreaseStreamRetentionPeriodRequest) Send(ctx context.Context) (*IncreaseStreamRetentionPeriodResponse, error)

Send marshals and sends the IncreaseStreamRetentionPeriod API request.

type IncreaseStreamRetentionPeriodResponse added in v0.9.0 

type IncreaseStreamRetentionPeriodResponse struct {
	*IncreaseStreamRetentionPeriodOutput
	// contains filtered or unexported fields
}

IncreaseStreamRetentionPeriodResponse is the response type for the IncreaseStreamRetentionPeriod API operation.

func (*IncreaseStreamRetentionPeriodResponse) SDKResponseMetdata added in v0.9.0 

func (r *IncreaseStreamRetentionPeriodResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the IncreaseStreamRetentionPeriod request.

type ListShardsInput added in v0.3.0 

type ListShardsInput struct {

	// Specify this parameter to indicate that you want to list the shards starting
	// with the shard whose ID immediately follows ExclusiveStartShardId.
	//
	// If you don't specify this parameter, the default behavior is for ListShards
	// to list the shards starting with the first one in the stream.
	//
	// You cannot specify this parameter if you specify NextToken.
	ExclusiveStartShardId *string `min:"1" type:"string"`

	// The maximum number of shards to return in a single call to ListShards. The
	// minimum value you can specify for this parameter is 1, and the maximum is
	// 1,000, which is also the default.
	//
	// When the number of shards to be listed is greater than the value of MaxResults,
	// the response contains a NextToken value that you can use in a subsequent
	// call to ListShards to list the next set of shards.
	MaxResults *int64 `min:"1" type:"integer"`

	// When the number of shards in the data stream is greater than the default
	// value for the MaxResults parameter, or if you explicitly specify a value
	// for MaxResults that is less than the number of shards in the data stream,
	// the response includes a pagination token named NextToken. You can specify
	// this NextToken value in a subsequent call to ListShards to list the next
	// set of shards.
	//
	// Don't specify StreamName or StreamCreationTimestamp if you specify NextToken
	// because the latter unambiguously identifies the stream.
	//
	// You can optionally specify a value for the MaxResults parameter when you
	// specify NextToken. If you specify a MaxResults value that is less than the
	// number of shards that the operation returns if you don't specify MaxResults,
	// the response will contain a new NextToken value. You can use the new NextToken
	// value in a subsequent call to the ListShards operation.
	//
	// Tokens expire after 300 seconds. When you obtain a value for NextToken in
	// the response to a call to ListShards, you have 300 seconds to use that value.
	// If you specify an expired token in a call to ListShards, you get ExpiredNextTokenException.
	NextToken *string `min:"1" type:"string"`

	// Specify this input parameter to distinguish data streams that have the same
	// name. For example, if you create a data stream and then delete it, and you
	// later create another data stream with the same name, you can use this input
	// parameter to specify which of the two streams you want to list the shards
	// for.
	//
	// You cannot specify this parameter if you specify the NextToken parameter.
	StreamCreationTimestamp *time.Time `type:"timestamp"`

	// The name of the data stream whose shards you want to list.
	//
	// You cannot specify this parameter if you specify the NextToken parameter.
	StreamName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListShardsInput) String added in v0.3.0 

func (s ListShardsInput) String() string

String returns the string representation

func (*ListShardsInput) Validate added in v0.3.0 

func (s *ListShardsInput) Validate() error

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

type ListShardsOutput added in v0.3.0 

type ListShardsOutput struct {

	// When the number of shards in the data stream is greater than the default
	// value for the MaxResults parameter, or if you explicitly specify a value
	// for MaxResults that is less than the number of shards in the data stream,
	// the response includes a pagination token named NextToken. You can specify
	// this NextToken value in a subsequent call to ListShards to list the next
	// set of shards. For more information about the use of this pagination token
	// when calling the ListShards operation, see ListShardsInput$NextToken.
	//
	// Tokens expire after 300 seconds. When you obtain a value for NextToken in
	// the response to a call to ListShards, you have 300 seconds to use that value.
	// If you specify an expired token in a call to ListShards, you get ExpiredNextTokenException.
	NextToken *string `min:"1" type:"string"`

	// An array of JSON objects. Each object represents one shard and specifies
	// the IDs of the shard, the shard's parent, and the shard that's adjacent to
	// the shard's parent. Each object also contains the starting and ending hash
	// keys and the starting and ending sequence numbers for the shard.
	Shards []Shard `type:"list"`
	// contains filtered or unexported fields
}

func (ListShardsOutput) String added in v0.3.0 

func (s ListShardsOutput) String() string

String returns the string representation

type ListShardsRequest added in v0.3.0 

type ListShardsRequest struct {
	*aws.Request
	Input *ListShardsInput
	Copy  func(*ListShardsInput) ListShardsRequest
}

ListShardsRequest is the request type for the ListShards API operation.

func (ListShardsRequest) Send added in v0.3.0 

func (r ListShardsRequest) Send(ctx context.Context) (*ListShardsResponse, error)

Send marshals and sends the ListShards API request.

type ListShardsResponse added in v0.9.0 

type ListShardsResponse struct {
	*ListShardsOutput
	// contains filtered or unexported fields
}

ListShardsResponse is the response type for the ListShards API operation.

func (*ListShardsResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListShardsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListShards request.

type ListStreamConsumersInput added in v0.5.0 

type ListStreamConsumersInput struct {

	// The maximum number of consumers that you want a single call of ListStreamConsumers
	// to return.
	MaxResults *int64 `min:"1" type:"integer"`

	// When the number of consumers that are registered with the data stream is
	// greater than the default value for the MaxResults parameter, or if you explicitly
	// specify a value for MaxResults that is less than the number of consumers
	// that are registered with the data stream, the response includes a pagination
	// token named NextToken. You can specify this NextToken value in a subsequent
	// call to ListStreamConsumers to list the next set of registered consumers.
	//
	// Don't specify StreamName or StreamCreationTimestamp if you specify NextToken
	// because the latter unambiguously identifies the stream.
	//
	// You can optionally specify a value for the MaxResults parameter when you
	// specify NextToken. If you specify a MaxResults value that is less than the
	// number of consumers that the operation returns if you don't specify MaxResults,
	// the response will contain a new NextToken value. You can use the new NextToken
	// value in a subsequent call to the ListStreamConsumers operation to list the
	// next set of consumers.
	//
	// Tokens expire after 300 seconds. When you obtain a value for NextToken in
	// the response to a call to ListStreamConsumers, you have 300 seconds to use
	// that value. If you specify an expired token in a call to ListStreamConsumers,
	// you get ExpiredNextTokenException.
	NextToken *string `min:"1" type:"string"`

	// The ARN of the Kinesis data stream for which you want to list the registered
	// consumers. For more information, see Amazon Resource Names (ARNs) and AWS
	// Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams).
	//
	// StreamARN is a required field
	StreamARN *string `min:"1" type:"string" required:"true"`

	// Specify this input parameter to distinguish data streams that have the same
	// name. For example, if you create a data stream and then delete it, and you
	// later create another data stream with the same name, you can use this input
	// parameter to specify which of the two streams you want to list the consumers
	// for.
	//
	// You can't specify this parameter if you specify the NextToken parameter.
	StreamCreationTimestamp *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

func (ListStreamConsumersInput) String added in v0.5.0 

func (s ListStreamConsumersInput) String() string

String returns the string representation

func (*ListStreamConsumersInput) Validate added in v0.5.0 

func (s *ListStreamConsumersInput) Validate() error

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

type ListStreamConsumersOutput added in v0.5.0 

type ListStreamConsumersOutput struct {

	// An array of JSON objects. Each object represents one registered consumer.
	Consumers []Consumer `type:"list"`

	// When the number of consumers that are registered with the data stream is
	// greater than the default value for the MaxResults parameter, or if you explicitly
	// specify a value for MaxResults that is less than the number of registered
	// consumers, the response includes a pagination token named NextToken. You
	// can specify this NextToken value in a subsequent call to ListStreamConsumers
	// to list the next set of registered consumers. For more information about
	// the use of this pagination token when calling the ListStreamConsumers operation,
	// see ListStreamConsumersInput$NextToken.
	//
	// Tokens expire after 300 seconds. When you obtain a value for NextToken in
	// the response to a call to ListStreamConsumers, you have 300 seconds to use
	// that value. If you specify an expired token in a call to ListStreamConsumers,
	// you get ExpiredNextTokenException.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListStreamConsumersOutput) String added in v0.5.0 

func (s ListStreamConsumersOutput) String() string

String returns the string representation

type ListStreamConsumersPaginator added in v0.9.0 

type ListStreamConsumersPaginator struct {
	aws.Pager
}

ListStreamConsumersPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListStreamConsumersPaginator added in v0.9.0 

func NewListStreamConsumersPaginator(req ListStreamConsumersRequest) ListStreamConsumersPaginator

NewListStreamConsumersRequestPaginator returns a paginator for ListStreamConsumers. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListStreamConsumersRequest(input)
p := kinesis.NewListStreamConsumersRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListStreamConsumersPaginator) CurrentPage added in v0.9.0 

func (p *ListStreamConsumersPaginator) CurrentPage() *ListStreamConsumersOutput

type ListStreamConsumersRequest added in v0.5.0 

type ListStreamConsumersRequest struct {
	*aws.Request
	Input *ListStreamConsumersInput
	Copy  func(*ListStreamConsumersInput) ListStreamConsumersRequest
}

ListStreamConsumersRequest is the request type for the ListStreamConsumers API operation.

func (ListStreamConsumersRequest) Send added in v0.5.0 

func (r ListStreamConsumersRequest) Send(ctx context.Context) (*ListStreamConsumersResponse, error)

Send marshals and sends the ListStreamConsumers API request.

type ListStreamConsumersResponse added in v0.9.0 

type ListStreamConsumersResponse struct {
	*ListStreamConsumersOutput
	// contains filtered or unexported fields
}

ListStreamConsumersResponse is the response type for the ListStreamConsumers API operation.

func (*ListStreamConsumersResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListStreamConsumersResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListStreamConsumers request.

type ListStreamsInput 

type ListStreamsInput struct {

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

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

Represents the input for ListStreams.

func (ListStreamsInput) String 

func (s ListStreamsInput) String() string

String returns the string representation

func (*ListStreamsInput) Validate 

func (s *ListStreamsInput) Validate() error

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

type ListStreamsOutput 

type ListStreamsOutput struct {

	// If set to true, there are more streams available to list.
	//
	// HasMoreStreams is a required field
	HasMoreStreams *bool `type:"boolean" required:"true"`

	// The names of the streams that are associated with the AWS account making
	// the ListStreams request.
	//
	// StreamNames is a required field
	StreamNames []string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Represents the output for ListStreams.

func (ListStreamsOutput) String 

func (s ListStreamsOutput) String() string

String returns the string representation

type ListStreamsPaginator added in v0.9.0 

type ListStreamsPaginator struct {
	aws.Pager
}

ListStreamsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListStreamsPaginator added in v0.9.0 

func NewListStreamsPaginator(req ListStreamsRequest) ListStreamsPaginator

NewListStreamsRequestPaginator returns a paginator for ListStreams. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListStreamsRequest(input)
p := kinesis.NewListStreamsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListStreamsPaginator) CurrentPage added in v0.9.0 

func (p *ListStreamsPaginator) CurrentPage() *ListStreamsOutput

type ListStreamsRequest 

type ListStreamsRequest struct {
	*aws.Request
	Input *ListStreamsInput
	Copy  func(*ListStreamsInput) ListStreamsRequest
}

ListStreamsRequest is the request type for the ListStreams API operation.

func (ListStreamsRequest) Send 

func (r ListStreamsRequest) Send(ctx context.Context) (*ListStreamsResponse, error)

Send marshals and sends the ListStreams API request.

type ListStreamsResponse added in v0.9.0 

type ListStreamsResponse struct {
	*ListStreamsOutput
	// contains filtered or unexported fields
}

ListStreamsResponse is the response type for the ListStreams API operation.

func (*ListStreamsResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListStreamsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListStreams request.

type ListTagsForStreamInput 

type ListTagsForStreamInput struct {

	// The key to use as the starting point for the list of tags. If this parameter
	// is set, ListTagsForStream gets all tags that occur after ExclusiveStartTagKey.
	ExclusiveStartTagKey *string `min:"1" type:"string"`

	// The number of tags to return. If this number is less than the total number
	// of tags associated with the stream, HasMoreTags is set to true. To list additional
	// tags, set ExclusiveStartTagKey to the last key in the response.
	Limit *int64 `min:"1" type:"integer"`

	// The name of the stream.
	//
	// StreamName is a required field
	StreamName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input for ListTagsForStream.

func (ListTagsForStreamInput) String 

func (s ListTagsForStreamInput) String() string

String returns the string representation

func (*ListTagsForStreamInput) Validate 

func (s *ListTagsForStreamInput) Validate() error

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

type ListTagsForStreamOutput 

type ListTagsForStreamOutput struct {

	// If set to true, more tags are available. To request additional tags, set
	// ExclusiveStartTagKey to the key of the last tag returned.
	//
	// HasMoreTags is a required field
	HasMoreTags *bool `type:"boolean" required:"true"`

	// A list of tags associated with StreamName, starting with the first tag after
	// ExclusiveStartTagKey and up to the specified Limit.
	//
	// Tags is a required field
	Tags []Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Represents the output for ListTagsForStream.

func (ListTagsForStreamOutput) String 

func (s ListTagsForStreamOutput) String() string

String returns the string representation

type ListTagsForStreamRequest 

type ListTagsForStreamRequest struct {
	*aws.Request
	Input *ListTagsForStreamInput
	Copy  func(*ListTagsForStreamInput) ListTagsForStreamRequest
}

ListTagsForStreamRequest is the request type for the ListTagsForStream API operation.

func (ListTagsForStreamRequest) Send 

func (r ListTagsForStreamRequest) Send(ctx context.Context) (*ListTagsForStreamResponse, error)

Send marshals and sends the ListTagsForStream API request.

type ListTagsForStreamResponse added in v0.9.0 

type ListTagsForStreamResponse struct {
	*ListTagsForStreamOutput
	// contains filtered or unexported fields
}

ListTagsForStreamResponse is the response type for the ListTagsForStream API operation.

func (*ListTagsForStreamResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListTagsForStreamResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTagsForStream request.

type MergeShardsInput 

type MergeShardsInput struct {

	// The shard ID of the adjacent shard for the merge.
	//
	// AdjacentShardToMerge is a required field
	AdjacentShardToMerge *string `min:"1" type:"string" required:"true"`

	// The shard ID of the shard to combine with the adjacent shard for the merge.
	//
	// ShardToMerge is a required field
	ShardToMerge *string `min:"1" type:"string" required:"true"`

	// The name of the stream for the merge.
	//
	// StreamName is a required field
	StreamName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input for MergeShards.

func (MergeShardsInput) String 

func (s MergeShardsInput) String() string

String returns the string representation

func (*MergeShardsInput) Validate 

func (s *MergeShardsInput) Validate() error

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

type MergeShardsOutput 

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

func (MergeShardsOutput) String 

func (s MergeShardsOutput) String() string

String returns the string representation

type MergeShardsRequest 

type MergeShardsRequest struct {
	*aws.Request
	Input *MergeShardsInput
	Copy  func(*MergeShardsInput) MergeShardsRequest
}

MergeShardsRequest is the request type for the MergeShards API operation.

func (MergeShardsRequest) Send 

func (r MergeShardsRequest) Send(ctx context.Context) (*MergeShardsResponse, error)

Send marshals and sends the MergeShards API request.

type MergeShardsResponse added in v0.9.0 

type MergeShardsResponse struct {
	*MergeShardsOutput
	// contains filtered or unexported fields
}

MergeShardsResponse is the response type for the MergeShards API operation.

func (*MergeShardsResponse) SDKResponseMetdata added in v0.9.0 

func (r *MergeShardsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the MergeShards request.

type MetricsName 

type MetricsName string
const (
	MetricsNameIncomingBytes                      MetricsName = "IncomingBytes"
	MetricsNameIncomingRecords                    MetricsName = "IncomingRecords"
	MetricsNameOutgoingBytes                      MetricsName = "OutgoingBytes"
	MetricsNameOutgoingRecords                    MetricsName = "OutgoingRecords"
	MetricsNameWriteProvisionedThroughputExceeded MetricsName = "WriteProvisionedThroughputExceeded"
	MetricsNameReadProvisionedThroughputExceeded  MetricsName = "ReadProvisionedThroughputExceeded"
	MetricsNameIteratorAgeMilliseconds            MetricsName = "IteratorAgeMilliseconds"
	MetricsNameAll                                MetricsName = "ALL"
)

Enum values for MetricsName

func (MetricsName) MarshalValue added in v0.3.0 

func (enum MetricsName) MarshalValue() (string, error)

func (MetricsName) MarshalValueBuf added in v0.3.0 

func (enum MetricsName) MarshalValueBuf(b []byte) ([]byte, error)

type PutRecordInput 

type PutRecordInput struct {

	// The data blob to put into the record, which is base64-encoded when the blob
	// is serialized. When the data blob (the payload before base64-encoding) is
	// added to the partition key size, the total size must not exceed the maximum
	// record size (1 MB).
	//
	// Data is automatically base64 encoded/decoded by the SDK.
	//
	// Data is a required field
	Data []byte `type:"blob" required:"true"`

	// The hash value used to explicitly determine the shard the data record is
	// assigned to by overriding the partition key hash.
	ExplicitHashKey *string `type:"string"`

	// Determines which shard in the stream the data record is assigned to. Partition
	// keys are Unicode strings with a maximum length limit of 256 characters for
	// each key. Amazon Kinesis Data Streams uses the partition key as input to
	// a hash function that maps the partition key and associated data to a specific
	// shard. Specifically, an MD5 hash function is used to map partition keys to
	// 128-bit integer values and to map associated data records to shards. As a
	// result of this hashing mechanism, all data records with the same partition
	// key map to the same shard within the stream.
	//
	// PartitionKey is a required field
	PartitionKey *string `min:"1" type:"string" required:"true"`

	// Guarantees strictly increasing sequence numbers, for puts from the same client
	// and to the same partition key. Usage: set the SequenceNumberForOrdering of
	// record n to the sequence number of record n-1 (as returned in the result
	// when putting record n-1). If this parameter is not set, records are coarsely
	// ordered based on arrival time.
	SequenceNumberForOrdering *string `type:"string"`

	// The name of the stream to put the data record into.
	//
	// StreamName is a required field
	StreamName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input for PutRecord.

func (PutRecordInput) String 

func (s PutRecordInput) String() string

String returns the string representation

func (*PutRecordInput) Validate 

func (s *PutRecordInput) Validate() error

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

type PutRecordOutput 

type PutRecordOutput struct {

	// The encryption type to use on the record. This parameter can be one of the
	// following values:
	//
	//    * NONE: Do not encrypt the records in the stream.
	//
	//    * KMS: Use server-side encryption on the records in the stream using a
	//    customer-managed AWS KMS key.
	EncryptionType EncryptionType `type:"string" enum:"true"`

	// The sequence number identifier that was assigned to the put data record.
	// The sequence number for the record is unique across all records in the stream.
	// A sequence number is the identifier associated with every record put into
	// the stream.
	//
	// SequenceNumber is a required field
	SequenceNumber *string `type:"string" required:"true"`

	// The shard ID of the shard where the data record was placed.
	//
	// ShardId is a required field
	ShardId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the output for PutRecord.

func (PutRecordOutput) String 

func (s PutRecordOutput) String() string

String returns the string representation

type PutRecordRequest 

type PutRecordRequest struct {
	*aws.Request
	Input *PutRecordInput
	Copy  func(*PutRecordInput) PutRecordRequest
}

PutRecordRequest is the request type for the PutRecord API operation.

func (PutRecordRequest) Send 

func (r PutRecordRequest) Send(ctx context.Context) (*PutRecordResponse, error)

Send marshals and sends the PutRecord API request.

type PutRecordResponse added in v0.9.0 

type PutRecordResponse struct {
	*PutRecordOutput
	// contains filtered or unexported fields
}

PutRecordResponse is the response type for the PutRecord API operation.

func (*PutRecordResponse) SDKResponseMetdata added in v0.9.0 

func (r *PutRecordResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutRecord request.

type PutRecordsInput 

type PutRecordsInput struct {

	// The records associated with the request.
	//
	// Records is a required field
	Records []PutRecordsRequestEntry `min:"1" type:"list" required:"true"`

	// The stream name associated with the request.
	//
	// StreamName is a required field
	StreamName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A PutRecords request.

func (PutRecordsInput) String 

func (s PutRecordsInput) String() string

String returns the string representation

func (*PutRecordsInput) Validate 

func (s *PutRecordsInput) Validate() error

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

type PutRecordsOutput 

type PutRecordsOutput struct {

	// The encryption type used on the records. This parameter can be one of the
	// following values:
	//
	//    * NONE: Do not encrypt the records.
	//
	//    * KMS: Use server-side encryption on the records using a customer-managed
	//    AWS KMS key.
	EncryptionType EncryptionType `type:"string" enum:"true"`

	// The number of unsuccessfully processed records in a PutRecords request.
	FailedRecordCount *int64 `min:"1" type:"integer"`

	// An array of successfully and unsuccessfully processed record results, correlated
	// with the request by natural ordering. A record that is successfully added
	// to a stream includes SequenceNumber and ShardId in the result. A record that
	// fails to be added to a stream includes ErrorCode and ErrorMessage in the
	// result.
	//
	// Records is a required field
	Records []PutRecordsResultEntry `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

PutRecords results.

func (PutRecordsOutput) String 

func (s PutRecordsOutput) String() string

String returns the string representation

type PutRecordsRequest 

type PutRecordsRequest struct {
	*aws.Request
	Input *PutRecordsInput
	Copy  func(*PutRecordsInput) PutRecordsRequest
}

PutRecordsRequest is the request type for the PutRecords API operation.

func (PutRecordsRequest) Send 

func (r PutRecordsRequest) Send(ctx context.Context) (*PutRecordsResponse, error)

Send marshals and sends the PutRecords API request.

type PutRecordsRequestEntry 

type PutRecordsRequestEntry struct {

	// The data blob to put into the record, which is base64-encoded when the blob
	// is serialized. When the data blob (the payload before base64-encoding) is
	// added to the partition key size, the total size must not exceed the maximum
	// record size (1 MB).
	//
	// Data is automatically base64 encoded/decoded by the SDK.
	//
	// Data is a required field
	Data []byte `type:"blob" required:"true"`

	// The hash value used to determine explicitly the shard that the data record
	// is assigned to by overriding the partition key hash.
	ExplicitHashKey *string `type:"string"`

	// Determines which shard in the stream the data record is assigned to. Partition
	// keys are Unicode strings with a maximum length limit of 256 characters for
	// each key. Amazon Kinesis Data Streams uses the partition key as input to
	// a hash function that maps the partition key and associated data to a specific
	// shard. Specifically, an MD5 hash function is used to map partition keys to
	// 128-bit integer values and to map associated data records to shards. As a
	// result of this hashing mechanism, all data records with the same partition
	// key map to the same shard within the stream.
	//
	// PartitionKey is a required field
	PartitionKey *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the output for PutRecords.

func (PutRecordsRequestEntry) String 

func (s PutRecordsRequestEntry) String() string

String returns the string representation

func (*PutRecordsRequestEntry) Validate 

func (s *PutRecordsRequestEntry) Validate() error

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

type PutRecordsResponse added in v0.9.0 

type PutRecordsResponse struct {
	*PutRecordsOutput
	// contains filtered or unexported fields
}

PutRecordsResponse is the response type for the PutRecords API operation.

func (*PutRecordsResponse) SDKResponseMetdata added in v0.9.0 

func (r *PutRecordsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutRecords request.

type PutRecordsResultEntry 

type PutRecordsResultEntry struct {

	// The error code for an individual record result. ErrorCodes can be either
	// ProvisionedThroughputExceededException or InternalFailure.
	ErrorCode *string `type:"string"`

	// The error message for an individual record result. An ErrorCode value of
	// ProvisionedThroughputExceededException has an error message that includes
	// the account ID, stream name, and shard ID. An ErrorCode value of InternalFailure
	// has the error message "Internal Service Failure".
	ErrorMessage *string `type:"string"`

	// The sequence number for an individual record result.
	SequenceNumber *string `type:"string"`

	// The shard ID for an individual record result.
	ShardId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents the result of an individual record from a PutRecords request. A record that is successfully added to a stream includes SequenceNumber and ShardId in the result. A record that fails to be added to the stream includes ErrorCode and ErrorMessage in the result.

func (PutRecordsResultEntry) String 

func (s PutRecordsResultEntry) String() string

String returns the string representation

type Record 

type Record struct {

	// The approximate time that the record was inserted into the stream.
	ApproximateArrivalTimestamp *time.Time `type:"timestamp"`

	// The data blob. The data in the blob is both opaque and immutable to Kinesis
	// Data Streams, which does not inspect, interpret, or change the data in the
	// blob in any way. When the data blob (the payload before base64-encoding)
	// is added to the partition key size, the total size must not exceed the maximum
	// record size (1 MB).
	//
	// Data is automatically base64 encoded/decoded by the SDK.
	//
	// Data is a required field
	Data []byte `type:"blob" required:"true"`

	// The encryption type used on the record. This parameter can be one of the
	// following values:
	//
	//    * NONE: Do not encrypt the records in the stream.
	//
	//    * KMS: Use server-side encryption on the records in the stream using a
	//    customer-managed AWS KMS key.
	EncryptionType EncryptionType `type:"string" enum:"true"`

	// Identifies which shard in the stream the data record is assigned to.
	//
	// PartitionKey is a required field
	PartitionKey *string `min:"1" type:"string" required:"true"`

	// The unique identifier of the record within its shard.
	//
	// SequenceNumber is a required field
	SequenceNumber *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The unit of data of the Kinesis data stream, which is composed of a sequence number, a partition key, and a data blob.

func (Record) String 

func (s Record) String() string

String returns the string representation

type RegisterStreamConsumerInput added in v0.5.0 

type RegisterStreamConsumerInput struct {

	// For a given Kinesis data stream, each consumer must have a unique name. However,
	// consumer names don't have to be unique across data streams.
	//
	// ConsumerName is a required field
	ConsumerName *string `min:"1" type:"string" required:"true"`

	// The ARN of the Kinesis data stream that you want to register the consumer
	// with. For more info, see Amazon Resource Names (ARNs) and AWS Service Namespaces
	// (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams).
	//
	// StreamARN is a required field
	StreamARN *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RegisterStreamConsumerInput) String added in v0.5.0 

func (s RegisterStreamConsumerInput) String() string

String returns the string representation

func (*RegisterStreamConsumerInput) Validate added in v0.5.0 

func (s *RegisterStreamConsumerInput) Validate() error

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

type RegisterStreamConsumerOutput added in v0.5.0 

type RegisterStreamConsumerOutput struct {

	// An object that represents the details of the consumer you registered. When
	// you register a consumer, it gets an ARN that is generated by Kinesis Data
	// Streams.
	//
	// Consumer is a required field
	Consumer *Consumer `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (RegisterStreamConsumerOutput) String added in v0.5.0 

func (s RegisterStreamConsumerOutput) String() string

String returns the string representation

type RegisterStreamConsumerRequest added in v0.5.0 

type RegisterStreamConsumerRequest struct {
	*aws.Request
	Input *RegisterStreamConsumerInput
	Copy  func(*RegisterStreamConsumerInput) RegisterStreamConsumerRequest
}

RegisterStreamConsumerRequest is the request type for the RegisterStreamConsumer API operation.

func (RegisterStreamConsumerRequest) Send added in v0.5.0 

func (r RegisterStreamConsumerRequest) Send(ctx context.Context) (*RegisterStreamConsumerResponse, error)

Send marshals and sends the RegisterStreamConsumer API request.

type RegisterStreamConsumerResponse added in v0.9.0 

type RegisterStreamConsumerResponse struct {
	*RegisterStreamConsumerOutput
	// contains filtered or unexported fields
}

RegisterStreamConsumerResponse is the response type for the RegisterStreamConsumer API operation.

func (*RegisterStreamConsumerResponse) SDKResponseMetdata added in v0.9.0 

func (r *RegisterStreamConsumerResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the RegisterStreamConsumer request.

type RemoveTagsFromStreamInput 

type RemoveTagsFromStreamInput struct {

	// The name of the stream.
	//
	// StreamName is a required field
	StreamName *string `min:"1" type:"string" required:"true"`

	// A list of tag keys. Each corresponding tag is removed from the stream.
	//
	// TagKeys is a required field
	TagKeys []string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Represents the input for RemoveTagsFromStream.

func (RemoveTagsFromStreamInput) String 

func (s RemoveTagsFromStreamInput) String() string

String returns the string representation

func (*RemoveTagsFromStreamInput) Validate 

func (s *RemoveTagsFromStreamInput) Validate() error

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

type RemoveTagsFromStreamOutput 

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

func (RemoveTagsFromStreamOutput) String 

func (s RemoveTagsFromStreamOutput) String() string

String returns the string representation

type RemoveTagsFromStreamRequest 

type RemoveTagsFromStreamRequest struct {
	*aws.Request
	Input *RemoveTagsFromStreamInput
	Copy  func(*RemoveTagsFromStreamInput) RemoveTagsFromStreamRequest
}

RemoveTagsFromStreamRequest is the request type for the RemoveTagsFromStream API operation.

func (RemoveTagsFromStreamRequest) Send 

func (r RemoveTagsFromStreamRequest) Send(ctx context.Context) (*RemoveTagsFromStreamResponse, error)

Send marshals and sends the RemoveTagsFromStream API request.

type RemoveTagsFromStreamResponse added in v0.9.0 

type RemoveTagsFromStreamResponse struct {
	*RemoveTagsFromStreamOutput
	// contains filtered or unexported fields
}

RemoveTagsFromStreamResponse is the response type for the RemoveTagsFromStream API operation.

func (*RemoveTagsFromStreamResponse) SDKResponseMetdata added in v0.9.0 

func (r *RemoveTagsFromStreamResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the RemoveTagsFromStream request.

type ScalingType 

type ScalingType string
const (
	ScalingTypeUniformScaling ScalingType = "UNIFORM_SCALING"
)

Enum values for ScalingType

func (ScalingType) MarshalValue added in v0.3.0 

func (enum ScalingType) MarshalValue() (string, error)

func (ScalingType) MarshalValueBuf added in v0.3.0 

func (enum ScalingType) MarshalValueBuf(b []byte) ([]byte, error)

type SequenceNumberRange 

type SequenceNumberRange struct {

	// The ending sequence number for the range. Shards that are in the OPEN state
	// have an ending sequence number of null.
	EndingSequenceNumber *string `type:"string"`

	// The starting sequence number for the range.
	//
	// StartingSequenceNumber is a required field
	StartingSequenceNumber *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The range of possible sequence numbers for the shard.

func (SequenceNumberRange) String 

func (s SequenceNumberRange) String() string

String returns the string representation

type Shard 

type Shard struct {

	// The shard ID of the shard adjacent to the shard's parent.
	AdjacentParentShardId *string `min:"1" type:"string"`

	// The range of possible hash key values for the shard, which is a set of ordered
	// contiguous positive integers.
	//
	// HashKeyRange is a required field
	HashKeyRange *HashKeyRange `type:"structure" required:"true"`

	// The shard ID of the shard's parent.
	ParentShardId *string `min:"1" type:"string"`

	// The range of possible sequence numbers for the shard.
	//
	// SequenceNumberRange is a required field
	SequenceNumberRange *SequenceNumberRange `type:"structure" required:"true"`

	// The unique identifier of the shard within the stream.
	//
	// ShardId is a required field
	ShardId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A uniquely identified group of data records in a Kinesis data stream.

func (Shard) String 

func (s Shard) String() string

String returns the string representation

type ShardIteratorType 

type ShardIteratorType string
const (
	ShardIteratorTypeAtSequenceNumber    ShardIteratorType = "AT_SEQUENCE_NUMBER"
	ShardIteratorTypeAfterSequenceNumber ShardIteratorType = "AFTER_SEQUENCE_NUMBER"
	ShardIteratorTypeTrimHorizon         ShardIteratorType = "TRIM_HORIZON"
	ShardIteratorTypeLatest              ShardIteratorType = "LATEST"
	ShardIteratorTypeAtTimestamp         ShardIteratorType = "AT_TIMESTAMP"
)

Enum values for ShardIteratorType

func (ShardIteratorType) MarshalValue added in v0.3.0 

func (enum ShardIteratorType) MarshalValue() (string, error)

func (ShardIteratorType) MarshalValueBuf added in v0.3.0 

func (enum ShardIteratorType) MarshalValueBuf(b []byte) ([]byte, error)

type SplitShardInput 

type SplitShardInput struct {

	// A hash key value for the starting hash key of one of the child shards created
	// by the split. The hash key range for a given shard constitutes a set of ordered
	// contiguous positive integers. The value for NewStartingHashKey must be in
	// the range of hash keys being mapped into the shard. The NewStartingHashKey
	// hash key value and all higher hash key values in hash key range are distributed
	// to one of the child shards. All the lower hash key values in the range are
	// distributed to the other child shard.
	//
	// NewStartingHashKey is a required field
	NewStartingHashKey *string `type:"string" required:"true"`

	// The shard ID of the shard to split.
	//
	// ShardToSplit is a required field
	ShardToSplit *string `min:"1" type:"string" required:"true"`

	// The name of the stream for the shard split.
	//
	// StreamName is a required field
	StreamName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input for SplitShard.

func (SplitShardInput) String 

func (s SplitShardInput) String() string

String returns the string representation

func (*SplitShardInput) Validate 

func (s *SplitShardInput) Validate() error

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

type SplitShardOutput 

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

func (SplitShardOutput) String 

func (s SplitShardOutput) String() string

String returns the string representation

type SplitShardRequest 

type SplitShardRequest struct {
	*aws.Request
	Input *SplitShardInput
	Copy  func(*SplitShardInput) SplitShardRequest
}

SplitShardRequest is the request type for the SplitShard API operation.

func (SplitShardRequest) Send 

func (r SplitShardRequest) Send(ctx context.Context) (*SplitShardResponse, error)

Send marshals and sends the SplitShard API request.

type SplitShardResponse added in v0.9.0 

type SplitShardResponse struct {
	*SplitShardOutput
	// contains filtered or unexported fields
}

SplitShardResponse is the response type for the SplitShard API operation.

func (*SplitShardResponse) SDKResponseMetdata added in v0.9.0 

func (r *SplitShardResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the SplitShard request.

type StartStreamEncryptionInput 

type StartStreamEncryptionInput struct {

	// The encryption type to use. The only valid value is KMS.
	//
	// EncryptionType is a required field
	EncryptionType EncryptionType `type:"string" required:"true" enum:"true"`

	// The GUID for the customer-managed AWS KMS key to use for encryption. This
	// value can be a globally unique identifier, a fully specified Amazon Resource
	// Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You
	// can also use a master key owned by Kinesis Data Streams by specifying the
	// alias aws/kinesis.
	//
	//    * Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
	//
	//    * Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
	//
	//    * Globally unique key ID example: 12345678-1234-1234-1234-123456789012
	//
	//    * Alias name example: alias/MyAliasName
	//
	//    * Master key owned by Kinesis Data Streams: alias/aws/kinesis
	//
	// KeyId is a required field
	KeyId *string `min:"1" type:"string" required:"true"`

	// The name of the stream for which to start encrypting records.
	//
	// StreamName is a required field
	StreamName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartStreamEncryptionInput) String 

func (s StartStreamEncryptionInput) String() string

String returns the string representation

func (*StartStreamEncryptionInput) Validate 

func (s *StartStreamEncryptionInput) Validate() error

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

type StartStreamEncryptionOutput 

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

func (StartStreamEncryptionOutput) String 

func (s StartStreamEncryptionOutput) String() string

String returns the string representation

type StartStreamEncryptionRequest 

type StartStreamEncryptionRequest struct {
	*aws.Request
	Input *StartStreamEncryptionInput
	Copy  func(*StartStreamEncryptionInput) StartStreamEncryptionRequest
}

StartStreamEncryptionRequest is the request type for the StartStreamEncryption API operation.

func (StartStreamEncryptionRequest) Send 

func (r StartStreamEncryptionRequest) Send(ctx context.Context) (*StartStreamEncryptionResponse, error)

Send marshals and sends the StartStreamEncryption API request.

type StartStreamEncryptionResponse added in v0.9.0 

type StartStreamEncryptionResponse struct {
	*StartStreamEncryptionOutput
	// contains filtered or unexported fields
}

StartStreamEncryptionResponse is the response type for the StartStreamEncryption API operation.

func (*StartStreamEncryptionResponse) SDKResponseMetdata added in v0.9.0 

func (r *StartStreamEncryptionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StartStreamEncryption request.

type StopStreamEncryptionInput 

type StopStreamEncryptionInput struct {

	// The encryption type. The only valid value is KMS.
	//
	// EncryptionType is a required field
	EncryptionType EncryptionType `type:"string" required:"true" enum:"true"`

	// The GUID for the customer-managed AWS KMS key to use for encryption. This
	// value can be a globally unique identifier, a fully specified Amazon Resource
	// Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You
	// can also use a master key owned by Kinesis Data Streams by specifying the
	// alias aws/kinesis.
	//
	//    * Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
	//
	//    * Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
	//
	//    * Globally unique key ID example: 12345678-1234-1234-1234-123456789012
	//
	//    * Alias name example: alias/MyAliasName
	//
	//    * Master key owned by Kinesis Data Streams: alias/aws/kinesis
	//
	// KeyId is a required field
	KeyId *string `min:"1" type:"string" required:"true"`

	// The name of the stream on which to stop encrypting records.
	//
	// StreamName is a required field
	StreamName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopStreamEncryptionInput) String 

func (s StopStreamEncryptionInput) String() string

String returns the string representation

func (*StopStreamEncryptionInput) Validate 

func (s *StopStreamEncryptionInput) Validate() error

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

type StopStreamEncryptionOutput 

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

func (StopStreamEncryptionOutput) String 

func (s StopStreamEncryptionOutput) String() string

String returns the string representation

type StopStreamEncryptionRequest 

type StopStreamEncryptionRequest struct {
	*aws.Request
	Input *StopStreamEncryptionInput
	Copy  func(*StopStreamEncryptionInput) StopStreamEncryptionRequest
}

StopStreamEncryptionRequest is the request type for the StopStreamEncryption API operation.

func (StopStreamEncryptionRequest) Send 

func (r StopStreamEncryptionRequest) Send(ctx context.Context) (*StopStreamEncryptionResponse, error)

Send marshals and sends the StopStreamEncryption API request.

type StopStreamEncryptionResponse added in v0.9.0 

type StopStreamEncryptionResponse struct {
	*StopStreamEncryptionOutput
	// contains filtered or unexported fields
}

StopStreamEncryptionResponse is the response type for the StopStreamEncryption API operation.

func (*StopStreamEncryptionResponse) SDKResponseMetdata added in v0.9.0 

func (r *StopStreamEncryptionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StopStreamEncryption request.

type StreamDescription 

type StreamDescription struct {

	// The server-side encryption type used on the stream. This parameter can be
	// one of the following values:
	//
	//    * NONE: Do not encrypt the records in the stream.
	//
	//    * KMS: Use server-side encryption on the records in the stream using a
	//    customer-managed AWS KMS key.
	EncryptionType EncryptionType `type:"string" enum:"true"`

	// Represents the current enhanced monitoring settings of the stream.
	//
	// EnhancedMonitoring is a required field
	EnhancedMonitoring []EnhancedMetrics `type:"list" required:"true"`

	// If set to true, more shards in the stream are available to describe.
	//
	// HasMoreShards is a required field
	HasMoreShards *bool `type:"boolean" required:"true"`

	// The GUID for the customer-managed AWS KMS key to use for encryption. This
	// value can be a globally unique identifier, a fully specified ARN to either
	// an alias or a key, or an alias name prefixed by "alias/".You can also use
	// a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.
	//
	//    * Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
	//
	//    * Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
	//
	//    * Globally unique key ID example: 12345678-1234-1234-1234-123456789012
	//
	//    * Alias name example: alias/MyAliasName
	//
	//    * Master key owned by Kinesis Data Streams: alias/aws/kinesis
	KeyId *string `min:"1" type:"string"`

	// The current retention period, in hours.
	//
	// RetentionPeriodHours is a required field
	RetentionPeriodHours *int64 `min:"1" type:"integer" required:"true"`

	// The shards that comprise the stream.
	//
	// Shards is a required field
	Shards []Shard `type:"list" required:"true"`

	// The Amazon Resource Name (ARN) for the stream being described.
	//
	// StreamARN is a required field
	StreamARN *string `min:"1" type:"string" required:"true"`

	// The approximate time that the stream was created.
	//
	// StreamCreationTimestamp is a required field
	StreamCreationTimestamp *time.Time `type:"timestamp" required:"true"`

	// The name of the stream being described.
	//
	// StreamName is a required field
	StreamName *string `min:"1" type:"string" required:"true"`

	// The current status of the stream being described. The stream status is one
	// of the following states:
	//
	//    * CREATING - The stream is being created. Kinesis Data Streams immediately
	//    returns and sets StreamStatus to CREATING.
	//
	//    * DELETING - The stream is being deleted. The specified stream is in the
	//    DELETING state until Kinesis Data Streams completes the deletion.
	//
	//    * ACTIVE - The stream exists and is ready for read and write operations
	//    or deletion. You should perform read and write operations only on an ACTIVE
	//    stream.
	//
	//    * UPDATING - Shards in the stream are being merged or split. Read and
	//    write operations continue to work while the stream is in the UPDATING
	//    state.
	//
	// StreamStatus is a required field
	StreamStatus StreamStatus `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

Represents the output for DescribeStream.

func (StreamDescription) String 

func (s StreamDescription) String() string

String returns the string representation

type StreamDescriptionSummary added in v0.2.0 

type StreamDescriptionSummary struct {

	// The number of enhanced fan-out consumers registered with the stream.
	ConsumerCount *int64 `type:"integer"`

	// The encryption type used. This value is one of the following:
	//
	//    * KMS
	//
	//    * NONE
	EncryptionType EncryptionType `type:"string" enum:"true"`

	// Represents the current enhanced monitoring settings of the stream.
	//
	// EnhancedMonitoring is a required field
	EnhancedMonitoring []EnhancedMetrics `type:"list" required:"true"`

	// The GUID for the customer-managed AWS KMS key to use for encryption. This
	// value can be a globally unique identifier, a fully specified ARN to either
	// an alias or a key, or an alias name prefixed by "alias/".You can also use
	// a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.
	//
	//    * Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
	//
	//    * Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
	//
	//    * Globally unique key ID example: 12345678-1234-1234-1234-123456789012
	//
	//    * Alias name example: alias/MyAliasName
	//
	//    * Master key owned by Kinesis Data Streams: alias/aws/kinesis
	KeyId *string `min:"1" type:"string"`

	// The number of open shards in the stream.
	//
	// OpenShardCount is a required field
	OpenShardCount *int64 `type:"integer" required:"true"`

	// The current retention period, in hours.
	//
	// RetentionPeriodHours is a required field
	RetentionPeriodHours *int64 `min:"1" type:"integer" required:"true"`

	// The Amazon Resource Name (ARN) for the stream being described.
	//
	// StreamARN is a required field
	StreamARN *string `min:"1" type:"string" required:"true"`

	// The approximate time that the stream was created.
	//
	// StreamCreationTimestamp is a required field
	StreamCreationTimestamp *time.Time `type:"timestamp" required:"true"`

	// The name of the stream being described.
	//
	// StreamName is a required field
	StreamName *string `min:"1" type:"string" required:"true"`

	// The current status of the stream being described. The stream status is one
	// of the following states:
	//
	//    * CREATING - The stream is being created. Kinesis Data Streams immediately
	//    returns and sets StreamStatus to CREATING.
	//
	//    * DELETING - The stream is being deleted. The specified stream is in the
	//    DELETING state until Kinesis Data Streams completes the deletion.
	//
	//    * ACTIVE - The stream exists and is ready for read and write operations
	//    or deletion. You should perform read and write operations only on an ACTIVE
	//    stream.
	//
	//    * UPDATING - Shards in the stream are being merged or split. Read and
	//    write operations continue to work while the stream is in the UPDATING
	//    state.
	//
	// StreamStatus is a required field
	StreamStatus StreamStatus `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

Represents the output for DescribeStreamSummary

func (StreamDescriptionSummary) String added in v0.2.0 

func (s StreamDescriptionSummary) String() string

String returns the string representation

type StreamStatus 

type StreamStatus string
const (
	StreamStatusCreating StreamStatus = "CREATING"
	StreamStatusDeleting StreamStatus = "DELETING"
	StreamStatusActive   StreamStatus = "ACTIVE"
	StreamStatusUpdating StreamStatus = "UPDATING"
)

Enum values for StreamStatus

func (StreamStatus) MarshalValue added in v0.3.0 

func (enum StreamStatus) MarshalValue() (string, error)

func (StreamStatus) MarshalValueBuf added in v0.3.0 

func (enum StreamStatus) MarshalValueBuf(b []byte) ([]byte, error)

type Tag 

type Tag struct {

	// A unique identifier for the tag. Maximum length: 128 characters. Valid characters:
	// Unicode letters, digits, white space, _ . / = + - % @
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// An optional string, typically used to describe or define the tag. Maximum
	// length: 256 characters. Valid characters: Unicode letters, digits, white
	// space, _ . / = + - % @
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

Metadata assigned to the stream, consisting of a key-value pair.

func (Tag) String 

func (s Tag) String() string

String returns the string representation

type UpdateShardCountInput 

type UpdateShardCountInput struct {

	// The scaling type. Uniform scaling creates shards of equal size.
	//
	// ScalingType is a required field
	ScalingType ScalingType `type:"string" required:"true" enum:"true"`

	// The name of the stream.
	//
	// StreamName is a required field
	StreamName *string `min:"1" type:"string" required:"true"`

	// The new number of shards.
	//
	// TargetShardCount is a required field
	TargetShardCount *int64 `min:"1" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateShardCountInput) String 

func (s UpdateShardCountInput) String() string

String returns the string representation

func (*UpdateShardCountInput) Validate 

func (s *UpdateShardCountInput) Validate() error

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

type UpdateShardCountOutput 

type UpdateShardCountOutput struct {

	// The current number of shards.
	CurrentShardCount *int64 `min:"1" type:"integer"`

	// The name of the stream.
	StreamName *string `min:"1" type:"string"`

	// The updated number of shards.
	TargetShardCount *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

func (UpdateShardCountOutput) String 

func (s UpdateShardCountOutput) String() string

String returns the string representation

type UpdateShardCountRequest 

type UpdateShardCountRequest struct {
	*aws.Request
	Input *UpdateShardCountInput
	Copy  func(*UpdateShardCountInput) UpdateShardCountRequest
}

UpdateShardCountRequest is the request type for the UpdateShardCount API operation.

func (UpdateShardCountRequest) Send 

func (r UpdateShardCountRequest) Send(ctx context.Context) (*UpdateShardCountResponse, error)

Send marshals and sends the UpdateShardCount API request.

type UpdateShardCountResponse added in v0.9.0 

type UpdateShardCountResponse struct {
	*UpdateShardCountOutput
	// contains filtered or unexported fields
}

UpdateShardCountResponse is the response type for the UpdateShardCount API operation.

func (*UpdateShardCountResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateShardCountResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateShardCount request.

Source Files

View all Source files

Directories

Path Synopsis
internal
testing Module
Package kinesisiface provides an interface to enable mocking the Amazon Kinesis service client for testing your code.
 Package kinesisiface provides an interface to enable mocking the Amazon Kinesis service client for testing your code.

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.