Module aws_sdk_kinesis::types

source ·
Expand description

Data structures used by operation inputs/outputs.

Modules§

  • builders
    Builders
  • error
    Error types that Amazon Kinesis can respond with.

Structs§

  • ChildShard

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

  • Consumer

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

  • ConsumerDescription

    An object that represents the details of a registered consumer. This type of object is returned by DescribeStreamConsumer.

  • EnhancedMetrics

    Represents enhanced metrics types.

  • HashKeyRange

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

  • PutRecordsRequestEntry

    Represents the output for PutRecords.

  • PutRecordsResultEntry

    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.

  • Record

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

  • SequenceNumberRange

    The range of possible sequence numbers for the shard.

  • Shard

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

  • ShardFilter

    The request parameter used to filter out the response of the ListShards API.

  • StreamDescription

    Represents the output for DescribeStream.

  • StreamDescriptionSummary

    Represents the output for DescribeStreamSummary

  • StreamModeDetails

    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.

  • StreamSummary

    The summary of a stream.

  • Tag

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

Enums§

  • ConsumerStatus
    When writing a match expression against ConsumerStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • EncryptionType
    When writing a match expression against EncryptionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • MetricsName
    When writing a match expression against MetricsName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • ScalingType
    When writing a match expression against ScalingType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • ShardFilterType
    When writing a match expression against ShardFilterType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • ShardIteratorType
    When writing a match expression against ShardIteratorType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • StreamMode
    When writing a match expression against StreamMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • StreamStatus
    When writing a match expression against StreamStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.