Struct aws_sdk_dynamodbstreams::model::StreamDescription

#[non_exhaustive]
pub struct StreamDescription {
    pub stream_arn: Option<String>,
    pub stream_label: Option<String>,
    pub stream_status: Option<StreamStatus>,
    pub stream_view_type: Option<StreamViewType>,
    pub creation_request_date_time: Option<DateTime>,
    pub table_name: Option<String>,
    pub key_schema: Option<Vec<KeySchemaElement>>,
    pub shards: Option<Vec<Shard>>,
    pub last_evaluated_shard_id: Option<String>,
}

Represents all of the data describing a particular stream.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

stream_arn: Option<String>

The Amazon Resource Name (ARN) for the stream.

stream_label: Option<String>

A timestamp, in ISO 8601 format, for this stream.

Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

• the AWS customer ID.

• the table name

• the StreamLabel

stream_status: Option<StreamStatus>

Indicates the current status of the stream:

• ENABLING - Streams is currently being enabled on the DynamoDB table.

• ENABLED - the stream is enabled.

• DISABLING - Streams is currently being disabled on the DynamoDB table.

• DISABLED - the stream is disabled.

stream_view_type: Option<StreamViewType>

Indicates the format of the records within this stream:

• KEYS_ONLY - only the key attributes of items that were modified in the DynamoDB table.

• NEW_IMAGE - entire items from the table, as they appeared after they were modified.

• OLD_IMAGE - entire items from the table, as they appeared before they were modified.

• NEW_AND_OLD_IMAGES - both the new and the old images of the items from the table.

creation_request_date_time: Option<DateTime>

The date and time when the request to create this stream was issued.

table_name: Option<String>

The DynamoDB table with which the stream is associated.

key_schema: Option<Vec<KeySchemaElement>>

The key attribute(s) of the stream's DynamoDB table.

shards: Option<Vec<Shard>>

The shards that comprise the stream.

last_evaluated_shard_id: Option<String>

The shard ID of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedShardId is empty, then the "last page" of results has been processed and there is currently no more data to be retrieved.

If LastEvaluatedShardId is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedShardId is empty.

Implementations

impl StreamDescription

pub fn stream_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) for the stream.

pub fn stream_label(&self) -> Option<&str>

A timestamp, in ISO 8601 format, for this stream.

Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

• the AWS customer ID.

• the table name

• the StreamLabel

pub fn stream_status(&self) -> Option<&StreamStatus>

Indicates the current status of the stream:

• ENABLING - Streams is currently being enabled on the DynamoDB table.

• ENABLED - the stream is enabled.

• DISABLING - Streams is currently being disabled on the DynamoDB table.

• DISABLED - the stream is disabled.

pub fn stream_view_type(&self) -> Option<&StreamViewType>

Indicates the format of the records within this stream:

• KEYS_ONLY - only the key attributes of items that were modified in the DynamoDB table.

• NEW_IMAGE - entire items from the table, as they appeared after they were modified.

• OLD_IMAGE - entire items from the table, as they appeared before they were modified.

• NEW_AND_OLD_IMAGES - both the new and the old images of the items from the table.

pub fn creation_request_date_time(&self) -> Option<&DateTime>

The date and time when the request to create this stream was issued.

pub fn table_name(&self) -> Option<&str>

The DynamoDB table with which the stream is associated.

pub fn key_schema(&self) -> Option<&[KeySchemaElement]>

The key attribute(s) of the stream's DynamoDB table.

pub fn shards(&self) -> Option<&[Shard]>

The shards that comprise the stream.

pub fn last_evaluated_shard_id(&self) -> Option<&str>

The shard ID of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedShardId is empty, then the "last page" of results has been processed and there is currently no more data to be retrieved.

If LastEvaluatedShardId is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedShardId is empty.

impl StreamDescription

pub fn builder() -> Builder

Creates a new builder-style object to manufacture StreamDescription

Trait Implementations

impl Clone for StreamDescription

fn clone(&self) -> StreamDescription

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StreamDescription

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<StreamDescription> for StreamDescription

fn eq(&self, other: &StreamDescription) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &StreamDescription) -> bool

This method tests for !=.

impl StructuralPartialEq for StreamDescription