package types
import "github.com/aws/aws-sdk-go-v2/service/kinesis/types"
Index ¶
- type Consumer
- type ConsumerDescription
- type ConsumerStatus
- type EncryptionType
- type EnhancedMetrics
- type ExpiredIteratorException
- func (e *ExpiredIteratorException) Error() string
- func (e *ExpiredIteratorException) ErrorCode() string
- func (e *ExpiredIteratorException) ErrorFault() smithy.ErrorFault
- func (e *ExpiredIteratorException) ErrorMessage() string
- type ExpiredNextTokenException
- func (e *ExpiredNextTokenException) Error() string
- func (e *ExpiredNextTokenException) ErrorCode() string
- func (e *ExpiredNextTokenException) ErrorFault() smithy.ErrorFault
- func (e *ExpiredNextTokenException) ErrorMessage() string
- type HashKeyRange
- type InternalFailureException
- func (e *InternalFailureException) Error() string
- func (e *InternalFailureException) ErrorCode() string
- func (e *InternalFailureException) ErrorFault() smithy.ErrorFault
- func (e *InternalFailureException) ErrorMessage() string
- type InvalidArgumentException
- func (e *InvalidArgumentException) Error() string
- func (e *InvalidArgumentException) ErrorCode() string
- func (e *InvalidArgumentException) ErrorFault() smithy.ErrorFault
- func (e *InvalidArgumentException) ErrorMessage() string
- type KMSAccessDeniedException
- func (e *KMSAccessDeniedException) Error() string
- func (e *KMSAccessDeniedException) ErrorCode() string
- func (e *KMSAccessDeniedException) ErrorFault() smithy.ErrorFault
- func (e *KMSAccessDeniedException) ErrorMessage() string
- type KMSDisabledException
- func (e *KMSDisabledException) Error() string
- func (e *KMSDisabledException) ErrorCode() string
- func (e *KMSDisabledException) ErrorFault() smithy.ErrorFault
- func (e *KMSDisabledException) ErrorMessage() string
- type KMSInvalidStateException
- func (e *KMSInvalidStateException) Error() string
- func (e *KMSInvalidStateException) ErrorCode() string
- func (e *KMSInvalidStateException) ErrorFault() smithy.ErrorFault
- func (e *KMSInvalidStateException) ErrorMessage() string
- type KMSNotFoundException
- func (e *KMSNotFoundException) Error() string
- func (e *KMSNotFoundException) ErrorCode() string
- func (e *KMSNotFoundException) ErrorFault() smithy.ErrorFault
- func (e *KMSNotFoundException) ErrorMessage() string
- type KMSOptInRequired
- func (e *KMSOptInRequired) Error() string
- func (e *KMSOptInRequired) ErrorCode() string
- func (e *KMSOptInRequired) ErrorFault() smithy.ErrorFault
- func (e *KMSOptInRequired) ErrorMessage() string
- type KMSThrottlingException
- func (e *KMSThrottlingException) Error() string
- func (e *KMSThrottlingException) ErrorCode() string
- func (e *KMSThrottlingException) ErrorFault() smithy.ErrorFault
- func (e *KMSThrottlingException) ErrorMessage() string
- type LimitExceededException
- func (e *LimitExceededException) Error() string
- func (e *LimitExceededException) ErrorCode() string
- func (e *LimitExceededException) ErrorFault() smithy.ErrorFault
- func (e *LimitExceededException) ErrorMessage() string
- type MetricsName
- type ProvisionedThroughputExceededException
- func (e *ProvisionedThroughputExceededException) Error() string
- func (e *ProvisionedThroughputExceededException) ErrorCode() string
- func (e *ProvisionedThroughputExceededException) ErrorFault() smithy.ErrorFault
- func (e *ProvisionedThroughputExceededException) ErrorMessage() string
- type PutRecordsRequestEntry
- type PutRecordsResultEntry
- type Record
- type ResourceInUseException
- func (e *ResourceInUseException) Error() string
- func (e *ResourceInUseException) ErrorCode() string
- func (e *ResourceInUseException) ErrorFault() smithy.ErrorFault
- func (e *ResourceInUseException) ErrorMessage() string
- type ResourceNotFoundException
- func (e *ResourceNotFoundException) Error() string
- func (e *ResourceNotFoundException) ErrorCode() string
- func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault
- func (e *ResourceNotFoundException) ErrorMessage() string
- type ScalingType
- type SequenceNumberRange
- type Shard
- type ShardIteratorType
- type StartingPosition
- type StreamDescription
- type StreamDescriptionSummary
- type StreamStatus
- type SubscribeToShardEvent
- type SubscribeToShardEventStream
- type SubscribeToShardEventStreamMemberInternalFailureException
- type SubscribeToShardEventStreamMemberKMSAccessDeniedException
- type SubscribeToShardEventStreamMemberKMSDisabledException
- type SubscribeToShardEventStreamMemberKMSInvalidStateException
- type SubscribeToShardEventStreamMemberKMSNotFoundException
- type SubscribeToShardEventStreamMemberKMSOptInRequired
- type SubscribeToShardEventStreamMemberKMSThrottlingException
- type SubscribeToShardEventStreamMemberResourceInUseException
- type SubscribeToShardEventStreamMemberResourceNotFoundException
- type SubscribeToShardEventStreamMemberSubscribeToShardEvent
- type Tag
- type UnknownUnionMember
Types ¶
type Consumer ¶
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. // // This member is required. ConsumerARN *string // A consumer can't read data while in the CREATING or DELETING states. // // This member is required. ConsumerStatus ConsumerStatus // The name of the consumer is something you choose when you register the consumer. // // This member is required. ConsumerName *string // // // This member is required. ConsumerCreationTimestamp *time.Time }
An object that represents the details of the consumer you registered.
type ConsumerDescription ¶
type ConsumerDescription struct { // // // This member is required. ConsumerCreationTimestamp *time.Time // The ARN of the stream with which you registered the consumer. // // This member is required. StreamARN *string // A consumer can't read data while in the CREATING or DELETING states. // // This member is required. ConsumerStatus ConsumerStatus // 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. // // This member is required. ConsumerARN *string // The name of the consumer is something you choose when you register the consumer. // // This member is required. ConsumerName *string }
An object that represents the details of a registered consumer.
type ConsumerStatus ¶
type ConsumerStatus string
const ( ConsumerStatusCreating ConsumerStatus = "CREATING" ConsumerStatusDeleting ConsumerStatus = "DELETING" ConsumerStatusActive ConsumerStatus = "ACTIVE" )
Enum values for ConsumerStatus
type EncryptionType ¶
type EncryptionType string
const ( EncryptionTypeNone EncryptionType = "NONE" EncryptionTypeKms EncryptionType = "KMS" )
Enum values for EncryptionType
type EnhancedMetrics ¶
type EnhancedMetrics struct { // List of shard-level metrics. The following are the valid shard-level metrics. // The value "ALL" enhances every metric. // // * IncomingBytes // // * // IncomingRecords // // * OutgoingBytes // // * OutgoingRecords // // * // WriteProvisionedThroughputExceeded // // * ReadProvisionedThroughputExceeded // // // * IteratorAgeMilliseconds // // * ALL // // For more information, see Monitoring the // Amazon Kinesis Data Streams Service with Amazon CloudWatch // (https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html) // in the Amazon Kinesis Data Streams Developer Guide. ShardLevelMetrics []MetricsName }
Represents enhanced metrics types.
type ExpiredIteratorException ¶
type ExpiredIteratorException struct { Message *string }
The provided iterator exceeds the maximum age allowed.
func (*ExpiredIteratorException) Error ¶
func (e *ExpiredIteratorException) Error() string
func (*ExpiredIteratorException) ErrorCode ¶
func (e *ExpiredIteratorException) ErrorCode() string
func (*ExpiredIteratorException) ErrorFault ¶
func (e *ExpiredIteratorException) ErrorFault() smithy.ErrorFault
func (*ExpiredIteratorException) ErrorMessage ¶
func (e *ExpiredIteratorException) ErrorMessage() string
type ExpiredNextTokenException ¶
type ExpiredNextTokenException struct { Message *string }
The pagination token passed to the operation is expired.
func (*ExpiredNextTokenException) Error ¶
func (e *ExpiredNextTokenException) Error() string
func (*ExpiredNextTokenException) ErrorCode ¶
func (e *ExpiredNextTokenException) ErrorCode() string
func (*ExpiredNextTokenException) ErrorFault ¶
func (e *ExpiredNextTokenException) ErrorFault() smithy.ErrorFault
func (*ExpiredNextTokenException) ErrorMessage ¶
func (e *ExpiredNextTokenException) ErrorMessage() string
type HashKeyRange ¶
type HashKeyRange struct { // The ending hash key of the hash key range. // // This member is required. EndingHashKey *string // The starting hash key of the hash key range. // // This member is required. StartingHashKey *string }
The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.
type InternalFailureException ¶
type InternalFailureException struct { Message *string }
func (*InternalFailureException) Error ¶
func (e *InternalFailureException) Error() string
func (*InternalFailureException) ErrorCode ¶
func (e *InternalFailureException) ErrorCode() string
func (*InternalFailureException) ErrorFault ¶
func (e *InternalFailureException) ErrorFault() smithy.ErrorFault
func (*InternalFailureException) ErrorMessage ¶
func (e *InternalFailureException) ErrorMessage() string
type InvalidArgumentException ¶
type InvalidArgumentException struct { Message *string }
A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.
func (*InvalidArgumentException) Error ¶
func (e *InvalidArgumentException) Error() string
func (*InvalidArgumentException) ErrorCode ¶
func (e *InvalidArgumentException) ErrorCode() string
func (*InvalidArgumentException) ErrorFault ¶
func (e *InvalidArgumentException) ErrorFault() smithy.ErrorFault
func (*InvalidArgumentException) ErrorMessage ¶
func (e *InvalidArgumentException) ErrorMessage() string
type KMSAccessDeniedException ¶
type KMSAccessDeniedException struct { Message *string }
The ciphertext references a key that doesn't exist or that you don't have access to.
func (*KMSAccessDeniedException) Error ¶
func (e *KMSAccessDeniedException) Error() string
func (*KMSAccessDeniedException) ErrorCode ¶
func (e *KMSAccessDeniedException) ErrorCode() string
func (*KMSAccessDeniedException) ErrorFault ¶
func (e *KMSAccessDeniedException) ErrorFault() smithy.ErrorFault
func (*KMSAccessDeniedException) ErrorMessage ¶
func (e *KMSAccessDeniedException) ErrorMessage() string
type KMSDisabledException ¶
type KMSDisabledException struct { Message *string }
The request was rejected because the specified customer master key (CMK) isn't enabled.
func (*KMSDisabledException) Error ¶
func (e *KMSDisabledException) Error() string
func (*KMSDisabledException) ErrorCode ¶
func (e *KMSDisabledException) ErrorCode() string
func (*KMSDisabledException) ErrorFault ¶
func (e *KMSDisabledException) ErrorFault() smithy.ErrorFault
func (*KMSDisabledException) ErrorMessage ¶
func (e *KMSDisabledException) ErrorMessage() string
type KMSInvalidStateException ¶
type KMSInvalidStateException struct { Message *string }
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 AWS Key Management Service Developer Guide.
func (*KMSInvalidStateException) Error ¶
func (e *KMSInvalidStateException) Error() string
func (*KMSInvalidStateException) ErrorCode ¶
func (e *KMSInvalidStateException) ErrorCode() string
func (*KMSInvalidStateException) ErrorFault ¶
func (e *KMSInvalidStateException) ErrorFault() smithy.ErrorFault
func (*KMSInvalidStateException) ErrorMessage ¶
func (e *KMSInvalidStateException) ErrorMessage() string
type KMSNotFoundException ¶
type KMSNotFoundException struct { Message *string }
The request was rejected because the specified entity or resource can't be found.
func (*KMSNotFoundException) Error ¶
func (e *KMSNotFoundException) Error() string
func (*KMSNotFoundException) ErrorCode ¶
func (e *KMSNotFoundException) ErrorCode() string
func (*KMSNotFoundException) ErrorFault ¶
func (e *KMSNotFoundException) ErrorFault() smithy.ErrorFault
func (*KMSNotFoundException) ErrorMessage ¶
func (e *KMSNotFoundException) ErrorMessage() string
type KMSOptInRequired ¶
type KMSOptInRequired struct { Message *string }
The AWS access key ID needs a subscription for the service.
func (*KMSOptInRequired) Error ¶
func (e *KMSOptInRequired) Error() string
func (*KMSOptInRequired) ErrorCode ¶
func (e *KMSOptInRequired) ErrorCode() string
func (*KMSOptInRequired) ErrorFault ¶
func (e *KMSOptInRequired) ErrorFault() smithy.ErrorFault
func (*KMSOptInRequired) ErrorMessage ¶
func (e *KMSOptInRequired) ErrorMessage() string
type KMSThrottlingException ¶
type KMSThrottlingException struct { Message *string }
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 AWS Key Management Service Developer Guide.
func (*KMSThrottlingException) Error ¶
func (e *KMSThrottlingException) Error() string
func (*KMSThrottlingException) ErrorCode ¶
func (e *KMSThrottlingException) ErrorCode() string
func (*KMSThrottlingException) ErrorFault ¶
func (e *KMSThrottlingException) ErrorFault() smithy.ErrorFault
func (*KMSThrottlingException) ErrorMessage ¶
func (e *KMSThrottlingException) ErrorMessage() string
type LimitExceededException ¶
type LimitExceededException struct { Message *string }
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
func (*LimitExceededException) Error ¶
func (e *LimitExceededException) Error() string
func (*LimitExceededException) ErrorCode ¶
func (e *LimitExceededException) ErrorCode() string
func (*LimitExceededException) ErrorFault ¶
func (e *LimitExceededException) ErrorFault() smithy.ErrorFault
func (*LimitExceededException) ErrorMessage ¶
func (e *LimitExceededException) ErrorMessage() string
type MetricsName ¶
type MetricsName string
const ( MetricsNameIncoming_bytes MetricsName = "IncomingBytes" MetricsNameIncoming_records MetricsName = "IncomingRecords" MetricsNameOutgoing_bytes MetricsName = "OutgoingBytes" MetricsNameOutgoing_records MetricsName = "OutgoingRecords" MetricsNameWrite_provisioned_throughput_exceeded MetricsName = "WriteProvisionedThroughputExceeded" MetricsNameRead_provisioned_throughput_exceeded MetricsName = "ReadProvisionedThroughputExceeded" MetricsNameIterator_age_milliseconds MetricsName = "IteratorAgeMilliseconds" MetricsNameAll MetricsName = "ALL" )
Enum values for MetricsName
type ProvisionedThroughputExceededException ¶
type ProvisionedThroughputExceededException struct { Message *string }
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 AWS (https://docs.aws.amazon.com/general/latest/gr/api-retries.html) in the AWS General Reference.
func (*ProvisionedThroughputExceededException) Error ¶
func (e *ProvisionedThroughputExceededException) Error() string
func (*ProvisionedThroughputExceededException) ErrorCode ¶
func (e *ProvisionedThroughputExceededException) ErrorCode() string
func (*ProvisionedThroughputExceededException) ErrorFault ¶
func (e *ProvisionedThroughputExceededException) ErrorFault() smithy.ErrorFault
func (*ProvisionedThroughputExceededException) ErrorMessage ¶
func (e *ProvisionedThroughputExceededException) ErrorMessage() string
type PutRecordsRequestEntry ¶
type PutRecordsRequestEntry struct { // 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. // // This member is required. PartitionKey *string // The data blob to put into the record, which is base64-encoded when the blob is // serialized. When the data blob (the payload before base64-encoding) is added to // the partition key size, the total size must not exceed the maximum record size // (1 MB). // // This member is required. Data []byte // The hash value used to determine explicitly the shard that the data record is // assigned to by overriding the partition key hash. ExplicitHashKey *string }
Represents the output for PutRecords.
type PutRecordsResultEntry ¶
type PutRecordsResultEntry struct { // The shard ID for an individual record result. ShardId *string // The sequence number for an individual record result. SequenceNumber *string // The error code for an individual record result. ErrorCodes can be either // ProvisionedThroughputExceededException or InternalFailure. ErrorCode *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 }
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.
type Record ¶
type Record struct { // Identifies which shard in the stream the data record is assigned to. // // This member is required. PartitionKey *string // The data blob. The data in the blob is both opaque and immutable to Kinesis Data // Streams, which does not inspect, interpret, or change the data in the blob in // any way. When the data blob (the payload before base64-encoding) is added to the // partition key size, the total size must not exceed the maximum record size (1 // MB). // // This member is required. Data []byte // The unique identifier of the record within its shard. // // This member is required. SequenceNumber *string // The encryption type used on the record. This parameter can be one of the // following values: // // * NONE: Do not encrypt the records in the stream. // // * // KMS: Use server-side encryption on the records in the stream using a // customer-managed AWS KMS key. EncryptionType EncryptionType // The approximate time that the record was inserted into the stream. ApproximateArrivalTimestamp *time.Time }
The unit of data of the Kinesis data stream, which is composed of a sequence number, a partition key, and a data blob.
type ResourceInUseException ¶
type ResourceInUseException struct { Message *string }
The resource is not available for this operation. For successful operation, the resource must be in the ACTIVE state.
func (*ResourceInUseException) Error ¶
func (e *ResourceInUseException) Error() string
func (*ResourceInUseException) ErrorCode ¶
func (e *ResourceInUseException) ErrorCode() string
func (*ResourceInUseException) ErrorFault ¶
func (e *ResourceInUseException) ErrorFault() smithy.ErrorFault
func (*ResourceInUseException) ErrorMessage ¶
func (e *ResourceInUseException) ErrorMessage() string
type ResourceNotFoundException ¶
type ResourceNotFoundException struct { Message *string }
The requested resource could not be found. The stream might not be specified correctly.
func (*ResourceNotFoundException) Error ¶
func (e *ResourceNotFoundException) Error() string
func (*ResourceNotFoundException) ErrorCode ¶
func (e *ResourceNotFoundException) ErrorCode() string
func (*ResourceNotFoundException) ErrorFault ¶
func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault
func (*ResourceNotFoundException) ErrorMessage ¶
func (e *ResourceNotFoundException) ErrorMessage() string
type ScalingType ¶
type ScalingType string
const ( ScalingTypeUniform_scaling ScalingType = "UNIFORM_SCALING" )
Enum values for ScalingType
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 // The starting sequence number for the range. // // This member is required. StartingSequenceNumber *string }
The range of possible sequence numbers for the shard.
type Shard ¶
type Shard struct { // The shard ID of the shard's parent. ParentShardId *string // The shard ID of the shard adjacent to the shard's parent. AdjacentParentShardId *string // The range of possible sequence numbers for the shard. // // This member is required. SequenceNumberRange *SequenceNumberRange // The range of possible hash key values for the shard, which is a set of ordered // contiguous positive integers. // // This member is required. HashKeyRange *HashKeyRange // The unique identifier of the shard within the stream. // // This member is required. ShardId *string }
A uniquely identified group of data records in a Kinesis data stream.
type ShardIteratorType ¶
type ShardIteratorType string
const ( ShardIteratorTypeAt_sequence_number ShardIteratorType = "AT_SEQUENCE_NUMBER" ShardIteratorTypeAfter_sequence_number ShardIteratorType = "AFTER_SEQUENCE_NUMBER" ShardIteratorTypeTrim_horizon ShardIteratorType = "TRIM_HORIZON" ShardIteratorTypeLatest ShardIteratorType = "LATEST" ShardIteratorTypeAt_timestamp ShardIteratorType = "AT_TIMESTAMP" )
Enum values for ShardIteratorType
type StartingPosition ¶
type StartingPosition struct { SequenceNumber *string Type ShardIteratorType Timestamp *time.Time }
type StreamDescription ¶
type StreamDescription struct { // The server-side encryption type used on the stream. This parameter can be one of // the following values: // // * NONE: Do not encrypt the records in the stream. // // // * KMS: Use server-side encryption on the records in the stream using a // customer-managed AWS KMS key. EncryptionType EncryptionType // The name of the stream being described. // // This member is required. StreamName *string // The approximate time that the stream was created. // // This member is required. StreamCreationTimestamp *time.Time // If set to true, more shards in the stream are available to describe. // // This member is required. HasMoreShards *bool // The GUID for the customer-managed AWS KMS key to use for encryption. This value // can be a globally unique identifier, a fully specified ARN to either an alias or // a key, or an alias name prefixed by "alias/".You can also use a master key owned // by Kinesis Data Streams by specifying the alias aws/kinesis. // // * Key ARN // example: // arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 // // // * Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName // // * // Globally unique key ID example: 12345678-1234-1234-1234-123456789012 // // * // Alias name example: alias/MyAliasName // // * Master key owned by Kinesis Data // Streams: alias/aws/kinesis KeyId *string // 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. // // This member is required. StreamStatus StreamStatus // The shards that comprise the stream. // // This member is required. Shards []*Shard // The Amazon Resource Name (ARN) for the stream being described. // // This member is required. StreamARN *string // The current retention period, in hours. // // This member is required. RetentionPeriodHours *int32 // Represents the current enhanced monitoring settings of the stream. // // This member is required. EnhancedMonitoring []*EnhancedMetrics }
Represents the output for DescribeStream ().
type StreamDescriptionSummary ¶
type StreamDescriptionSummary struct { // The GUID for the customer-managed AWS KMS key to use for encryption. This value // can be a globally unique identifier, a fully specified ARN to either an alias or // a key, or an alias name prefixed by "alias/".You can also use a master key owned // by Kinesis Data Streams by specifying the alias aws/kinesis. // // * Key ARN // example: // arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 // // // * Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName // // // * Globally unique key ID example: 12345678-1234-1234-1234-123456789012 // // * // Alias name example: alias/MyAliasName // // * Master key owned by Kinesis Data // Streams: alias/aws/kinesis KeyId *string // 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. // // This member is required. StreamStatus StreamStatus // The Amazon Resource Name (ARN) for the stream being described. // // This member is required. StreamARN *string // The current retention period, in hours. // // This member is required. RetentionPeriodHours *int32 // Represents the current enhanced monitoring settings of the stream. // // This member is required. EnhancedMonitoring []*EnhancedMetrics // The encryption type used. This value is one of the following: // // * KMS // // * // NONE EncryptionType EncryptionType // The name of the stream being described. // // This member is required. StreamName *string // The approximate time that the stream was created. // // This member is required. StreamCreationTimestamp *time.Time // The number of enhanced fan-out consumers registered with the stream. ConsumerCount *int32 // The number of open shards in the stream. // // This member is required. OpenShardCount *int32 }
Represents the output for DescribeStreamSummary ()
type StreamStatus ¶
type StreamStatus string
const ( StreamStatusCreating StreamStatus = "CREATING" StreamStatusDeleting StreamStatus = "DELETING" StreamStatusActive StreamStatus = "ACTIVE" StreamStatusUpdating StreamStatus = "UPDATING" )
Enum values for StreamStatus
type SubscribeToShardEvent ¶
type SubscribeToShardEvent struct { // 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. // // This member is required. MillisBehindLatest *int64 // // // This member is required. Records []*Record // Use this as StartingSequenceNumber in the next call to SubscribeToShard (). // // This member is required. ContinuationSequenceNumber *string }
After you call SubscribeToShard (), Kinesis Data Streams sends events of this type to your consumer.
type SubscribeToShardEventStream ¶
type SubscribeToShardEventStream interface {
// contains filtered or unexported methods
}
type SubscribeToShardEventStreamMemberInternalFailureException ¶
type SubscribeToShardEventStreamMemberInternalFailureException struct { Value *InternalFailureException }
type SubscribeToShardEventStreamMemberKMSAccessDeniedException ¶
type SubscribeToShardEventStreamMemberKMSAccessDeniedException struct { Value *KMSAccessDeniedException }
The ciphertext references a key that doesn't exist or that you don't have access to.
type SubscribeToShardEventStreamMemberKMSDisabledException ¶
type SubscribeToShardEventStreamMemberKMSDisabledException struct { Value *KMSDisabledException }
The request was rejected because the specified customer master key (CMK) isn't enabled.
type SubscribeToShardEventStreamMemberKMSInvalidStateException ¶
type SubscribeToShardEventStreamMemberKMSInvalidStateException struct { Value *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 AWS Key Management Service Developer Guide.
type SubscribeToShardEventStreamMemberKMSNotFoundException ¶
type SubscribeToShardEventStreamMemberKMSNotFoundException struct { Value *KMSNotFoundException }
The request was rejected because the specified entity or resource can't be found.
type SubscribeToShardEventStreamMemberKMSOptInRequired ¶
type SubscribeToShardEventStreamMemberKMSOptInRequired struct { Value *KMSOptInRequired }
The AWS access key ID needs a subscription for the service.
type SubscribeToShardEventStreamMemberKMSThrottlingException ¶
type SubscribeToShardEventStreamMemberKMSThrottlingException struct { Value *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 AWS Key Management Service Developer Guide.
type SubscribeToShardEventStreamMemberResourceInUseException ¶
type SubscribeToShardEventStreamMemberResourceInUseException struct { Value *ResourceInUseException }
The resource is not available for this operation. For successful operation, the resource must be in the ACTIVE state.
type SubscribeToShardEventStreamMemberResourceNotFoundException ¶
type SubscribeToShardEventStreamMemberResourceNotFoundException struct { Value *ResourceNotFoundException }
The requested resource could not be found. The stream might not be specified correctly.
type SubscribeToShardEventStreamMemberSubscribeToShardEvent ¶
type SubscribeToShardEventStreamMemberSubscribeToShardEvent struct { Value *SubscribeToShardEvent }
After you call SubscribeToShard (), Kinesis Data Streams sends events of this type to your consumer.
type Tag ¶
type Tag struct { // A unique identifier for the tag. Maximum length: 128 characters. Valid // characters: Unicode letters, digits, white space, _ . / = + - % @ // // This member is required. Key *string // An optional string, typically used to describe or define the tag. Maximum // length: 256 characters. Valid characters: Unicode letters, digits, white space, // _ . / = + - % @ Value *string }
Metadata assigned to the stream, consisting of a key-value pair.
type UnknownUnionMember ¶
UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.
Source Files ¶
- Version
- v0.26.0
- Published
- Oct 1, 2020
- Platform
- js/wasm
- Imports
- 3 packages
- Last checked
- 3 hours ago –
Tools for package owners.