Struct aws_sdk_dynamodbstreams::model::StreamDescription
source · [−]#[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>,
}
Expand description
Represents all of the data describing a particular stream.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
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
sourceimpl StreamDescription
impl StreamDescription
sourcepub fn stream_arn(&self) -> Option<&str>
pub fn stream_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) for the stream.
sourcepub fn stream_label(&self) -> Option<&str>
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
sourcepub fn stream_status(&self) -> Option<&StreamStatus>
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.
sourcepub fn stream_view_type(&self) -> Option<&StreamViewType>
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.
sourcepub fn creation_request_date_time(&self) -> Option<&DateTime>
pub fn creation_request_date_time(&self) -> Option<&DateTime>
The date and time when the request to create this stream was issued.
sourcepub fn table_name(&self) -> Option<&str>
pub fn table_name(&self) -> Option<&str>
The DynamoDB table with which the stream is associated.
sourcepub fn key_schema(&self) -> Option<&[KeySchemaElement]>
pub fn key_schema(&self) -> Option<&[KeySchemaElement]>
The key attribute(s) of the stream's DynamoDB table.
sourcepub fn last_evaluated_shard_id(&self) -> Option<&str>
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.
sourceimpl StreamDescription
impl StreamDescription
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture StreamDescription
.
Trait Implementations
sourceimpl Clone for StreamDescription
impl Clone for StreamDescription
sourcefn clone(&self) -> StreamDescription
fn clone(&self) -> StreamDescription
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for StreamDescription
impl Debug for StreamDescription
sourceimpl PartialEq<StreamDescription> for StreamDescription
impl PartialEq<StreamDescription> for StreamDescription
sourcefn eq(&self, other: &StreamDescription) -> bool
fn eq(&self, other: &StreamDescription) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &StreamDescription) -> bool
fn ne(&self, other: &StreamDescription) -> bool
This method tests for !=
.
impl StructuralPartialEq for StreamDescription
Auto Trait Implementations
impl RefUnwindSafe for StreamDescription
impl Send for StreamDescription
impl Sync for StreamDescription
impl Unpin for StreamDescription
impl UnwindSafe for StreamDescription
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more