Skip to content

Kinesis Classes

AddTagsToStreamInput

Tags

  • Type: typing.Dict[str, str]
  • Required: Yes

StreamName

  • Type: typing.Optional[str]

StreamARN

  • Type: typing.Optional[str]

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

ChildShard

ShardId

  • Type:
  • Required: Yes

ParentShards

  • Type: typing.List[str]
  • Required: Yes

HashKeyRange

  • Type:
  • Required: Yes

Consumer

ConsumerName

  • Type:
  • Required: Yes

ConsumerARN

  • Type:
  • Required: Yes

ConsumerStatus

  • Type: typing.Literal['ACTIVE', 'CREATING', 'DELETING']
  • Required: Yes

ConsumerCreationTimestamp

  • Type:
  • Required: Yes

ConsumerDescription

ConsumerName

  • Type:
  • Required: Yes

ConsumerARN

  • Type:
  • Required: Yes

ConsumerStatus

  • Type: typing.Literal['ACTIVE', 'CREATING', 'DELETING']
  • Required: Yes

ConsumerCreationTimestamp

  • Type:
  • Required: Yes

StreamARN

  • Type:
  • Required: Yes

CreateStreamInput

StreamName

  • Type:
  • Required: Yes

ShardCount

  • Type: typing.Optional[int]

StreamModeDetails

  • Type:

Tags

  • Type: typing.Optional[typing.Dict[str, str]]

DecreaseStreamRetentionPeriodInput

RetentionPeriodHours

  • Type:
  • Required: Yes

StreamName

  • Type: typing.Optional[str]

StreamARN

  • Type: typing.Optional[str]

DeleteResourcePolicyInput

ResourceARN

  • Type:
  • Required: Yes

DeleteStreamInput

StreamName

  • Type: typing.Optional[str]

EnforceConsumerDeletion

  • Type: typing.Optional[bool]

StreamARN

  • Type: typing.Optional[str]

DeregisterStreamConsumerInput

StreamARN

  • Type: typing.Optional[str]

ConsumerName

  • Type: typing.Optional[str]

ConsumerARN

  • Type: typing.Optional[str]

DescribeLimitsOutput

ShardLimit

  • Type:
  • Required: Yes

OpenShardCount

  • Type:
  • Required: Yes

OnDemandStreamCount

  • Type:
  • Required: Yes

OnDemandStreamCountLimit

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeStreamConsumerInput

StreamARN

  • Type: typing.Optional[str]

ConsumerName

  • Type: typing.Optional[str]

ConsumerARN

  • Type: typing.Optional[str]

DescribeStreamConsumerOutput

ConsumerDescription

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeStreamInput

StreamName

  • Type: typing.Optional[str]

Limit

  • Type: typing.Optional[int]

ExclusiveStartShardId

  • Type: typing.Optional[str]

StreamARN

  • Type: typing.Optional[str]

DescribeStreamInputPaginate

StreamName

  • Type: typing.Optional[str]

StreamARN

  • Type: typing.Optional[str]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.kinesis.kinesis_classes.PaginatorConfig]

DescribeStreamInputWait

StreamName

  • Type: typing.Optional[str]

Limit

  • Type: typing.Optional[int]

ExclusiveStartShardId

  • Type: typing.Optional[str]

StreamARN

  • Type: typing.Optional[str]

WaiterConfig

  • Type:

DescribeStreamInputWaitExtra

StreamName

  • Type: typing.Optional[str]

Limit

  • Type: typing.Optional[int]

ExclusiveStartShardId

  • Type: typing.Optional[str]

StreamARN

  • Type: typing.Optional[str]

WaiterConfig

  • Type:

DescribeStreamOutput

StreamDescription

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeStreamSummaryInput

StreamName

  • Type: typing.Optional[str]

StreamARN

  • Type: typing.Optional[str]

DescribeStreamSummaryOutput

StreamDescriptionSummary

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DisableEnhancedMonitoringInput

