Class: Aws::DynamoDB::Types::TableDescription

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-dynamodb/types.rb

Overview

Represents the properties of a table.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#archival_summary ⇒ Types::ArchivalSummary

Contains information about the table archive.

Returns:



9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 9020

class TableDescription < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :table_status,
  :creation_date_time,
  :provisioned_throughput,
  :table_size_bytes,
  :item_count,
  :table_arn,
  :table_id,
  :billing_mode_summary,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :stream_specification,
  :latest_stream_label,
  :latest_stream_arn,
  :global_table_version,
  :replicas,
  :restore_summary,
  :sse_description,
  :archival_summary,
  :table_class_summary,
  :deletion_protection_enabled,
  :on_demand_throughput,
  :warm_throughput,
  :multi_region_consistency)
  SENSITIVE = []
  include Aws::Structure
end

#attribute_definitions ⇒ Array<Types::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.

Returns:



9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 9020

class TableDescription < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :table_status,
  :creation_date_time,
  :provisioned_throughput,
  :table_size_bytes,
  :item_count,
  :table_arn,
  :table_id,
  :billing_mode_summary,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :stream_specification,
  :latest_stream_label,
  :latest_stream_arn,
  :global_table_version,
  :replicas,
  :restore_summary,
  :sse_description,
  :archival_summary,
  :table_class_summary,
  :deletion_protection_enabled,
  :on_demand_throughput,
  :warm_throughput,
  :multi_region_consistency)
  SENSITIVE = []
  include Aws::Structure
end

#billing_mode_summary ⇒ Types::BillingModeSummary

Contains the details for the read/write capacity mode.

Returns:



9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 9020

class TableDescription < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :table_status,
  :creation_date_time,
  :provisioned_throughput,
  :table_size_bytes,
  :item_count,
  :table_arn,
  :table_id,
  :billing_mode_summary,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :stream_specification,
  :latest_stream_label,
  :latest_stream_arn,
  :global_table_version,
  :replicas,
  :restore_summary,
  :sse_description,
  :archival_summary,
  :table_class_summary,
  :deletion_protection_enabled,
  :on_demand_throughput,
  :warm_throughput,
  :multi_region_consistency)
  SENSITIVE = []
  include Aws::Structure
end

#creation_date_time ⇒ Time

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

[1]: www.epochconverter.com/

Returns:

  • (Time) 


9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 9020

class TableDescription < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :table_status,
  :creation_date_time,
  :provisioned_throughput,
  :table_size_bytes,
  :item_count,
  :table_arn,
  :table_id,
  :billing_mode_summary,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :stream_specification,
  :latest_stream_label,
  :latest_stream_arn,
  :global_table_version,
  :replicas,
  :restore_summary,
  :sse_description,
  :archival_summary,
  :table_class_summary,
  :deletion_protection_enabled,
  :on_demand_throughput,
  :warm_throughput,
  :multi_region_consistency)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protection_enabled ⇒ Boolean

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

Returns:

  • (Boolean) 


9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 9020

class TableDescription < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :table_status,
  :creation_date_time,
  :provisioned_throughput,
  :table_size_bytes,
  :item_count,
  :table_arn,
  :table_id,
  :billing_mode_summary,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :stream_specification,
  :latest_stream_label,
  :latest_stream_arn,
  :global_table_version,
  :replicas,
  :restore_summary,
  :sse_description,
  :archival_summary,
  :table_class_summary,
  :deletion_protection_enabled,
  :on_demand_throughput,
  :warm_throughput,
  :multi_region_consistency)
  SENSITIVE = []
  include Aws::Structure
end

