Struct aws_sdk_dynamodb::model::TableDescription
source · [−]#[non_exhaustive]pub struct TableDescription {Show 22 fields
pub attribute_definitions: Option<Vec<AttributeDefinition>>,
pub table_name: Option<String>,
pub key_schema: Option<Vec<KeySchemaElement>>,
pub table_status: Option<TableStatus>,
pub creation_date_time: Option<DateTime>,
pub provisioned_throughput: Option<ProvisionedThroughputDescription>,
pub table_size_bytes: i64,
pub item_count: i64,
pub table_arn: Option<String>,
pub table_id: Option<String>,
pub billing_mode_summary: Option<BillingModeSummary>,
pub local_secondary_indexes: Option<Vec<LocalSecondaryIndexDescription>>,
pub global_secondary_indexes: Option<Vec<GlobalSecondaryIndexDescription>>,
pub stream_specification: Option<StreamSpecification>,
pub latest_stream_label: Option<String>,
pub latest_stream_arn: Option<String>,
pub global_table_version: Option<String>,
pub replicas: Option<Vec<ReplicaDescription>>,
pub restore_summary: Option<RestoreSummary>,
pub sse_description: Option<SseDescription>,
pub archival_summary: Option<ArchivalSummary>,
pub table_class_summary: Option<TableClassSummary>,
}
Expand description
Represents the properties of a table.
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.attribute_definitions: Option<Vec<AttributeDefinition>>
An array of AttributeDefinition
objects. Each of these objects describes one attribute in the table and index key schema.
Each AttributeDefinition
object in this array is composed of:
-
AttributeName
- The name of the attribute. -
AttributeType
- The data type for the attribute.
table_name: Option<String>
The name of the table.
key_schema: Option<Vec<KeySchemaElement>>
The primary key structure for the table. Each KeySchemaElement
consists of:
-
AttributeName
- The name of the attribute. -
KeyType
- The role of the attribute:-
HASH
- partition key -
RANGE
- sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
-
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
table_status: Option<TableStatus>
The current state of the table:
-
CREATING
- The table is being created. -
UPDATING
- The table is being updated. -
DELETING
- The table is being deleted. -
ACTIVE
- The table is ready for use. -
INACCESSIBLE_ENCRYPTION_CREDENTIALS
- The KMS key used to encrypt the table in inaccessible. Table operations may fail due to failure to use the KMS key. DynamoDB will initiate the table archival process when a table's KMS key remains inaccessible for more than seven days. -
ARCHIVING
- The table is being archived. Operations are not allowed until archival is complete. -
ARCHIVED
- The table has been archived. See the ArchivalReason for more information.
creation_date_time: Option<DateTime>
The date and time when the table was created, in UNIX epoch time format.
provisioned_throughput: Option<ProvisionedThroughputDescription>
The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
table_size_bytes: i64
The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
item_count: i64
The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
table_arn: Option<String>
The Amazon Resource Name (ARN) that uniquely identifies the table.
table_id: Option<String>
Unique identifier for the table for which the backup was created.
billing_mode_summary: Option<BillingModeSummary>
Contains the details for the read/write capacity mode.
local_secondary_indexes: Option<Vec<LocalSecondaryIndexDescription>>
Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:
-
IndexName
- The name of the local secondary index. -
KeySchema
- Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table. -
Projection
- Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:-
ProjectionType
- One of the following:-
KEYS_ONLY
- Only the index and primary keys are projected into the index. -
INCLUDE
- Only the specified table attributes are projected into the index. The list of projected attributes is inNonKeyAttributes
. -
ALL
- All of the table attributes are projected into the index.
-
-
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided inNonKeyAttributes
, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
-
-
IndexSizeBytes
- Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. -
ItemCount
- Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
If the table is in the DELETING
state, no information about indexes will be returned.
global_secondary_indexes: Option<Vec<GlobalSecondaryIndexDescription>>
The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:
-
Backfilling
- If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table. It is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during aCreateTable
operation.)You can delete an index that is being created during the
Backfilling
phase whenIndexStatus
is set to CREATING andBackfilling
is true. You can't delete the index that is being created whenIndexStatus
is set to CREATING andBackfilling
is false. (This attribute does not appear for indexes that were created during aCreateTable
operation.) -
IndexName
- The name of the global secondary index. -
IndexSizeBytes
- The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. -
IndexStatus
- The current status of the global secondary index:-
CREATING
- The index is being created. -
UPDATING
- The index is being updated. -
DELETING
- The index is being deleted. -
ACTIVE
- The index is ready for use.
-
-
ItemCount
- The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. -
KeySchema
- Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table. -
Projection
- Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:-
ProjectionType
- One of the following:-
KEYS_ONLY
- Only the index and primary keys are projected into the index. -
INCLUDE
- In addition to the attributes described inKEYS_ONLY
, the secondary index will include other non-key attributes that you specify. -
ALL
- All of the table attributes are projected into the index.
-
-
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided inNonKeyAttributes
, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
-
-
ProvisionedThroughput
- The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases.
If the table is in the DELETING
state, no information about indexes will be returned.
stream_specification: Option<StreamSpecification>
The current DynamoDB Streams configuration for the table.
latest_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:
-
Amazon Web Services customer ID
-
Table name
-
StreamLabel
latest_stream_arn: Option<String>
The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
global_table_version: Option<String>
Represents the version of global tables in use, if the table is replicated across Amazon Web Services Regions.
replicas: Option<Vec<ReplicaDescription>>
Represents replicas of the table.
restore_summary: Option<RestoreSummary>
Contains details for the restore.
sse_description: Option<SseDescription>
The description of the server-side encryption status on the specified table.
archival_summary: Option<ArchivalSummary>
Contains information about the table archive.
table_class_summary: Option<TableClassSummary>
Contains details of the table class.
Implementations
sourceimpl TableDescription
impl TableDescription
sourcepub fn attribute_definitions(&self) -> Option<&[AttributeDefinition]>
pub fn attribute_definitions(&self) -> Option<&[AttributeDefinition]>
An array of AttributeDefinition
objects. Each of these objects describes one attribute in the table and index key schema.
Each AttributeDefinition
object in this array is composed of:
-
AttributeName
- The name of the attribute. -
AttributeType
- The data type for the attribute.
sourcepub fn table_name(&self) -> Option<&str>
pub fn table_name(&self) -> Option<&str>
The name of the table.
sourcepub fn key_schema(&self) -> Option<&[KeySchemaElement]>
pub fn key_schema(&self) -> Option<&[KeySchemaElement]>
The primary key structure for the table. Each KeySchemaElement
consists of:
-
AttributeName
- The name of the attribute. -
KeyType
- The role of the attribute:-
HASH
- partition key -
RANGE
- sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
-
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
sourcepub fn table_status(&self) -> Option<&TableStatus>
pub fn table_status(&self) -> Option<&TableStatus>
The current state of the table:
-
CREATING
- The table is being created. -
UPDATING
- The table is being updated. -
DELETING
- The table is being deleted. -
ACTIVE
- The table is ready for use. -
INACCESSIBLE_ENCRYPTION_CREDENTIALS
- The KMS key used to encrypt the table in inaccessible. Table operations may fail due to failure to use the KMS key. DynamoDB will initiate the table archival process when a table's KMS key remains inaccessible for more than seven days. -
ARCHIVING
- The table is being archived. Operations are not allowed until archival is complete. -
ARCHIVED
- The table has been archived. See the ArchivalReason for more information.
sourcepub fn creation_date_time(&self) -> Option<&DateTime>
pub fn creation_date_time(&self) -> Option<&DateTime>
The date and time when the table was created, in UNIX epoch time format.
sourcepub fn provisioned_throughput(
&self
) -> Option<&ProvisionedThroughputDescription>
pub fn provisioned_throughput(
&self
) -> Option<&ProvisionedThroughputDescription>
The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
sourcepub fn table_size_bytes(&self) -> i64
pub fn table_size_bytes(&self) -> i64
The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
sourcepub fn item_count(&self) -> i64
pub fn item_count(&self) -> i64
The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
sourcepub fn table_arn(&self) -> Option<&str>
pub fn table_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) that uniquely identifies the table.
sourcepub fn table_id(&self) -> Option<&str>
pub fn table_id(&self) -> Option<&str>
Unique identifier for the table for which the backup was created.
sourcepub fn billing_mode_summary(&self) -> Option<&BillingModeSummary>
pub fn billing_mode_summary(&self) -> Option<&BillingModeSummary>
Contains the details for the read/write capacity mode.
sourcepub fn local_secondary_indexes(
&self
) -> Option<&[LocalSecondaryIndexDescription]>
pub fn local_secondary_indexes(
&self
) -> Option<&[LocalSecondaryIndexDescription]>
Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:
-
IndexName
- The name of the local secondary index. -
KeySchema
- Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table. -
Projection
- Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:-
ProjectionType
- One of the following:-
KEYS_ONLY
- Only the index and primary keys are projected into the index. -
INCLUDE
- Only the specified table attributes are projected into the index. The list of projected attributes is inNonKeyAttributes
. -
ALL
- All of the table attributes are projected into the index.
-
-
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided inNonKeyAttributes
, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
-
-
IndexSizeBytes
- Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. -
ItemCount
- Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
If the table is in the DELETING
state, no information about indexes will be returned.
sourcepub fn global_secondary_indexes(
&self
) -> Option<&[GlobalSecondaryIndexDescription]>
pub fn global_secondary_indexes(
&self
) -> Option<&[GlobalSecondaryIndexDescription]>
The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:
-
Backfilling
- If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table. It is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during aCreateTable
operation.)You can delete an index that is being created during the
Backfilling
phase whenIndexStatus
is set to CREATING andBackfilling
is true. You can't delete the index that is being created whenIndexStatus
is set to CREATING andBackfilling
is false. (This attribute does not appear for indexes that were created during aCreateTable
operation.) -
IndexName
- The name of the global secondary index. -
IndexSizeBytes
- The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. -
IndexStatus
- The current status of the global secondary index:-
CREATING
- The index is being created. -
UPDATING
- The index is being updated. -
DELETING
- The index is being deleted. -
ACTIVE
- The index is ready for use.
-
-
ItemCount
- The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. -
KeySchema
- Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table. -
Projection
- Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:-
ProjectionType
- One of the following:-
KEYS_ONLY
- Only the index and primary keys are projected into the index. -
INCLUDE
- In addition to the attributes described inKEYS_ONLY
, the secondary index will include other non-key attributes that you specify. -
ALL
- All of the table attributes are projected into the index.
-
-
NonKeyAttributes
- A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided inNonKeyAttributes
, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
-
-
ProvisionedThroughput
- The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases.
If the table is in the DELETING
state, no information about indexes will be returned.
sourcepub fn stream_specification(&self) -> Option<&StreamSpecification>
pub fn stream_specification(&self) -> Option<&StreamSpecification>
The current DynamoDB Streams configuration for the table.
sourcepub fn latest_stream_label(&self) -> Option<&str>
pub fn latest_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:
-
Amazon Web Services customer ID
-
Table name
-
StreamLabel
sourcepub fn latest_stream_arn(&self) -> Option<&str>
pub fn latest_stream_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
sourcepub fn global_table_version(&self) -> Option<&str>
pub fn global_table_version(&self) -> Option<&str>
Represents the version of global tables in use, if the table is replicated across Amazon Web Services Regions.
sourcepub fn restore_summary(&self) -> Option<&RestoreSummary>
pub fn restore_summary(&self) -> Option<&RestoreSummary>
Contains details for the restore.
sourcepub fn sse_description(&self) -> Option<&SseDescription>
pub fn sse_description(&self) -> Option<&SseDescription>
The description of the server-side encryption status on the specified table.
sourcepub fn archival_summary(&self) -> Option<&ArchivalSummary>
pub fn archival_summary(&self) -> Option<&ArchivalSummary>
Contains information about the table archive.
sourcepub fn table_class_summary(&self) -> Option<&TableClassSummary>
pub fn table_class_summary(&self) -> Option<&TableClassSummary>
Contains details of the table class.
sourceimpl TableDescription
impl TableDescription
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture TableDescription
Trait Implementations
sourceimpl Clone for TableDescription
impl Clone for TableDescription
sourcefn clone(&self) -> TableDescription
fn clone(&self) -> TableDescription
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 TableDescription
impl Debug for TableDescription
sourceimpl PartialEq<TableDescription> for TableDescription
impl PartialEq<TableDescription> for TableDescription
sourcefn eq(&self, other: &TableDescription) -> bool
fn eq(&self, other: &TableDescription) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &TableDescription) -> bool
fn ne(&self, other: &TableDescription) -> bool
This method tests for !=
.
impl StructuralPartialEq for TableDescription
Auto Trait Implementations
impl RefUnwindSafe for TableDescription
impl Send for TableDescription
impl Sync for TableDescription
impl Unpin for TableDescription
impl UnwindSafe for TableDescription
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> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
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