ShardLevelMetrics

  • Type: typing.List[typing.Literal['ALL', 'IncomingBytes', 'IncomingRecords', 'IteratorAgeMilliseconds', 'OutgoingBytes', 'OutgoingRecords', 'ReadProvisionedThroughputExceeded', 'WriteProvisionedThroughputExceeded']]
  • Required: Yes

StreamName

  • Type: typing.Optional[str]

StreamARN

  • Type: typing.Optional[str]

EmptyResponseMetadata

ResponseMetadata

  • Type:
  • Required: Yes

EnableEnhancedMonitoringInput

ShardLevelMetrics

  • Type: typing.List[typing.Literal['ALL', 'IncomingBytes', 'IncomingRecords', 'IteratorAgeMilliseconds', 'OutgoingBytes', 'OutgoingRecords', 'ReadProvisionedThroughputExceeded', 'WriteProvisionedThroughputExceeded']]
  • Required: Yes

StreamName

  • Type: typing.Optional[str]

StreamARN

  • Type: typing.Optional[str]

EnhancedMetrics

ShardLevelMetrics

  • Type: typing.Optional[typing.List[typing.Literal['ALL', 'IncomingBytes', 'IncomingRecords', 'IteratorAgeMilliseconds', 'OutgoingBytes', 'OutgoingRecords', 'ReadProvisionedThroughputExceeded', 'WriteProvisionedThroughputExceeded']]]

EnhancedMonitoringOutput

StreamName

  • Type:
  • Required: Yes

CurrentShardLevelMetrics

  • Type: typing.List[typing.Literal['ALL', 'IncomingBytes', 'IncomingRecords', 'IteratorAgeMilliseconds', 'OutgoingBytes', 'OutgoingRecords', 'ReadProvisionedThroughputExceeded', 'WriteProvisionedThroughputExceeded']]
  • Required: Yes

DesiredShardLevelMetrics

  • Type: typing.List[typing.Literal['ALL', 'IncomingBytes', 'IncomingRecords', 'IteratorAgeMilliseconds', 'OutgoingBytes', 'OutgoingRecords', 'ReadProvisionedThroughputExceeded', 'WriteProvisionedThroughputExceeded']]
  • Required: Yes

StreamARN

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetRecordsInput

ShardIterator

  • Type:
  • Required: Yes

Limit

  • Type: typing.Optional[int]

StreamARN

  • Type: typing.Optional[str]

GetRecordsOutput

Records

  • Type: typing.List[aws_resource_validator.pydantic_models.kinesis.kinesis_classes.Record]
  • Required: Yes

NextShardIterator

  • Type:
  • Required: Yes

MillisBehindLatest

  • Type:
  • Required: Yes

ChildShards

  • Type: typing.List[aws_resource_validator.pydantic_models.kinesis.kinesis_classes.ChildShard]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetResourcePolicyInput

ResourceARN

  • Type:
  • Required: Yes

GetResourcePolicyOutput

Policy

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetShardIteratorInput

ShardId

  • Type:
  • Required: Yes

ShardIteratorType

  • Type: typing.Literal['AFTER_SEQUENCE_NUMBER', 'AT_SEQUENCE_NUMBER', 'AT_TIMESTAMP', 'LATEST', 'TRIM_HORIZON']
  • Required: Yes

StreamName

  • Type: typing.Optional[str]

StartingSequenceNumber

  • Type: typing.Optional[str]

Timestamp

  • Type:

StreamARN

  • Type: typing.Optional[str]

GetShardIteratorOutput

ShardIterator

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

HashKeyRange

StartingHashKey

  • Type:
  • Required: Yes

EndingHashKey

  • Type:
  • Required: Yes

IncreaseStreamRetentionPeriodInput

RetentionPeriodHours

  • Type:
  • Required: Yes

StreamName

  • Type: typing.Optional[str]

StreamARN

  • Type: typing.Optional[str]

InternalFailureException

message

  • Type: typing.Optional[str]

KMSAccessDeniedException

message

  • Type: typing.Optional[str]

KMSDisabledException

message

  • Type: typing.Optional[str]

KMSInvalidStateException

message

  • Type: typing.Optional[str]