#global_secondary_indexes ⇒ Array<Types::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 a `CreateTable` operation.)

    You can delete an index that is being created during the ‘Backfilling` phase when `IndexStatus` is set to CREATING and `Backfilling` is true. You can’t delete the index that is being created when ‘IndexStatus` is set to CREATING and `Backfilling` is false. (This attribute does not appear for indexes that were created during a `CreateTable` 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 in `KEYS_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 in `NonKeyAttributes`, summed across all of the secondary indexes, must not exceed 100. 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.

Returns:



9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 9020

class TableDescription < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :table_status,
  :creation_date_time,
  :provisioned_throughput,
  :table_size_bytes,
  :item_count,
  :table_arn,
  :table_id,
  :billing_mode_summary,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :stream_specification,
  :latest_stream_label,
  :latest_stream_arn,
  :global_table_version,
  :replicas,
  :restore_summary,
  :sse_description,
  :archival_summary,
  :table_class_summary,
  :deletion_protection_enabled,
  :on_demand_throughput,
  :warm_throughput,
  :multi_region_consistency)
  SENSITIVE = []
  include Aws::Structure
end

#global_table_version ⇒ String

Represents the version of [global tables] in use, if the table is replicated across Amazon Web Services Regions.

[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html

Returns:

  • (String) 


9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 9020

class TableDescription < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :table_status,
  :creation_date_time,
  :provisioned_throughput,
  :table_size_bytes,
  :item_count,
  :table_arn,
  :table_id,
  :billing_mode_summary,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :stream_specification,
  :latest_stream_label,
  :latest_stream_arn,
  :global_table_version,
  :replicas,
  :restore_summary,
  :sse_description,
  :archival_summary,
  :table_class_summary,
  :deletion_protection_enabled,
  :on_demand_throughput,
  :warm_throughput,
  :multi_region_consistency)
  SENSITIVE = []
  include Aws::Structure
end

#item_count ⇒ Integer

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.

Returns:

  • (Integer) 


9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 9020

class TableDescription < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :table_status,
  :creation_date_time,
  :provisioned_throughput,
  :table_size_bytes,
  :item_count,
  :table_arn,
  :table_id,
  :billing_mode_summary,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :stream_specification,
  :latest_stream_label,
  :latest_stream_arn,
  :global_table_version,
  :replicas,
  :restore_summary,
  :sse_description,
  :archival_summary,
  :table_class_summary,
  :deletion_protection_enabled,
  :on_demand_throughput,
  :warm_throughput,
  :multi_region_consistency)
  SENSITIVE = []
  include Aws::Structure
end

#key_schema ⇒ Array<Types::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

    <note markdown=“1”> 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.

    </note>

For more information about primary keys, see [Primary Key] in the *Amazon DynamoDB Developer Guide*.

[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html#DataModelPrimaryKey

Returns:



9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 9020

class TableDescription < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :table_status,
  :creation_date_time,
  :provisioned_throughput,
  :table_size_bytes,
  :item_count,
  :table_arn,
  :table_id,
  :billing_mode_summary,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :stream_specification,
  :latest_stream_label,
  :latest_stream_arn,
  :global_table_version,
  :replicas,
  :restore_summary,
  :sse_description,
  :archival_summary,
  :table_class_summary,
  :deletion_protection_enabled,
  :on_demand_throughput,
  :warm_throughput,
  :multi_region_consistency)
  SENSITIVE = []
  include Aws::Structure
end

#latest_stream_arn ⇒ String

The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.

Returns:

  • (String) 


9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 9020

class TableDescription < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :table_status,
  :creation_date_time,
  :provisioned_throughput,
  :table_size_bytes,
  :item_count,
  :table_arn,
  :table_id,
  :billing_mode_summary,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :stream_specification,
  :latest_stream_label,
  :latest_stream_arn,
  :global_table_version,
  :replicas,
  :restore_summary,
  :sse_description,
  :archival_summary,
  :table_class_summary,
  :deletion_protection_enabled,
  :on_demand_throughput,
  :warm_throughput,
  :multi_region_consistency)
  SENSITIVE = []
  include Aws::Structure
end

#latest_stream_label ⇒ 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`

Returns:

  • (String) 


9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 9020

class TableDescription < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :table_status,
  :creation_date_time,
  :provisioned_throughput,
  :table_size_bytes,
  :item_count,
  :table_arn,
  :table_id,
  :billing_mode_summary,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :stream_specification,
  :latest_stream_label,
  :latest_stream_arn,
  :global_table_version,
  :replicas,
  :restore_summary,
  :sse_description,
  :archival_summary,
  :table_class_summary,
  :deletion_protection_enabled,
  :on_demand_throughput,
  :warm_throughput,
  :multi_region_consistency)
  SENSITIVE = []
  include Aws::Structure
