kinesis

package
v1.43.14 Latest Latest
Warning

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

 Go to latest Published: Mar 8, 2022 License: Apache-2.0 Imports: 17 Imported by: 1,006

Documentation

Overview

Package kinesis provides the client and types for making API requests to Amazon 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 contact Amazon 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 Amazon Kinesis client Kinesis 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 (
	// ConsumerStatusCreating is a ConsumerStatus enum value
	ConsumerStatusCreating = "CREATING"

	// ConsumerStatusDeleting is a ConsumerStatus enum value
	ConsumerStatusDeleting = "DELETING"

	// ConsumerStatusActive is a ConsumerStatus enum value
	ConsumerStatusActive = "ACTIVE"
)
View Source 
const (
	// EncryptionTypeNone is a EncryptionType enum value
	EncryptionTypeNone = "NONE"

	// EncryptionTypeKms is a EncryptionType enum value
	EncryptionTypeKms = "KMS"
)
View Source 
const (
	// MetricsNameIncomingBytes is a MetricsName enum value
	MetricsNameIncomingBytes = "IncomingBytes"

	// MetricsNameIncomingRecords is a MetricsName enum value
	MetricsNameIncomingRecords = "IncomingRecords"

	// MetricsNameOutgoingBytes is a MetricsName enum value
	MetricsNameOutgoingBytes = "OutgoingBytes"

	// MetricsNameOutgoingRecords is a MetricsName enum value
	MetricsNameOutgoingRecords = "OutgoingRecords"

	// MetricsNameWriteProvisionedThroughputExceeded is a MetricsName enum value
	MetricsNameWriteProvisionedThroughputExceeded = "WriteProvisionedThroughputExceeded"

	// MetricsNameReadProvisionedThroughputExceeded is a MetricsName enum value
	MetricsNameReadProvisionedThroughputExceeded = "ReadProvisionedThroughputExceeded"

	// MetricsNameIteratorAgeMilliseconds is a MetricsName enum value
	MetricsNameIteratorAgeMilliseconds = "IteratorAgeMilliseconds"

	// MetricsNameAll is a MetricsName enum value
	MetricsNameAll = "ALL"
)
View Source 
const (
	// ShardFilterTypeAfterShardId is a ShardFilterType enum value
	ShardFilterTypeAfterShardId = "AFTER_SHARD_ID"

	// ShardFilterTypeAtTrimHorizon is a ShardFilterType enum value
	ShardFilterTypeAtTrimHorizon = "AT_TRIM_HORIZON"

	// ShardFilterTypeFromTrimHorizon is a ShardFilterType enum value
	ShardFilterTypeFromTrimHorizon = "FROM_TRIM_HORIZON"

	// ShardFilterTypeAtLatest is a ShardFilterType enum value
	ShardFilterTypeAtLatest = "AT_LATEST"

	// ShardFilterTypeAtTimestamp is a ShardFilterType enum value
	ShardFilterTypeAtTimestamp = "AT_TIMESTAMP"

	// ShardFilterTypeFromTimestamp is a ShardFilterType enum value
	ShardFilterTypeFromTimestamp = "FROM_TIMESTAMP"
)
View Source 
const (
	// ShardIteratorTypeAtSequenceNumber is a ShardIteratorType enum value
	ShardIteratorTypeAtSequenceNumber = "AT_SEQUENCE_NUMBER"

	// ShardIteratorTypeAfterSequenceNumber is a ShardIteratorType enum value
	ShardIteratorTypeAfterSequenceNumber = "AFTER_SEQUENCE_NUMBER"

	// ShardIteratorTypeTrimHorizon is a ShardIteratorType enum value
	ShardIteratorTypeTrimHorizon = "TRIM_HORIZON"

	// ShardIteratorTypeLatest is a ShardIteratorType enum value
	ShardIteratorTypeLatest = "LATEST"

	// ShardIteratorTypeAtTimestamp is a ShardIteratorType enum value
	ShardIteratorTypeAtTimestamp = "AT_TIMESTAMP"
)
View Source 
const (
	// StreamModeProvisioned is a StreamMode enum value
	StreamModeProvisioned = "PROVISIONED"

	// StreamModeOnDemand is a StreamMode enum value
	StreamModeOnDemand = "ON_DEMAND"
)
View Source 
const (
	// StreamStatusCreating is a StreamStatus enum value
	StreamStatusCreating = "CREATING"

	// StreamStatusDeleting is a StreamStatus enum value
	StreamStatusDeleting = "DELETING"

	// StreamStatusActive is a StreamStatus enum value
	StreamStatusActive = "ACTIVE"

	// StreamStatusUpdating is a StreamStatus enum value
	StreamStatusUpdating = "UPDATING"
)
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"

	// ErrCodeInternalFailureException for service response error code
	// "InternalFailureException".
	//
	// The processing of the request failed because of an unknown error, exception,
	// or failure.
	ErrCodeInternalFailureException = "InternalFailureException"

	// 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 (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
	// in the Amazon Web Services 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 Amazon Web Services 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 (https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second)
	// in the Amazon Web Services 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 (https://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 Amazon Web Services (https://docs.aws.amazon.com/general/latest/gr/api-retries.html)
	// in the Amazon Web Services 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"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "kinesis"   // Name of service.
	EndpointsID = ServiceName // ID to lookup a service endpoint with.
	ServiceID   = "Kinesis"   // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// ScalingTypeUniformScaling is a ScalingType enum value
	ScalingTypeUniformScaling = "UNIFORM_SCALING"
)

Variables

This section is empty.

Functions

func ConsumerStatus_Values added in v1.34.3 

func ConsumerStatus_Values() []string

ConsumerStatus_Values returns all elements of the ConsumerStatus enum

func EncryptionType_Values added in v1.34.3 

func EncryptionType_Values() []string

EncryptionType_Values returns all elements of the EncryptionType enum

func MetricsName_Values added in v1.34.3 

func MetricsName_Values() []string

MetricsName_Values returns all elements of the MetricsName enum

func ScalingType_Values added in v1.34.3 

func ScalingType_Values() []string

ScalingType_Values returns all elements of the ScalingType enum

func ShardFilterType_Values added in v1.34.6 

func ShardFilterType_Values() []string

ShardFilterType_Values returns all elements of the ShardFilterType enum

func ShardIteratorType_Values added in v1.34.3 

func ShardIteratorType_Values() []string

ShardIteratorType_Values returns all elements of the ShardIteratorType enum

func StreamMode_Values added in v1.42.16 

func StreamMode_Values() []string

StreamMode_Values returns all elements of the StreamMode enum

func StreamStatus_Values added in v1.34.3 

func StreamStatus_Values() []string

StreamStatus_Values returns all elements of the StreamStatus enum

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) GoString added in v0.6.5 

func (s AddTagsToStreamInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddTagsToStreamInput) SetStreamName added in v1.5.0 

func (s *AddTagsToStreamInput) SetStreamName(v string) *AddTagsToStreamInput

SetStreamName sets the StreamName field's value.

func (*AddTagsToStreamInput) SetTags added in v1.5.0 

func (s *AddTagsToStreamInput) SetTags(v map[string]*string) *AddTagsToStreamInput

SetTags sets the Tags field's value.

func (AddTagsToStreamInput) String added in v0.6.5 

func (s AddTagsToStreamInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddTagsToStreamInput) Validate added in v1.1.21 

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) GoString added in v0.6.5 

func (s AddTagsToStreamOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AddTagsToStreamOutput) String added in v0.6.5 

func (s AddTagsToStreamOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ChildShard added in v1.34.6 

type ChildShard struct {

	// 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 current shard that is the parent of the existing child shard.
	//
	// ParentShards is a required field
	ParentShards []*string `type:"list" required:"true"`

	// The shard ID of the existing child shard of the current shard.
	//
	// ShardId is a required field
	ShardId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Output parameter of the GetRecords API. The existing child shard of the current shard.

func (ChildShard) GoString added in v1.34.6 

func (s ChildShard) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ChildShard) SetHashKeyRange added in v1.34.6 

func (s *ChildShard) SetHashKeyRange(v *HashKeyRange) *ChildShard

SetHashKeyRange sets the HashKeyRange field's value.

func (*ChildShard) SetParentShards added in v1.34.6 

func (s *ChildShard) SetParentShards(v []*string) *ChildShard

SetParentShards sets the ParentShards field's value.

func (*ChildShard) SetShardId added in v1.34.6 

func (s *ChildShard) SetShardId(v string) *ChildShard

SetShardId sets the ShardId field's value.

func (ChildShard) String added in v1.34.6 

func (s ChildShard) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Consumer added in v1.15.4 

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 *string `type:"string" required:"true" enum:"ConsumerStatus"`
	// contains filtered or unexported fields
}

An object that represents the details of the consumer you registered. This type of object is returned by RegisterStreamConsumer.

func (Consumer) GoString added in v1.15.4 

func (s Consumer) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Consumer) SetConsumerARN added in v1.15.4 

func (s *Consumer) SetConsumerARN(v string) *Consumer

SetConsumerARN sets the ConsumerARN field's value.

func (*Consumer) SetConsumerCreationTimestamp added in v1.15.4 

func (s *Consumer) SetConsumerCreationTimestamp(v time.Time) *Consumer

SetConsumerCreationTimestamp sets the ConsumerCreationTimestamp field's value.

func (*Consumer) SetConsumerName added in v1.15.4 

func (s *Consumer) SetConsumerName(v string) *Consumer

SetConsumerName sets the ConsumerName field's value.

func (*Consumer) SetConsumerStatus added in v1.15.4 

func (s *Consumer) SetConsumerStatus(v string) *Consumer

SetConsumerStatus sets the ConsumerStatus field's value.

func (Consumer) String added in v1.15.4 

func (s Consumer) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConsumerDescription added in v1.15.4 

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 *string `type:"string" required:"true" enum:"ConsumerStatus"`

	// 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. This type of object is returned by DescribeStreamConsumer.

func (ConsumerDescription) GoString added in v1.15.4 

func (s ConsumerDescription) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConsumerDescription) SetConsumerARN added in v1.15.4 

func (s *ConsumerDescription) SetConsumerARN(v string) *ConsumerDescription

SetConsumerARN sets the ConsumerARN field's value.

func (*ConsumerDescription) SetConsumerCreationTimestamp added in v1.15.4 

func (s *ConsumerDescription) SetConsumerCreationTimestamp(v time.Time) *ConsumerDescription

SetConsumerCreationTimestamp sets the ConsumerCreationTimestamp field's value.

func (*ConsumerDescription) SetConsumerName added in v1.15.4 

func (s *ConsumerDescription) SetConsumerName(v string) *ConsumerDescription

SetConsumerName sets the ConsumerName field's value.

func (*ConsumerDescription) SetConsumerStatus added in v1.15.4 

func (s *ConsumerDescription) SetConsumerStatus(v string) *ConsumerDescription

SetConsumerStatus sets the ConsumerStatus field's value.

func (*ConsumerDescription) SetStreamARN added in v1.15.4 

func (s *ConsumerDescription) SetStreamARN(v string) *ConsumerDescription

SetStreamARN sets the StreamARN field's value.

func (ConsumerDescription) String added in v1.15.4 

func (s ConsumerDescription) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.
	ShardCount *int64 `min:"1" type:"integer"`

	// Indicates the capacity mode of the data stream. Currently, in Kinesis Data
	// Streams, you can choose between an on-demand capacity mode and a provisioned
	// capacity mode for your data streams.
	StreamModeDetails *StreamModeDetails `type:"structure"`

	// A name to identify the stream. The stream name is scoped to the Amazon Web
	// Services account used by the application that creates the stream. It is also
	// scoped by Amazon Web Services Region. That is, two streams in two different
	// Amazon Web Services accounts can have the same name. Two streams in the same
	// Amazon Web Services 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) GoString added in v0.6.5 

func (s CreateStreamInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateStreamInput) SetShardCount added in v1.5.0 

func (s *CreateStreamInput) SetShardCount(v int64) *CreateStreamInput

SetShardCount sets the ShardCount field's value.

func (*CreateStreamInput) SetStreamModeDetails added in v1.42.16 

func (s *CreateStreamInput) SetStreamModeDetails(v *StreamModeDetails) *CreateStreamInput

SetStreamModeDetails sets the StreamModeDetails field's value.

func (*CreateStreamInput) SetStreamName added in v1.5.0 

func (s *CreateStreamInput) SetStreamName(v string) *CreateStreamInput

SetStreamName sets the StreamName field's value.

func (CreateStreamInput) String added in v0.6.5 

func (s CreateStreamInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateStreamInput) Validate added in v1.1.21 

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) GoString added in v0.6.5 