KMSNotFoundException

message

  • Type: typing.Optional[str]

KMSOptInRequired

message

  • Type: typing.Optional[str]

KMSThrottlingException

message

  • Type: typing.Optional[str]

ListShardsInput

StreamName

  • Type: typing.Optional[str]

NextToken

  • Type: typing.Optional[str]

ExclusiveStartShardId

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

StreamCreationTimestamp

  • Type: typing.Union[datetime.datetime, str, NoneType]

ShardFilter

  • Type:

StreamARN

  • Type: typing.Optional[str]

ListShardsInputPaginate

StreamName

  • Type: typing.Optional[str]

ExclusiveStartShardId

  • Type: typing.Optional[str]

StreamCreationTimestamp

  • Type: typing.Union[datetime.datetime, str, NoneType]

ShardFilter

  • Type:

StreamARN

  • Type: typing.Optional[str]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.kinesis.kinesis_classes.PaginatorConfig]

ListShardsOutput

Shards

  • Type: typing.List[aws_resource_validator.pydantic_models.kinesis.kinesis_classes.Shard]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListStreamConsumersInput

StreamARN

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

StreamCreationTimestamp

  • Type: typing.Union[datetime.datetime, str, NoneType]

ListStreamConsumersInputPaginate

StreamARN

  • Type:
  • Required: Yes

StreamCreationTimestamp

  • Type: typing.Union[datetime.datetime, str, NoneType]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.kinesis.kinesis_classes.PaginatorConfig]

ListStreamConsumersOutput

Consumers

  • Type: typing.List[aws_resource_validator.pydantic_models.kinesis.kinesis_classes.Consumer]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListStreamsInput

Limit

  • Type: typing.Optional[int]

ExclusiveStartStreamName

  • Type: typing.Optional[str]

NextToken

  • Type: typing.Optional[str]

ListStreamsInputPaginate

ExclusiveStartStreamName

  • Type: typing.Optional[str]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.kinesis.kinesis_classes.PaginatorConfig]

ListStreamsOutput

StreamNames

  • Type: typing.List[str]
  • Required: Yes

HasMoreStreams

  • Type:
  • Required: Yes

StreamSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.kinesis.kinesis_classes.StreamSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListTagsForStreamInput

StreamName

  • Type: typing.Optional[str]

ExclusiveStartTagKey

  • Type: typing.Optional[str]

Limit

  • Type: typing.Optional[int]

StreamARN

  • Type: typing.Optional[str]

ListTagsForStreamOutput

Tags

  • Type: typing.List[aws_resource_validator.pydantic_models.kinesis.kinesis_classes.Tag]
  • Required: Yes

HasMoreTags

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

MergeShardsInput

ShardToMerge

  • Type:
  • Required: Yes

AdjacentShardToMerge

  • Type:
  • Required: Yes

StreamName

  • Type: typing.Optional[str]

StreamARN

  • Type: typing.Optional[str]

PaginatorConfig

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

PutRecordInput

Data

  • Type: typing.Union[str, bytes, typing.IO[typing.Any], botocore.response.StreamingBody]
  • Required: Yes

PartitionKey

  • Type:
  • Required: Yes

StreamName

  • Type: typing.Optional[str]

ExplicitHashKey

  • Type: typing.Optional[str]

SequenceNumberForOrdering

  • Type: typing.Optional[str]

StreamARN

  • Type: typing.Optional[str]

PutRecordOutput

ShardId

  • Type:
  • Required: Yes

SequenceNumber

  • Type:
  • Required: Yes

EncryptionType

  • Type: typing.Literal['KMS', 'NONE']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

PutRecordsInput

Records

  • Type: typing.List[aws_resource_validator.pydantic_models.kinesis.kinesis_classes.PutRecordsRequestEntry]
  • Required: Yes

StreamName

  • Type: typing.Optional[str]

StreamARN

  • Type: typing.Optional[str]

PutRecordsOutput

FailedRecordCount

  • Type:
  • Required: Yes