end

#local_secondary_indexes ⇒ Array<Types::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 in `NonKeyAttributes`.

      • ‘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 in `NonKeyAttributes`, summed across all of the secondary indexes, must not exceed 100. 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.

Returns:



9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 9020

class TableDescription < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :table_status,
  :creation_date_time,
  :provisioned_throughput,
  :table_size_bytes,
  :item_count,
  :table_arn,
  :table_id,
  :billing_mode_summary,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :stream_specification,
  :latest_stream_label,
  :latest_stream_arn,
  :global_table_version,
  :replicas,
  :restore_summary,
  :sse_description,
  :archival_summary,
  :table_class_summary,
  :deletion_protection_enabled,
  :on_demand_throughput,
  :warm_throughput,
  :multi_region_consistency)
  SENSITIVE = []
  include Aws::Structure
end

#multi_region_consistency ⇒ String

Indicates one of the following consistency modes for a global table:

  • ‘EVENTUAL`: Indicates that the global table is configured for multi-Region eventual consistency.

  • ‘STRONG`: Indicates that the global table is configured for multi-Region strong consistency (preview).

    <note markdown=“1”> Multi-Region strong consistency (MRSC) is a new DynamoDB global tables capability currently available in preview mode. For more information, see [Global tables multi-Region strong consistency].

    </note>

If you don’t specify this field, the global table consistency mode defaults to ‘EVENTUAL`.

[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/PreviewFeatures.html#multi-region-strong-consistency-gt

Returns:

  • (String) 


9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 9020

class TableDescription < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :table_status,
  :creation_date_time,
  :provisioned_throughput,
  :table_size_bytes,
  :item_count,
  :table_arn,
  :table_id,
  :billing_mode_summary,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :stream_specification,
  :latest_stream_label,
  :latest_stream_arn,
  :global_table_version,
  :replicas,
  :restore_summary,
  :sse_description,
  :archival_summary,
  :table_class_summary,
  :deletion_protection_enabled,
  :on_demand_throughput,
  :warm_throughput,
  :multi_region_consistency)
  SENSITIVE = []
  include Aws::Structure
end

#on_demand_throughput ⇒ Types::OnDemandThroughput

The maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify ‘MaxReadRequestUnits`, `MaxWriteRequestUnits`, or both.

Returns:



9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 9020

class TableDescription < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :table_status,
  :creation_date_time,
  :provisioned_throughput,
  :table_size_bytes,
  :item_count,
  :table_arn,
  :table_id,
  :billing_mode_summary,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :stream_specification,
  :latest_stream_label,
  :latest_stream_arn,
  :global_table_version,
  :replicas,
  :restore_summary,
  :sse_description,
  :archival_summary,
  :table_class_summary,
  :deletion_protection_enabled,
  :on_demand_throughput,
  :warm_throughput,
  :multi_region_consistency)
  SENSITIVE = []
  include Aws::Structure
end

#provisioned_throughput ⇒ Types::ProvisionedThroughputDescription

The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

Returns:



9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 9020

class TableDescription < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :table_status,
  :creation_date_time,
  :provisioned_throughput,
  :table_size_bytes,
  :item_count,
  :table_arn,
  :table_id,
  :billing_mode_summary,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :stream_specification,
  :latest_stream_label,
  :latest_stream_arn,
  :global_table_version,
  :replicas,
  :restore_summary,
  :sse_description,
  :archival_summary,
  :table_class_summary,
  :deletion_protection_enabled,
  :on_demand_throughput,
  :warm_throughput,
  :multi_region_consistency)
  SENSITIVE = []
  include Aws::Structure