func (s CreateStreamOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (CreateStreamOutput) String added in v0.6.5 

func (s CreateStreamOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DecreaseStreamRetentionPeriodInput added in v0.9.13 

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 `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) GoString added in v0.9.13 

func (s DecreaseStreamRetentionPeriodInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DecreaseStreamRetentionPeriodInput) SetRetentionPeriodHours added in v1.5.0 

func (s *DecreaseStreamRetentionPeriodInput) SetRetentionPeriodHours(v int64) *DecreaseStreamRetentionPeriodInput

SetRetentionPeriodHours sets the RetentionPeriodHours field's value.

func (*DecreaseStreamRetentionPeriodInput) SetStreamName added in v1.5.0 

func (s *DecreaseStreamRetentionPeriodInput) SetStreamName(v string) *DecreaseStreamRetentionPeriodInput

SetStreamName sets the StreamName field's value.

func (DecreaseStreamRetentionPeriodInput) String added in v0.9.13 

func (s DecreaseStreamRetentionPeriodInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DecreaseStreamRetentionPeriodInput) Validate added in v1.1.21 

func (s *DecreaseStreamRetentionPeriodInput) Validate() error

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

type DecreaseStreamRetentionPeriodOutput added in v0.9.13 

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

func (DecreaseStreamRetentionPeriodOutput) GoString added in v0.9.13 

func (s DecreaseStreamRetentionPeriodOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DecreaseStreamRetentionPeriodOutput) String added in v0.9.13 

func (s DecreaseStreamRetentionPeriodOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString added in v0.6.5 

func (s DeleteStreamInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteStreamInput) SetEnforceConsumerDeletion added in v1.15.4 

func (s *DeleteStreamInput) SetEnforceConsumerDeletion(v bool) *DeleteStreamInput

SetEnforceConsumerDeletion sets the EnforceConsumerDeletion field's value.

func (*DeleteStreamInput) SetStreamName added in v1.5.0 

func (s *DeleteStreamInput) SetStreamName(v string) *DeleteStreamInput

SetStreamName sets the StreamName field's value.

func (DeleteStreamInput) String added in v0.6.5 

func (s DeleteStreamInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteStreamInput) Validate added in v1.1.21 

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) GoString added in v0.6.5 

func (s DeleteStreamOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteStreamOutput) String added in v0.6.5 

func (s DeleteStreamOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeregisterStreamConsumerInput added in v1.15.4 

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 Amazon Web Services
	// 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) GoString added in v1.15.4 

func (s DeregisterStreamConsumerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeregisterStreamConsumerInput) SetConsumerARN added in v1.15.4 

func (s *DeregisterStreamConsumerInput) SetConsumerARN(v string) *DeregisterStreamConsumerInput

SetConsumerARN sets the ConsumerARN field's value.

func (*DeregisterStreamConsumerInput) SetConsumerName added in v1.15.4 

func (s *DeregisterStreamConsumerInput) SetConsumerName(v string) *DeregisterStreamConsumerInput

SetConsumerName sets the ConsumerName field's value.

func (*DeregisterStreamConsumerInput) SetStreamARN added in v1.15.4 

func (s *DeregisterStreamConsumerInput) SetStreamARN(v string) *DeregisterStreamConsumerInput

SetStreamARN sets the StreamARN field's value.

func (DeregisterStreamConsumerInput) String added in v1.15.4 

func (s DeregisterStreamConsumerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeregisterStreamConsumerInput) Validate added in v1.15.4 

func (s *DeregisterStreamConsumerInput) Validate() error

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

type DeregisterStreamConsumerOutput added in v1.15.4 

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

func (DeregisterStreamConsumerOutput) GoString added in v1.15.4 

func (s DeregisterStreamConsumerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeregisterStreamConsumerOutput) String added in v1.15.4 

func (s DeregisterStreamConsumerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeLimitsInput added in v1.5.5 

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

func (DescribeLimitsInput) GoString added in v1.5.5 

func (s DescribeLimitsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DescribeLimitsInput) String added in v1.5.5 

func (s DescribeLimitsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeLimitsOutput added in v1.5.5 

type DescribeLimitsOutput struct {

	// Indicates the number of data streams with the on-demand capacity mode.
	//
	// OnDemandStreamCount is a required field
	OnDemandStreamCount *int64 `type:"integer" required:"true"`

	// The maximum number of data streams with the on-demand capacity mode.
	//
	// OnDemandStreamCountLimit is a required field
	OnDemandStreamCountLimit *int64 `type:"integer" required:"true"`

	// 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) GoString added in v1.5.5 

func (s DescribeLimitsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLimitsOutput) SetOnDemandStreamCount added in v1.42.16 

func (s *DescribeLimitsOutput) SetOnDemandStreamCount(v int64) *DescribeLimitsOutput

SetOnDemandStreamCount sets the OnDemandStreamCount field's value.

func (*DescribeLimitsOutput) SetOnDemandStreamCountLimit added in v1.42.16 

func (s *DescribeLimitsOutput) SetOnDemandStreamCountLimit(v int64) *DescribeLimitsOutput

SetOnDemandStreamCountLimit sets the OnDemandStreamCountLimit field's value.

func (*DescribeLimitsOutput) SetOpenShardCount added in v1.5.5 

func (s *DescribeLimitsOutput) SetOpenShardCount(v int64) *DescribeLimitsOutput

SetOpenShardCount sets the OpenShardCount field's value.

func (*DescribeLimitsOutput) SetShardLimit added in v1.5.5 

func (s *DescribeLimitsOutput) SetShardLimit(v int64) *DescribeLimitsOutput

SetShardLimit sets the ShardLimit field's value.

func (DescribeLimitsOutput) String added in v1.5.5 

func (s DescribeLimitsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeStreamConsumerInput added in v1.15.4 

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 Amazon Web Services
	// 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) GoString added in v1.15.4 

func (s DescribeStreamConsumerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStreamConsumerInput) SetConsumerARN added in v1.15.4 

func (s *DescribeStreamConsumerInput) SetConsumerARN(v string) *DescribeStreamConsumerInput

SetConsumerARN sets the ConsumerARN field's value.

func (*DescribeStreamConsumerInput) SetConsumerName added in v1.15.4 

func (s *DescribeStreamConsumerInput) SetConsumerName(v string) *DescribeStreamConsumerInput

SetConsumerName sets the ConsumerName field's value.

func (*DescribeStreamConsumerInput) SetStreamARN added in v1.15.4 

func (s *DescribeStreamConsumerInput) SetStreamARN(v string) *DescribeStreamConsumerInput

SetStreamARN sets the StreamARN field's value.

func (DescribeStreamConsumerInput) String added in v1.15.4 

func (s DescribeStreamConsumerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStreamConsumerInput) Validate added in v1.15.4 

func (s *DescribeStreamConsumerInput) Validate() error

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

type DescribeStreamConsumerOutput added in v1.15.4 

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) GoString added in v1.15.4 

func (s DescribeStreamConsumerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStreamConsumerOutput) SetConsumerDescription added in v1.15.4 

func (s *DescribeStreamConsumerOutput) SetConsumerDescription(v *ConsumerDescription) *DescribeStreamConsumerOutput

SetConsumerDescription sets the ConsumerDescription field's value.

func (DescribeStreamConsumerOutput) String added in v1.15.4 

func (s DescribeStreamConsumerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeStreamInput 

type DescribeStreamInput struct {

	// The shard ID of the shard to start with.
	//
	// Specify this parameter to indicate that you want to describe the stream starting
	// with the shard whose ID immediately follows ExclusiveStartShardId.
	//
	// If you don't specify this parameter, the default behavior for DescribeStream
	// is to describe the stream starting with the first shard in the stream.
	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 results 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) GoString added in v0.6.5 

func (s DescribeStreamInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStreamInput) SetExclusiveStartShardId added in v1.5.0 

func (s *DescribeStreamInput) SetExclusiveStartShardId(v string) *DescribeStreamInput

SetExclusiveStartShardId sets the ExclusiveStartShardId field's value.

func (*DescribeStreamInput) SetLimit added in v1.5.0 

func (s *DescribeStreamInput) SetLimit(v int64) *DescribeStreamInput

SetLimit sets the Limit field's value.

func (*DescribeStreamInput) SetStreamName added in v1.5.0 

func (s *DescribeStreamInput) SetStreamName(v string) *DescribeStreamInput

SetStreamName sets the StreamName field's value.

func (DescribeStreamInput) String added in v0.6.5 

func (s DescribeStreamInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStreamInput) Validate added in v1.1.21 

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) GoString added in v0.6.5 

func (s DescribeStreamOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStreamOutput) SetStreamDescription added in v1.5.0 

func (s *DescribeStreamOutput) SetStreamDescription(v *StreamDescription) *DescribeStreamOutput

SetStreamDescription sets the StreamDescription field's value.

func (DescribeStreamOutput) String added in v0.6.5 

func (s DescribeStreamOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeStreamSummaryInput added in v1.12.31 

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) GoString added in v1.12.31 

func (s DescribeStreamSummaryInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStreamSummaryInput) SetStreamName added in v1.12.31 

func (s *DescribeStreamSummaryInput) SetStreamName(v string) *DescribeStreamSummaryInput

SetStreamName sets the StreamName field's value.

func (DescribeStreamSummaryInput) String added in v1.12.31 

func (s DescribeStreamSummaryInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStreamSummaryInput) Validate added in v1.12.31 

func (s *DescribeStreamSummaryInput) Validate() error

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

type DescribeStreamSummaryOutput added in v1.12.31 

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) GoString added in v1.12.31 

func (s DescribeStreamSummaryOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStreamSummaryOutput) SetStreamDescriptionSummary added in v1.12.31 

func (s *DescribeStreamSummaryOutput) SetStreamDescriptionSummary(v *StreamDescriptionSummary) *DescribeStreamSummaryOutput

SetStreamDescriptionSummary sets the StreamDescriptionSummary field's value.

func (DescribeStreamSummaryOutput) String added in v1.12.31 

func (s DescribeStreamSummaryOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisableEnhancedMonitoringInput added in v1.1.19 

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 (https://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 []*string `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) GoString added in v1.1.19 

func (s DisableEnhancedMonitoringInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisableEnhancedMonitoringInput) SetShardLevelMetrics added in v1.5.0 

func (s *DisableEnhancedMonitoringInput) SetShardLevelMetrics(v []*string) *DisableEnhancedMonitoringInput

SetShardLevelMetrics sets the ShardLevelMetrics field's value.

func (*DisableEnhancedMonitoringInput) SetStreamName added in v1.5.0 

func (s *DisableEnhancedMonitoringInput) SetStreamName(v string) *DisableEnhancedMonitoringInput

SetStreamName sets the StreamName field's value.

func (DisableEnhancedMonitoringInput) String added in v1.1.19 

func (s DisableEnhancedMonitoringInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisableEnhancedMonitoringInput) Validate added in v1.1.21 

func (s *DisableEnhancedMonitoringInput) Validate() error

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

type EnableEnhancedMonitoringInput added in v1.1.19 

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 (https://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 []*string `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) GoString added in v1.1.19 

func (s EnableEnhancedMonitoringInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EnableEnhancedMonitoringInput) SetShardLevelMetrics added in v1.5.0 

func (s *EnableEnhancedMonitoringInput) SetShardLevelMetrics(v []*string) *EnableEnhancedMonitoringInput

SetShardLevelMetrics sets the ShardLevelMetrics field's value.

func (*EnableEnhancedMonitoringInput) SetStreamName added in v1.5.0 

func (s *EnableEnhancedMonitoringInput) SetStreamName(v string) *EnableEnhancedMonitoringInput

SetStreamName sets the StreamName field's value.

func (EnableEnhancedMonitoringInput) String added in v1.1.19 

func (s EnableEnhancedMonitoringInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EnableEnhancedMonitoringInput) Validate added in v1.1.21 

func (s *EnableEnhancedMonitoringInput) Validate() error

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

type EnhancedMetrics added in v1.1.19 

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 (https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html)
	// in the Amazon Kinesis Data Streams Developer Guide.
	ShardLevelMetrics []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

Represents enhanced metrics types.

func (EnhancedMetrics) GoString added in v1.1.19 

func (s EnhancedMetrics) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EnhancedMetrics) SetShardLevelMetrics added in v1.5.0 

func (s *EnhancedMetrics) SetShardLevelMetrics(v []*string) *EnhancedMetrics

SetShardLevelMetrics sets the ShardLevelMetrics field's value.

func (EnhancedMetrics) String added in v1.1.19 

func (s EnhancedMetrics) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EnhancedMonitoringOutput added in v1.1.19 

type EnhancedMonitoringOutput struct {

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

	// Represents the list of all the metrics that would be in the enhanced state
	// after the operation.
	DesiredShardLevelMetrics []*string `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 (EnhancedMonitoringOutput) GoString added in v1.1.19 

func (s EnhancedMonitoringOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EnhancedMonitoringOutput) SetCurrentShardLevelMetrics added in v1.5.0 

func (s *EnhancedMonitoringOutput) SetCurrentShardLevelMetrics(v []*string) *EnhancedMonitoringOutput

SetCurrentShardLevelMetrics sets the CurrentShardLevelMetrics field's value.

func (*EnhancedMonitoringOutput) SetDesiredShardLevelMetrics added in v1.5.0 

func (s *EnhancedMonitoringOutput) SetDesiredShardLevelMetrics(v []*string) *EnhancedMonitoringOutput

SetDesiredShardLevelMetrics sets the DesiredShardLevelMetrics field's value.

func (*EnhancedMonitoringOutput) SetStreamName added in v1.5.0 

func (s *EnhancedMonitoringOutput) SetStreamName(v string) *EnhancedMonitoringOutput

SetStreamName sets the StreamName field's value.

func (EnhancedMonitoringOutput) String added in v1.1.19 

func (s EnhancedMonitoringOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExpiredIteratorException added in v1.28.0 

type ExpiredIteratorException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A message that provides information about the error.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The provided iterator exceeds the maximum age allowed.

func (*ExpiredIteratorException) Code added in v1.28.0 

func (s *ExpiredIteratorException) Code() string

Code returns the exception type name.

func (*ExpiredIteratorException) Error added in v1.28.0 

func (s *ExpiredIteratorException) Error() string

func (ExpiredIteratorException) GoString added in v1.28.0 

func (s ExpiredIteratorException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExpiredIteratorException) Message added in v1.28.0 

func (s *ExpiredIteratorException) Message() string

Message returns the exception's message.

func (*ExpiredIteratorException) OrigErr added in v1.28.0 

func (s *ExpiredIteratorException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ExpiredIteratorException) RequestID added in v1.28.0 

func (s *ExpiredIteratorException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ExpiredIteratorException) StatusCode added in v1.28.0 

func (s *ExpiredIteratorException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ExpiredIteratorException) String added in v1.28.0 

func (s ExpiredIteratorException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExpiredNextTokenException added in v1.28.0 

type ExpiredNextTokenException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The pagination token passed to the operation is expired.

func (*ExpiredNextTokenException) Code added in v1.28.0 

func (s *ExpiredNextTokenException) Code() string

Code returns the exception type name.

func (*ExpiredNextTokenException) Error added in v1.28.0 

func (s *ExpiredNextTokenException) Error() string

func (ExpiredNextTokenException) GoString added in v1.28.0 

func (s ExpiredNextTokenException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExpiredNextTokenException) Message added in v1.28.0 

func (s *ExpiredNextTokenException) Message() string

Message returns the exception's message.

func (*ExpiredNextTokenException) OrigErr added in v1.28.0 

func (s *ExpiredNextTokenException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ExpiredNextTokenException) RequestID added in v1.28.0 

func (s *ExpiredNextTokenException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ExpiredNextTokenException) StatusCode added in v1.28.0 

func (s *ExpiredNextTokenException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ExpiredNextTokenException) String added in v1.28.0 

func (s ExpiredNextTokenException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.
	// The default value is 10,000.
	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) GoString added in v0.6.5 

func (s GetRecordsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRecordsInput) SetLimit added in v1.5.0 

func (s *GetRecordsInput) SetLimit(v int64) *GetRecordsInput

SetLimit sets the Limit field's value.

func (*GetRecordsInput) SetShardIterator added in v1.5.0 

func (s *GetRecordsInput) SetShardIterator(v string) *GetRecordsInput

SetShardIterator sets the ShardIterator field's value.

func (GetRecordsInput) String added in v0.6.5 

func (s GetRecordsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRecordsInput) Validate added in v1.1.21 

func (s *GetRecordsInput) Validate() error

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

type GetRecordsOutput 

type GetRecordsOutput struct {

	// The list of the current shard's child shards, returned in the GetRecords
	// API's response only when the end of the current shard is reached.
	ChildShards []*ChildShard `type:"list"`

	// 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) GoString added in v0.6.5 

func (s GetRecordsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetRecordsOutput) SetChildShards added in v1.34.6 

func (s *GetRecordsOutput) SetChildShards(v []*ChildShard) *GetRecordsOutput

SetChildShards sets the ChildShards field's value.

func (*GetRecordsOutput) SetMillisBehindLatest added in v1.5.0 

func (s *GetRecordsOutput) SetMillisBehindLatest(v int64) *GetRecordsOutput

SetMillisBehindLatest sets the MillisBehindLatest field's value.

func (*GetRecordsOutput) SetNextShardIterator added in v1.5.0 

func (s *GetRecordsOutput) SetNextShardIterator(v string) *GetRecordsOutput

SetNextShardIterator sets the NextShardIterator field's value.

func (*GetRecordsOutput) SetRecords added in v1.5.0 

func (s *GetRecordsOutput) SetRecords(v []*Record) *GetRecordsOutput

SetRecords sets the Records field's value.

func (GetRecordsOutput) String added in v0.6.5 

func (s GetRecordsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *string `type:"string" required:"true" enum:"ShardIteratorType"`

	// 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) GoString added in v0.6.5 

func (s GetShardIteratorInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetShardIteratorInput) SetShardId added in v1.5.0 

func (s *GetShardIteratorInput) SetShardId(v string) *GetShardIteratorInput

SetShardId sets the ShardId field's value.

func (*GetShardIteratorInput) SetShardIteratorType added in v1.5.0 

func (s *GetShardIteratorInput) SetShardIteratorType(v string) *GetShardIteratorInput

SetShardIteratorType sets the ShardIteratorType field's value.

func (*GetShardIteratorInput) SetStartingSequenceNumber added in v1.5.0 

func (s *GetShardIteratorInput) SetStartingSequenceNumber(v string) *GetShardIteratorInput

SetStartingSequenceNumber sets the StartingSequenceNumber field's value.

func (*GetShardIteratorInput) SetStreamName added in v1.5.0 

func (s *GetShardIteratorInput) SetStreamName(v string) *GetShardIteratorInput

SetStreamName sets the StreamName field's value.

func (*GetShardIteratorInput) SetTimestamp added in v1.5.0 

func (s *GetShardIteratorInput) SetTimestamp(v time.Time) *GetShardIteratorInput

SetTimestamp sets the Timestamp field's value.

func (GetShardIteratorInput) String added in v0.6.5 

func (s GetShardIteratorInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetShardIteratorInput) Validate added in v1.1.21 

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) GoString added in v0.6.5 

func (s GetShardIteratorOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetShardIteratorOutput) SetShardIterator added in v1.5.0 

func (s *GetShardIteratorOutput) SetShardIterator(v string) *GetShardIteratorOutput

SetShardIterator sets the ShardIterator field's value.

func (GetShardIteratorOutput) String added in v0.6.5 

func (s GetShardIteratorOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString added in v0.6.5 

func (s HashKeyRange) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HashKeyRange) SetEndingHashKey added in v1.5.0 

func (s *HashKeyRange) SetEndingHashKey(v string) *HashKeyRange

SetEndingHashKey sets the EndingHashKey field's value.

func (*HashKeyRange) SetStartingHashKey added in v1.5.0 

func (s *HashKeyRange) SetStartingHashKey(v string) *HashKeyRange

SetStartingHashKey sets the StartingHashKey field's value.

func (HashKeyRange) String added in v0.6.5 

func (s HashKeyRange) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IncreaseStreamRetentionPeriodInput added in v0.9.13 

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 `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) GoString added in v0.9.13 

func (s IncreaseStreamRetentionPeriodInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IncreaseStreamRetentionPeriodInput) SetRetentionPeriodHours added in v1.5.0 

func (s *IncreaseStreamRetentionPeriodInput) SetRetentionPeriodHours(v int64) *IncreaseStreamRetentionPeriodInput

SetRetentionPeriodHours sets the RetentionPeriodHours field's value.

func (*IncreaseStreamRetentionPeriodInput) SetStreamName added in v1.5.0 

func (s *IncreaseStreamRetentionPeriodInput) SetStreamName(v string) *IncreaseStreamRetentionPeriodInput

SetStreamName sets the StreamName field's value.

func (IncreaseStreamRetentionPeriodInput) String added in v0.9.13 

func (s IncreaseStreamRetentionPeriodInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IncreaseStreamRetentionPeriodInput) Validate added in v1.1.21 

func (s *IncreaseStreamRetentionPeriodInput) Validate() error

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

type IncreaseStreamRetentionPeriodOutput added in v0.9.13 

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

func (IncreaseStreamRetentionPeriodOutput) GoString added in v0.9.13 

func (s IncreaseStreamRetentionPeriodOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (IncreaseStreamRetentionPeriodOutput) String added in v0.9.13 

func (s IncreaseStreamRetentionPeriodOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalFailureException added in v1.18.0 

type InternalFailureException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The processing of the request failed because of an unknown error, exception, or failure.

func (*InternalFailureException) Code added in v1.18.0 

func (s *InternalFailureException) Code() string

Code returns the exception type name.

func (*InternalFailureException) Error added in v1.18.0 

func (s *InternalFailureException) Error() string

func (InternalFailureException) GoString added in v1.18.0 

func (s InternalFailureException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalFailureException) MarshalEvent added in v1.27.0 

func (s *InternalFailureException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*InternalFailureException) Message added in v1.18.0 

func (s *InternalFailureException) Message() string

Message returns the exception's message.

func (*InternalFailureException) OrigErr added in v1.18.0 

func (s *InternalFailureException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalFailureException) RequestID added in v1.28.0 

func (s *InternalFailureException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalFailureException) StatusCode added in v1.28.0 

func (s *InternalFailureException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalFailureException) String added in v1.18.0 

func (s InternalFailureException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalFailureException) UnmarshalEvent added in v1.18.0 

func (s *InternalFailureException) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the InternalFailureException value. This method is only used internally within the SDK's EventStream handling.

type InvalidArgumentException added in v1.28.0 

type InvalidArgumentException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A message that provides information about the error.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

func (*InvalidArgumentException) Code added in v1.28.0 

func (s *InvalidArgumentException) Code() string

Code returns the exception type name.

func (*InvalidArgumentException) Error added in v1.28.0 

func (s *InvalidArgumentException) Error() string

func (InvalidArgumentException) GoString added in v1.28.0 

func (s InvalidArgumentException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidArgumentException) Message added in v1.28.0 

func (s *InvalidArgumentException) Message() string

Message returns the exception's message.

func (*InvalidArgumentException) OrigErr added in v1.28.0 

func (s *InvalidArgumentException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidArgumentException) RequestID added in v1.28.0 

func (s *InvalidArgumentException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidArgumentException) StatusCode added in v1.28.0 

func (s *InvalidArgumentException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidArgumentException) String added in v1.28.0 

func (s InvalidArgumentException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type KMSAccessDeniedException added in v1.18.0 

type KMSAccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A message that provides information about the error.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The ciphertext references a key that doesn't exist or that you don't have access to.

func (*KMSAccessDeniedException) Code added in v1.18.0 

func (s *KMSAccessDeniedException) Code() string

Code returns the exception type name.

func (*KMSAccessDeniedException) Error added in v1.18.0 

func (s *KMSAccessDeniedException) Error() string

func (KMSAccessDeniedException) GoString added in v1.18.0 

func (s KMSAccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KMSAccessDeniedException) MarshalEvent added in v1.27.0 

func (s *KMSAccessDeniedException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*KMSAccessDeniedException) Message added in v1.18.0 

func (s *KMSAccessDeniedException) Message() string

Message returns the exception's message.

func (*KMSAccessDeniedException) OrigErr added in v1.18.0 

func (s *KMSAccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*KMSAccessDeniedException) RequestID added in v1.28.0 

func (s *KMSAccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*KMSAccessDeniedException) StatusCode added in v1.28.0 

func (s *KMSAccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (KMSAccessDeniedException) String added in v1.18.0 

func (s KMSAccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KMSAccessDeniedException) UnmarshalEvent added in v1.18.0 

func (s *KMSAccessDeniedException) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the KMSAccessDeniedException value. This method is only used internally within the SDK's EventStream handling.

type KMSDisabledException added in v1.18.0 

type KMSDisabledException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A message that provides information about the error.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The request was rejected because the specified customer master key (CMK) isn't enabled.

func (*KMSDisabledException) Code added in v1.18.0 

func (s *KMSDisabledException) Code() string

Code returns the exception type name.

func (*KMSDisabledException) Error added in v1.18.0 

func (s *KMSDisabledException) Error() string

func (KMSDisabledException) GoString added in v1.18.0 

func (s KMSDisabledException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KMSDisabledException) MarshalEvent added in v1.27.0 

func (s *KMSDisabledException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*KMSDisabledException) Message added in v1.18.0 

func (s *KMSDisabledException) Message() string

Message returns the exception's message.

func (*KMSDisabledException) OrigErr added in v1.18.0 

func (s *KMSDisabledException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*KMSDisabledException) RequestID added in v1.28.0 

func (s *KMSDisabledException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*KMSDisabledException) StatusCode added in v1.28.0 

func (s *KMSDisabledException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (KMSDisabledException) String added in v1.18.0 

func (s KMSDisabledException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KMSDisabledException) UnmarshalEvent added in v1.18.0 

func (s *KMSDisabledException) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the KMSDisabledException value. This method is only used internally within the SDK's EventStream handling.

type KMSInvalidStateException added in v1.18.0 

type KMSInvalidStateException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A message that provides information about the error.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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 (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the Amazon Web Services Key Management Service Developer Guide.

func (*KMSInvalidStateException) Code added in v1.18.0 

func (s *KMSInvalidStateException) Code() string

Code returns the exception type name.

func (*KMSInvalidStateException) Error added in v1.18.0 

func (s *KMSInvalidStateException) Error() string

func (KMSInvalidStateException) GoString added in v1.18.0 

func (s KMSInvalidStateException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KMSInvalidStateException) MarshalEvent added in v1.27.0 

func (s *KMSInvalidStateException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*KMSInvalidStateException) Message added in v1.18.0 

func (s *KMSInvalidStateException) Message() string

Message returns the exception's message.

func (*KMSInvalidStateException) OrigErr added in v1.18.0 

func (s *KMSInvalidStateException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*KMSInvalidStateException) RequestID added in v1.28.0 

func (s *KMSInvalidStateException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*KMSInvalidStateException) StatusCode added in v1.28.0 

func (s *KMSInvalidStateException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (KMSInvalidStateException) String added in v1.18.0 

func (s KMSInvalidStateException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KMSInvalidStateException) UnmarshalEvent added in v1.18.0 

func (s *KMSInvalidStateException) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the KMSInvalidStateException value. This method is only used internally within the SDK's EventStream handling.

type KMSNotFoundException added in v1.18.0 

type KMSNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A message that provides information about the error.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The request was rejected because the specified entity or resource can't be found.

func (*KMSNotFoundException) Code added in v1.18.0 

func (s *KMSNotFoundException) Code() string

Code returns the exception type name.

func (*KMSNotFoundException) Error added in v1.18.0 

func (s *KMSNotFoundException) Error() string

func (KMSNotFoundException) GoString added in v1.18.0 

func (s KMSNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KMSNotFoundException) MarshalEvent added in v1.27.0 

func (s *KMSNotFoundException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*KMSNotFoundException) Message added in v1.18.0 

func (s *KMSNotFoundException) Message() string

Message returns the exception's message.

func (*KMSNotFoundException) OrigErr added in v1.18.0 

func (s *KMSNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*KMSNotFoundException) RequestID added in v1.28.0 

func (s *KMSNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*KMSNotFoundException) StatusCode added in v1.28.0 

func (s *KMSNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (KMSNotFoundException) String added in v1.18.0 

func (s KMSNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KMSNotFoundException) UnmarshalEvent added in v1.18.0 

func (s *KMSNotFoundException) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the KMSNotFoundException value. This method is only used internally within the SDK's EventStream handling.

type KMSOptInRequired added in v1.18.0 

type KMSOptInRequired struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A message that provides information about the error.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The Amazon Web Services access key ID needs a subscription for the service.

func (*KMSOptInRequired) Code added in v1.18.0 

func (s *KMSOptInRequired) Code() string

Code returns the exception type name.

func (*KMSOptInRequired) Error added in v1.18.0 

func (s *KMSOptInRequired) Error() string

func (KMSOptInRequired) GoString added in v1.18.0 

func (s KMSOptInRequired) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KMSOptInRequired) MarshalEvent added in v1.27.0 

func (s *KMSOptInRequired) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*KMSOptInRequired) Message added in v1.18.0 

func (s *KMSOptInRequired) Message() string

Message returns the exception's message.

func (*KMSOptInRequired) OrigErr added in v1.18.0 

func (s *KMSOptInRequired) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*KMSOptInRequired) RequestID added in v1.28.0 

func (s *KMSOptInRequired) RequestID() string

RequestID returns the service's response RequestID for request.

func (*KMSOptInRequired) StatusCode added in v1.28.0 

func (s *KMSOptInRequired) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (KMSOptInRequired) String added in v1.18.0 

func (s KMSOptInRequired) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KMSOptInRequired) UnmarshalEvent added in v1.18.0 

func (s *KMSOptInRequired) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the KMSOptInRequired value. This method is only used internally within the SDK's EventStream handling.

type KMSThrottlingException added in v1.18.0 

type KMSThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A message that provides information about the error.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The request was denied due to request throttling. For more information about throttling, see Limits (https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second) in the Amazon Web Services Key Management Service Developer Guide.

func (*KMSThrottlingException) Code added in v1.18.0 

func (s *KMSThrottlingException) Code() string

Code returns the exception type name.

func (*KMSThrottlingException) Error added in v1.18.0 

func (s *KMSThrottlingException) Error() string

func (KMSThrottlingException) GoString added in v1.18.0 

func (s KMSThrottlingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KMSThrottlingException) MarshalEvent added in v1.27.0 

func (s *KMSThrottlingException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*KMSThrottlingException) Message added in v1.18.0 

func (s *KMSThrottlingException) Message() string

Message returns the exception's message.

func (*KMSThrottlingException) OrigErr added in v1.18.0 

func (s *KMSThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*KMSThrottlingException) RequestID added in v1.28.0 

func (s *KMSThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*KMSThrottlingException) StatusCode added in v1.28.0 

func (s *KMSThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (KMSThrottlingException) String added in v1.18.0 

func (s KMSThrottlingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KMSThrottlingException) UnmarshalEvent added in v1.18.0 

func (s *KMSThrottlingException) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the KMSThrottlingException value. This method is only used internally within the SDK's EventStream handling.

type Kinesis 

type Kinesis struct {
	*client.Client
}

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

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

func New 

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

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

Example: 

mySession := session.Must(session.NewSession())

// Create a Kinesis client from just a session.
svc := kinesis.New(mySession)

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

func (*Kinesis) AddTagsToStream 

func (c *Kinesis) AddTagsToStream(input *AddTagsToStreamInput) (*AddTagsToStreamOutput, error)

AddTagsToStream API operation for Amazon Kinesis.

Adds or updates tags for the specified Kinesis data stream. You can assign up to 50 tags to a data stream.

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.

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

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

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found. The stream might not be specified correctly.

  • ResourceInUseException The resource is not available for this operation. For successful operation, the resource must be in the ACTIVE state.

  • InvalidArgumentException A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

  • LimitExceededException The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

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

func (*Kinesis) AddTagsToStreamRequest 

func (c *Kinesis) AddTagsToStreamRequest(input *AddTagsToStreamInput) (req *request.Request, output *AddTagsToStreamOutput)

AddTagsToStreamRequest generates a "aws/request.Request" representing the client's request for the AddTagsToStream operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AddTagsToStream for more information on using the AddTagsToStream API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

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

func (*Kinesis) AddTagsToStreamWithContext added in v1.8.0 

func (c *Kinesis) AddTagsToStreamWithContext(ctx aws.Context, input *AddTagsToStreamInput, opts ...request.Option) (*AddTagsToStreamOutput, error)

AddTagsToStreamWithContext is the same as AddTagsToStream with the addition of the ability to pass a context and additional request options.

See AddTagsToStream for details on how to use this API operation.

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 (*Kinesis) CreateStream 

func (c *Kinesis) CreateStream(input *CreateStreamInput) (*CreateStreamOutput, error)

CreateStream 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 MiB per second. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MiB 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 Amazon Web Services account used by the application. It is also scoped by Amazon Web Services 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 Amazon Web Services account, see Amazon Kinesis Data Streams Limits (https://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 Amazon Web Services Support (https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html).

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

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

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

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

Returned Error Types:

  • ResourceInUseException The resource is not available for this operation. For successful operation, the resource must be in the ACTIVE state.

  • LimitExceededException The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

  • InvalidArgumentException A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

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

func (*Kinesis) CreateStreamRequest 

func (c *Kinesis) CreateStreamRequest(input *CreateStreamInput) (req *request.Request, output *CreateStreamOutput)

CreateStreamRequest generates a "aws/request.Request" representing the client's request for the CreateStream operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateStream for more information on using the CreateStream API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

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

func (*Kinesis) CreateStreamWithContext added in v1.8.0 

func (c *Kinesis) CreateStreamWithContext(ctx aws.Context, input *CreateStreamInput, opts ...request.Option) (*CreateStreamOutput, error)

CreateStreamWithContext is the same as CreateStream with the addition of the ability to pass a context and additional request options.

See CreateStream for details on how to use this API operation.

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 (*Kinesis) DecreaseStreamRetentionPeriod added in v0.9.13 

func (c *Kinesis) DecreaseStreamRetentionPeriod(input *DecreaseStreamRetentionPeriodInput) (*DecreaseStreamRetentionPeriodOutput, error)

DecreaseStreamRetentionPeriod 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.

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

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

Returned Error Types:

  • ResourceInUseException The resource is not available for this operation. For successful operation, the resource must be in the ACTIVE state.

  • ResourceNotFoundException The requested resource could not be found. The stream might not be specified correctly.

  • LimitExceededException The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

  • InvalidArgumentException A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

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

func (*Kinesis) DecreaseStreamRetentionPeriodRequest added in v0.9.13 

func (c *Kinesis) DecreaseStreamRetentionPeriodRequest(input *DecreaseStreamRetentionPeriodInput) (req *request.Request, output *DecreaseStreamRetentionPeriodOutput)

DecreaseStreamRetentionPeriodRequest generates a "aws/request.Request" representing the client's request for the DecreaseStreamRetentionPeriod operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DecreaseStreamRetentionPeriod for more information on using the DecreaseStreamRetentionPeriod API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

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

func (*Kinesis) DecreaseStreamRetentionPeriodWithContext added in v1.8.0 

func (c *Kinesis) DecreaseStreamRetentionPeriodWithContext(ctx aws.Context, input *DecreaseStreamRetentionPeriodInput, opts ...request.Option) (*DecreaseStreamRetentionPeriodOutput, error)

DecreaseStreamRetentionPeriodWithContext is the same as DecreaseStreamRetentionPeriod with the addition of the ability to pass a context and additional request options.

See DecreaseStreamRetentionPeriod for details on how to use this API operation.

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 (*Kinesis) DeleteStream 

func (c *Kinesis) DeleteStream(input *DeleteStreamInput) (*DeleteStreamOutput, error)

DeleteStream 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 DescribeStreamSummary operation to check the state of the stream, which is returned in StreamStatus.

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

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

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

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found. The stream might not be specified correctly.

  • LimitExceededException The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

  • ResourceInUseException The resource is not available for this operation. For successful operation, the resource must be in the ACTIVE state.

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

func (*Kinesis) DeleteStreamRequest 

func (c *Kinesis) DeleteStreamRequest(input *DeleteStreamInput) (req *request.Request, output *DeleteStreamOutput)

DeleteStreamRequest generates a "aws/request.Request" representing the client's request for the DeleteStream operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteStream for more information on using the DeleteStream API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

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

func (*Kinesis) DeleteStreamWithContext added in v1.8.0 

func (c *Kinesis) DeleteStreamWithContext(ctx aws.Context, input *DeleteStreamInput, opts ...request.Option) (*DeleteStreamOutput, error)

DeleteStreamWithContext is the same as DeleteStream with the addition of the ability to pass a context and additional request options.

See DeleteStream for details on how to use this API operation.

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 (*Kinesis) DeregisterStreamConsumer added in v1.15.4 

func (c *Kinesis) DeregisterStreamConsumer(input *DeregisterStreamConsumerInput) (*DeregisterStreamConsumerOutput, error)

DeregisterStreamConsumer 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 stream.

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

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

Returned Error Types:

  • LimitExceededException The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

  • ResourceNotFoundException The requested resource could not be found. The stream might not be specified correctly.

  • InvalidArgumentException A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

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

func (*Kinesis) DeregisterStreamConsumerRequest added in v1.15.4 

func (c *Kinesis) DeregisterStreamConsumerRequest(input *DeregisterStreamConsumerInput) (req *request.Request, output *DeregisterStreamConsumerOutput)

DeregisterStreamConsumerRequest generates a "aws/request.Request" representing the client's request for the DeregisterStreamConsumer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeregisterStreamConsumer for more information on using the DeregisterStreamConsumer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

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

func (*Kinesis) DeregisterStreamConsumerWithContext added in v1.15.4 

func (c *Kinesis) DeregisterStreamConsumerWithContext(ctx aws.Context, input *DeregisterStreamConsumerInput, opts ...request.Option) (*DeregisterStreamConsumerOutput, error)

DeregisterStreamConsumerWithContext is the same as DeregisterStreamConsumer with the addition of the ability to pass a context and additional request options.

See DeregisterStreamConsumer for details on how to use this API operation.

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 (*Kinesis) DescribeLimits added in v1.5.5 

func (c *Kinesis) DescribeLimits(input *DescribeLimitsInput) (*DescribeLimitsOutput, error)

DescribeLimits 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.

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

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

Returned Error Types:

  • LimitExceededException The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

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

func (*Kinesis) DescribeLimitsRequest added in v1.5.5 

func (c *Kinesis) DescribeLimitsRequest(input *DescribeLimitsInput) (req *request.Request, output *DescribeLimitsOutput)

DescribeLimitsRequest generates a "aws/request.Request" representing the client's request for the DescribeLimits operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeLimits for more information on using the DescribeLimits API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

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

func (*Kinesis) DescribeLimitsWithContext added in v1.8.0 

func (c *Kinesis) DescribeLimitsWithContext(ctx aws.Context, input *DescribeLimitsInput, opts ...request.Option) (*DescribeLimitsOutput, error)

DescribeLimitsWithContext is the same as DescribeLimits with the addition of the ability to pass a context and additional request options.

See DescribeLimits for details on how to use this API operation.

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 (*Kinesis) DescribeStream 

func (c *Kinesis) DescribeStream(input *DescribeStreamInput) (*DescribeStreamOutput, error)

DescribeStream API operation for Amazon Kinesis.

Describes the specified Kinesis data stream.

This API has been revised. It's highly recommended that you use the DescribeStreamSummary API to get a summarized description of the specified Kinesis data stream and the ListShards API to list the shards in a specified data stream and obtain information about each shard.

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 (https://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.

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

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

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found. The stream might not be specified correctly.

  • LimitExceededException The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

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

func (*Kinesis) DescribeStreamConsumer added in v1.15.4 

func (c *Kinesis) DescribeStreamConsumer(input *DescribeStreamConsumerInput) (*DescribeStreamConsumerOutput, error)

DescribeStreamConsumer 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 stream.

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

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

Returned Error Types:

  • LimitExceededException The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

  • ResourceNotFoundException The requested resource could not be found. The stream might not be specified correctly.

  • InvalidArgumentException A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

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

func (*Kinesis) DescribeStreamConsumerRequest added in v1.15.4 

func (c *Kinesis) DescribeStreamConsumerRequest(input *DescribeStreamConsumerInput) (req *request.Request, output *DescribeStreamConsumerOutput)

DescribeStreamConsumerRequest generates a "aws/request.Request" representing the client's request for the DescribeStreamConsumer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeStreamConsumer for more information on using the DescribeStreamConsumer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

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

func (*Kinesis) DescribeStreamConsumerWithContext added in v1.15.4 

func (c *Kinesis) DescribeStreamConsumerWithContext(ctx aws.Context, input *DescribeStreamConsumerInput, opts ...request.Option) (*DescribeStreamConsumerOutput, error)

DescribeStreamConsumerWithContext is the same as DescribeStreamConsumer with the addition of the ability to pass a context and additional request options.

See DescribeStreamConsumer for details on how to use this API operation.

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 (*Kinesis) DescribeStreamPages 

func (c *Kinesis) DescribeStreamPages(input *DescribeStreamInput, fn func(*DescribeStreamOutput, bool) bool) error

DescribeStreamPages iterates over the pages of a DescribeStream operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeStream method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a DescribeStream operation.
pageNum := 0
err := client.DescribeStreamPages(params,
    func(page *kinesis.DescribeStreamOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Kinesis) DescribeStreamPagesWithContext added in v1.8.0 

func (c *Kinesis) DescribeStreamPagesWithContext(ctx aws.Context, input *DescribeStreamInput, fn func(*DescribeStreamOutput, bool) bool, opts ...request.Option) error

DescribeStreamPagesWithContext same as DescribeStreamPages except it takes a Context and allows setting request options on the pages.

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 (*Kinesis) DescribeStreamRequest 

func (c *Kinesis) DescribeStreamRequest(input *DescribeStreamInput) (req *request.Request, output *DescribeStreamOutput)

DescribeStreamRequest generates a "aws/request.Request" representing the client's request for the DescribeStream operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeStream for more information on using the DescribeStream API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

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

func (*Kinesis) DescribeStreamSummary added in v1.12.31 

func (c *Kinesis) DescribeStreamSummary(input *DescribeStreamSummaryInput) (*DescribeStreamSummaryOutput, error)

DescribeStreamSummary 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.

DescribeStreamSummary has a limit of 20 transactions per second per account.

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

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

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found. The stream might not be specified correctly.

  • LimitExceededException The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

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

func (*Kinesis) DescribeStreamSummaryRequest added in v1.12.31 

func (c *Kinesis) DescribeStreamSummaryRequest(input *DescribeStreamSummaryInput) (req *request.Request, output *DescribeStreamSummaryOutput)

DescribeStreamSummaryRequest generates a "aws/request.Request" representing the client's request for the DescribeStreamSummary operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeStreamSummary for more information on using the DescribeStreamSummary API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

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

func (*Kinesis) DescribeStreamSummaryWithContext added in v1.12.31 

func (c *Kinesis) DescribeStreamSummaryWithContext(ctx aws.Context, input *DescribeStreamSummaryInput, opts ...request.Option) (*DescribeStreamSummaryOutput, error)

DescribeStreamSummaryWithContext is the same as DescribeStreamSummary with the addition of the ability to pass a context and additional request options.

See DescribeStreamSummary for details on how to use this API operation.

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 (*Kinesis) DescribeStreamWithContext added in v1.8.0 

func (c *Kinesis) DescribeStreamWithContext(ctx aws.Context, input *DescribeStreamInput, opts ...request.Option) (*DescribeStreamOutput, error)

DescribeStreamWithContext is the same as DescribeStream with the addition of the ability to pass a context and additional request options.

See DescribeStream for details on how to use this API operation.

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 (*Kinesis) DisableEnhancedMonitoring added in v1.1.19 

func (c *Kinesis) DisableEnhancedMonitoring(input *DisableEnhancedMonitoringInput) (*EnhancedMonitoringOutput, error)

DisableEnhancedMonitoring API operation for Amazon Kinesis.

Disables enhanced monitoring.

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

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

Returned Error Types:

  • InvalidArgumentException A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

  • LimitExceededException The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

  • ResourceInUseException The resource is not available for this operation. For successful operation, the resource must be in the ACTIVE state.

  • ResourceNotFoundException The requested resource could not be found. The stream might not be specified correctly.

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

func (*Kinesis) DisableEnhancedMonitoringRequest added in v1.1.19 

func (c *Kinesis) DisableEnhancedMonitoringRequest(input *DisableEnhancedMonitoringInput) (req *request.Request, output *EnhancedMonitoringOutput)

DisableEnhancedMonitoringRequest generates a "aws/request.Request" representing the client's request for the DisableEnhancedMonitoring operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisableEnhancedMonitoring for more information on using the DisableEnhancedMonitoring API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

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

func (*Kinesis) DisableEnhancedMonitoringWithContext added in v1.8.0 

func (c *Kinesis) DisableEnhancedMonitoringWithContext(ctx aws.Context, input *DisableEnhancedMonitoringInput, opts ...request.Option) (*EnhancedMonitoringOutput, error)

DisableEnhancedMonitoringWithContext is the same as DisableEnhancedMonitoring with the addition of the ability to pass a context and additional request options.

See DisableEnhancedMonitoring for details on how to use this API operation.

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 (*Kinesis) EnableEnhancedMonitoring added in v1.1.19 

func (c *Kinesis) EnableEnhancedMonitoring(input *EnableEnhancedMonitoringInput) (*EnhancedMonitoringOutput, error)

EnableEnhancedMonitoring API operation for Amazon Kinesis.

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

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

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

Returned Error Types:

  • InvalidArgumentException A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

  • LimitExceededException The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

  • ResourceInUseException The resource is not available for this operation. For successful operation, the resource must be in the ACTIVE state.

  • ResourceNotFoundException The requested resource could not be found. The stream might not be specified correctly.

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

func (*Kinesis) EnableEnhancedMonitoringRequest added in v1.1.19 

func (c *Kinesis) EnableEnhancedMonitoringRequest(input *EnableEnhancedMonitoringInput) (req *request.Request, output *EnhancedMonitoringOutput)

EnableEnhancedMonitoringRequest generates a "aws/request.Request" representing the client's request for the EnableEnhancedMonitoring operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See EnableEnhancedMonitoring for more information on using the EnableEnhancedMonitoring API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

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

func (*Kinesis) EnableEnhancedMonitoringWithContext added in v1.8.0 

func (c *Kinesis) EnableEnhancedMonitoringWithContext(ctx aws.Context, input *EnableEnhancedMonitoringInput, opts ...request.Option) (*EnhancedMonitoringOutput, error)

EnableEnhancedMonitoringWithContext is the same as EnableEnhancedMonitoring with the addition of the ability to pass a context and additional request options.

See EnableEnhancedMonitoring for details on how to use this API operation.

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 (*Kinesis) GetRecords 

func (c *Kinesis) GetRecords(input *GetRecordsInput) (*GetRecordsOutput, error)

GetRecords 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 (https://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. It is recommended that consumer applications retrieve records via the GetRecords command using the 5 TPS limit to remain caught up. Retrieving records less frequently can lead to consumer applications falling behind. 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 (https://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 shard.

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

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

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found. The stream might not be specified correctly.

  • InvalidArgumentException A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

  • 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 (https://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 Amazon Web Services (https://docs.aws.amazon.com/general/latest/gr/api-retries.html) in the Amazon Web Services General Reference.

  • ExpiredIteratorException The provided iterator exceeds the maximum age allowed.

  • KMSDisabledException The request was rejected because the specified customer master key (CMK) isn't enabled.

  • 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 (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the Amazon Web Services Key Management Service Developer Guide.

  • KMSAccessDeniedException The ciphertext references a key that doesn't exist or that you don't have access to.

  • KMSNotFoundException The request was rejected because the specified entity or resource can't be found.

  • KMSOptInRequired The Amazon Web Services access key ID needs a subscription for the service.

  • KMSThrottlingException The request was denied due to request throttling. For more information about throttling, see Limits (https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second) in the Amazon Web Services Key Management Service Developer Guide.

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

func (*Kinesis) GetRecordsRequest 

func (c *Kinesis) GetRecordsRequest(input *GetRecordsInput) (req *request.Request, output *GetRecordsOutput)

GetRecordsRequest generates a "aws/request.Request" representing the client's request for the GetRecords operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRecords for more information on using the GetRecords API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

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

func (*Kinesis) GetRecordsWithContext added in v1.8.0 

func (c *Kinesis) GetRecordsWithContext(ctx aws.Context, input *GetRecordsInput, opts ...request.Option) (*GetRecordsOutput, error)

GetRecordsWithContext is the same as GetRecords with the addition of the ability to pass a context and additional request options.

See GetRecords for details on how to use this API operation.

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 (*Kinesis) GetShardIterator 

func (c *Kinesis) GetShardIterator(input *GetShardIteratorInput) (*GetShardIteratorOutput, error)

GetShardIterator 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 (https://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.

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

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

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found. The stream might not be specified correctly.

  • InvalidArgumentException A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

  • 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 (https://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 Amazon Web Services (https://docs.aws.amazon.com/general/latest/gr/api-retries.html) in the Amazon Web Services General Reference.

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

func (*Kinesis) GetShardIteratorRequest 

func (c *Kinesis) GetShardIteratorRequest(input *GetShardIteratorInput) (req *request.Request, output *GetShardIteratorOutput)

GetShardIteratorRequest generates a "aws/request.Request" representing the client's request for the GetShardIterator operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetShardIterator for more information on using the GetShardIterator API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

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

func (*Kinesis) GetShardIteratorWithContext added in v1.8.0 

func (c *Kinesis) GetShardIteratorWithContext(ctx aws.Context, input *GetShardIteratorInput, opts ...request.Option) (*GetShardIteratorOutput, error)

GetShardIteratorWithContext is the same as GetShardIterator with the addition of the ability to pass a context and additional request options.

See GetShardIterator for details on how to use this API operation.

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 (*Kinesis) IncreaseStreamRetentionPeriod added in v0.9.13 

func (c *Kinesis) IncreaseStreamRetentionPeriod(input *IncreaseStreamRetentionPeriodInput) (*IncreaseStreamRetentionPeriodOutput, error)

IncreaseStreamRetentionPeriod 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 8760 hours (365 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.

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

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

Returned Error Types:

  • ResourceInUseException The resource is not available for this operation. For successful operation, the resource must be in the ACTIVE state.

  • ResourceNotFoundException The requested resource could not be found. The stream might not be specified correctly.

  • LimitExceededException The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

  • InvalidArgumentException A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

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

func (*Kinesis) IncreaseStreamRetentionPeriodRequest added in v0.9.13 

func (c *Kinesis) IncreaseStreamRetentionPeriodRequest(input *IncreaseStreamRetentionPeriodInput) (req *request.Request, output *IncreaseStreamRetentionPeriodOutput)

IncreaseStreamRetentionPeriodRequest generates a "aws/request.Request" representing the client's request for the IncreaseStreamRetentionPeriod operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See IncreaseStreamRetentionPeriod for more information on using the IncreaseStreamRetentionPeriod API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

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

func (*Kinesis) IncreaseStreamRetentionPeriodWithContext added in v1.8.0 

func (c *Kinesis) IncreaseStreamRetentionPeriodWithContext(ctx aws.Context, input *IncreaseStreamRetentionPeriodInput, opts ...request.Option) (*IncreaseStreamRetentionPeriodOutput, error)

IncreaseStreamRetentionPeriodWithContext is the same as IncreaseStreamRetentionPeriod with the addition of the ability to pass a context and additional request options.

See IncreaseStreamRetentionPeriod for details on how to use this API operation.

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 (*Kinesis) ListShards added in v1.12.71 

func (c *Kinesis) ListShards(input *ListShardsInput) (*ListShardsOutput, error)

ListShards API operation for Amazon Kinesis.

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

This action does not list expired shards. For information about expired shards, see Data Routing, Data Persistence, and Shard State after a Reshard (https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-after-resharding.html#kinesis-using-sdk-java-resharding-data-routing).

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).

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

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

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found. The stream might not be specified correctly.

  • InvalidArgumentException A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

  • LimitExceededException The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

  • ExpiredNextTokenException The pagination token passed to the operation is expired.

  • ResourceInUseException The resource is not available for this operation. For successful operation, the resource must be in the ACTIVE state.

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

func (*Kinesis) ListShardsRequest added in v1.12.71 

func (c *Kinesis) ListShardsRequest(input *ListShardsInput) (req *request.Request, output *ListShardsOutput)

ListShardsRequest generates a "aws/request.Request" representing the client's request for the ListShards operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListShards for more information on using the ListShards API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

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

func (*Kinesis) ListShardsWithContext added in v1.12.71 

func (c *Kinesis) ListShardsWithContext(ctx aws.Context, input *ListShardsInput, opts ...request.Option) (*ListShardsOutput, error)

ListShardsWithContext is the same as ListShards with the addition of the ability to pass a context and additional request options.

See ListShards for details on how to use this API operation.

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 (*Kinesis) ListStreamConsumers added in v1.15.4 

func (c *Kinesis) ListStreamConsumers(input *ListStreamConsumersInput) (*ListStreamConsumersOutput, error)

ListStreamConsumers 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 5 transactions per second per stream.

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

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

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found. The stream might not be specified correctly.

  • InvalidArgumentException A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

  • LimitExceededException The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

  • ExpiredNextTokenException The pagination token passed to the operation is expired.

  • ResourceInUseException The resource is not available for this operation. For successful operation, the resource must be in the ACTIVE state.

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

func (*Kinesis) ListStreamConsumersPages added in v1.15.4 

func (c *Kinesis) ListStreamConsumersPages(input *ListStreamConsumersInput, fn func(*ListStreamConsumersOutput, bool) bool) error

ListStreamConsumersPages iterates over the pages of a ListStreamConsumers operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListStreamConsumers method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListStreamConsumers operation.
pageNum := 0
err := client.ListStreamConsumersPages(params,
    func(page *kinesis.ListStreamConsumersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Kinesis) ListStreamConsumersPagesWithContext added in v1.15.4 

func (c *Kinesis) ListStreamConsumersPagesWithContext(ctx aws.Context, input *ListStreamConsumersInput, fn func(*ListStreamConsumersOutput, bool) bool, opts ...request.Option) error

ListStreamConsumersPagesWithContext same as ListStreamConsumersPages except it takes a Context and allows setting request options on the pages.

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 (*Kinesis) ListStreamConsumersRequest added in v1.15.4 

func (c *Kinesis) ListStreamConsumersRequest(input *ListStreamConsumersInput) (req *request.Request, output *ListStreamConsumersOutput)

ListStreamConsumersRequest generates a "aws/request.Request" representing the client's request for the ListStreamConsumers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListStreamConsumers for more information on using the ListStreamConsumers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

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

func (*Kinesis) ListStreamConsumersWithContext added in v1.15.4 

func (c *Kinesis) ListStreamConsumersWithContext(ctx aws.Context, input *ListStreamConsumersInput, opts ...request.Option) (*ListStreamConsumersOutput, error)

ListStreamConsumersWithContext is the same as ListStreamConsumers with the addition of the ability to pass a context and additional request options.

See ListStreamConsumers for details on how to use this API operation.

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 (*Kinesis) ListStreams 

func (c *Kinesis) ListStreams(input *ListStreamsInput) (*ListStreamsOutput, error)

ListStreams 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 100.

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.

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

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

Returned Error Types:

  • LimitExceededException The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

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

func (*Kinesis) ListStreamsPages 

func (c *Kinesis) ListStreamsPages(input *ListStreamsInput, fn func(*ListStreamsOutput, bool) bool) error

ListStreamsPages iterates over the pages of a ListStreams operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListStreams method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListStreams operation.
pageNum := 0
err := client.ListStreamsPages(params,
    func(page *kinesis.ListStreamsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Kinesis) ListStreamsPagesWithContext added in v1.8.0 

func (c *Kinesis) ListStreamsPagesWithContext(ctx aws.Context, input *ListStreamsInput, fn func(*ListStreamsOutput, bool) bool, opts ...request.Option) error

ListStreamsPagesWithContext same as ListStreamsPages except it takes a Context and allows setting request options on the pages.

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 (*Kinesis) ListStreamsRequest 

func (c *Kinesis) ListStreamsRequest(input *ListStreamsInput) (req *request.Request, output *ListStreamsOutput)

ListStreamsRequest generates a "aws/request.Request" representing the client's request for the ListStreams operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListStreams for more information on using the ListStreams API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

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

func (*Kinesis) ListStreamsWithContext added in v1.8.0 

func (c *Kinesis) ListStreamsWithContext(ctx aws.Context, input *ListStreamsInput, opts ...request.Option) (*ListStreamsOutput, error)

ListStreamsWithContext is the same as ListStreams with the addition of the ability to pass a context and additional request options.

See ListStreams for details on how to use this API operation.

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 (*Kinesis) ListTagsForStream 

func (c *Kinesis) ListTagsForStream(input *ListTagsForStreamInput) (*ListTagsForStreamOutput, error)

ListTagsForStream 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.

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

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

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found. The stream might not be specified correctly.

  • InvalidArgumentException A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

  • LimitExceededException The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

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

func (*Kinesis) ListTagsForStreamRequest 

func (c *Kinesis) ListTagsForStreamRequest(input *ListTagsForStreamInput) (req *request.Request, output *ListTagsForStreamOutput)

ListTagsForStreamRequest generates a "aws/request.Request" representing the client's request for the ListTagsForStream operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForStream for more information on using the ListTagsForStream API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

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

func (*Kinesis) ListTagsForStreamWithContext added in v1.8.0 

func (c *Kinesis) ListTagsForStreamWithContext(ctx aws.Context, input *ListTagsForStreamInput, opts ...request.Option) (*ListTagsForStreamOutput, error)

ListTagsForStreamWithContext is the same as ListTagsForStream with the addition of the ability to pass a context and additional request options.

See ListTagsForStream for details on how to use this API operation.

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 (*Kinesis) MergeShards 

func (c *Kinesis) MergeShards(input *MergeShardsInput) (*MergeShardsOutput, error)

MergeShards 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 (https://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 DescribeStreamSummary 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 DescribeStreamSummary and the ListShards APIs 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.

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

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

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found. The stream might not be specified correctly.

  • ResourceInUseException The resource is not available for this operation. For successful operation, the resource must be in the ACTIVE state.

  • InvalidArgumentException A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

  • LimitExceededException The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

  • ValidationException

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

func (*Kinesis) MergeShardsRequest 

func (c *Kinesis) MergeShardsRequest(input *MergeShardsInput) (req *request.Request, output *MergeShardsOutput)

MergeShardsRequest generates a "aws/request.Request" representing the client's request for the MergeShards operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See MergeShards for more information on using the MergeShards API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

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

func (*Kinesis) MergeShardsWithContext added in v1.8.0 

func (c *Kinesis) MergeShardsWithContext(ctx aws.Context, input *MergeShardsInput, opts ...request.Option) (*MergeShardsOutput, error)

MergeShardsWithContext is the same as MergeShards with the addition of the ability to pass a context and additional request options.

See MergeShards for details on how to use this API operation.

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 (*Kinesis) PutRecord 

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

PutRecord 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 MiB 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 (https://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 (https://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.

After you write a record to a stream, you cannot modify that record or its order within the stream.

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.

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

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

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found. The stream might not be specified correctly.

  • InvalidArgumentException A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

  • 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 (https://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 Amazon Web Services (https://docs.aws.amazon.com/general/latest/gr/api-retries.html) in the Amazon Web Services General Reference.

  • KMSDisabledException The request was rejected because the specified customer master key (CMK) isn't enabled.

  • 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 (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the Amazon Web Services Key Management Service Developer Guide.

  • KMSAccessDeniedException The ciphertext references a key that doesn't exist or that you don't have access to.

  • KMSNotFoundException The request was rejected because the specified entity or resource can't be found.

  • KMSOptInRequired The Amazon Web Services access key ID needs a subscription for the service.

  • KMSThrottlingException The request was denied due to request throttling. For more information about throttling, see Limits (https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second) in the Amazon Web Services Key Management Service Developer Guide.

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

func (*Kinesis) PutRecordRequest 

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

PutRecordRequest generates a "aws/request.Request" representing the client's request for the PutRecord operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutRecord for more information on using the PutRecord API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

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

func (*Kinesis) PutRecordWithContext added in v1.8.0 

func (c *Kinesis) PutRecordWithContext(ctx aws.Context, input *PutRecordInput, opts ...request.Option) (*PutRecordOutput, error)

PutRecordWithContext is the same as PutRecord with the addition of the ability to pass a context and additional request options.

See PutRecord for details on how to use this API operation.

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 (*Kinesis) PutRecords 

func (c *Kinesis) PutRecords(input *PutRecordsInput) (*PutRecordsOutput, error)

PutRecords 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 MiB, up to a limit of 5 MiB 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 MiB 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 (https://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 (https://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. As a result, PutRecords doesn't guarantee the ordering of records. If you need to read records in the same order they are written to the stream, use PutRecord instead of PutRecords, and write to the same shard.

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 (https://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.

After you write a record to a stream, you cannot modify that record or its order within the stream.

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.

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

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

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found. The stream might not be specified correctly.

  • InvalidArgumentException A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

  • 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 (https://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 Amazon Web Services (https://docs.aws.amazon.com/general/latest/gr/api-retries.html) in the Amazon Web Services General Reference.

  • KMSDisabledException The request was rejected because the specified customer master key (CMK) isn't enabled.

  • 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 (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the Amazon Web Services Key Management Service Developer Guide.

  • KMSAccessDeniedException The ciphertext references a key that doesn't exist or that you don't have access to.

  • KMSNotFoundException The request was rejected because the specified entity or resource can't be found.

  • KMSOptInRequired The Amazon Web Services access key ID needs a subscription for the service.

  • KMSThrottlingException The request was denied due to request throttling. For more information about throttling, see Limits (https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second) in the Amazon Web Services Key Management Service Developer Guide.

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

func (*Kinesis) PutRecordsRequest 

func (c *Kinesis) PutRecordsRequest(input *PutRecordsInput) (req *request.Request, output *PutRecordsOutput)

PutRecordsRequest generates a "aws/request.Request" representing the client's request for the PutRecords operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutRecords for more information on using the PutRecords API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

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

func (*Kinesis) PutRecordsWithContext added in v1.8.0 

func (c *Kinesis) PutRecordsWithContext(ctx aws.Context, input *PutRecordsInput, opts ...request.Option) (*PutRecordsOutput, error)

PutRecordsWithContext is the same as PutRecords with the addition of the ability to pass a context and additional request options.

See PutRecords for details on how to use this API operation.

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 (*Kinesis) RegisterStreamConsumer added in v1.15.4 

func (c *Kinesis) RegisterStreamConsumer(input *RegisterStreamConsumerInput) (*RegisterStreamConsumerOutput, error)

RegisterStreamConsumer API operation for Amazon Kinesis.

Registers a consumer with a Kinesis data stream. When you use this operation, the consumer you register can then call SubscribeToShard to receive data from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every shard you subscribe to. This rate is unaffected by the total number of consumers that read from the same stream.

You can register up to 20 consumers per stream. A given consumer can only be registered with one stream at a time.

For an example of how to use this operations, see Enhanced Fan-Out Using the Kinesis Data Streams API (/streams/latest/dev/building-enhanced-consumers-api.html).

The use of this operation has a limit of five transactions per second per account. Also, only 5 consumers can be created simultaneously. In other words, you cannot have more than 5 consumers in a CREATING status at the same time. Registering a 6th consumer while there are 5 in a CREATING status results in a LimitExceededException.

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

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

Returned Error Types:

  • InvalidArgumentException A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

  • LimitExceededException The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

  • ResourceInUseException The resource is not available for this operation. For successful operation, the resource must be in the ACTIVE state.

  • ResourceNotFoundException The requested resource could not be found. The stream might not be specified correctly.

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

func (*Kinesis) RegisterStreamConsumerRequest added in v1.15.4 

func (c *Kinesis) RegisterStreamConsumerRequest(input *RegisterStreamConsumerInput) (req *request.Request, output *RegisterStreamConsumerOutput)

RegisterStreamConsumerRequest generates a "aws/request.Request" representing the client's request for the RegisterStreamConsumer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RegisterStreamConsumer for more information on using the RegisterStreamConsumer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

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

func (*Kinesis) RegisterStreamConsumerWithContext added in v1.15.4 

func (c *Kinesis) RegisterStreamConsumerWithContext(ctx aws.Context, input *RegisterStreamConsumerInput, opts ...request.Option) (*RegisterStreamConsumerOutput, error)

RegisterStreamConsumerWithContext is the same as RegisterStreamConsumer with the addition of the ability to pass a context and additional request options.

See RegisterStreamConsumer for details on how to use this API operation.

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 (*Kinesis) RemoveTagsFromStream 

func (c *Kinesis) RemoveTagsFromStream(input *RemoveTagsFromStreamInput) (*RemoveTagsFromStreamOutput, error)

RemoveTagsFromStream 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.

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

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

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found. The stream might not be specified correctly.

  • ResourceInUseException The resource is not available for this operation. For successful operation, the resource must be in the ACTIVE state.

  • InvalidArgumentException A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

  • LimitExceededException The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

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

func (*Kinesis) RemoveTagsFromStreamRequest 

func (c *Kinesis) RemoveTagsFromStreamRequest(input *RemoveTagsFromStreamInput) (req *request.Request, output *RemoveTagsFromStreamOutput)

RemoveTagsFromStreamRequest generates a "aws/request.Request" representing the client's request for the RemoveTagsFromStream operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RemoveTagsFromStream for more information on using the RemoveTagsFromStream API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

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

func (*Kinesis) RemoveTagsFromStreamWithContext added in v1.8.0 

func (c *Kinesis) RemoveTagsFromStreamWithContext(ctx aws.Context, input *RemoveTagsFromStreamInput, opts ...request.Option) (*RemoveTagsFromStreamOutput, error)

RemoveTagsFromStreamWithContext is the same as RemoveTagsFromStream with the addition of the ability to pass a context and additional request options.

See RemoveTagsFromStream for details on how to use this API operation.

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 (*Kinesis) SplitShard 

func (c *Kinesis) SplitShard(input *SplitShardInput) (*SplitShardOutput, error)

SplitShard 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 (https://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 DescribeStreamSummary and the ListShards APIs 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 DescribeStreamSummary 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 the specified stream does not exist, DescribeStreamSummary 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 Amazon Web Services account, see Kinesis Data Streams Limits (https://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 Amazon Web Services Support (https://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.

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

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

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found. The stream might not be specified correctly.

  • ResourceInUseException The resource is not available for this operation. For successful operation, the resource must be in the ACTIVE state.

  • InvalidArgumentException A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

  • LimitExceededException The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

  • ValidationException

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

func (*Kinesis) SplitShardRequest 

func (c *Kinesis) SplitShardRequest(input *SplitShardInput) (req *request.Request, output *SplitShardOutput)

SplitShardRequest generates a "aws/request.Request" representing the client's request for the SplitShard operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SplitShard for more information on using the SplitShard API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

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

func (*Kinesis) SplitShardWithContext added in v1.8.0 

func (c *Kinesis) SplitShardWithContext(ctx aws.Context, input *SplitShardInput, opts ...request.Option) (*SplitShardOutput, error)

SplitShardWithContext is the same as SplitShard with the addition of the ability to pass a context and additional request options.

See SplitShard for details on how to use this API operation.

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 (*Kinesis) StartStreamEncryption added in v1.10.8 

func (c *Kinesis) StartStreamEncryption(input *StartStreamEncryptionInput) (*StartStreamEncryptionOutput, error)

StartStreamEncryption API operation for Amazon Kinesis.

Enables or updates server-side encryption using an Amazon Web Services 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 Amazon Web Services 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.

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

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

Returned Error Types:

  • InvalidArgumentException A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

  • LimitExceededException The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

  • ResourceInUseException The resource is not available for this operation. For successful operation, the resource must be in the ACTIVE state.

  • ResourceNotFoundException The requested resource could not be found. The stream might not be specified correctly.

  • KMSDisabledException The request was rejected because the specified customer master key (CMK) isn't enabled.

  • 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 (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the Amazon Web Services Key Management Service Developer Guide.

  • KMSAccessDeniedException The ciphertext references a key that doesn't exist or that you don't have access to.

  • KMSNotFoundException The request was rejected because the specified entity or resource can't be found.

  • KMSOptInRequired The Amazon Web Services access key ID needs a subscription for the service.

  • KMSThrottlingException The request was denied due to request throttling. For more information about throttling, see Limits (https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second) in the Amazon Web Services Key Management Service Developer Guide.

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

func (*Kinesis) StartStreamEncryptionRequest added in v1.10.8 

func (c *Kinesis) StartStreamEncryptionRequest(input *StartStreamEncryptionInput) (req *request.Request, output *StartStreamEncryptionOutput)

StartStreamEncryptionRequest generates a "aws/request.Request" representing the client's request for the StartStreamEncryption operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartStreamEncryption for more information on using the StartStreamEncryption API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

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

func (*Kinesis) StartStreamEncryptionWithContext added in v1.10.8 

func (c *Kinesis) StartStreamEncryptionWithContext(ctx aws.Context, input *StartStreamEncryptionInput, opts ...request.Option) (*StartStreamEncryptionOutput, error)

StartStreamEncryptionWithContext is the same as StartStreamEncryption with the addition of the ability to pass a context and additional request options.

See StartStreamEncryption for details on how to use this API operation.

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 (*Kinesis) StopStreamEncryption added in v1.10.8 

func (c *Kinesis) StopStreamEncryption(input *StopStreamEncryptionInput) (*StopStreamEncryptionOutput, error)

StopStreamEncryption 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.

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

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

Returned Error Types:

  • InvalidArgumentException A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

  • LimitExceededException The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

  • ResourceInUseException The resource is not available for this operation. For successful operation, the resource must be in the ACTIVE state.

  • ResourceNotFoundException The requested resource could not be found. The stream might not be specified correctly.

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

func (*Kinesis) StopStreamEncryptionRequest added in v1.10.8 

func (c *Kinesis) StopStreamEncryptionRequest(input *StopStreamEncryptionInput) (req *request.Request, output *StopStreamEncryptionOutput)

StopStreamEncryptionRequest generates a "aws/request.Request" representing the client's request for the StopStreamEncryption operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopStreamEncryption for more information on using the StopStreamEncryption API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

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

func (*Kinesis) StopStreamEncryptionWithContext added in v1.10.8 

func (c *Kinesis) StopStreamEncryptionWithContext(ctx aws.Context, input *StopStreamEncryptionInput, opts ...request.Option) (*StopStreamEncryptionOutput, error)

StopStreamEncryptionWithContext is the same as StopStreamEncryption with the addition of the ability to pass a context and additional request options.

See StopStreamEncryption for details on how to use this API operation.

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 (*Kinesis) SubscribeToShard added in v1.18.0 

func (c *Kinesis) SubscribeToShard(input *SubscribeToShardInput) (*SubscribeToShardOutput, error)

SubscribeToShard API operation for Amazon Kinesis.

This operation establishes an HTTP/2 connection between the consumer you specify in the ConsumerARN parameter and the shard you specify in the ShardId parameter. After the connection is successfully established, Kinesis Data Streams pushes records from the shard to the consumer over this connection. Before you call this operation, call RegisterStreamConsumer to register the consumer with Kinesis Data Streams.

When the SubscribeToShard call succeeds, your consumer starts receiving events of type SubscribeToShardEvent over the HTTP/2 connection for up to 5 minutes, after which time you need to call SubscribeToShard again to renew the subscription if you want to continue to receive records.

You can make one call to SubscribeToShard per second per registered consumer per shard. For example, if you have a 4000 shard stream and two registered stream consumers, you can make one SubscribeToShard request per second for each combination of shard and registered consumer, allowing you to subscribe both consumers to all 4000 shards in one second.

If you call SubscribeToShard again with the same ConsumerARN and ShardId within 5 seconds of a successful call, you'll get a ResourceInUseException. If you call SubscribeToShard 5 seconds or more after a successful call, the second call takes over the subscription and the previous connection expires or fails with a ResourceInUseException.

For an example of how to use this operations, see Enhanced Fan-Out Using the Kinesis Data Streams API (/streams/latest/dev/building-enhanced-consumers-api.html).

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

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

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found. The stream might not be specified correctly.

  • InvalidArgumentException A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

  • ResourceInUseException The resource is not available for this operation. For successful operation, the resource must be in the ACTIVE state.

  • LimitExceededException The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/SubscribeToShard

func (*Kinesis) SubscribeToShardRequest added in v1.18.0 

func (c *Kinesis) SubscribeToShardRequest(input *SubscribeToShardInput) (req *request.Request, output *SubscribeToShardOutput)

SubscribeToShardRequest generates a "aws/request.Request" representing the client's request for the SubscribeToShard operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See SubscribeToShard for more information on using the SubscribeToShard API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/SubscribeToShard

func (*Kinesis) SubscribeToShardWithContext added in v1.18.0 

func (c *Kinesis) SubscribeToShardWithContext(ctx aws.Context, input *SubscribeToShardInput, opts ...request.Option) (*SubscribeToShardOutput, error)

SubscribeToShardWithContext is the same as SubscribeToShard with the addition of the ability to pass a context and additional request options.

See SubscribeToShard for details on how to use this API operation.

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 (*Kinesis) UpdateShardCount added in v1.5.5 

func (c *Kinesis) UpdateShardCount(input *UpdateShardCountInput) (*UpdateShardCountOutput, error)

UpdateShardCount 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. These short-lived shards count towards your total shard limit for your account in the Region.

When using this operation, we recommend that you specify a target shard count that is a multiple of 25% (25%, 50%, 75%, 100%). You can specify any target value within your shard limit. However, if you specify a target that isn't a multiple of 25%, the scaling action might take longer to complete.

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

  • Scale more than ten times 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 10000 shards in a stream

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

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

For the default limits for an Amazon Web Services account, see Streams Limits (https://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).

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

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

Returned Error Types:

  • InvalidArgumentException A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

  • LimitExceededException The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

  • ResourceInUseException The resource is not available for this operation. For successful operation, the resource must be in the ACTIVE state.

  • ResourceNotFoundException The requested resource could not be found. The stream might not be specified correctly.

  • ValidationException

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

func (*Kinesis) UpdateShardCountRequest added in v1.5.5 

func (c *Kinesis) UpdateShardCountRequest(input *UpdateShardCountInput) (req *request.Request, output *UpdateShardCountOutput)

UpdateShardCountRequest generates a "aws/request.Request" representing the client's request for the UpdateShardCount operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateShardCount for more information on using the UpdateShardCount API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

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

func (*Kinesis) UpdateShardCountWithContext added in v1.8.0 

func (c *Kinesis) UpdateShardCountWithContext(ctx aws.Context, input *UpdateShardCountInput, opts ...request.Option) (*UpdateShardCountOutput, error)

UpdateShardCountWithContext is the same as UpdateShardCount with the addition of the ability to pass a context and additional request options.

See UpdateShardCount for details on how to use this API operation.

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 (*Kinesis) UpdateStreamMode added in v1.42.16 

func (c *Kinesis) UpdateStreamMode(input *UpdateStreamModeInput) (*UpdateStreamModeOutput, error)

UpdateStreamMode API operation for Amazon Kinesis.

Updates the capacity mode of the data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data stream.

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

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

Returned Error Types:

  • InvalidArgumentException A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

  • LimitExceededException The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

  • ResourceInUseException The resource is not available for this operation. For successful operation, the resource must be in the ACTIVE state.

  • ResourceNotFoundException The requested resource could not be found. The stream might not be specified correctly.

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/UpdateStreamMode

func (*Kinesis) UpdateStreamModeRequest added in v1.42.16 

func (c *Kinesis) UpdateStreamModeRequest(input *UpdateStreamModeInput) (req *request.Request, output *UpdateStreamModeOutput)

UpdateStreamModeRequest generates a "aws/request.Request" representing the client's request for the UpdateStreamMode operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateStreamMode for more information on using the UpdateStreamMode API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/UpdateStreamMode

func (*Kinesis) UpdateStreamModeWithContext added in v1.42.16 

func (c *Kinesis) UpdateStreamModeWithContext(ctx aws.Context, input *UpdateStreamModeInput, opts ...request.Option) (*UpdateStreamModeOutput, error)

UpdateStreamModeWithContext is the same as UpdateStreamMode with the addition of the ability to pass a context and additional request options.

See UpdateStreamMode for details on how to use this API operation.

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 (*Kinesis) WaitUntilStreamExists added in v0.10.3 

func (c *Kinesis) WaitUntilStreamExists(input *DescribeStreamInput) 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.

func (*Kinesis) WaitUntilStreamExistsWithContext added in v1.8.0 

func (c *Kinesis) WaitUntilStreamExistsWithContext(ctx aws.Context, input *DescribeStreamInput, opts ...request.WaiterOption) error

WaitUntilStreamExistsWithContext is an extended version of WaitUntilStreamExists. With the support for passing in a context and options to configure the Waiter and the underlying request options.

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 (*Kinesis) WaitUntilStreamNotExists added in v1.8.16 

func (c *Kinesis) WaitUntilStreamNotExists(input *DescribeStreamInput) 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.

func (*Kinesis) WaitUntilStreamNotExistsWithContext added in v1.8.16 

func (c *Kinesis) WaitUntilStreamNotExistsWithContext(ctx aws.Context, input *DescribeStreamInput, opts ...request.WaiterOption) error

WaitUntilStreamNotExistsWithContext is an extended version of WaitUntilStreamNotExists. With the support for passing in a context and options to configure the Waiter and the underlying request options.

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 LimitExceededException added in v1.28.0 

type LimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A message that provides information about the error.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

func (*LimitExceededException) Code added in v1.28.0 

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error added in v1.28.0 

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString added in v1.28.0 

func (s LimitExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LimitExceededException) Message added in v1.28.0 

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr added in v1.28.0 

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID added in v1.28.0 

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode added in v1.28.0 

func (s *LimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (LimitExceededException) String added in v1.28.0 

func (s LimitExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListShardsInput added in v1.12.71 

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
	// maximum number of shards to return in a single call. The default value is
	// 1000. If you specify a value greater than 1000, at most 1000 results are
	// returned.
	//
	// 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"`

	// Enables you to filter out the response of the ListShards API. You can only
	// specify one filter at a time.
	//
	// If you use the ShardFilter parameter when invoking the ListShards API, the
	// Type is the required property and must be specified. If you specify the AT_TRIM_HORIZON,
	// FROM_TRIM_HORIZON, or AT_LATEST types, you do not need to specify either
	// the ShardId or the Timestamp optional properties.
	//
	// If you specify the AFTER_SHARD_ID type, you must also provide the value for
	// the optional ShardId property. The ShardId property is identical in fuctionality
	// to the ExclusiveStartShardId parameter of the ListShards API. When ShardId
	// property is specified, the response includes the shards starting with the
	// shard whose ID immediately follows the ShardId that you provided.
	//
	// If you specify the AT_TIMESTAMP or FROM_TIMESTAMP_ID type, you must also
	// provide the value for the optional Timestamp property. If you specify the
	// AT_TIMESTAMP type, then all shards that were open at the provided timestamp
	// are returned. If you specify the FROM_TIMESTAMP type, then all shards starting
	// from the provided timestamp to TIP are returned.
	ShardFilter *ShardFilter `type:"structure"`

	// 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) GoString added in v1.12.71 

func (s ListShardsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListShardsInput) SetExclusiveStartShardId added in v1.12.71 

func (s *ListShardsInput) SetExclusiveStartShardId(v string) *ListShardsInput

SetExclusiveStartShardId sets the ExclusiveStartShardId field's value.

func (*ListShardsInput) SetMaxResults added in v1.12.71 

func (s *ListShardsInput) SetMaxResults(v int64) *ListShardsInput

SetMaxResults sets the MaxResults field's value.

func (*ListShardsInput) SetNextToken added in v1.12.71 

func (s *ListShardsInput) SetNextToken(v string) *ListShardsInput

SetNextToken sets the NextToken field's value.

func (*ListShardsInput) SetShardFilter added in v1.34.6 

func (s *ListShardsInput) SetShardFilter(v *ShardFilter) *ListShardsInput

SetShardFilter sets the ShardFilter field's value.

func (*ListShardsInput) SetStreamCreationTimestamp added in v1.12.71 

func (s *ListShardsInput) SetStreamCreationTimestamp(v time.Time) *ListShardsInput

SetStreamCreationTimestamp sets the StreamCreationTimestamp field's value.

func (*ListShardsInput) SetStreamName added in v1.12.71 

func (s *ListShardsInput) SetStreamName(v string) *ListShardsInput

SetStreamName sets the StreamName field's value.

func (ListShardsInput) String added in v1.12.71 

func (s ListShardsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListShardsInput) Validate added in v1.12.71 

func (s *ListShardsInput) Validate() error

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

type ListShardsOutput added in v1.12.71 

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) GoString added in v1.12.71 

func (s ListShardsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListShardsOutput) SetNextToken added in v1.12.71 

func (s *ListShardsOutput) SetNextToken(v string) *ListShardsOutput

SetNextToken sets the NextToken field's value.

func (*ListShardsOutput) SetShards added in v1.12.71 

func (s *ListShardsOutput) SetShards(v []*Shard) *ListShardsOutput

SetShards sets the Shards field's value.

func (ListShardsOutput) String added in v1.12.71 

func (s ListShardsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListStreamConsumersInput added in v1.15.4 

type ListStreamConsumersInput struct {

	// The maximum number of consumers that you want a single call of ListStreamConsumers
	// to return. The default value is 100. If you specify a value greater than
	// 100, at most 100 results are returned.
	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 Amazon
	// Web Services 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) GoString added in v1.15.4 

func (s ListStreamConsumersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStreamConsumersInput) SetMaxResults added in v1.15.4 

func (s *ListStreamConsumersInput) SetMaxResults(v int64) *ListStreamConsumersInput

SetMaxResults sets the MaxResults field's value.

func (*ListStreamConsumersInput) SetNextToken added in v1.15.4 

func (s *ListStreamConsumersInput) SetNextToken(v string) *ListStreamConsumersInput

SetNextToken sets the NextToken field's value.

func (*ListStreamConsumersInput) SetStreamARN added in v1.15.4 

func (s *ListStreamConsumersInput) SetStreamARN(v string) *ListStreamConsumersInput

SetStreamARN sets the StreamARN field's value.

func (*ListStreamConsumersInput) SetStreamCreationTimestamp added in v1.15.4 

func (s *ListStreamConsumersInput) SetStreamCreationTimestamp(v time.Time) *ListStreamConsumersInput

SetStreamCreationTimestamp sets the StreamCreationTimestamp field's value.

func (ListStreamConsumersInput) String added in v1.15.4 

func (s ListStreamConsumersInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStreamConsumersInput) Validate added in v1.15.4 

func (s *ListStreamConsumersInput) Validate() error

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

type ListStreamConsumersOutput added in v1.15.4 

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) GoString added in v1.15.4 

func (s ListStreamConsumersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStreamConsumersOutput) SetConsumers added in v1.15.4 

func (s *ListStreamConsumersOutput) SetConsumers(v []*Consumer) *ListStreamConsumersOutput

SetConsumers sets the Consumers field's value.

func (*ListStreamConsumersOutput) SetNextToken added in v1.15.4 

func (s *ListStreamConsumersOutput) SetNextToken(v string) *ListStreamConsumersOutput

SetNextToken sets the NextToken field's value.

func (ListStreamConsumersOutput) String added in v1.15.4 

func (s ListStreamConsumersOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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. The default value is 100. If you specify
	// a value greater than 100, at most 100 results are returned.
	Limit *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

Represents the input for ListStreams.

func (ListStreamsInput) GoString added in v0.6.5 

func (s ListStreamsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStreamsInput) SetExclusiveStartStreamName added in v1.5.0 

func (s *ListStreamsInput) SetExclusiveStartStreamName(v string) *ListStreamsInput

SetExclusiveStartStreamName sets the ExclusiveStartStreamName field's value.

func (*ListStreamsInput) SetLimit added in v1.5.0 

func (s *ListStreamsInput) SetLimit(v int64) *ListStreamsInput

SetLimit sets the Limit field's value.

func (ListStreamsInput) String added in v0.6.5 

func (s ListStreamsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStreamsInput) Validate added in v1.1.21 

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 Amazon Web Services
	// 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) GoString added in v0.6.5 

func (s ListStreamsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListStreamsOutput) SetHasMoreStreams added in v1.5.0 

func (s *ListStreamsOutput) SetHasMoreStreams(v bool) *ListStreamsOutput

SetHasMoreStreams sets the HasMoreStreams field's value.

func (*ListStreamsOutput) SetStreamNames added in v1.5.0 

func (s *ListStreamsOutput) SetStreamNames(v []*string) *ListStreamsOutput

SetStreamNames sets the StreamNames field's value.

func (ListStreamsOutput) String added in v0.6.5 

func (s ListStreamsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString added in v0.6.5 

func (s ListTagsForStreamInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForStreamInput) SetExclusiveStartTagKey added in v1.5.0 

func (s *ListTagsForStreamInput) SetExclusiveStartTagKey(v string) *ListTagsForStreamInput

SetExclusiveStartTagKey sets the ExclusiveStartTagKey field's value.

func (*ListTagsForStreamInput) SetLimit added in v1.5.0 

func (s *ListTagsForStreamInput) SetLimit(v int64) *ListTagsForStreamInput

SetLimit sets the Limit field's value.

func (*ListTagsForStreamInput) SetStreamName added in v1.5.0 

func (s *ListTagsForStreamInput) SetStreamName(v string) *ListTagsForStreamInput

SetStreamName sets the StreamName field's value.

func (ListTagsForStreamInput) String added in v0.6.5 

func (s ListTagsForStreamInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForStreamInput) Validate added in v1.1.21 

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) GoString added in v0.6.5 

func (s ListTagsForStreamOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForStreamOutput) SetHasMoreTags added in v1.5.0 

func (s *ListTagsForStreamOutput) SetHasMoreTags(v bool) *ListTagsForStreamOutput

SetHasMoreTags sets the HasMoreTags field's value.

func (*ListTagsForStreamOutput) SetTags added in v1.5.0 

func (s *ListTagsForStreamOutput) SetTags(v []*Tag) *ListTagsForStreamOutput

SetTags sets the Tags field's value.

func (ListTagsForStreamOutput) String added in v0.6.5 

func (s ListTagsForStreamOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString added in v0.6.5 

func (s MergeShardsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MergeShardsInput) SetAdjacentShardToMerge added in v1.5.0 

func (s *MergeShardsInput) SetAdjacentShardToMerge(v string) *MergeShardsInput

SetAdjacentShardToMerge sets the AdjacentShardToMerge field's value.

func (*MergeShardsInput) SetShardToMerge added in v1.5.0 

func (s *MergeShardsInput) SetShardToMerge(v string) *MergeShardsInput

SetShardToMerge sets the ShardToMerge field's value.

func (*MergeShardsInput) SetStreamName added in v1.5.0 

func (s *MergeShardsInput) SetStreamName(v string) *MergeShardsInput

SetStreamName sets the StreamName field's value.

func (MergeShardsInput) String added in v0.6.5 

func (s MergeShardsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MergeShardsInput) Validate added in v1.1.21 

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) GoString added in v0.6.5 

func (s MergeShardsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (MergeShardsOutput) String added in v0.6.5 

func (s MergeShardsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ProvisionedThroughputExceededException added in v1.28.0 

type ProvisionedThroughputExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A message that provides information about the error.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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 (https://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 Amazon Web Services (https://docs.aws.amazon.com/general/latest/gr/api-retries.html) in the Amazon Web Services General Reference.

func (*ProvisionedThroughputExceededException) Code added in v1.28.0 

func (s *ProvisionedThroughputExceededException) Code() string

Code returns the exception type name.

func (*ProvisionedThroughputExceededException) Error added in v1.28.0 

func (s *ProvisionedThroughputExceededException) Error() string

func (ProvisionedThroughputExceededException) GoString added in v1.28.0 

func (s ProvisionedThroughputExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ProvisionedThroughputExceededException) Message added in v1.28.0 

func (s *ProvisionedThroughputExceededException) Message() string

Message returns the exception's message.

func (*ProvisionedThroughputExceededException) OrigErr added in v1.28.0 

func (s *ProvisionedThroughputExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ProvisionedThroughputExceededException) RequestID added in v1.28.0 

func (s *ProvisionedThroughputExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ProvisionedThroughputExceededException) StatusCode added in v1.28.0 

func (s *ProvisionedThroughputExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ProvisionedThroughputExceededException) String added in v1.28.0 

func (s ProvisionedThroughputExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 MiB).
	// 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) GoString added in v0.6.5 

func (s PutRecordInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutRecordInput) SetData added in v1.5.0 

func (s *PutRecordInput) SetData(v []byte) *PutRecordInput

SetData sets the Data field's value.

func (*PutRecordInput) SetExplicitHashKey added in v1.5.0 

func (s *PutRecordInput) SetExplicitHashKey(v string) *PutRecordInput

SetExplicitHashKey sets the ExplicitHashKey field's value.

func (*PutRecordInput) SetPartitionKey added in v1.5.0 

func (s *PutRecordInput) SetPartitionKey(v string) *PutRecordInput

SetPartitionKey sets the PartitionKey field's value.

func (*PutRecordInput) SetSequenceNumberForOrdering added in v1.5.0 

func (s *PutRecordInput) SetSequenceNumberForOrdering(v string) *PutRecordInput

SetSequenceNumberForOrdering sets the SequenceNumberForOrdering field's value.

func (*PutRecordInput) SetStreamName added in v1.5.0 

func (s *PutRecordInput) SetStreamName(v string) *PutRecordInput

SetStreamName sets the StreamName field's value.

func (PutRecordInput) String added in v0.6.5 

func (s PutRecordInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutRecordInput) Validate added in v1.1.21 

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 Amazon Web Services KMS key.
	EncryptionType *string `type:"string" enum:"EncryptionType"`

	// 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) GoString added in v0.6.5 

func (s PutRecordOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutRecordOutput) SetEncryptionType added in v1.10.8 

func (s *PutRecordOutput) SetEncryptionType(v string) *PutRecordOutput

SetEncryptionType sets the EncryptionType field's value.

func (*PutRecordOutput) SetSequenceNumber added in v1.5.0 

func (s *PutRecordOutput) SetSequenceNumber(v string) *PutRecordOutput

SetSequenceNumber sets the SequenceNumber field's value.

func (*PutRecordOutput) SetShardId added in v1.5.0 

func (s *PutRecordOutput) SetShardId(v string) *PutRecordOutput

SetShardId sets the ShardId field's value.

func (PutRecordOutput) String added in v0.6.5 

func (s PutRecordOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString added in v0.6.5 

func (s PutRecordsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutRecordsInput) SetRecords added in v1.5.0 

func (s *PutRecordsInput) SetRecords(v []*PutRecordsRequestEntry) *PutRecordsInput

SetRecords sets the Records field's value.

func (*PutRecordsInput) SetStreamName added in v1.5.0 

func (s *PutRecordsInput) SetStreamName(v string) *PutRecordsInput

SetStreamName sets the StreamName field's value.

func (PutRecordsInput) String added in v0.6.5 

func (s PutRecordsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutRecordsInput) Validate added in v1.1.21 

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
	//    Amazon Web Services KMS key.
	EncryptionType *string `type:"string" enum:"EncryptionType"`

	// 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. 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) GoString added in v0.6.5 

func (s PutRecordsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutRecordsOutput) SetEncryptionType added in v1.10.8 

func (s *PutRecordsOutput) SetEncryptionType(v string) *PutRecordsOutput

SetEncryptionType sets the EncryptionType field's value.

func (*PutRecordsOutput) SetFailedRecordCount added in v1.5.0 

func (s *PutRecordsOutput) SetFailedRecordCount(v int64) *PutRecordsOutput

SetFailedRecordCount sets the FailedRecordCount field's value.

func (*PutRecordsOutput) SetRecords added in v1.5.0 

func (s *PutRecordsOutput) SetRecords(v []*PutRecordsResultEntry) *PutRecordsOutput

SetRecords sets the Records field's value.

func (PutRecordsOutput) String added in v0.6.5 

func (s PutRecordsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 MiB).
	// 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) GoString added in v0.6.5 

func (s PutRecordsRequestEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutRecordsRequestEntry) SetData added in v1.5.0 

func (s *PutRecordsRequestEntry) SetData(v []byte) *PutRecordsRequestEntry

SetData sets the Data field's value.

func (*PutRecordsRequestEntry) SetExplicitHashKey added in v1.5.0 

func (s *PutRecordsRequestEntry) SetExplicitHashKey(v string) *PutRecordsRequestEntry

SetExplicitHashKey sets the ExplicitHashKey field's value.

func (*PutRecordsRequestEntry) SetPartitionKey added in v1.5.0 

func (s *PutRecordsRequestEntry) SetPartitionKey(v string) *PutRecordsRequestEntry

SetPartitionKey sets the PartitionKey field's value.

func (PutRecordsRequestEntry) String added in v0.6.5 

func (s PutRecordsRequestEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutRecordsRequestEntry) Validate added in v1.1.21 

func (s *PutRecordsRequestEntry) Validate() error

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

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) GoString added in v0.6.5 

func (s PutRecordsResultEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutRecordsResultEntry) SetErrorCode added in v1.5.0 

func (s *PutRecordsResultEntry) SetErrorCode(v string) *PutRecordsResultEntry

SetErrorCode sets the ErrorCode field's value.

func (*PutRecordsResultEntry) SetErrorMessage added in v1.5.0 

func (s *PutRecordsResultEntry) SetErrorMessage(v string) *PutRecordsResultEntry

SetErrorMessage sets the ErrorMessage field's value.

func (*PutRecordsResultEntry) SetSequenceNumber added in v1.5.0 

func (s *PutRecordsResultEntry) SetSequenceNumber(v string) *PutRecordsResultEntry

SetSequenceNumber sets the SequenceNumber field's value.

func (*PutRecordsResultEntry) SetShardId added in v1.5.0 

func (s *PutRecordsResultEntry) SetShardId(v string) *PutRecordsResultEntry

SetShardId sets the ShardId field's value.

func (PutRecordsResultEntry) String added in v0.6.5 

func (s PutRecordsResultEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 MiB).
	// 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 Amazon Web Services KMS key.
	EncryptionType *string `type:"string" enum:"EncryptionType"`

	// 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) GoString added in v0.6.5 

func (s Record) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Record) SetApproximateArrivalTimestamp added in v1.5.0 

func (s *Record) SetApproximateArrivalTimestamp(v time.Time) *Record

SetApproximateArrivalTimestamp sets the ApproximateArrivalTimestamp field's value.

func (*Record) SetData added in v1.5.0 

func (s *Record) SetData(v []byte) *Record

SetData sets the Data field's value.

func (*Record) SetEncryptionType added in v1.10.8 

func (s *Record) SetEncryptionType(v string) *Record

SetEncryptionType sets the EncryptionType field's value.

func (*Record) SetPartitionKey added in v1.5.0 

func (s *Record) SetPartitionKey(v string) *Record

SetPartitionKey sets the PartitionKey field's value.

func (*Record) SetSequenceNumber added in v1.5.0 

func (s *Record) SetSequenceNumber(v string) *Record

SetSequenceNumber sets the SequenceNumber field's value.

func (Record) String added in v0.6.5 

func (s Record) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RegisterStreamConsumerInput added in v1.15.4 

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 Amazon Web Services
	// 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) GoString added in v1.15.4 

func (s RegisterStreamConsumerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegisterStreamConsumerInput) SetConsumerName added in v1.15.4 

func (s *RegisterStreamConsumerInput) SetConsumerName(v string) *RegisterStreamConsumerInput

SetConsumerName sets the ConsumerName field's value.

func (*RegisterStreamConsumerInput) SetStreamARN added in v1.15.4 

func (s *RegisterStreamConsumerInput) SetStreamARN(v string) *RegisterStreamConsumerInput

SetStreamARN sets the StreamARN field's value.

func (RegisterStreamConsumerInput) String added in v1.15.4 

func (s RegisterStreamConsumerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegisterStreamConsumerInput) Validate added in v1.15.4 

func (s *RegisterStreamConsumerInput) Validate() error

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

type RegisterStreamConsumerOutput added in v1.15.4 

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) GoString added in v1.15.4 

func (s RegisterStreamConsumerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegisterStreamConsumerOutput) SetConsumer added in v1.15.4 

func (s *RegisterStreamConsumerOutput) SetConsumer(v *Consumer) *RegisterStreamConsumerOutput

SetConsumer sets the Consumer field's value.

func (RegisterStreamConsumerOutput) String added in v1.15.4 

func (s RegisterStreamConsumerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString added in v0.6.5 

func (s RemoveTagsFromStreamInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RemoveTagsFromStreamInput) SetStreamName added in v1.5.0 

func (s *RemoveTagsFromStreamInput) SetStreamName(v string) *RemoveTagsFromStreamInput

SetStreamName sets the StreamName field's value.

func (*RemoveTagsFromStreamInput) SetTagKeys added in v1.5.0 

func (s *RemoveTagsFromStreamInput) SetTagKeys(v []*string) *RemoveTagsFromStreamInput

SetTagKeys sets the TagKeys field's value.

func (RemoveTagsFromStreamInput) String added in v0.6.5 

func (s RemoveTagsFromStreamInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RemoveTagsFromStreamInput) Validate added in v1.1.21 

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) GoString added in v0.6.5 

func (s RemoveTagsFromStreamOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (RemoveTagsFromStreamOutput) String added in v0.6.5 

func (s RemoveTagsFromStreamOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceInUseException added in v1.18.0 

type ResourceInUseException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A message that provides information about the error.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The resource is not available for this operation. For successful operation, the resource must be in the ACTIVE state.

func (*ResourceInUseException) Code added in v1.18.0 

func (s *ResourceInUseException) Code() string

Code returns the exception type name.

func (*ResourceInUseException) Error added in v1.18.0 

func (s *ResourceInUseException) Error() string

func (ResourceInUseException) GoString added in v1.18.0 

func (s ResourceInUseException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceInUseException) MarshalEvent added in v1.27.0 

func (s *ResourceInUseException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*ResourceInUseException) Message added in v1.18.0 

func (s *ResourceInUseException) Message() string

Message returns the exception's message.

func (*ResourceInUseException) OrigErr added in v1.18.0 

func (s *ResourceInUseException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceInUseException) RequestID added in v1.28.0 

func (s *ResourceInUseException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceInUseException) StatusCode added in v1.28.0 

func (s *ResourceInUseException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceInUseException) String added in v1.18.0 

func (s ResourceInUseException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceInUseException) UnmarshalEvent added in v1.18.0 

func (s *ResourceInUseException) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the ResourceInUseException value. This method is only used internally within the SDK's EventStream handling.

type ResourceNotFoundException added in v1.18.0 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A message that provides information about the error.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The requested resource could not be found. The stream might not be specified correctly.

func (*ResourceNotFoundException) Code added in v1.18.0 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.18.0 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.18.0 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) MarshalEvent added in v1.27.0 

func (s *ResourceNotFoundException) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*ResourceNotFoundException) Message added in v1.18.0 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.18.0 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.28.0 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.28.0 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String added in v1.18.0 

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) UnmarshalEvent added in v1.18.0 

func (s *ResourceNotFoundException) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the ResourceNotFoundException value. This method is only used internally within the SDK's EventStream handling.

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) GoString added in v0.6.5 

func (s SequenceNumberRange) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SequenceNumberRange) SetEndingSequenceNumber added in v1.5.0 

func (s *SequenceNumberRange) SetEndingSequenceNumber(v string) *SequenceNumberRange

SetEndingSequenceNumber sets the EndingSequenceNumber field's value.

func (*SequenceNumberRange) SetStartingSequenceNumber added in v1.5.0 

func (s *SequenceNumberRange) SetStartingSequenceNumber(v string) *SequenceNumberRange

SetStartingSequenceNumber sets the StartingSequenceNumber field's value.

func (SequenceNumberRange) String added in v0.6.5 

func (s SequenceNumberRange) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString added in v0.6.5 

func (s Shard) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Shard) SetAdjacentParentShardId added in v1.5.0 

func (s *Shard) SetAdjacentParentShardId(v string) *Shard

SetAdjacentParentShardId sets the AdjacentParentShardId field's value.

func (*Shard) SetHashKeyRange added in v1.5.0 

func (s *Shard) SetHashKeyRange(v *HashKeyRange) *Shard

SetHashKeyRange sets the HashKeyRange field's value.

func (*Shard) SetParentShardId added in v1.5.0 

func (s *Shard) SetParentShardId(v string) *Shard

SetParentShardId sets the ParentShardId field's value.

func (*Shard) SetSequenceNumberRange added in v1.5.0 

func (s *Shard) SetSequenceNumberRange(v *SequenceNumberRange) *Shard

SetSequenceNumberRange sets the SequenceNumberRange field's value.

func (*Shard) SetShardId added in v1.5.0 

func (s *Shard) SetShardId(v string) *Shard

SetShardId sets the ShardId field's value.

func (Shard) String added in v0.6.5 

func (s Shard) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ShardFilter added in v1.34.6 

type ShardFilter struct {

	// The exclusive start shardID speified in the ShardFilter parameter. This property
	// can only be used if the AFTER_SHARD_ID shard type is specified.
	ShardId *string `min:"1" type:"string"`

	// The timestamps specified in the ShardFilter parameter. A timestamp is a Unix
	// epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00
	// or 1459799926.480. This property can only be used if FROM_TIMESTAMP or AT_TIMESTAMP
	// shard types are specified.
	Timestamp *time.Time `type:"timestamp"`

	// The shard type specified in the ShardFilter parameter. This is a required
	// property of the ShardFilter parameter.
	//
	// You can specify the following valid values:
	//
	//    * AFTER_SHARD_ID - the response includes all the shards, starting with
	//    the shard whose ID immediately follows the ShardId that you provided.
	//
	//    * AT_TRIM_HORIZON - the response includes all the shards that were open
	//    at TRIM_HORIZON.
	//
	//    * FROM_TRIM_HORIZON - (default), the response includes all the shards
	//    within the retention period of the data stream (trim to tip).
	//
	//    * AT_LATEST - the response includes only the currently open shards of
	//    the data stream.
	//
	//    * AT_TIMESTAMP - the response includes all shards whose start timestamp
	//    is less than or equal to the given timestamp and end timestamp is greater
	//    than or equal to the given timestamp or still open.
	//
	//    * FROM_TIMESTAMP - the response incldues all closed shards whose end timestamp
	//    is greater than or equal to the given timestamp and also all open shards.
	//    Corrected to TRIM_HORIZON of the data stream if FROM_TIMESTAMP is less
	//    than the TRIM_HORIZON value.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"ShardFilterType"`
	// contains filtered or unexported fields
}

The request parameter used to filter out the response of the ListShards API.

func (ShardFilter) GoString added in v1.34.6 

func (s ShardFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ShardFilter) SetShardId added in v1.34.6 

func (s *ShardFilter) SetShardId(v string) *ShardFilter

SetShardId sets the ShardId field's value.

func (*ShardFilter) SetTimestamp added in v1.34.6 

func (s *ShardFilter) SetTimestamp(v time.Time) *ShardFilter

SetTimestamp sets the Timestamp field's value.

func (*ShardFilter) SetType added in v1.34.6 

func (s *ShardFilter) SetType(v string) *ShardFilter

SetType sets the Type field's value.

func (ShardFilter) String added in v1.34.6 

func (s ShardFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ShardFilter) Validate added in v1.34.6 

func (s *ShardFilter) Validate() error

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

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) GoString added in v0.6.5 

func (s SplitShardInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SplitShardInput) SetNewStartingHashKey added in v1.5.0 

func (s *SplitShardInput) SetNewStartingHashKey(v string) *SplitShardInput

SetNewStartingHashKey sets the NewStartingHashKey field's value.

func (*SplitShardInput) SetShardToSplit added in v1.5.0 

func (s *SplitShardInput) SetShardToSplit(v string) *SplitShardInput

SetShardToSplit sets the ShardToSplit field's value.

func (*SplitShardInput) SetStreamName added in v1.5.0 

func (s *SplitShardInput) SetStreamName(v string) *SplitShardInput

SetStreamName sets the StreamName field's value.

func (SplitShardInput) String added in v0.6.5 

func (s SplitShardInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SplitShardInput) Validate added in v1.1.21 

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) GoString added in v0.6.5 

func (s SplitShardOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (SplitShardOutput) String added in v0.6.5 

func (s SplitShardOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartStreamEncryptionInput added in v1.10.8 

type StartStreamEncryptionInput struct {

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

	// The GUID for the customer-managed Amazon Web Services 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) GoString added in v1.10.8 

func (s StartStreamEncryptionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartStreamEncryptionInput) SetEncryptionType added in v1.10.8 

func (s *StartStreamEncryptionInput) SetEncryptionType(v string) *StartStreamEncryptionInput

SetEncryptionType sets the EncryptionType field's value.

func (*StartStreamEncryptionInput) SetKeyId added in v1.10.8 

func (s *StartStreamEncryptionInput) SetKeyId(v string) *StartStreamEncryptionInput

SetKeyId sets the KeyId field's value.

func (*StartStreamEncryptionInput) SetStreamName added in v1.10.8 

func (s *StartStreamEncryptionInput) SetStreamName(v string) *StartStreamEncryptionInput

SetStreamName sets the StreamName field's value.

func (StartStreamEncryptionInput) String added in v1.10.8 

func (s StartStreamEncryptionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartStreamEncryptionInput) Validate added in v1.10.8 

func (s *StartStreamEncryptionInput) Validate() error

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

type StartStreamEncryptionOutput added in v1.10.8 

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

func (StartStreamEncryptionOutput) GoString added in v1.10.8 

func (s StartStreamEncryptionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (StartStreamEncryptionOutput) String added in v1.10.8 

func (s StartStreamEncryptionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartingPosition added in v1.18.0 

type StartingPosition struct {

	// The sequence number of the data record in the shard from which to start streaming.
	// To specify a sequence number, set StartingPosition to AT_SEQUENCE_NUMBER
	// or AFTER_SEQUENCE_NUMBER.
	SequenceNumber *string `type:"string"`

	// The time stamp of the data record from which to start reading. To specify
	// a time stamp, set StartingPosition to 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,
	// records will be streamed from the next (later) record. If the time stamp
	// is older than the current trim horizon, records will be streamed from the
	// oldest untrimmed data record (TRIM_HORIZON).
	Timestamp *time.Time `type:"timestamp"`

	// You can set the starting position to one of the following values:
	//
	// AT_SEQUENCE_NUMBER: Start streaming from the position denoted by the sequence
	// number specified in the SequenceNumber field.
	//
	// AFTER_SEQUENCE_NUMBER: Start streaming right after the position denoted by
	// the sequence number specified in the SequenceNumber field.
	//
	// AT_TIMESTAMP: Start streaming from the position denoted by the time stamp
	// specified in the Timestamp field.
	//
	// TRIM_HORIZON: Start streaming at the last untrimmed record in the shard,
	// which is the oldest data record in the shard.
	//
	// LATEST: Start streaming just after the most recent record in the shard, so
	// that you always read the most recent data in the shard.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"ShardIteratorType"`
	// contains filtered or unexported fields
}

The starting position in the data stream from which to start streaming.

func (StartingPosition) GoString added in v1.18.0 

func (s StartingPosition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartingPosition) SetSequenceNumber added in v1.18.0 

func (s *StartingPosition) SetSequenceNumber(v string) *StartingPosition

SetSequenceNumber sets the SequenceNumber field's value.

func (*StartingPosition) SetTimestamp added in v1.18.0 

func (s *StartingPosition) SetTimestamp(v time.Time) *StartingPosition

SetTimestamp sets the Timestamp field's value.

func (*StartingPosition) SetType added in v1.18.0 

func (s *StartingPosition) SetType(v string) *StartingPosition

SetType sets the Type field's value.

func (StartingPosition) String added in v1.18.0 

func (s StartingPosition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartingPosition) Validate added in v1.18.0 

func (s *StartingPosition) Validate() error

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

type StopStreamEncryptionInput added in v1.10.8 

type StopStreamEncryptionInput struct {

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

	// The GUID for the customer-managed Amazon Web Services 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) GoString added in v1.10.8 

func (s StopStreamEncryptionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopStreamEncryptionInput) SetEncryptionType added in v1.10.8 

func (s *StopStreamEncryptionInput) SetEncryptionType(v string) *StopStreamEncryptionInput

SetEncryptionType sets the EncryptionType field's value.

func (*StopStreamEncryptionInput) SetKeyId added in v1.10.8 

func (s *StopStreamEncryptionInput) SetKeyId(v string) *StopStreamEncryptionInput

SetKeyId sets the KeyId field's value.

func (*StopStreamEncryptionInput) SetStreamName added in v1.10.8 

func (s *StopStreamEncryptionInput) SetStreamName(v string) *StopStreamEncryptionInput

SetStreamName sets the StreamName field's value.

func (StopStreamEncryptionInput) String added in v1.10.8 

func (s StopStreamEncryptionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopStreamEncryptionInput) Validate added in v1.10.8 

func (s *StopStreamEncryptionInput) Validate() error

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

type StopStreamEncryptionOutput added in v1.10.8 

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

func (StopStreamEncryptionOutput) GoString added in v1.10.8 

func (s StopStreamEncryptionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (StopStreamEncryptionOutput) String added in v1.10.8 

func (s StopStreamEncryptionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon Web Services KMS key.
	EncryptionType *string `type:"string" enum:"EncryptionType"`

	// 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 Amazon Web Services 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. Minimum value of 24. Maximum value
	// of 168.
	//
	// RetentionPeriodHours is a required field
	RetentionPeriodHours *int64 `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"`

	// Specifies the capacity mode to which you want to set your data stream. Currently,
	// in Kinesis Data Streams, you can choose between an on-demand capacity mode
	// and a provisioned capacity mode for your data streams.
	StreamModeDetails *StreamModeDetails `type:"structure"`

	// 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 *string `type:"string" required:"true" enum:"StreamStatus"`
	// contains filtered or unexported fields
}

Represents the output for DescribeStream.

func (StreamDescription) GoString added in v0.6.5 

func (s StreamDescription) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StreamDescription) SetEncryptionType added in v1.10.8 

func (s *StreamDescription) SetEncryptionType(v string) *StreamDescription

SetEncryptionType sets the EncryptionType field's value.

func (*StreamDescription) SetEnhancedMonitoring added in v1.5.0 

func (s *StreamDescription) SetEnhancedMonitoring(v []*EnhancedMetrics) *StreamDescription

SetEnhancedMonitoring sets the EnhancedMonitoring field's value.

func (*StreamDescription) SetHasMoreShards added in v1.5.0 

func (s *StreamDescription) SetHasMoreShards(v bool) *StreamDescription

SetHasMoreShards sets the HasMoreShards field's value.

func (*StreamDescription) SetKeyId added in v1.10.8 

func (s *StreamDescription) SetKeyId(v string) *StreamDescription

SetKeyId sets the KeyId field's value.

func (*StreamDescription) SetRetentionPeriodHours added in v1.5.0 

func (s *StreamDescription) SetRetentionPeriodHours(v int64) *StreamDescription

SetRetentionPeriodHours sets the RetentionPeriodHours field's value.

func (*StreamDescription) SetShards added in v1.5.0 

func (s *StreamDescription) SetShards(v []*Shard) *StreamDescription

SetShards sets the Shards field's value.

func (*StreamDescription) SetStreamARN added in v1.5.0 

func (s *StreamDescription) SetStreamARN(v string) *StreamDescription

SetStreamARN sets the StreamARN field's value.

func (*StreamDescription) SetStreamCreationTimestamp added in v1.5.5 

func (s *StreamDescription) SetStreamCreationTimestamp(v time.Time) *StreamDescription

SetStreamCreationTimestamp sets the StreamCreationTimestamp field's value.

func (*StreamDescription) SetStreamModeDetails added in v1.42.16 

func (s *StreamDescription) SetStreamModeDetails(v *StreamModeDetails) *StreamDescription

SetStreamModeDetails sets the StreamModeDetails field's value.

func (*StreamDescription) SetStreamName added in v1.5.0 

func (s *StreamDescription) SetStreamName(v string) *StreamDescription

SetStreamName sets the StreamName field's value.

func (*StreamDescription) SetStreamStatus added in v1.5.0 

func (s *StreamDescription) SetStreamStatus(v string) *StreamDescription

SetStreamStatus sets the StreamStatus field's value.

func (StreamDescription) String added in v0.6.5 

func (s StreamDescription) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StreamDescriptionSummary added in v1.12.31 

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 *string `type:"string" enum:"EncryptionType"`

	// 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 Amazon Web Services 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 `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"`

	// Specifies the capacity mode to which you want to set your data stream. Currently,
	// in Kinesis Data Streams, you can choose between an on-demand ycapacity mode
	// and a provisioned capacity mode for your data streams.
	StreamModeDetails *StreamModeDetails `type:"structure"`

	// 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 *string `type:"string" required:"true" enum:"StreamStatus"`
	// contains filtered or unexported fields
}

Represents the output for DescribeStreamSummary

func (StreamDescriptionSummary) GoString added in v1.12.31 

func (s StreamDescriptionSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StreamDescriptionSummary) SetConsumerCount added in v1.15.4 

func (s *StreamDescriptionSummary) SetConsumerCount(v int64) *StreamDescriptionSummary

SetConsumerCount sets the ConsumerCount field's value.

func (*StreamDescriptionSummary) SetEncryptionType added in v1.12.31 

func (s *StreamDescriptionSummary) SetEncryptionType(v string) *StreamDescriptionSummary

SetEncryptionType sets the EncryptionType field's value.

func (*StreamDescriptionSummary) SetEnhancedMonitoring added in v1.12.31 

func (s *StreamDescriptionSummary) SetEnhancedMonitoring(v []*EnhancedMetrics) *StreamDescriptionSummary

SetEnhancedMonitoring sets the EnhancedMonitoring field's value.

func (*StreamDescriptionSummary) SetKeyId added in v1.12.31 

func (s *StreamDescriptionSummary) SetKeyId(v string) *StreamDescriptionSummary

SetKeyId sets the KeyId field's value.

func (*StreamDescriptionSummary) SetOpenShardCount added in v1.12.31 

func (s *StreamDescriptionSummary) SetOpenShardCount(v int64) *StreamDescriptionSummary

SetOpenShardCount sets the OpenShardCount field's value.

func (*StreamDescriptionSummary) SetRetentionPeriodHours added in v1.12.31 

func (s *StreamDescriptionSummary) SetRetentionPeriodHours(v int64) *StreamDescriptionSummary

SetRetentionPeriodHours sets the RetentionPeriodHours field's value.

func (*StreamDescriptionSummary) SetStreamARN added in v1.12.31 

func (s *StreamDescriptionSummary) SetStreamARN(v string) *StreamDescriptionSummary

SetStreamARN sets the StreamARN field's value.

func (*StreamDescriptionSummary) SetStreamCreationTimestamp added in v1.12.31 

func (s *StreamDescriptionSummary) SetStreamCreationTimestamp(v time.Time) *StreamDescriptionSummary

SetStreamCreationTimestamp sets the StreamCreationTimestamp field's value.

func (*StreamDescriptionSummary) SetStreamModeDetails added in v1.42.16 

func (s *StreamDescriptionSummary) SetStreamModeDetails(v *StreamModeDetails) *StreamDescriptionSummary

SetStreamModeDetails sets the StreamModeDetails field's value.

func (*StreamDescriptionSummary) SetStreamName added in v1.12.31 

func (s *StreamDescriptionSummary) SetStreamName(v string) *StreamDescriptionSummary

SetStreamName sets the StreamName field's value.

func (*StreamDescriptionSummary) SetStreamStatus added in v1.12.31 

func (s *StreamDescriptionSummary) SetStreamStatus(v string) *StreamDescriptionSummary

SetStreamStatus sets the StreamStatus field's value.

func (StreamDescriptionSummary) String added in v1.12.31 

func (s StreamDescriptionSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StreamModeDetails added in v1.42.16 

type StreamModeDetails struct {

	// Specifies the capacity mode to which you want to set your data stream. Currently,
	// in Kinesis Data Streams, you can choose between an on-demand capacity mode
	// and a provisioned capacity mode for your data streams.
	//
	// StreamMode is a required field
	StreamMode *string `type:"string" required:"true" enum:"StreamMode"`
	// contains filtered or unexported fields
}

Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.

func (StreamModeDetails) GoString added in v1.42.16 

func (s StreamModeDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StreamModeDetails) SetStreamMode added in v1.42.16 

func (s *StreamModeDetails) SetStreamMode(v string) *StreamModeDetails

SetStreamMode sets the StreamMode field's value.

func (StreamModeDetails) String added in v1.42.16 

func (s StreamModeDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StreamModeDetails) Validate added in v1.42.16 

func (s *StreamModeDetails) Validate() error

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

type SubscribeToShardEvent added in v1.18.0 

type SubscribeToShardEvent struct {

	// The list of the child shards of the current shard, returned only at the end
	// of the current shard.
	ChildShards []*ChildShard `type:"list"`

	// Use this as SequenceNumber in the next call to SubscribeToShard, with StartingPosition
	// set to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER. Use ContinuationSequenceNumber
	// for checkpointing because it captures your shard progress even when no data
	// is written to the shard.
	//
	// ContinuationSequenceNumber is a required field
	ContinuationSequenceNumber *string `type:"string" required:"true"`

	// The number of milliseconds the read records are 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 is a required field
	MillisBehindLatest *int64 `type:"long" required:"true"`

	// Records is a required field
	Records []*Record `type:"list" required:"true"`
	// contains filtered or unexported fields
}

After you call SubscribeToShard, Kinesis Data Streams sends events of this type over an HTTP/2 connection to your consumer.

func (SubscribeToShardEvent) GoString added in v1.18.0 

func (s SubscribeToShardEvent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SubscribeToShardEvent) MarshalEvent added in v1.27.0 

func (s *SubscribeToShardEvent) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*SubscribeToShardEvent) SetChildShards added in v1.34.6 

func (s *SubscribeToShardEvent) SetChildShards(v []*ChildShard) *SubscribeToShardEvent

SetChildShards sets the ChildShards field's value.

func (*SubscribeToShardEvent) SetContinuationSequenceNumber added in v1.18.0 

func (s *SubscribeToShardEvent) SetContinuationSequenceNumber(v string) *SubscribeToShardEvent

SetContinuationSequenceNumber sets the ContinuationSequenceNumber field's value.

func (*SubscribeToShardEvent) SetMillisBehindLatest added in v1.18.0 

func (s *SubscribeToShardEvent) SetMillisBehindLatest(v int64) *SubscribeToShardEvent

SetMillisBehindLatest sets the MillisBehindLatest field's value.

func (*SubscribeToShardEvent) SetRecords added in v1.18.0 

func (s *SubscribeToShardEvent) SetRecords(v []*Record) *SubscribeToShardEvent

SetRecords sets the Records field's value.

func (SubscribeToShardEvent) String added in v1.18.0 

func (s SubscribeToShardEvent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SubscribeToShardEvent) UnmarshalEvent added in v1.18.0 

func (s *SubscribeToShardEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the SubscribeToShardEvent value. This method is only used internally within the SDK's EventStream handling.

type SubscribeToShardEventStream added in v1.18.0 

type SubscribeToShardEventStream struct {

	// Reader is the EventStream reader for the SubscribeToShardEventStream
	// events. This value is automatically set by the SDK when the API call is made
	// Use this member when unit testing your code with the SDK to mock out the
	// EventStream Reader.
	//
	// Must not be nil.
	Reader SubscribeToShardEventStreamReader

	// StreamCloser is the io.Closer for the EventStream connection. For HTTP
	// EventStream this is the response Body. The stream will be closed when
	// the Close method of the EventStream is called.
	StreamCloser io.Closer
	// contains filtered or unexported fields
}

SubscribeToShardEventStream provides the event stream handling for the SubscribeToShard.

For testing and mocking the event stream this type should be initialized via the NewSubscribeToShardEventStream constructor function. Using the functional options to pass in nested mock behavior.

func NewSubscribeToShardEventStream added in v1.34.3 

func NewSubscribeToShardEventStream(opts ...func(*SubscribeToShardEventStream)) *SubscribeToShardEventStream

NewSubscribeToShardEventStream initializes an SubscribeToShardEventStream. This function should only be used for testing and mocking the SubscribeToShardEventStream stream within your application.

The Reader member must be set before reading events from the stream.

The StreamCloser member should be set to the underlying io.Closer, (e.g. http.Response.Body), that will be closed when the stream Close method is called. 

es := NewSubscribeToShardEventStream(func(o *SubscribeToShardEventStream){
    es.Reader = myMockStreamReader
    es.StreamCloser = myMockStreamCloser
})

func (*SubscribeToShardEventStream) Close added in v1.18.0 

func (es *SubscribeToShardEventStream) Close() (err error)

Close closes the stream. This will also cause the stream to be closed. Close must be called when done using the stream API. Not calling Close may result in resource leaks.

You can use the closing of the Reader's Events channel to terminate your application's read from the API's stream.

func (*SubscribeToShardEventStream) Err added in v1.18.0 

func (es *SubscribeToShardEventStream) Err() error

Err returns any error that occurred while reading or writing EventStream Events from the service API's response. Returns nil if there were no errors.

func (*SubscribeToShardEventStream) Events added in v1.18.0 

func (es *SubscribeToShardEventStream) Events() <-chan SubscribeToShardEventStreamEvent

Events returns a channel to read events from.

These events are:

  • SubscribeToShardEvent
  • SubscribeToShardEventStreamUnknownEvent

type SubscribeToShardEventStreamEvent added in v1.18.0 

type SubscribeToShardEventStreamEvent interface {
	eventstreamapi.Marshaler
	eventstreamapi.Unmarshaler
	// contains filtered or unexported methods
}

SubscribeToShardEventStreamEvent groups together all EventStream events writes for SubscribeToShardEventStream.

These events are:

  • SubscribeToShardEvent

type SubscribeToShardEventStreamReader added in v1.18.0 

type SubscribeToShardEventStreamReader interface {
	// Returns a channel of events as they are read from the event stream.
	Events() <-chan SubscribeToShardEventStreamEvent

	// Close will stop the reader reading events from the stream.
	Close() error

	// Returns any error that has occurred while reading from the event stream.
	Err() error
}

SubscribeToShardEventStreamReader provides the interface for reading to the stream. The default implementation for this interface will be SubscribeToShardEventStreamData.

The reader's Close method must allow multiple concurrent calls.

These events are:

  • SubscribeToShardEvent
  • SubscribeToShardEventStreamUnknownEvent

type SubscribeToShardEventStreamUnknownEvent added in v1.33.7 

type SubscribeToShardEventStreamUnknownEvent struct {
	Type    string
	Message eventstream.Message
}

SubscribeToShardEventStreamUnknownEvent provides a failsafe event for the SubscribeToShardEventStream group of events when an unknown event is received.

func (*SubscribeToShardEventStreamUnknownEvent) MarshalEvent added in v1.33.7 

func (e *SubscribeToShardEventStreamUnknownEvent) MarshalEvent(pm protocol.PayloadMarshaler) (
	msg eventstream.Message, err error,
)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*SubscribeToShardEventStreamUnknownEvent) UnmarshalEvent added in v1.33.7 

func (e *SubscribeToShardEventStreamUnknownEvent) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the SubscribeToShardEventStreamData value. This method is only used internally within the SDK's EventStream handling.

type SubscribeToShardInput added in v1.18.0 

type SubscribeToShardInput struct {

	// For this parameter, use the value you obtained when you called RegisterStreamConsumer.
	//
	// ConsumerARN is a required field
	ConsumerARN *string `min:"1" type:"string" required:"true"`

	// The ID of the shard you want to subscribe to. To see a list of all the shards
	// for a given stream, use ListShards.
	//
	// ShardId is a required field
	ShardId *string `min:"1" type:"string" required:"true"`

	// The starting position in the data stream from which to start streaming.
	//
	// StartingPosition is a required field
	StartingPosition *StartingPosition `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (SubscribeToShardInput) GoString added in v1.18.0 

func (s SubscribeToShardInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SubscribeToShardInput) SetConsumerARN added in v1.18.0 

func (s *SubscribeToShardInput) SetConsumerARN(v string) *SubscribeToShardInput

SetConsumerARN sets the ConsumerARN field's value.

func (*SubscribeToShardInput) SetShardId added in v1.18.0 

func (s *SubscribeToShardInput) SetShardId(v string) *SubscribeToShardInput

SetShardId sets the ShardId field's value.

func (*SubscribeToShardInput) SetStartingPosition added in v1.18.0 

func (s *SubscribeToShardInput) SetStartingPosition(v *StartingPosition) *SubscribeToShardInput

SetStartingPosition sets the StartingPosition field's value.

func (SubscribeToShardInput) String added in v1.18.0 

func (s SubscribeToShardInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SubscribeToShardInput) Validate added in v1.18.0 

func (s *SubscribeToShardInput) Validate() error

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

type SubscribeToShardOutput added in v1.18.0 

type SubscribeToShardOutput struct {
	EventStream *SubscribeToShardEventStream
	// contains filtered or unexported fields
}

func (*SubscribeToShardOutput) GetEventStream added in v1.27.0 

func (s *SubscribeToShardOutput) GetEventStream() *SubscribeToShardEventStream

func (*SubscribeToShardOutput) GetStream added in v1.27.0 

func (s *SubscribeToShardOutput) GetStream() *SubscribeToShardEventStream

GetStream returns the type to interact with the event stream.

func (SubscribeToShardOutput) GoString added in v1.18.0 

func (s SubscribeToShardOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SubscribeToShardOutput) MarshalEvent added in v1.27.0 

func (s *SubscribeToShardOutput) MarshalEvent(pm protocol.PayloadMarshaler) (msg eventstream.Message, err error)

MarshalEvent marshals the type into an stream event value. This method should only used internally within the SDK's EventStream handling.

func (*SubscribeToShardOutput) SetEventStream added in v1.18.0 

func (s *SubscribeToShardOutput) SetEventStream(v *SubscribeToShardEventStream) *SubscribeToShardOutput

func (SubscribeToShardOutput) String added in v1.18.0 

func (s SubscribeToShardOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SubscribeToShardOutput) UnmarshalEvent added in v1.18.0 

func (s *SubscribeToShardOutput) UnmarshalEvent(
	payloadUnmarshaler protocol.PayloadUnmarshaler,
	msg eventstream.Message,
) error

UnmarshalEvent unmarshals the EventStream Message into the SubscribeToShardOutput value. This method is only used internally within the SDK's EventStream handling.

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) GoString added in v0.6.5 

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey added in v1.5.0 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.5.0 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String added in v0.6.5 

func (s Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateShardCountInput added in v1.5.5 

type UpdateShardCountInput struct {

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

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

	// The new number of shards. This value has the following default limits. By
	// default, you cannot do the following:
	//
	//    * Set this value to more than double your current shard count for a stream.
	//
	//    * Set this value below half your current shard count for a stream.
	//
	//    * Set this value to more than 10000 shards in a stream (the default limit
	//    for shard count per stream is 10000 per account per region), unless you
	//    request a limit increase.
	//
	//    * Scale a stream with more than 10000 shards down unless you set this
	//    value to less than 10000 shards.
	//
	// TargetShardCount is a required field
	TargetShardCount *int64 `min:"1" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateShardCountInput) GoString added in v1.5.5 

func (s UpdateShardCountInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateShardCountInput) SetScalingType added in v1.5.5 

func (s *UpdateShardCountInput) SetScalingType(v string) *UpdateShardCountInput

SetScalingType sets the ScalingType field's value.

func (*UpdateShardCountInput) SetStreamName added in v1.5.5 

func (s *UpdateShardCountInput) SetStreamName(v string) *UpdateShardCountInput

SetStreamName sets the StreamName field's value.

func (*UpdateShardCountInput) SetTargetShardCount added in v1.5.5 

func (s *UpdateShardCountInput) SetTargetShardCount(v int64) *UpdateShardCountInput

SetTargetShardCount sets the TargetShardCount field's value.

func (UpdateShardCountInput) String added in v1.5.5 

func (s UpdateShardCountInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateShardCountInput) Validate added in v1.5.5 

func (s *UpdateShardCountInput) Validate() error

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

type UpdateShardCountOutput added in v1.5.5 

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) GoString added in v1.5.5 

func (s UpdateShardCountOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateShardCountOutput) SetCurrentShardCount added in v1.5.5 

func (s *UpdateShardCountOutput) SetCurrentShardCount(v int64) *UpdateShardCountOutput

SetCurrentShardCount sets the CurrentShardCount field's value.

func (*UpdateShardCountOutput) SetStreamName added in v1.5.5 

func (s *UpdateShardCountOutput) SetStreamName(v string) *UpdateShardCountOutput

SetStreamName sets the StreamName field's value.

func (*UpdateShardCountOutput) SetTargetShardCount added in v1.5.5 

func (s *UpdateShardCountOutput) SetTargetShardCount(v int64) *UpdateShardCountOutput

SetTargetShardCount sets the TargetShardCount field's value.

func (UpdateShardCountOutput) String added in v1.5.5 

func (s UpdateShardCountOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateStreamModeInput added in v1.42.16 

type UpdateStreamModeInput struct {

	// Specifies the ARN of the data stream whose capacity mode you want to update.
	//
	// StreamARN is a required field
	StreamARN *string `min:"1" type:"string" required:"true"`

	// Specifies the capacity mode to which you want to set your data stream. Currently,
	// in Kinesis Data Streams, you can choose between an on-demand capacity mode
	// and a provisioned capacity mode for your data streams.
	//
	// StreamModeDetails is a required field
	StreamModeDetails *StreamModeDetails `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateStreamModeInput) GoString added in v1.42.16 

func (s UpdateStreamModeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateStreamModeInput) SetStreamARN added in v1.42.16 

func (s *UpdateStreamModeInput) SetStreamARN(v string) *UpdateStreamModeInput

SetStreamARN sets the StreamARN field's value.

func (*UpdateStreamModeInput) SetStreamModeDetails added in v1.42.16 

func (s *UpdateStreamModeInput) SetStreamModeDetails(v *StreamModeDetails) *UpdateStreamModeInput

SetStreamModeDetails sets the StreamModeDetails field's value.

func (UpdateStreamModeInput) String added in v1.42.16 

func (s UpdateStreamModeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateStreamModeInput) Validate added in v1.42.16 

func (s *UpdateStreamModeInput) Validate() error

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

type UpdateStreamModeOutput added in v1.42.16 

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

func (UpdateStreamModeOutput) GoString added in v1.42.16 

func (s UpdateStreamModeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateStreamModeOutput) String added in v1.42.16 

func (s UpdateStreamModeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException added in v1.42.16 

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

func (*ValidationException) Code added in v1.42.16 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error added in v1.42.16 

func (s *ValidationException) Error() string

func (ValidationException) GoString added in v1.42.16 

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message added in v1.42.16 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr added in v1.42.16 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID added in v1.42.16 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode added in v1.42.16 

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String added in v1.42.16 

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Source Files

View all Source files

Directories

Path Synopsis
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.