Records

  • Type: typing.List[aws_resource_validator.pydantic_models.kinesis.kinesis_classes.PutRecordsResultEntry]
  • Required: Yes

EncryptionType

  • Type: typing.Literal['KMS', 'NONE']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

PutRecordsRequestEntry

Data

  • Type: typing.Union[str, bytes, typing.IO[typing.Any], botocore.response.StreamingBody]
  • Required: Yes

PartitionKey

  • Type:
  • Required: Yes

ExplicitHashKey

  • Type: typing.Optional[str]

PutRecordsResultEntry

SequenceNumber

  • Type: typing.Optional[str]

ShardId

  • Type: typing.Optional[str]

ErrorCode

  • Type: typing.Optional[str]

ErrorMessage

  • Type: typing.Optional[str]

PutResourcePolicyInput

ResourceARN

  • Type:
  • Required: Yes

Policy

  • Type:
  • Required: Yes

Record

SequenceNumber

  • Type:
  • Required: Yes

Data

  • Type:
  • Required: Yes

PartitionKey

  • Type:
  • Required: Yes

ApproximateArrivalTimestamp

  • Type: typing.Optional[datetime.datetime]

EncryptionType

  • Type: typing.Optional[typing.Literal['KMS', 'NONE']]

RegisterStreamConsumerInput

StreamARN

  • Type:
  • Required: Yes

ConsumerName

  • Type:
  • Required: Yes

RegisterStreamConsumerOutput

Consumer

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

RemoveTagsFromStreamInput

TagKeys

  • Type: typing.List[str]
  • Required: Yes

StreamName

  • Type: typing.Optional[str]

StreamARN

  • Type: typing.Optional[str]

ResourceInUseException

message

  • Type: typing.Optional[str]

ResourceNotFoundException

message

  • Type: typing.Optional[str]

ResponseMetadata

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

SequenceNumberRange

StartingSequenceNumber

  • Type:
  • Required: Yes

EndingSequenceNumber

  • Type: typing.Optional[str]

Shard

ShardId

  • Type:
  • Required: Yes

HashKeyRange

  • Type:
  • Required: Yes

SequenceNumberRange

  • Type:
  • Required: Yes

ParentShardId

  • Type: typing.Optional[str]

AdjacentParentShardId

  • Type: typing.Optional[str]

ShardFilter

Type

  • Type: typing.Literal['AFTER_SHARD_ID', 'AT_LATEST', 'AT_TIMESTAMP', 'AT_TRIM_HORIZON', 'FROM_TIMESTAMP', 'FROM_TRIM_HORIZON']
  • Required: Yes

ShardId

  • Type: typing.Optional[str]

Timestamp

  • Type:

SplitShardInput

ShardToSplit

  • Type:
  • Required: Yes

NewStartingHashKey

  • Type:
  • Required: Yes

StreamName

  • Type: typing.Optional[str]

StreamARN

  • Type: typing.Optional[str]

StartStreamEncryptionInput

EncryptionType

  • Type: typing.Literal['KMS', 'NONE']
  • Required: Yes

KeyId

  • Type:
  • Required: Yes

StreamName

  • Type: typing.Optional[str]

StreamARN

  • Type: typing.Optional[str]

StartingPosition

Type

  • Type: typing.Literal['AFTER_SEQUENCE_NUMBER', 'AT_SEQUENCE_NUMBER', 'AT_TIMESTAMP', 'LATEST', 'TRIM_HORIZON']
  • Required: Yes

SequenceNumber

  • Type: typing.Optional[str]

Timestamp

  • Type:

StopStreamEncryptionInput

EncryptionType

  • Type: typing.Literal['KMS', 'NONE']
  • Required: Yes

KeyId

  • Type:
  • Required: Yes

StreamName

  • Type: typing.Optional[str]

StreamARN

  • Type: typing.Optional[str]

StreamDescription

StreamName

  • Type:
  • Required: Yes

StreamARN

  • Type:
  • Required: Yes

StreamStatus

  • Type: typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'UPDATING']
  • Required: Yes

Shards

  • Type: typing.List[aws_resource_validator.pydantic_models.kinesis.kinesis_classes.Shard]
  • Required: Yes