end

#replicas ⇒ Array<Types::ReplicaDescription>

Represents replicas of the table.

Returns:



9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 9020

class TableDescription < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :table_status,
  :creation_date_time,
  :provisioned_throughput,
  :table_size_bytes,
  :item_count,
  :table_arn,
  :table_id,
  :billing_mode_summary,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :stream_specification,
  :latest_stream_label,
  :latest_stream_arn,
  :global_table_version,
  :replicas,
  :restore_summary,
  :sse_description,
  :archival_summary,
  :table_class_summary,
  :deletion_protection_enabled,
  :on_demand_throughput,
  :warm_throughput,
  :multi_region_consistency)
  SENSITIVE = []
  include Aws::Structure
end

#restore_summary ⇒ Types::RestoreSummary

Contains details for the restore.

Returns:



9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 9020

class TableDescription < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :table_status,
  :creation_date_time,
  :provisioned_throughput,
  :table_size_bytes,
  :item_count,
  :table_arn,
  :table_id,
  :billing_mode_summary,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :stream_specification,
  :latest_stream_label,
  :latest_stream_arn,
  :global_table_version,
  :replicas,
  :restore_summary,
  :sse_description,
  :archival_summary,
  :table_class_summary,
  :deletion_protection_enabled,
  :on_demand_throughput,
  :warm_throughput,
  :multi_region_consistency)
  SENSITIVE = []
  include Aws::Structure
end

#sse_description ⇒ Types::SSEDescription

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

Returns:



9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 9020

class TableDescription < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :table_status,
  :creation_date_time,
  :provisioned_throughput,
  :table_size_bytes,
  :item_count,
  :table_arn,
  :table_id,
  :billing_mode_summary,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :stream_specification,
  :latest_stream_label,
  :latest_stream_arn,
  :global_table_version,
  :replicas,
  :restore_summary,
  :sse_description,
  :archival_summary,
  :table_class_summary,
  :deletion_protection_enabled,
  :on_demand_throughput,
  :warm_throughput,
  :multi_region_consistency)
  SENSITIVE = []
  include Aws::Structure
end

#stream_specification ⇒ Types::StreamSpecification

The current DynamoDB Streams configuration for the table.

Returns:



9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 9020

class TableDescription < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :table_status,
  :creation_date_time,
  :provisioned_throughput,
  :table_size_bytes,
  :item_count,
  :table_arn,
  :table_id,
  :billing_mode_summary,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :stream_specification,
  :latest_stream_label,
  :latest_stream_arn,
  :global_table_version,
  :replicas,
  :restore_summary,
  :sse_description,
  :archival_summary,
  :table_class_summary,
  :deletion_protection_enabled,
  :on_demand_throughput,
  :warm_throughput,
  :multi_region_consistency)
  SENSITIVE = []
  include Aws::Structure
end

#table_arn ⇒ String

The Amazon Resource Name (ARN) that uniquely identifies the table.

Returns:

  • (String) 


9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 9020

class TableDescription < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :table_status,
  :creation_date_time,
  :provisioned_throughput,
  :table_size_bytes,
  :item_count,
  :table_arn,
  :table_id,
  :billing_mode_summary,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :stream_specification,
  :latest_stream_label,
  :latest_stream_arn,
  :global_table_version,
  :replicas,
  :restore_summary,
  :sse_description,
  :archival_summary,
  :table_class_summary,
  :deletion_protection_enabled,
  :on_demand_throughput,
  :warm_throughput,
  :multi_region_consistency)
  SENSITIVE = []
  include Aws::Structure
end

#table_class_summary ⇒ Types::TableClassSummary

Contains details of the table class.

Returns:



9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 9020

