Skip to main content

TableDescription

Struct TableDescription 

Source
pub struct TableDescription {
Show 16 fields pub table_name: Option<String>, pub table_arn: Option<String>, pub table_id: Option<String>, pub table_status: Option<String>, pub creation_date_time: Option<f64>, pub item_count: Option<i64>, pub table_size_bytes: Option<i64>, pub billing_mode_summary: Option<BillingModeSummary>, pub provisioned_throughput: Option<ProvisionedThroughputDescription>, pub key_schema: Vec<KeySchemaElement>, pub attribute_definitions: Vec<AttributeDefinition>, pub stream_specification: Option<StreamSpecification>, pub sse_description: Option<SSEDescription>, pub table_class_summary: Option<TableClassSummary>, pub deletion_protection_enabled: Option<bool>, pub archival_summary: Option<ArchivalSummary>,
}
Expand description

Represents the properties of a table.

AWS API: dynamodb.v1.TableDescription Reference: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference//TableDescription

§Coverage

16 of 28 fields included. Omitted fields:

  • LocalSecondaryIndexes — not selected in manifest
  • GlobalSecondaryIndexes — not selected in manifest
  • LatestStreamLabel — not selected in manifest
  • LatestStreamArn — not selected in manifest
  • GlobalTableVersion — not selected in manifest
  • Replicas — not selected in manifest
  • GlobalTableWitnesses — not selected in manifest
  • GlobalTableSettingsReplicationMode — not selected in manifest
  • RestoreSummary — not selected in manifest
  • OnDemandThroughput — not selected in manifest
  • WarmThroughput — not selected in manifest
  • MultiRegionConsistency — not selected in manifest

Fields§

§table_name: Option<String>

The name of the table.

§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.

§table_status: Option<String>

The current state of the table: CREATING

  • The table is being created. UPDATING
  • The table/index configuration is being updated. The table/index remains available for data operations when UPDATING. 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<f64>

The date and time when the table was created, in UNIX epoch time format.

§item_count: Option<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_size_bytes: Option<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.

§billing_mode_summary: Option<BillingModeSummary>

Contains the details for the read/write capacity mode.

§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.

§key_schema: 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.
§attribute_definitions: 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.
§stream_specification: Option<StreamSpecification>

The current DynamoDB Streams configuration for the table.

§sse_description: Option<SSEDescription>

The description of the server-side encryption status on the specified table.

§table_class_summary: Option<TableClassSummary>

Contains details of the table class.

§deletion_protection_enabled: Option<bool>

Indicates whether deletion protection is enabled (true) or disabled (false) on the table.

§archival_summary: Option<ArchivalSummary>

Contains information about the table archive.

Trait Implementations§

Source§

impl Clone for TableDescription

Source§

fn clone(&self) -> TableDescription

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TableDescription

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TableDescription

Source§

fn default() -> TableDescription

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for TableDescription

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for TableDescription

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,