HasMoreShards

  • Type:
  • Required: Yes

RetentionPeriodHours

  • Type:
  • Required: Yes

StreamCreationTimestamp

  • Type:
  • Required: Yes

EnhancedMonitoring

  • Type: typing.List[aws_resource_validator.pydantic_models.kinesis.kinesis_classes.EnhancedMetrics]
  • Required: Yes

StreamModeDetails

  • Type:

EncryptionType

  • Type: typing.Optional[typing.Literal['KMS', 'NONE']]

KeyId

  • Type: typing.Optional[str]

StreamDescriptionSummary

StreamName

  • Type:
  • Required: Yes

StreamARN

  • Type:
  • Required: Yes

StreamStatus

  • Type: typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'UPDATING']
  • Required: Yes

RetentionPeriodHours

  • Type:
  • Required: Yes

StreamCreationTimestamp

  • Type:
  • Required: Yes

EnhancedMonitoring

  • Type: typing.List[aws_resource_validator.pydantic_models.kinesis.kinesis_classes.EnhancedMetrics]
  • Required: Yes

OpenShardCount

  • Type:
  • Required: Yes

StreamModeDetails

  • Type:

EncryptionType

  • Type: typing.Optional[typing.Literal['KMS', 'NONE']]

KeyId

  • Type: typing.Optional[str]

ConsumerCount

  • Type: typing.Optional[int]

StreamModeDetails

StreamMode

  • Type: typing.Literal['ON_DEMAND', 'PROVISIONED']
  • Required: Yes

StreamSummary

StreamName

  • Type:
  • Required: Yes

StreamARN

  • Type:
  • Required: Yes

StreamStatus

  • Type: typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'UPDATING']
  • Required: Yes

StreamModeDetails

  • Type:

StreamCreationTimestamp

  • Type: typing.Optional[datetime.datetime]

SubscribeToShardEvent

Records

  • Type: typing.List[aws_resource_validator.pydantic_models.kinesis.kinesis_classes.Record]
  • Required: Yes

ContinuationSequenceNumber

  • Type:
  • Required: Yes

MillisBehindLatest

  • Type:
  • Required: Yes

ChildShards

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kinesis.kinesis_classes.ChildShard]]

SubscribeToShardEventStream

SubscribeToShardEvent

  • Type:
  • Required: Yes

ResourceNotFoundException

  • Type:

ResourceInUseException

  • Type:

KMSDisabledException

  • Type:

KMSInvalidStateException

  • Type:

KMSAccessDeniedException

  • Type:

KMSNotFoundException

  • Type:

KMSOptInRequired

  • Type:

KMSThrottlingException

  • Type:

InternalFailureException

  • Type:

SubscribeToShardInput

ConsumerARN

  • Type:
  • Required: Yes

ShardId

  • Type:
  • Required: Yes

StartingPosition

  • Type:
  • Required: Yes

SubscribeToShardOutput

EventStream

  • Type: aws_resource_validator.pydantic_models.base_validator_model.EventStream[aws_resource_validator.pydantic_models.kinesis.kinesis_classes.SubscribeToShardEventStream]
  • Required: Yes

Tag

Key

  • Type:
  • Required: Yes

Value

  • Type: typing.Optional[str]

UpdateShardCountInput

TargetShardCount

  • Type:
  • Required: Yes

ScalingType

  • Type: typing.Literal['UNIFORM_SCALING']
  • Required: Yes

StreamName

  • Type: typing.Optional[str]

StreamARN

  • Type: typing.Optional[str]

UpdateShardCountOutput

StreamName

  • Type:
  • Required: Yes

CurrentShardCount

  • Type:
  • Required: Yes

TargetShardCount

  • Type:
  • Required: Yes

StreamARN

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateStreamModeInput

StreamARN

  • Type:
  • Required: Yes

StreamModeDetails

  • Type:
  • Required: Yes

WaiterConfig

Delay

  • Type: typing.Optional[int]

MaxAttempts

  • Type: typing.Optional[int]