class TableDescription < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :table_status,
  :creation_date_time,
  :provisioned_throughput,
  :table_size_bytes,
  :item_count,
  :table_arn,
  :table_id,
  :billing_mode_summary,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :stream_specification,
  :latest_stream_label,
  :latest_stream_arn,
  :global_table_version,
  :replicas,
  :restore_summary,
  :sse_description,
  :archival_summary,
  :table_class_summary,
  :deletion_protection_enabled,
  :on_demand_throughput,
  :warm_throughput,
  :multi_region_consistency)
  SENSITIVE = []
  include Aws::Structure
end

#table_id ⇒ String

Unique identifier for the table for which the backup was created.

Returns:

  • (String) 


9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 9020

class TableDescription < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :table_status,
  :creation_date_time,
  :provisioned_throughput,
  :table_size_bytes,
  :item_count,
  :table_arn,
  :table_id,
  :billing_mode_summary,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :stream_specification,
  :latest_stream_label,
  :latest_stream_arn,
  :global_table_version,
  :replicas,
  :restore_summary,
  :sse_description,
  :archival_summary,
  :table_class_summary,
  :deletion_protection_enabled,
  :on_demand_throughput,
  :warm_throughput,
  :multi_region_consistency)
  SENSITIVE = []
  include Aws::Structure
end

#table_name ⇒ String

The name of the table.

Returns:

  • (String) 


9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 9020

class TableDescription < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :table_status,
  :creation_date_time,
  :provisioned_throughput,
  :table_size_bytes,
  :item_count,
  :table_arn,
  :table_id,
  :billing_mode_summary,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :stream_specification,
  :latest_stream_label,
  :latest_stream_arn,
  :global_table_version,
  :replicas,
  :restore_summary,
  :sse_description,
  :archival_summary,
  :table_class_summary,
  :deletion_protection_enabled,
  :on_demand_throughput,
  :warm_throughput,
  :multi_region_consistency)
  SENSITIVE = []
  include Aws::Structure
end

#table_size_bytes ⇒ Integer

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.

Returns:

  • (Integer) 


9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 9020

class TableDescription < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :table_status,
  :creation_date_time,
  :provisioned_throughput,
  :table_size_bytes,
  :item_count,
  :table_arn,
  :table_id,
  :billing_mode_summary,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :stream_specification,
  :latest_stream_label,
  :latest_stream_arn,
  :global_table_version,
  :replicas,
  :restore_summary,
  :sse_description,
  :archival_summary,
  :table_class_summary,
  :deletion_protection_enabled,
  :on_demand_throughput,
  :warm_throughput,
  :multi_region_consistency)
  SENSITIVE = []
  include Aws::Structure
end

#table_status ⇒ 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.

Returns:

  • (String) 


9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 9020

class TableDescription < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :table_status,
  :creation_date_time,
  :provisioned_throughput,
  :table_size_bytes,
  :item_count,
  :table_arn,
  :table_id,
  :billing_mode_summary,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :stream_specification,
  :latest_stream_label,
  :latest_stream_arn,
  :global_table_version,
  :replicas,
  :restore_summary,
  :sse_description,
  :archival_summary,
  :table_class_summary,
  :deletion_protection_enabled,
  :on_demand_throughput,
  :warm_throughput,
  :multi_region_consistency)
  SENSITIVE = []
  include Aws::Structure
end

#warm_throughput ⇒ Types::TableWarmThroughputDescription

Describes the warm throughput value of the base table.

Returns:



9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 9020

class TableDescription < Struct.new(
  :attribute_definitions,
  :table_name,
  :key_schema,
  :table_status,
  :creation_date_time,
  :provisioned_throughput,
  :table_size_bytes,
  :item_count,
  :table_arn,
  :table_id,
  :billing_mode_summary,
  :local_secondary_indexes,
  :global_secondary_indexes,
  :stream_specification,
  :latest_stream_label,
  :latest_stream_arn,
  :global_table_version,
  :replicas,
  :restore_summary,
  :sse_description,
  :archival_summary,
  :table_class_summary,
  :deletion_protection_enabled,
  :on_demand_throughput,
  :warm_throughput,
  :multi_region_consistency)
  SENSITIVE = []
  include Aws::Structure
end