2025/06/30 - Amazon DynamoDB - 13 updated api methods
Changes This change adds support for witnesses in global tables. It also adds a new table status, REPLICATION_NOT_AUTHORIZED. This status will indicate scenarios where global replicas table can't be utilized for data plane operations.
{'GlobalTableDescription': {'ReplicationGroup': {'ReplicaStatus': {'ARCHIVED',
'ARCHIVING',
'REPLICATION_NOT_AUTHORIZED'},
'WarmThroughput': {'Status': {'REPLICATION_NOT_AUTHORIZED'}}}}}
Creates a global table from an existing table. A global table creates a replication relationship between two or more DynamoDB tables with the same table name in the provided Regions.
If you want to add a new replica table to a global table, each of the following conditions must be true:
The table must have the same primary key as all of the other replicas.
The table must have the same name as all of the other replicas.
The table must have DynamoDB Streams enabled, with the stream containing both the new and the old images of the item.
None of the replica tables in the global table can contain any data.
If global secondary indexes are specified, then the following conditions must also be met:
The global secondary indexes must have the same name.
The global secondary indexes must have the same hash key and sort key (if present).
If local secondary indexes are specified, then the following conditions must also be met:
The local secondary indexes must have the same name.
The local secondary indexes must have the same hash key and sort key (if present).
See also: AWS API Documentation
Request Syntax
client.create_global_table(
GlobalTableName='string',
ReplicationGroup=[
{
'RegionName': 'string'
},
]
)
string
[REQUIRED]
The global table name.
list
[REQUIRED]
The Regions where the global table needs to be created.
(dict) --
Represents the properties of a replica.
RegionName (string) --
The Region where the replica needs to be created.
dict
Response Syntax
{
'GlobalTableDescription': {
'ReplicationGroup': [
{
'RegionName': 'string',
'ReplicaStatus': 'CREATING'|'CREATION_FAILED'|'UPDATING'|'DELETING'|'ACTIVE'|'REGION_DISABLED'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED',
'ReplicaStatusDescription': 'string',
'ReplicaStatusPercentProgress': 'string',
'KMSMasterKeyId': 'string',
'ProvisionedThroughputOverride': {
'ReadCapacityUnits': 123
},
'OnDemandThroughputOverride': {
'MaxReadRequestUnits': 123
},
'WarmThroughput': {
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123,
'Status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED'
},
'GlobalSecondaryIndexes': [
{
'IndexName': 'string',
'ProvisionedThroughputOverride': {
'ReadCapacityUnits': 123
},
'OnDemandThroughputOverride': {
'MaxReadRequestUnits': 123
},
'WarmThroughput': {
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123,
'Status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'
}
},
],
'ReplicaInaccessibleDateTime': datetime(2015, 1, 1),
'ReplicaTableClassSummary': {
'TableClass': 'STANDARD'|'STANDARD_INFREQUENT_ACCESS',
'LastUpdateDateTime': datetime(2015, 1, 1)
}
},
],
'GlobalTableArn': 'string',
'CreationDateTime': datetime(2015, 1, 1),
'GlobalTableStatus': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING',
'GlobalTableName': 'string'
}
}
Response Structure
(dict) --
GlobalTableDescription (dict) --
Contains the details of the global table.
ReplicationGroup (list) --
The Regions where the global table has replicas.
(dict) --
Contains the details of the replica.
RegionName (string) --
The name of the Region.
ReplicaStatus (string) --
The current state of the replica:
CREATING - The replica is being created.
UPDATING - The replica is being updated.
DELETING - The replica is being deleted.
ACTIVE - The replica is ready for use.
REGION_DISABLED - The replica is inaccessible because the Amazon Web Services Region has been disabled.
INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table is inaccessible.
ReplicaStatusDescription (string) --
Detailed information about the replica status.
ReplicaStatusPercentProgress (string) --
Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.
KMSMasterKeyId (string) --
The KMS key of the replica that will be used for KMS encryption.
ProvisionedThroughputOverride (dict) --
Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings.
ReadCapacityUnits (integer) --
Replica-specific read capacity units. If not specified, uses the source table's read capacity settings.
OnDemandThroughputOverride (dict) --
Overrides the maximum on-demand throughput settings for the specified replica table.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified replica table.
WarmThroughput (dict) --
Represents the warm throughput value for this replica.
ReadUnitsPerSecond (integer) --
Represents the base table's warm throughput value in read units per second.
WriteUnitsPerSecond (integer) --
Represents the base table's warm throughput value in write units per second.
Status (string) --
Represents warm throughput value of the base table.
GlobalSecondaryIndexes (list) --
Replica-specific global secondary index settings.
(dict) --
Represents the properties of a replica global secondary index.
IndexName (string) --
The name of the global secondary index.
ProvisionedThroughputOverride (dict) --
If not described, uses the source table GSI's read capacity settings.
ReadCapacityUnits (integer) --
Replica-specific read capacity units. If not specified, uses the source table's read capacity settings.
OnDemandThroughputOverride (dict) --
Overrides the maximum on-demand throughput for the specified global secondary index in the specified replica table.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified replica table.
WarmThroughput (dict) --
Represents the warm throughput of the global secondary index for this replica.
ReadUnitsPerSecond (integer) --
Represents warm throughput read units per second value for a global secondary index.
WriteUnitsPerSecond (integer) --
Represents warm throughput write units per second value for a global secondary index.
Status (string) --
Represents the warm throughput status being created or updated on a global secondary index. The status can only be UPDATING or ACTIVE.
ReplicaInaccessibleDateTime (datetime) --
The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the ReplicaStatus property.
ReplicaTableClassSummary (dict) --
Contains details of the table class.
TableClass (string) --
The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
LastUpdateDateTime (datetime) --
The date and time at which the table class was last updated.
GlobalTableArn (string) --
The unique identifier of the global table.
CreationDateTime (datetime) --
The creation time of the global table.
GlobalTableStatus (string) --
The current state of the global table:
CREATING - The global table is being created.
UPDATING - The global table is being updated.
DELETING - The global table is being deleted.
ACTIVE - The global table is ready for use.
GlobalTableName (string) --
The global table name.
{'TableDescription': {'GlobalTableWitnesses': [{'RegionName': 'string',
'WitnessStatus': 'CREATING | '
'DELETING | '
'ACTIVE'}],
'Replicas': {'ReplicaStatus': {'ARCHIVED',
'ARCHIVING',
'REPLICATION_NOT_AUTHORIZED'},
'WarmThroughput': {'Status': {'REPLICATION_NOT_AUTHORIZED'}}},
'TableStatus': {'REPLICATION_NOT_AUTHORIZED'},
'WarmThroughput': {'Status': {'REPLICATION_NOT_AUTHORIZED'}}}}
The CreateTable operation adds a new table to your account. In an Amazon Web Services account, table names must be unique within each Region. That is, you can have two tables with same name if you create the tables in different Regions.
CreateTable is an asynchronous operation. Upon receiving a CreateTable request, DynamoDB immediately returns a response with a TableStatus of CREATING. After the table is created, DynamoDB sets the TableStatus to ACTIVE. You can perform read and write operations only on an ACTIVE table.
You can optionally define secondary indexes on the new table, as part of the CreateTable operation. If you want to create multiple tables with secondary indexes on them, you must create the tables sequentially. Only one table with secondary indexes can be in the CREATING state at any given time.
You can use the DescribeTable action to check the table status.
See also: AWS API Documentation
Request Syntax
client.create_table(
AttributeDefinitions=[
{
'AttributeName': 'string',
'AttributeType': 'S'|'N'|'B'
},
],
TableName='string',
KeySchema=[
{
'AttributeName': 'string',
'KeyType': 'HASH'|'RANGE'
},
],
LocalSecondaryIndexes=[
{
'IndexName': 'string',
'KeySchema': [
{
'AttributeName': 'string',
'KeyType': 'HASH'|'RANGE'
},
],
'Projection': {
'ProjectionType': 'ALL'|'KEYS_ONLY'|'INCLUDE',
'NonKeyAttributes': [
'string',
]
}
},
],
GlobalSecondaryIndexes=[
{
'IndexName': 'string',
'KeySchema': [
{
'AttributeName': 'string',
'KeyType': 'HASH'|'RANGE'
},
],
'Projection': {
'ProjectionType': 'ALL'|'KEYS_ONLY'|'INCLUDE',
'NonKeyAttributes': [
'string',
]
},
'ProvisionedThroughput': {
'ReadCapacityUnits': 123,
'WriteCapacityUnits': 123
},
'OnDemandThroughput': {
'MaxReadRequestUnits': 123,
'MaxWriteRequestUnits': 123
},
'WarmThroughput': {
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123
}
},
],
BillingMode='PROVISIONED'|'PAY_PER_REQUEST',
ProvisionedThroughput={
'ReadCapacityUnits': 123,
'WriteCapacityUnits': 123
},
StreamSpecification={
'StreamEnabled': True|False,
'StreamViewType': 'NEW_IMAGE'|'OLD_IMAGE'|'NEW_AND_OLD_IMAGES'|'KEYS_ONLY'
},
SSESpecification={
'Enabled': True|False,
'SSEType': 'AES256'|'KMS',
'KMSMasterKeyId': 'string'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
TableClass='STANDARD'|'STANDARD_INFREQUENT_ACCESS',
DeletionProtectionEnabled=True|False,
WarmThroughput={
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123
},
ResourcePolicy='string',
OnDemandThroughput={
'MaxReadRequestUnits': 123,
'MaxWriteRequestUnits': 123
}
)
list
[REQUIRED]
An array of attributes that describe the key schema for the table and indexes.
(dict) --
Represents an attribute for describing the schema for the table and indexes.
AttributeName (string) -- [REQUIRED]
A name for the attribute.
AttributeType (string) -- [REQUIRED]
The data type for the attribute, where:
S - the attribute is of type String
N - the attribute is of type Number
B - the attribute is of type Binary
string
[REQUIRED]
The name of the table to create. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
list
[REQUIRED]
Specifies the attributes that make up the primary key for a table or an index. The attributes in KeySchema must also be defined in the AttributeDefinitions array. For more information, see Data Model in the Amazon DynamoDB Developer Guide.
Each KeySchemaElement in the array is composed of:
AttributeName - The name of this key attribute.
KeyType - The role that the key attribute will assume:
HASH - partition key
RANGE - sort key
For a simple primary key (partition key), you must provide exactly one element with a KeyType of HASH.
For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order: The first element must have a KeyType of HASH, and the second element must have a KeyType of RANGE.
For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.
(dict) --
Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.
A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.
AttributeName (string) -- [REQUIRED]
The name of a key attribute.
KeyType (string) -- [REQUIRED]
The role that this key attribute will assume:
HASH - partition key
RANGE - sort key
list
One or more local secondary indexes (the maximum is 5) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained.
Each local secondary index in the array includes the following:
IndexName - The name of the local secondary index. Must be unique only for this table.
KeySchema - Specifies the key schema for the local secondary index. 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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
(dict) --
Represents the properties of a local secondary index.
IndexName (string) -- [REQUIRED]
The name of the local secondary index. The name must be unique among all other indexes on this table.
KeySchema (list) -- [REQUIRED]
The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
HASH - partition key
RANGE - sort key
(dict) --
Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.
A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.
AttributeName (string) -- [REQUIRED]
The name of a key attribute.
KeyType (string) -- [REQUIRED]
The role that this key attribute will assume:
HASH - partition key
RANGE - sort key
Projection (dict) -- [REQUIRED]
Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
ProjectionType (string) --
The set of attributes that are projected into the index:
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.
When using the DynamoDB console, ALL is selected by default.
NonKeyAttributes (list) --
Represents the non-key attribute names which will be projected into the index.
For global and local secondary indexes, the total count of 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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
(string) --
list
One or more global secondary indexes (the maximum is 20) to be created on the table. Each global secondary index in the array includes the following:
IndexName - The name of the global secondary index. Must be unique only for this table.
KeySchema - Specifies the key schema for the global secondary index.
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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units.
(dict) --
Represents the properties of a global secondary index.
IndexName (string) -- [REQUIRED]
The name of the global secondary index. The name must be unique among all other indexes on this table.
KeySchema (list) -- [REQUIRED]
The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
HASH - partition key
RANGE - sort key
(dict) --
Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.
A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.
AttributeName (string) -- [REQUIRED]
The name of a key attribute.
KeyType (string) -- [REQUIRED]
The role that this key attribute will assume:
HASH - partition key
RANGE - sort key
Projection (dict) -- [REQUIRED]
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
ProjectionType (string) --
The set of attributes that are projected into the index:
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.
When using the DynamoDB console, ALL is selected by default.
NonKeyAttributes (list) --
Represents the non-key attribute names which will be projected into the index.
For global and local secondary indexes, the total count of 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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
(string) --
ProvisionedThroughput (dict) --
Represents the provisioned throughput settings for the specified global secondary index. You must use either OnDemandThroughput or ProvisionedThroughput based on your table's capacity mode.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
ReadCapacityUnits (integer) -- [REQUIRED]
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
WriteCapacityUnits (integer) -- [REQUIRED]
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
OnDemandThroughput (dict) --
The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both. You must use either OnDemandThroughput or ProvisionedThroughput based on your table's capacity mode.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.
MaxWriteRequestUnits (integer) --
Maximum number of write request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.
WarmThroughput (dict) --
Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index. If you use this parameter, you must specify ReadUnitsPerSecond, WriteUnitsPerSecond, or both.
ReadUnitsPerSecond (integer) --
Represents the number of read operations your base table can instantaneously support.
WriteUnitsPerSecond (integer) --
Represents the number of write operations your base table can instantaneously support.
string
Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.
PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for most DynamoDB workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.
PROVISIONED - We recommend using PROVISIONED for steady workloads with predictable growth where capacity requirements can be reliably forecasted. PROVISIONED sets the billing mode to Provisioned capacity mode.
dict
Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.
If you set BillingMode as PROVISIONED, you must specify this property. If you set BillingMode as PAY_PER_REQUEST, you cannot specify this property.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
ReadCapacityUnits (integer) -- [REQUIRED]
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
WriteCapacityUnits (integer) -- [REQUIRED]
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
dict
The settings for DynamoDB Streams on the table. These settings consist of:
StreamEnabled - Indicates whether DynamoDB Streams is to be enabled (true) or disabled (false).
StreamViewType - When an item in the table is modified, StreamViewType determines what information is written to the table's stream. Valid values for StreamViewType are:
KEYS_ONLY - Only the key attributes of the modified item are written to the stream.
NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.
OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.
NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.
StreamEnabled (boolean) -- [REQUIRED]
Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
StreamViewType (string) --
When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:
KEYS_ONLY - Only the key attributes of the modified item are written to the stream.
NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.
OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.
NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.
dict
Represents the settings used to enable server-side encryption.
Enabled (boolean) --
Indicates whether server-side encryption is done using an Amazon Web Services managed key or an Amazon Web Services owned key. If enabled (true), server-side encryption type is set to KMS and an Amazon Web Services managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to Amazon Web Services owned key.
SSEType (string) --
Server-side encryption type. The only supported value is:
KMS - Server-side encryption that uses Key Management Service. The key is stored in your account and is managed by KMS (KMS charges apply).
KMSMasterKeyId (string) --
The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key alias/aws/dynamodb.
list
A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB.
(dict) --
Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single DynamoDB table.
Amazon Web Services-assigned tag names and values are automatically assigned the aws: prefix, which the user cannot assign. Amazon Web Services-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix user: in the Cost Allocation Report. You cannot backdate the application of a tag.
For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.
Key (string) -- [REQUIRED]
The key of the tag. Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.
Value (string) -- [REQUIRED]
The value of the tag. Tag values are case-sensitive and can be null.
string
The table class of the new table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
boolean
Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
dict
Represents the warm throughput (in read units per second and write units per second) for creating a table.
ReadUnitsPerSecond (integer) --
Represents the number of read operations your base table can instantaneously support.
WriteUnitsPerSecond (integer) --
Represents the number of write operations your base table can instantaneously support.
string
An Amazon Web Services resource-based policy document in JSON format that will be attached to the table.
When you attach a resource-based policy while creating a table, the policy application is strongly consistent.
The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit. For a full list of all considerations that apply for resource-based policies, see Resource-based policy considerations.
dict
Sets the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.
MaxWriteRequestUnits (integer) --
Maximum number of write request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.
dict
Response Syntax
{
'TableDescription': {
'AttributeDefinitions': [
{
'AttributeName': 'string',
'AttributeType': 'S'|'N'|'B'
},
],
'TableName': 'string',
'KeySchema': [
{
'AttributeName': 'string',
'KeyType': 'HASH'|'RANGE'
},
],
'TableStatus': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED',
'CreationDateTime': datetime(2015, 1, 1),
'ProvisionedThroughput': {
'LastIncreaseDateTime': datetime(2015, 1, 1),
'LastDecreaseDateTime': datetime(2015, 1, 1),
'NumberOfDecreasesToday': 123,
'ReadCapacityUnits': 123,
'WriteCapacityUnits': 123
},
'TableSizeBytes': 123,
'ItemCount': 123,
'TableArn': 'string',
'TableId': 'string',
'BillingModeSummary': {
'BillingMode': 'PROVISIONED'|'PAY_PER_REQUEST',
'LastUpdateToPayPerRequestDateTime': datetime(2015, 1, 1)
},
'LocalSecondaryIndexes': [
{
'IndexName': 'string',
'KeySchema': [
{
'AttributeName': 'string',
'KeyType': 'HASH'|'RANGE'
},
],
'Projection': {
'ProjectionType': 'ALL'|'KEYS_ONLY'|'INCLUDE',
'NonKeyAttributes': [
'string',
]
},
'IndexSizeBytes': 123,
'ItemCount': 123,
'IndexArn': 'string'
},
],
'GlobalSecondaryIndexes': [
{
'IndexName': 'string',
'KeySchema': [
{
'AttributeName': 'string',
'KeyType': 'HASH'|'RANGE'
},
],
'Projection': {
'ProjectionType': 'ALL'|'KEYS_ONLY'|'INCLUDE',
'NonKeyAttributes': [
'string',
]
},
'IndexStatus': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE',
'Backfilling': True|False,
'ProvisionedThroughput': {
'LastIncreaseDateTime': datetime(2015, 1, 1),
'LastDecreaseDateTime': datetime(2015, 1, 1),
'NumberOfDecreasesToday': 123,
'ReadCapacityUnits': 123,
'WriteCapacityUnits': 123
},
'IndexSizeBytes': 123,
'ItemCount': 123,
'IndexArn': 'string',
'OnDemandThroughput': {
'MaxReadRequestUnits': 123,
'MaxWriteRequestUnits': 123
},
'WarmThroughput': {
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123,
'Status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'
}
},
],
'StreamSpecification': {
'StreamEnabled': True|False,
'StreamViewType': 'NEW_IMAGE'|'OLD_IMAGE'|'NEW_AND_OLD_IMAGES'|'KEYS_ONLY'
},
'LatestStreamLabel': 'string',
'LatestStreamArn': 'string',
'GlobalTableVersion': 'string',
'Replicas': [
{
'RegionName': 'string',
'ReplicaStatus': 'CREATING'|'CREATION_FAILED'|'UPDATING'|'DELETING'|'ACTIVE'|'REGION_DISABLED'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED',
'ReplicaStatusDescription': 'string',
'ReplicaStatusPercentProgress': 'string',
'KMSMasterKeyId': 'string',
'ProvisionedThroughputOverride': {
'ReadCapacityUnits': 123
},
'OnDemandThroughputOverride': {
'MaxReadRequestUnits': 123
},
'WarmThroughput': {
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123,
'Status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED'
},
'GlobalSecondaryIndexes': [
{
'IndexName': 'string',
'ProvisionedThroughputOverride': {
'ReadCapacityUnits': 123
},
'OnDemandThroughputOverride': {
'MaxReadRequestUnits': 123
},
'WarmThroughput': {
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123,
'Status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'
}
},
],
'ReplicaInaccessibleDateTime': datetime(2015, 1, 1),
'ReplicaTableClassSummary': {
'TableClass': 'STANDARD'|'STANDARD_INFREQUENT_ACCESS',
'LastUpdateDateTime': datetime(2015, 1, 1)
}
},
],
'GlobalTableWitnesses': [
{
'RegionName': 'string',
'WitnessStatus': 'CREATING'|'DELETING'|'ACTIVE'
},
],
'RestoreSummary': {
'SourceBackupArn': 'string',
'SourceTableArn': 'string',
'RestoreDateTime': datetime(2015, 1, 1),
'RestoreInProgress': True|False
},
'SSEDescription': {
'Status': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'UPDATING',
'SSEType': 'AES256'|'KMS',
'KMSMasterKeyArn': 'string',
'InaccessibleEncryptionDateTime': datetime(2015, 1, 1)
},
'ArchivalSummary': {
'ArchivalDateTime': datetime(2015, 1, 1),
'ArchivalReason': 'string',
'ArchivalBackupArn': 'string'
},
'TableClassSummary': {
'TableClass': 'STANDARD'|'STANDARD_INFREQUENT_ACCESS',
'LastUpdateDateTime': datetime(2015, 1, 1)
},
'DeletionProtectionEnabled': True|False,
'OnDemandThroughput': {
'MaxReadRequestUnits': 123,
'MaxWriteRequestUnits': 123
},
'WarmThroughput': {
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123,
'Status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED'
},
'MultiRegionConsistency': 'EVENTUAL'|'STRONG'
}
}
Response Structure
(dict) --
Represents the output of a CreateTable operation.
TableDescription (dict) --
Represents the properties of the table.
AttributeDefinitions (list) --
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.
(dict) --
Represents an attribute for describing the schema for the table and indexes.
AttributeName (string) --
A name for the attribute.
AttributeType (string) --
The data type for the attribute, where:
S - the attribute is of type String
N - the attribute is of type Number
B - the attribute is of type Binary
TableName (string) --
The name of the table.
KeySchema (list) --
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
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
(dict) --
Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.
A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.
AttributeName (string) --
The name of a key attribute.
KeyType (string) --
The role that this key attribute will assume:
HASH - partition key
RANGE - sort key
TableStatus (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.
CreationDateTime (datetime) --
The date and time when the table was created, in UNIX epoch time format.
ProvisionedThroughput (dict) --
The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
LastIncreaseDateTime (datetime) --
The date and time of the last provisioned throughput increase for this table.
LastDecreaseDateTime (datetime) --
The date and time of the last provisioned throughput decrease for this table.
NumberOfDecreasesToday (integer) --
The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
ReadCapacityUnits (integer) --
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.
WriteCapacityUnits (integer) --
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
TableSizeBytes (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.
ItemCount (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.
TableArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the table.
TableId (string) --
Unique identifier for the table for which the backup was created.
BillingModeSummary (dict) --
Contains the details for the read/write capacity mode.
BillingMode (string) --
Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.
PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.
PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.
LastUpdateToPayPerRequestDateTime (datetime) --
Represents the time when PAY_PER_REQUEST was last set as the read/write capacity mode.
LocalSecondaryIndexes (list) --
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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
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.
(dict) --
Represents the properties of a local secondary index.
IndexName (string) --
Represents the name of the local secondary index.
KeySchema (list) --
The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
HASH - partition key
RANGE - sort key
(dict) --
Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.
A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.
AttributeName (string) --
The name of a key attribute.
KeyType (string) --
The role that this key attribute will assume:
HASH - partition key
RANGE - sort key
Projection (dict) --
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
ProjectionType (string) --
The set of attributes that are projected into the index:
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.
When using the DynamoDB console, ALL is selected by default.
NonKeyAttributes (list) --
Represents the non-key attribute names which will be projected into the index.
For global and local secondary indexes, the total count of 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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
(string) --
IndexSizeBytes (integer) --
The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
ItemCount (integer) --
The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
IndexArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the index.
GlobalSecondaryIndexes (list) --
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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
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.
(dict) --
Represents the properties of a global secondary index.
IndexName (string) --
The name of the global secondary index.
KeySchema (list) --
The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
HASH - partition key
RANGE - sort key
(dict) --
Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.
A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.
AttributeName (string) --
The name of a key attribute.
KeyType (string) --
The role that this key attribute will assume:
HASH - partition key
RANGE - sort key
Projection (dict) --
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
ProjectionType (string) --
The set of attributes that are projected into the index:
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.
When using the DynamoDB console, ALL is selected by default.
NonKeyAttributes (list) --
Represents the non-key attribute names which will be projected into the index.
For global and local secondary indexes, the total count of 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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
(string) --
IndexStatus (string) --
The current state 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.
Backfilling (boolean) --
Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.
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.
ProvisionedThroughput (dict) --
Represents the provisioned throughput settings for the specified global secondary index.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
LastIncreaseDateTime (datetime) --
The date and time of the last provisioned throughput increase for this table.
LastDecreaseDateTime (datetime) --
The date and time of the last provisioned throughput decrease for this table.
NumberOfDecreasesToday (integer) --
The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
ReadCapacityUnits (integer) --
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.
WriteCapacityUnits (integer) --
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
IndexSizeBytes (integer) --
The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
ItemCount (integer) --
The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
IndexArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the index.
OnDemandThroughput (dict) --
The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.
MaxWriteRequestUnits (integer) --
Maximum number of write request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.
WarmThroughput (dict) --
Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index.
ReadUnitsPerSecond (integer) --
Represents warm throughput read units per second value for a global secondary index.
WriteUnitsPerSecond (integer) --
Represents warm throughput write units per second value for a global secondary index.
Status (string) --
Represents the warm throughput status being created or updated on a global secondary index. The status can only be UPDATING or ACTIVE.
StreamSpecification (dict) --
The current DynamoDB Streams configuration for the table.
StreamEnabled (boolean) --
Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
StreamViewType (string) --
When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:
KEYS_ONLY - Only the key attributes of the modified item are written to the stream.
NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.
OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.
NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.
LatestStreamLabel (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
LatestStreamArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
GlobalTableVersion (string) --
Represents the version of global tables in use, if the table is replicated across Amazon Web Services Regions.
Replicas (list) --
Represents replicas of the table.
(dict) --
Contains the details of the replica.
RegionName (string) --
The name of the Region.
ReplicaStatus (string) --
The current state of the replica:
CREATING - The replica is being created.
UPDATING - The replica is being updated.
DELETING - The replica is being deleted.
ACTIVE - The replica is ready for use.
REGION_DISABLED - The replica is inaccessible because the Amazon Web Services Region has been disabled.
INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table is inaccessible.
ReplicaStatusDescription (string) --
Detailed information about the replica status.
ReplicaStatusPercentProgress (string) --
Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.
KMSMasterKeyId (string) --
The KMS key of the replica that will be used for KMS encryption.
ProvisionedThroughputOverride (dict) --
Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings.
ReadCapacityUnits (integer) --
Replica-specific read capacity units. If not specified, uses the source table's read capacity settings.
OnDemandThroughputOverride (dict) --
Overrides the maximum on-demand throughput settings for the specified replica table.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified replica table.
WarmThroughput (dict) --
Represents the warm throughput value for this replica.
ReadUnitsPerSecond (integer) --
Represents the base table's warm throughput value in read units per second.
WriteUnitsPerSecond (integer) --
Represents the base table's warm throughput value in write units per second.
Status (string) --
Represents warm throughput value of the base table.
GlobalSecondaryIndexes (list) --
Replica-specific global secondary index settings.
(dict) --
Represents the properties of a replica global secondary index.
IndexName (string) --
The name of the global secondary index.
ProvisionedThroughputOverride (dict) --
If not described, uses the source table GSI's read capacity settings.
ReadCapacityUnits (integer) --
Replica-specific read capacity units. If not specified, uses the source table's read capacity settings.
OnDemandThroughputOverride (dict) --
Overrides the maximum on-demand throughput for the specified global secondary index in the specified replica table.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified replica table.
WarmThroughput (dict) --
Represents the warm throughput of the global secondary index for this replica.
ReadUnitsPerSecond (integer) --
Represents warm throughput read units per second value for a global secondary index.
WriteUnitsPerSecond (integer) --
Represents warm throughput write units per second value for a global secondary index.
Status (string) --
Represents the warm throughput status being created or updated on a global secondary index. The status can only be UPDATING or ACTIVE.
ReplicaInaccessibleDateTime (datetime) --
The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the ReplicaStatus property.
ReplicaTableClassSummary (dict) --
Contains details of the table class.
TableClass (string) --
The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
LastUpdateDateTime (datetime) --
The date and time at which the table class was last updated.
GlobalTableWitnesses (list) --
The witness Region and its current status in the MRSC global table. Only one witness Region can be configured per MRSC global table.
(dict) --
Represents the properties of a witness Region in a MRSC global table.
RegionName (string) --
The name of the Amazon Web Services Region that serves as a witness for the MRSC global table.
WitnessStatus (string) --
The current status of the witness Region in the MRSC global table.
RestoreSummary (dict) --
Contains details for the restore.
SourceBackupArn (string) --
The Amazon Resource Name (ARN) of the backup from which the table was restored.
SourceTableArn (string) --
The ARN of the source table of the backup that is being restored.
RestoreDateTime (datetime) --
Point in time or source backup time.
RestoreInProgress (boolean) --
Indicates if a restore is in progress or not.
SSEDescription (dict) --
The description of the server-side encryption status on the specified table.
Status (string) --
Represents the current state of server-side encryption. The only supported values are:
ENABLED - Server-side encryption is enabled.
UPDATING - Server-side encryption is being updated.
SSEType (string) --
Server-side encryption type. The only supported value is:
KMS - Server-side encryption that uses Key Management Service. The key is stored in your account and is managed by KMS (KMS charges apply).
KMSMasterKeyArn (string) --
The KMS key ARN used for the KMS encryption.
InaccessibleEncryptionDateTime (datetime) --
Indicates the time, in UNIX epoch date format, when DynamoDB detected that the table's KMS key was inaccessible. This attribute will automatically be cleared when DynamoDB detects that the table's KMS key is accessible again. DynamoDB will initiate the table archival process when table's KMS key remains inaccessible for more than seven days from this date.
ArchivalSummary (dict) --
Contains information about the table archive.
ArchivalDateTime (datetime) --
The date and time when table archival was initiated by DynamoDB, in UNIX epoch time format.
ArchivalReason (string) --
The reason DynamoDB archived the table. Currently, the only possible value is:
INACCESSIBLE_ENCRYPTION_CREDENTIALS - The table was archived due to the table's KMS key being inaccessible for more than seven days. An On-Demand backup was created at the archival time.
ArchivalBackupArn (string) --
The Amazon Resource Name (ARN) of the backup the table was archived to, when applicable in the archival reason. If you wish to restore this backup to the same table name, you will need to delete the original table.
TableClassSummary (dict) --
Contains details of the table class.
TableClass (string) --
The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
LastUpdateDateTime (datetime) --
The date and time at which the table class was last updated.
DeletionProtectionEnabled (boolean) --
Indicates whether deletion protection is enabled (true) or disabled (false) on the table.
OnDemandThroughput (dict) --
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.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.
MaxWriteRequestUnits (integer) --
Maximum number of write request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.
WarmThroughput (dict) --
Describes the warm throughput value of the base table.
ReadUnitsPerSecond (integer) --
Represents the base table's warm throughput value in read units per second.
WriteUnitsPerSecond (integer) --
Represents the base table's warm throughput value in write units per second.
Status (string) --
Represents warm throughput value of the base table.
MultiRegionConsistency (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 (MREC).
STRONG: Indicates that the global table is configured for multi-Region strong consistency (MRSC).
If you don't specify this field, the global table consistency mode defaults to EVENTUAL. For more information about global tables consistency modes, see Consistency modes in DynamoDB developer guide.
{'TableDescription': {'GlobalTableWitnesses': [{'RegionName': 'string',
'WitnessStatus': 'CREATING | '
'DELETING | '
'ACTIVE'}],
'Replicas': {'ReplicaStatus': {'ARCHIVED',
'ARCHIVING',
'REPLICATION_NOT_AUTHORIZED'},
'WarmThroughput': {'Status': {'REPLICATION_NOT_AUTHORIZED'}}},
'TableStatus': {'REPLICATION_NOT_AUTHORIZED'},
'WarmThroughput': {'Status': {'REPLICATION_NOT_AUTHORIZED'}}}}
The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns a ResourceInUseException. If the specified table does not exist, DynamoDB returns a ResourceNotFoundException. If table is already in the DELETING state, no error is returned.
When you delete a table, any indexes on that table are also deleted.
If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the DISABLED state, and the stream is automatically deleted after 24 hours.
Use the DescribeTable action to check the status of the table.
See also: AWS API Documentation
Request Syntax
client.delete_table(
TableName='string'
)
string
[REQUIRED]
The name of the table to delete. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
dict
Response Syntax
{
'TableDescription': {
'AttributeDefinitions': [
{
'AttributeName': 'string',
'AttributeType': 'S'|'N'|'B'
},
],
'TableName': 'string',
'KeySchema': [
{
'AttributeName': 'string',
'KeyType': 'HASH'|'RANGE'
},
],
'TableStatus': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED',
'CreationDateTime': datetime(2015, 1, 1),
'ProvisionedThroughput': {
'LastIncreaseDateTime': datetime(2015, 1, 1),
'LastDecreaseDateTime': datetime(2015, 1, 1),
'NumberOfDecreasesToday': 123,
'ReadCapacityUnits': 123,
'WriteCapacityUnits': 123
},
'TableSizeBytes': 123,
'ItemCount': 123,
'TableArn': 'string',
'TableId': 'string',
'BillingModeSummary': {
'BillingMode': 'PROVISIONED'|'PAY_PER_REQUEST',
'LastUpdateToPayPerRequestDateTime': datetime(2015, 1, 1)
},
'LocalSecondaryIndexes': [
{
'IndexName': 'string',
'KeySchema': [
{
'AttributeName': 'string',
'KeyType': 'HASH'|'RANGE'
},
],
'Projection': {
'ProjectionType': 'ALL'|'KEYS_ONLY'|'INCLUDE',
'NonKeyAttributes': [
'string',
]
},
'IndexSizeBytes': 123,
'ItemCount': 123,
'IndexArn': 'string'
},
],
'GlobalSecondaryIndexes': [
{
'IndexName': 'string',
'KeySchema': [
{
'AttributeName': 'string',
'KeyType': 'HASH'|'RANGE'
},
],
'Projection': {
'ProjectionType': 'ALL'|'KEYS_ONLY'|'INCLUDE',
'NonKeyAttributes': [
'string',
]
},
'IndexStatus': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE',
'Backfilling': True|False,
'ProvisionedThroughput': {
'LastIncreaseDateTime': datetime(2015, 1, 1),
'LastDecreaseDateTime': datetime(2015, 1, 1),
'NumberOfDecreasesToday': 123,
'ReadCapacityUnits': 123,
'WriteCapacityUnits': 123
},
'IndexSizeBytes': 123,
'ItemCount': 123,
'IndexArn': 'string',
'OnDemandThroughput': {
'MaxReadRequestUnits': 123,
'MaxWriteRequestUnits': 123
},
'WarmThroughput': {
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123,
'Status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'
}
},
],
'StreamSpecification': {
'StreamEnabled': True|False,
'StreamViewType': 'NEW_IMAGE'|'OLD_IMAGE'|'NEW_AND_OLD_IMAGES'|'KEYS_ONLY'
},
'LatestStreamLabel': 'string',
'LatestStreamArn': 'string',
'GlobalTableVersion': 'string',
'Replicas': [
{
'RegionName': 'string',
'ReplicaStatus': 'CREATING'|'CREATION_FAILED'|'UPDATING'|'DELETING'|'ACTIVE'|'REGION_DISABLED'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED',
'ReplicaStatusDescription': 'string',
'ReplicaStatusPercentProgress': 'string',
'KMSMasterKeyId': 'string',
'ProvisionedThroughputOverride': {
'ReadCapacityUnits': 123
},
'OnDemandThroughputOverride': {
'MaxReadRequestUnits': 123
},
'WarmThroughput': {
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123,
'Status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED'
},
'GlobalSecondaryIndexes': [
{
'IndexName': 'string',
'ProvisionedThroughputOverride': {
'ReadCapacityUnits': 123
},
'OnDemandThroughputOverride': {
'MaxReadRequestUnits': 123
},
'WarmThroughput': {
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123,
'Status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'
}
},
],
'ReplicaInaccessibleDateTime': datetime(2015, 1, 1),
'ReplicaTableClassSummary': {
'TableClass': 'STANDARD'|'STANDARD_INFREQUENT_ACCESS',
'LastUpdateDateTime': datetime(2015, 1, 1)
}
},
],
'GlobalTableWitnesses': [
{
'RegionName': 'string',
'WitnessStatus': 'CREATING'|'DELETING'|'ACTIVE'
},
],
'RestoreSummary': {
'SourceBackupArn': 'string',
'SourceTableArn': 'string',
'RestoreDateTime': datetime(2015, 1, 1),
'RestoreInProgress': True|False
},
'SSEDescription': {
'Status': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'UPDATING',
'SSEType': 'AES256'|'KMS',
'KMSMasterKeyArn': 'string',
'InaccessibleEncryptionDateTime': datetime(2015, 1, 1)
},
'ArchivalSummary': {
'ArchivalDateTime': datetime(2015, 1, 1),
'ArchivalReason': 'string',
'ArchivalBackupArn': 'string'
},
'TableClassSummary': {
'TableClass': 'STANDARD'|'STANDARD_INFREQUENT_ACCESS',
'LastUpdateDateTime': datetime(2015, 1, 1)
},
'DeletionProtectionEnabled': True|False,
'OnDemandThroughput': {
'MaxReadRequestUnits': 123,
'MaxWriteRequestUnits': 123
},
'WarmThroughput': {
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123,
'Status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED'
},
'MultiRegionConsistency': 'EVENTUAL'|'STRONG'
}
}
Response Structure
(dict) --
Represents the output of a DeleteTable operation.
TableDescription (dict) --
Represents the properties of a table.
AttributeDefinitions (list) --
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.
(dict) --
Represents an attribute for describing the schema for the table and indexes.
AttributeName (string) --
A name for the attribute.
AttributeType (string) --
The data type for the attribute, where:
S - the attribute is of type String
N - the attribute is of type Number
B - the attribute is of type Binary
TableName (string) --
The name of the table.
KeySchema (list) --
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
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
(dict) --
Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.
A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.
AttributeName (string) --
The name of a key attribute.
KeyType (string) --
The role that this key attribute will assume:
HASH - partition key
RANGE - sort key
TableStatus (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.
CreationDateTime (datetime) --
The date and time when the table was created, in UNIX epoch time format.
ProvisionedThroughput (dict) --
The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
LastIncreaseDateTime (datetime) --
The date and time of the last provisioned throughput increase for this table.
LastDecreaseDateTime (datetime) --
The date and time of the last provisioned throughput decrease for this table.
NumberOfDecreasesToday (integer) --
The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
ReadCapacityUnits (integer) --
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.
WriteCapacityUnits (integer) --
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
TableSizeBytes (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.
ItemCount (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.
TableArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the table.
TableId (string) --
Unique identifier for the table for which the backup was created.
BillingModeSummary (dict) --
Contains the details for the read/write capacity mode.
BillingMode (string) --
Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.
PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.
PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.
LastUpdateToPayPerRequestDateTime (datetime) --
Represents the time when PAY_PER_REQUEST was last set as the read/write capacity mode.
LocalSecondaryIndexes (list) --
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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
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.
(dict) --
Represents the properties of a local secondary index.
IndexName (string) --
Represents the name of the local secondary index.
KeySchema (list) --
The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
HASH - partition key
RANGE - sort key
(dict) --
Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.
A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.
AttributeName (string) --
The name of a key attribute.
KeyType (string) --
The role that this key attribute will assume:
HASH - partition key
RANGE - sort key
Projection (dict) --
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
ProjectionType (string) --
The set of attributes that are projected into the index:
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.
When using the DynamoDB console, ALL is selected by default.
NonKeyAttributes (list) --
Represents the non-key attribute names which will be projected into the index.
For global and local secondary indexes, the total count of 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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
(string) --
IndexSizeBytes (integer) --
The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
ItemCount (integer) --
The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
IndexArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the index.
GlobalSecondaryIndexes (list) --
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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
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.
(dict) --
Represents the properties of a global secondary index.
IndexName (string) --
The name of the global secondary index.
KeySchema (list) --
The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
HASH - partition key
RANGE - sort key
(dict) --
Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.
A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.
AttributeName (string) --
The name of a key attribute.
KeyType (string) --
The role that this key attribute will assume:
HASH - partition key
RANGE - sort key
Projection (dict) --
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
ProjectionType (string) --
The set of attributes that are projected into the index:
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.
When using the DynamoDB console, ALL is selected by default.
NonKeyAttributes (list) --
Represents the non-key attribute names which will be projected into the index.
For global and local secondary indexes, the total count of 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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
(string) --
IndexStatus (string) --
The current state 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.
Backfilling (boolean) --
Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.
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.
ProvisionedThroughput (dict) --
Represents the provisioned throughput settings for the specified global secondary index.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
LastIncreaseDateTime (datetime) --
The date and time of the last provisioned throughput increase for this table.
LastDecreaseDateTime (datetime) --
The date and time of the last provisioned throughput decrease for this table.
NumberOfDecreasesToday (integer) --
The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
ReadCapacityUnits (integer) --
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.
WriteCapacityUnits (integer) --
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
IndexSizeBytes (integer) --
The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
ItemCount (integer) --
The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
IndexArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the index.
OnDemandThroughput (dict) --
The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.
MaxWriteRequestUnits (integer) --
Maximum number of write request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.
WarmThroughput (dict) --
Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index.
ReadUnitsPerSecond (integer) --
Represents warm throughput read units per second value for a global secondary index.
WriteUnitsPerSecond (integer) --
Represents warm throughput write units per second value for a global secondary index.
Status (string) --
Represents the warm throughput status being created or updated on a global secondary index. The status can only be UPDATING or ACTIVE.
StreamSpecification (dict) --
The current DynamoDB Streams configuration for the table.
StreamEnabled (boolean) --
Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
StreamViewType (string) --
When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:
KEYS_ONLY - Only the key attributes of the modified item are written to the stream.
NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.
OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.
NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.
LatestStreamLabel (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
LatestStreamArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
GlobalTableVersion (string) --
Represents the version of global tables in use, if the table is replicated across Amazon Web Services Regions.
Replicas (list) --
Represents replicas of the table.
(dict) --
Contains the details of the replica.
RegionName (string) --
The name of the Region.
ReplicaStatus (string) --
The current state of the replica:
CREATING - The replica is being created.
UPDATING - The replica is being updated.
DELETING - The replica is being deleted.
ACTIVE - The replica is ready for use.
REGION_DISABLED - The replica is inaccessible because the Amazon Web Services Region has been disabled.
INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table is inaccessible.
ReplicaStatusDescription (string) --
Detailed information about the replica status.
ReplicaStatusPercentProgress (string) --
Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.
KMSMasterKeyId (string) --
The KMS key of the replica that will be used for KMS encryption.
ProvisionedThroughputOverride (dict) --
Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings.
ReadCapacityUnits (integer) --
Replica-specific read capacity units. If not specified, uses the source table's read capacity settings.
OnDemandThroughputOverride (dict) --
Overrides the maximum on-demand throughput settings for the specified replica table.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified replica table.
WarmThroughput (dict) --
Represents the warm throughput value for this replica.
ReadUnitsPerSecond (integer) --
Represents the base table's warm throughput value in read units per second.
WriteUnitsPerSecond (integer) --
Represents the base table's warm throughput value in write units per second.
Status (string) --
Represents warm throughput value of the base table.
GlobalSecondaryIndexes (list) --
Replica-specific global secondary index settings.
(dict) --
Represents the properties of a replica global secondary index.
IndexName (string) --
The name of the global secondary index.
ProvisionedThroughputOverride (dict) --
If not described, uses the source table GSI's read capacity settings.
ReadCapacityUnits (integer) --
Replica-specific read capacity units. If not specified, uses the source table's read capacity settings.
OnDemandThroughputOverride (dict) --
Overrides the maximum on-demand throughput for the specified global secondary index in the specified replica table.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified replica table.
WarmThroughput (dict) --
Represents the warm throughput of the global secondary index for this replica.
ReadUnitsPerSecond (integer) --
Represents warm throughput read units per second value for a global secondary index.
WriteUnitsPerSecond (integer) --
Represents warm throughput write units per second value for a global secondary index.
Status (string) --
Represents the warm throughput status being created or updated on a global secondary index. The status can only be UPDATING or ACTIVE.
ReplicaInaccessibleDateTime (datetime) --
The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the ReplicaStatus property.
ReplicaTableClassSummary (dict) --
Contains details of the table class.
TableClass (string) --
The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
LastUpdateDateTime (datetime) --
The date and time at which the table class was last updated.
GlobalTableWitnesses (list) --
The witness Region and its current status in the MRSC global table. Only one witness Region can be configured per MRSC global table.
(dict) --
Represents the properties of a witness Region in a MRSC global table.
RegionName (string) --
The name of the Amazon Web Services Region that serves as a witness for the MRSC global table.
WitnessStatus (string) --
The current status of the witness Region in the MRSC global table.
RestoreSummary (dict) --
Contains details for the restore.
SourceBackupArn (string) --
The Amazon Resource Name (ARN) of the backup from which the table was restored.
SourceTableArn (string) --
The ARN of the source table of the backup that is being restored.
RestoreDateTime (datetime) --
Point in time or source backup time.
RestoreInProgress (boolean) --
Indicates if a restore is in progress or not.
SSEDescription (dict) --
The description of the server-side encryption status on the specified table.
Status (string) --
Represents the current state of server-side encryption. The only supported values are:
ENABLED - Server-side encryption is enabled.
UPDATING - Server-side encryption is being updated.
SSEType (string) --
Server-side encryption type. The only supported value is:
KMS - Server-side encryption that uses Key Management Service. The key is stored in your account and is managed by KMS (KMS charges apply).
KMSMasterKeyArn (string) --
The KMS key ARN used for the KMS encryption.
InaccessibleEncryptionDateTime (datetime) --
Indicates the time, in UNIX epoch date format, when DynamoDB detected that the table's KMS key was inaccessible. This attribute will automatically be cleared when DynamoDB detects that the table's KMS key is accessible again. DynamoDB will initiate the table archival process when table's KMS key remains inaccessible for more than seven days from this date.
ArchivalSummary (dict) --
Contains information about the table archive.
ArchivalDateTime (datetime) --
The date and time when table archival was initiated by DynamoDB, in UNIX epoch time format.
ArchivalReason (string) --
The reason DynamoDB archived the table. Currently, the only possible value is:
INACCESSIBLE_ENCRYPTION_CREDENTIALS - The table was archived due to the table's KMS key being inaccessible for more than seven days. An On-Demand backup was created at the archival time.
ArchivalBackupArn (string) --
The Amazon Resource Name (ARN) of the backup the table was archived to, when applicable in the archival reason. If you wish to restore this backup to the same table name, you will need to delete the original table.
TableClassSummary (dict) --
Contains details of the table class.
TableClass (string) --
The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
LastUpdateDateTime (datetime) --
The date and time at which the table class was last updated.
DeletionProtectionEnabled (boolean) --
Indicates whether deletion protection is enabled (true) or disabled (false) on the table.
OnDemandThroughput (dict) --
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.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.
MaxWriteRequestUnits (integer) --
Maximum number of write request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.
WarmThroughput (dict) --
Describes the warm throughput value of the base table.
ReadUnitsPerSecond (integer) --
Represents the base table's warm throughput value in read units per second.
WriteUnitsPerSecond (integer) --
Represents the base table's warm throughput value in write units per second.
Status (string) --
Represents warm throughput value of the base table.
MultiRegionConsistency (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 (MREC).
STRONG: Indicates that the global table is configured for multi-Region strong consistency (MRSC).
If you don't specify this field, the global table consistency mode defaults to EVENTUAL. For more information about global tables consistency modes, see Consistency modes in DynamoDB developer guide.
{'GlobalTableDescription': {'ReplicationGroup': {'ReplicaStatus': {'ARCHIVED',
'ARCHIVING',
'REPLICATION_NOT_AUTHORIZED'},
'WarmThroughput': {'Status': {'REPLICATION_NOT_AUTHORIZED'}}}}}
Returns information about the specified global table.
See also: AWS API Documentation
Request Syntax
client.describe_global_table(
GlobalTableName='string'
)
string
[REQUIRED]
The name of the global table.
dict
Response Syntax
{
'GlobalTableDescription': {
'ReplicationGroup': [
{
'RegionName': 'string',
'ReplicaStatus': 'CREATING'|'CREATION_FAILED'|'UPDATING'|'DELETING'|'ACTIVE'|'REGION_DISABLED'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED',
'ReplicaStatusDescription': 'string',
'ReplicaStatusPercentProgress': 'string',
'KMSMasterKeyId': 'string',
'ProvisionedThroughputOverride': {
'ReadCapacityUnits': 123
},
'OnDemandThroughputOverride': {
'MaxReadRequestUnits': 123
},
'WarmThroughput': {
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123,
'Status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED'
},
'GlobalSecondaryIndexes': [
{
'IndexName': 'string',
'ProvisionedThroughputOverride': {
'ReadCapacityUnits': 123
},
'OnDemandThroughputOverride': {
'MaxReadRequestUnits': 123
},
'WarmThroughput': {
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123,
'Status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'
}
},
],
'ReplicaInaccessibleDateTime': datetime(2015, 1, 1),
'ReplicaTableClassSummary': {
'TableClass': 'STANDARD'|'STANDARD_INFREQUENT_ACCESS',
'LastUpdateDateTime': datetime(2015, 1, 1)
}
},
],
'GlobalTableArn': 'string',
'CreationDateTime': datetime(2015, 1, 1),
'GlobalTableStatus': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING',
'GlobalTableName': 'string'
}
}
Response Structure
(dict) --
GlobalTableDescription (dict) --
Contains the details of the global table.
ReplicationGroup (list) --
The Regions where the global table has replicas.
(dict) --
Contains the details of the replica.
RegionName (string) --
The name of the Region.
ReplicaStatus (string) --
The current state of the replica:
CREATING - The replica is being created.
UPDATING - The replica is being updated.
DELETING - The replica is being deleted.
ACTIVE - The replica is ready for use.
REGION_DISABLED - The replica is inaccessible because the Amazon Web Services Region has been disabled.
INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table is inaccessible.
ReplicaStatusDescription (string) --
Detailed information about the replica status.
ReplicaStatusPercentProgress (string) --
Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.
KMSMasterKeyId (string) --
The KMS key of the replica that will be used for KMS encryption.
ProvisionedThroughputOverride (dict) --
Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings.
ReadCapacityUnits (integer) --
Replica-specific read capacity units. If not specified, uses the source table's read capacity settings.
OnDemandThroughputOverride (dict) --
Overrides the maximum on-demand throughput settings for the specified replica table.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified replica table.
WarmThroughput (dict) --
Represents the warm throughput value for this replica.
ReadUnitsPerSecond (integer) --
Represents the base table's warm throughput value in read units per second.
WriteUnitsPerSecond (integer) --
Represents the base table's warm throughput value in write units per second.
Status (string) --
Represents warm throughput value of the base table.
GlobalSecondaryIndexes (list) --
Replica-specific global secondary index settings.
(dict) --
Represents the properties of a replica global secondary index.
IndexName (string) --
The name of the global secondary index.
ProvisionedThroughputOverride (dict) --
If not described, uses the source table GSI's read capacity settings.
ReadCapacityUnits (integer) --
Replica-specific read capacity units. If not specified, uses the source table's read capacity settings.
OnDemandThroughputOverride (dict) --
Overrides the maximum on-demand throughput for the specified global secondary index in the specified replica table.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified replica table.
WarmThroughput (dict) --
Represents the warm throughput of the global secondary index for this replica.
ReadUnitsPerSecond (integer) --
Represents warm throughput read units per second value for a global secondary index.
WriteUnitsPerSecond (integer) --
Represents warm throughput write units per second value for a global secondary index.
Status (string) --
Represents the warm throughput status being created or updated on a global secondary index. The status can only be UPDATING or ACTIVE.
ReplicaInaccessibleDateTime (datetime) --
The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the ReplicaStatus property.
ReplicaTableClassSummary (dict) --
Contains details of the table class.
TableClass (string) --
The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
LastUpdateDateTime (datetime) --
The date and time at which the table class was last updated.
GlobalTableArn (string) --
The unique identifier of the global table.
CreationDateTime (datetime) --
The creation time of the global table.
GlobalTableStatus (string) --
The current state of the global table:
CREATING - The global table is being created.
UPDATING - The global table is being updated.
DELETING - The global table is being deleted.
ACTIVE - The global table is ready for use.
GlobalTableName (string) --
The global table name.
{'ReplicaSettings': {'ReplicaStatus': {'ARCHIVED',
'ARCHIVING',
'REPLICATION_NOT_AUTHORIZED'}}}
Describes Region-specific settings for a global table.
See also: AWS API Documentation
Request Syntax
client.describe_global_table_settings(
GlobalTableName='string'
)
string
[REQUIRED]
The name of the global table to describe.
dict
Response Syntax
{
'GlobalTableName': 'string',
'ReplicaSettings': [
{
'RegionName': 'string',
'ReplicaStatus': 'CREATING'|'CREATION_FAILED'|'UPDATING'|'DELETING'|'ACTIVE'|'REGION_DISABLED'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED',
'ReplicaBillingModeSummary': {
'BillingMode': 'PROVISIONED'|'PAY_PER_REQUEST',
'LastUpdateToPayPerRequestDateTime': datetime(2015, 1, 1)
},
'ReplicaProvisionedReadCapacityUnits': 123,
'ReplicaProvisionedReadCapacityAutoScalingSettings': {
'MinimumUnits': 123,
'MaximumUnits': 123,
'AutoScalingDisabled': True|False,
'AutoScalingRoleArn': 'string',
'ScalingPolicies': [
{
'PolicyName': 'string',
'TargetTrackingScalingPolicyConfiguration': {
'DisableScaleIn': True|False,
'ScaleInCooldown': 123,
'ScaleOutCooldown': 123,
'TargetValue': 123.0
}
},
]
},
'ReplicaProvisionedWriteCapacityUnits': 123,
'ReplicaProvisionedWriteCapacityAutoScalingSettings': {
'MinimumUnits': 123,
'MaximumUnits': 123,
'AutoScalingDisabled': True|False,
'AutoScalingRoleArn': 'string',
'ScalingPolicies': [
{
'PolicyName': 'string',
'TargetTrackingScalingPolicyConfiguration': {
'DisableScaleIn': True|False,
'ScaleInCooldown': 123,
'ScaleOutCooldown': 123,
'TargetValue': 123.0
}
},
]
},
'ReplicaGlobalSecondaryIndexSettings': [
{
'IndexName': 'string',
'IndexStatus': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE',
'ProvisionedReadCapacityUnits': 123,
'ProvisionedReadCapacityAutoScalingSettings': {
'MinimumUnits': 123,
'MaximumUnits': 123,
'AutoScalingDisabled': True|False,
'AutoScalingRoleArn': 'string',
'ScalingPolicies': [
{
'PolicyName': 'string',
'TargetTrackingScalingPolicyConfiguration': {
'DisableScaleIn': True|False,
'ScaleInCooldown': 123,
'ScaleOutCooldown': 123,
'TargetValue': 123.0
}
},
]
},
'ProvisionedWriteCapacityUnits': 123,
'ProvisionedWriteCapacityAutoScalingSettings': {
'MinimumUnits': 123,
'MaximumUnits': 123,
'AutoScalingDisabled': True|False,
'AutoScalingRoleArn': 'string',
'ScalingPolicies': [
{
'PolicyName': 'string',
'TargetTrackingScalingPolicyConfiguration': {
'DisableScaleIn': True|False,
'ScaleInCooldown': 123,
'ScaleOutCooldown': 123,
'TargetValue': 123.0
}
},
]
}
},
],
'ReplicaTableClassSummary': {
'TableClass': 'STANDARD'|'STANDARD_INFREQUENT_ACCESS',
'LastUpdateDateTime': datetime(2015, 1, 1)
}
},
]
}
Response Structure
(dict) --
GlobalTableName (string) --
The name of the global table.
ReplicaSettings (list) --
The Region-specific settings for the global table.
(dict) --
Represents the properties of a replica.
RegionName (string) --
The Region name of the replica.
ReplicaStatus (string) --
The current state of the Region:
CREATING - The Region is being created.
UPDATING - The Region is being updated.
DELETING - The Region is being deleted.
ACTIVE - The Region is ready for use.
ReplicaBillingModeSummary (dict) --
The read/write capacity mode of the replica.
BillingMode (string) --
Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.
PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.
PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.
LastUpdateToPayPerRequestDateTime (datetime) --
Represents the time when PAY_PER_REQUEST was last set as the read/write capacity mode.
ReplicaProvisionedReadCapacityUnits (integer) --
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
ReplicaProvisionedReadCapacityAutoScalingSettings (dict) --
Auto scaling settings for a global table replica's read capacity units.
MinimumUnits (integer) --
The minimum capacity units that a global table or global secondary index should be scaled down to.
MaximumUnits (integer) --
The maximum capacity units that a global table or global secondary index should be scaled up to.
AutoScalingDisabled (boolean) --
Disabled auto scaling for this global table or global secondary index.
AutoScalingRoleArn (string) --
Role ARN used for configuring the auto scaling policy.
ScalingPolicies (list) --
Information about the scaling policies.
(dict) --
Represents the properties of the scaling policy.
PolicyName (string) --
The name of the scaling policy.
TargetTrackingScalingPolicyConfiguration (dict) --
Represents a target tracking scaling policy configuration.
DisableScaleIn (boolean) --
Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.
ScaleInCooldown (integer) --
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.
ScaleOutCooldown (integer) --
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.
TargetValue (float) --
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
ReplicaProvisionedWriteCapacityUnits (integer) --
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
ReplicaProvisionedWriteCapacityAutoScalingSettings (dict) --
Auto scaling settings for a global table replica's write capacity units.
MinimumUnits (integer) --
The minimum capacity units that a global table or global secondary index should be scaled down to.
MaximumUnits (integer) --
The maximum capacity units that a global table or global secondary index should be scaled up to.
AutoScalingDisabled (boolean) --
Disabled auto scaling for this global table or global secondary index.
AutoScalingRoleArn (string) --
Role ARN used for configuring the auto scaling policy.
ScalingPolicies (list) --
Information about the scaling policies.
(dict) --
Represents the properties of the scaling policy.
PolicyName (string) --
The name of the scaling policy.
TargetTrackingScalingPolicyConfiguration (dict) --
Represents a target tracking scaling policy configuration.
DisableScaleIn (boolean) --
Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.
ScaleInCooldown (integer) --
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.
ScaleOutCooldown (integer) --
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.
TargetValue (float) --
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
ReplicaGlobalSecondaryIndexSettings (list) --
Replica global secondary index settings for the global table.
(dict) --
Represents the properties of a global secondary index.
IndexName (string) --
The name of the global secondary index. The name must be unique among all other indexes on this table.
IndexStatus (string) --
The current status of the global secondary index:
CREATING - The global secondary index is being created.
UPDATING - The global secondary index is being updated.
DELETING - The global secondary index is being deleted.
ACTIVE - The global secondary index is ready for use.
ProvisionedReadCapacityUnits (integer) --
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.
ProvisionedReadCapacityAutoScalingSettings (dict) --
Auto scaling settings for a global secondary index replica's read capacity units.
MinimumUnits (integer) --
The minimum capacity units that a global table or global secondary index should be scaled down to.
MaximumUnits (integer) --
The maximum capacity units that a global table or global secondary index should be scaled up to.
AutoScalingDisabled (boolean) --
Disabled auto scaling for this global table or global secondary index.
AutoScalingRoleArn (string) --
Role ARN used for configuring the auto scaling policy.
ScalingPolicies (list) --
Information about the scaling policies.
(dict) --
Represents the properties of the scaling policy.
PolicyName (string) --
The name of the scaling policy.
TargetTrackingScalingPolicyConfiguration (dict) --
Represents a target tracking scaling policy configuration.
DisableScaleIn (boolean) --
Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.
ScaleInCooldown (integer) --
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.
ScaleOutCooldown (integer) --
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.
TargetValue (float) --
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
ProvisionedWriteCapacityUnits (integer) --
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
ProvisionedWriteCapacityAutoScalingSettings (dict) --
Auto scaling settings for a global secondary index replica's write capacity units.
MinimumUnits (integer) --
The minimum capacity units that a global table or global secondary index should be scaled down to.
MaximumUnits (integer) --
The maximum capacity units that a global table or global secondary index should be scaled up to.
AutoScalingDisabled (boolean) --
Disabled auto scaling for this global table or global secondary index.
AutoScalingRoleArn (string) --
Role ARN used for configuring the auto scaling policy.
ScalingPolicies (list) --
Information about the scaling policies.
(dict) --
Represents the properties of the scaling policy.
PolicyName (string) --
The name of the scaling policy.
TargetTrackingScalingPolicyConfiguration (dict) --
Represents a target tracking scaling policy configuration.
DisableScaleIn (boolean) --
Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.
ScaleInCooldown (integer) --
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.
ScaleOutCooldown (integer) --
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.
TargetValue (float) --
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
ReplicaTableClassSummary (dict) --
Contains details of the table class.
TableClass (string) --
The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
LastUpdateDateTime (datetime) --
The date and time at which the table class was last updated.
{'Table': {'GlobalTableWitnesses': [{'RegionName': 'string',
'WitnessStatus': 'CREATING | DELETING | '
'ACTIVE'}],
'Replicas': {'ReplicaStatus': {'ARCHIVED',
'ARCHIVING',
'REPLICATION_NOT_AUTHORIZED'},
'WarmThroughput': {'Status': {'REPLICATION_NOT_AUTHORIZED'}}},
'TableStatus': {'REPLICATION_NOT_AUTHORIZED'},
'WarmThroughput': {'Status': {'REPLICATION_NOT_AUTHORIZED'}}}}
Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.
See also: AWS API Documentation
Request Syntax
client.describe_table(
TableName='string'
)
string
[REQUIRED]
The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
dict
Response Syntax
{
'Table': {
'AttributeDefinitions': [
{
'AttributeName': 'string',
'AttributeType': 'S'|'N'|'B'
},
],
'TableName': 'string',
'KeySchema': [
{
'AttributeName': 'string',
'KeyType': 'HASH'|'RANGE'
},
],
'TableStatus': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED',
'CreationDateTime': datetime(2015, 1, 1),
'ProvisionedThroughput': {
'LastIncreaseDateTime': datetime(2015, 1, 1),
'LastDecreaseDateTime': datetime(2015, 1, 1),
'NumberOfDecreasesToday': 123,
'ReadCapacityUnits': 123,
'WriteCapacityUnits': 123
},
'TableSizeBytes': 123,
'ItemCount': 123,
'TableArn': 'string',
'TableId': 'string',
'BillingModeSummary': {
'BillingMode': 'PROVISIONED'|'PAY_PER_REQUEST',
'LastUpdateToPayPerRequestDateTime': datetime(2015, 1, 1)
},
'LocalSecondaryIndexes': [
{
'IndexName': 'string',
'KeySchema': [
{
'AttributeName': 'string',
'KeyType': 'HASH'|'RANGE'
},
],
'Projection': {
'ProjectionType': 'ALL'|'KEYS_ONLY'|'INCLUDE',
'NonKeyAttributes': [
'string',
]
},
'IndexSizeBytes': 123,
'ItemCount': 123,
'IndexArn': 'string'
},
],
'GlobalSecondaryIndexes': [
{
'IndexName': 'string',
'KeySchema': [
{
'AttributeName': 'string',
'KeyType': 'HASH'|'RANGE'
},
],
'Projection': {
'ProjectionType': 'ALL'|'KEYS_ONLY'|'INCLUDE',
'NonKeyAttributes': [
'string',
]
},
'IndexStatus': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE',
'Backfilling': True|False,
'ProvisionedThroughput': {
'LastIncreaseDateTime': datetime(2015, 1, 1),
'LastDecreaseDateTime': datetime(2015, 1, 1),
'NumberOfDecreasesToday': 123,
'ReadCapacityUnits': 123,
'WriteCapacityUnits': 123
},
'IndexSizeBytes': 123,
'ItemCount': 123,
'IndexArn': 'string',
'OnDemandThroughput': {
'MaxReadRequestUnits': 123,
'MaxWriteRequestUnits': 123
},
'WarmThroughput': {
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123,
'Status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'
}
},
],
'StreamSpecification': {
'StreamEnabled': True|False,
'StreamViewType': 'NEW_IMAGE'|'OLD_IMAGE'|'NEW_AND_OLD_IMAGES'|'KEYS_ONLY'
},
'LatestStreamLabel': 'string',
'LatestStreamArn': 'string',
'GlobalTableVersion': 'string',
'Replicas': [
{
'RegionName': 'string',
'ReplicaStatus': 'CREATING'|'CREATION_FAILED'|'UPDATING'|'DELETING'|'ACTIVE'|'REGION_DISABLED'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED',
'ReplicaStatusDescription': 'string',
'ReplicaStatusPercentProgress': 'string',
'KMSMasterKeyId': 'string',
'ProvisionedThroughputOverride': {
'ReadCapacityUnits': 123
},
'OnDemandThroughputOverride': {
'MaxReadRequestUnits': 123
},
'WarmThroughput': {
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123,
'Status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED'
},
'GlobalSecondaryIndexes': [
{
'IndexName': 'string',
'ProvisionedThroughputOverride': {
'ReadCapacityUnits': 123
},
'OnDemandThroughputOverride': {
'MaxReadRequestUnits': 123
},
'WarmThroughput': {
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123,
'Status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'
}
},
],
'ReplicaInaccessibleDateTime': datetime(2015, 1, 1),
'ReplicaTableClassSummary': {
'TableClass': 'STANDARD'|'STANDARD_INFREQUENT_ACCESS',
'LastUpdateDateTime': datetime(2015, 1, 1)
}
},
],
'GlobalTableWitnesses': [
{
'RegionName': 'string',
'WitnessStatus': 'CREATING'|'DELETING'|'ACTIVE'
},
],
'RestoreSummary': {
'SourceBackupArn': 'string',
'SourceTableArn': 'string',
'RestoreDateTime': datetime(2015, 1, 1),
'RestoreInProgress': True|False
},
'SSEDescription': {
'Status': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'UPDATING',
'SSEType': 'AES256'|'KMS',
'KMSMasterKeyArn': 'string',
'InaccessibleEncryptionDateTime': datetime(2015, 1, 1)
},
'ArchivalSummary': {
'ArchivalDateTime': datetime(2015, 1, 1),
'ArchivalReason': 'string',
'ArchivalBackupArn': 'string'
},
'TableClassSummary': {
'TableClass': 'STANDARD'|'STANDARD_INFREQUENT_ACCESS',
'LastUpdateDateTime': datetime(2015, 1, 1)
},
'DeletionProtectionEnabled': True|False,
'OnDemandThroughput': {
'MaxReadRequestUnits': 123,
'MaxWriteRequestUnits': 123
},
'WarmThroughput': {
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123,
'Status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED'
},
'MultiRegionConsistency': 'EVENTUAL'|'STRONG'
}
}
Response Structure
(dict) --
Represents the output of a DescribeTable operation.
Table (dict) --
The properties of the table.
AttributeDefinitions (list) --
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.
(dict) --
Represents an attribute for describing the schema for the table and indexes.
AttributeName (string) --
A name for the attribute.
AttributeType (string) --
The data type for the attribute, where:
S - the attribute is of type String
N - the attribute is of type Number
B - the attribute is of type Binary
TableName (string) --
The name of the table.
KeySchema (list) --
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
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
(dict) --
Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.
A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.
AttributeName (string) --
The name of a key attribute.
KeyType (string) --
The role that this key attribute will assume:
HASH - partition key
RANGE - sort key
TableStatus (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.
CreationDateTime (datetime) --
The date and time when the table was created, in UNIX epoch time format.
ProvisionedThroughput (dict) --
The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
LastIncreaseDateTime (datetime) --
The date and time of the last provisioned throughput increase for this table.
LastDecreaseDateTime (datetime) --
The date and time of the last provisioned throughput decrease for this table.
NumberOfDecreasesToday (integer) --
The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
ReadCapacityUnits (integer) --
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.
WriteCapacityUnits (integer) --
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
TableSizeBytes (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.
ItemCount (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.
TableArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the table.
TableId (string) --
Unique identifier for the table for which the backup was created.
BillingModeSummary (dict) --
Contains the details for the read/write capacity mode.
BillingMode (string) --
Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.
PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.
PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.
LastUpdateToPayPerRequestDateTime (datetime) --
Represents the time when PAY_PER_REQUEST was last set as the read/write capacity mode.
LocalSecondaryIndexes (list) --
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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
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.
(dict) --
Represents the properties of a local secondary index.
IndexName (string) --
Represents the name of the local secondary index.
KeySchema (list) --
The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
HASH - partition key
RANGE - sort key
(dict) --
Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.
A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.
AttributeName (string) --
The name of a key attribute.
KeyType (string) --
The role that this key attribute will assume:
HASH - partition key
RANGE - sort key
Projection (dict) --
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
ProjectionType (string) --
The set of attributes that are projected into the index:
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.
When using the DynamoDB console, ALL is selected by default.
NonKeyAttributes (list) --
Represents the non-key attribute names which will be projected into the index.
For global and local secondary indexes, the total count of 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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
(string) --
IndexSizeBytes (integer) --
The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
ItemCount (integer) --
The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
IndexArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the index.
GlobalSecondaryIndexes (list) --
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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
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.
(dict) --
Represents the properties of a global secondary index.
IndexName (string) --
The name of the global secondary index.
KeySchema (list) --
The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
HASH - partition key
RANGE - sort key
(dict) --
Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.
A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.
AttributeName (string) --
The name of a key attribute.
KeyType (string) --
The role that this key attribute will assume:
HASH - partition key
RANGE - sort key
Projection (dict) --
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
ProjectionType (string) --
The set of attributes that are projected into the index:
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.
When using the DynamoDB console, ALL is selected by default.
NonKeyAttributes (list) --
Represents the non-key attribute names which will be projected into the index.
For global and local secondary indexes, the total count of 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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
(string) --
IndexStatus (string) --
The current state 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.
Backfilling (boolean) --
Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.
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.
ProvisionedThroughput (dict) --
Represents the provisioned throughput settings for the specified global secondary index.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
LastIncreaseDateTime (datetime) --
The date and time of the last provisioned throughput increase for this table.
LastDecreaseDateTime (datetime) --
The date and time of the last provisioned throughput decrease for this table.
NumberOfDecreasesToday (integer) --
The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
ReadCapacityUnits (integer) --
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.
WriteCapacityUnits (integer) --
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
IndexSizeBytes (integer) --
The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
ItemCount (integer) --
The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
IndexArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the index.
OnDemandThroughput (dict) --
The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.
MaxWriteRequestUnits (integer) --
Maximum number of write request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.
WarmThroughput (dict) --
Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index.
ReadUnitsPerSecond (integer) --
Represents warm throughput read units per second value for a global secondary index.
WriteUnitsPerSecond (integer) --
Represents warm throughput write units per second value for a global secondary index.
Status (string) --
Represents the warm throughput status being created or updated on a global secondary index. The status can only be UPDATING or ACTIVE.
StreamSpecification (dict) --
The current DynamoDB Streams configuration for the table.
StreamEnabled (boolean) --
Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
StreamViewType (string) --
When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:
KEYS_ONLY - Only the key attributes of the modified item are written to the stream.
NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.
OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.
NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.
LatestStreamLabel (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
LatestStreamArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
GlobalTableVersion (string) --
Represents the version of global tables in use, if the table is replicated across Amazon Web Services Regions.
Replicas (list) --
Represents replicas of the table.
(dict) --
Contains the details of the replica.
RegionName (string) --
The name of the Region.
ReplicaStatus (string) --
The current state of the replica:
CREATING - The replica is being created.
UPDATING - The replica is being updated.
DELETING - The replica is being deleted.
ACTIVE - The replica is ready for use.
REGION_DISABLED - The replica is inaccessible because the Amazon Web Services Region has been disabled.
INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table is inaccessible.
ReplicaStatusDescription (string) --
Detailed information about the replica status.
ReplicaStatusPercentProgress (string) --
Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.
KMSMasterKeyId (string) --
The KMS key of the replica that will be used for KMS encryption.
ProvisionedThroughputOverride (dict) --
Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings.
ReadCapacityUnits (integer) --
Replica-specific read capacity units. If not specified, uses the source table's read capacity settings.
OnDemandThroughputOverride (dict) --
Overrides the maximum on-demand throughput settings for the specified replica table.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified replica table.
WarmThroughput (dict) --
Represents the warm throughput value for this replica.
ReadUnitsPerSecond (integer) --
Represents the base table's warm throughput value in read units per second.
WriteUnitsPerSecond (integer) --
Represents the base table's warm throughput value in write units per second.
Status (string) --
Represents warm throughput value of the base table.
GlobalSecondaryIndexes (list) --
Replica-specific global secondary index settings.
(dict) --
Represents the properties of a replica global secondary index.
IndexName (string) --
The name of the global secondary index.
ProvisionedThroughputOverride (dict) --
If not described, uses the source table GSI's read capacity settings.
ReadCapacityUnits (integer) --
Replica-specific read capacity units. If not specified, uses the source table's read capacity settings.
OnDemandThroughputOverride (dict) --
Overrides the maximum on-demand throughput for the specified global secondary index in the specified replica table.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified replica table.
WarmThroughput (dict) --
Represents the warm throughput of the global secondary index for this replica.
ReadUnitsPerSecond (integer) --
Represents warm throughput read units per second value for a global secondary index.
WriteUnitsPerSecond (integer) --
Represents warm throughput write units per second value for a global secondary index.
Status (string) --
Represents the warm throughput status being created or updated on a global secondary index. The status can only be UPDATING or ACTIVE.
ReplicaInaccessibleDateTime (datetime) --
The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the ReplicaStatus property.
ReplicaTableClassSummary (dict) --
Contains details of the table class.
TableClass (string) --
The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
LastUpdateDateTime (datetime) --
The date and time at which the table class was last updated.
GlobalTableWitnesses (list) --
The witness Region and its current status in the MRSC global table. Only one witness Region can be configured per MRSC global table.
(dict) --
Represents the properties of a witness Region in a MRSC global table.
RegionName (string) --
The name of the Amazon Web Services Region that serves as a witness for the MRSC global table.
WitnessStatus (string) --
The current status of the witness Region in the MRSC global table.
RestoreSummary (dict) --
Contains details for the restore.
SourceBackupArn (string) --
The Amazon Resource Name (ARN) of the backup from which the table was restored.
SourceTableArn (string) --
The ARN of the source table of the backup that is being restored.
RestoreDateTime (datetime) --
Point in time or source backup time.
RestoreInProgress (boolean) --
Indicates if a restore is in progress or not.
SSEDescription (dict) --
The description of the server-side encryption status on the specified table.
Status (string) --
Represents the current state of server-side encryption. The only supported values are:
ENABLED - Server-side encryption is enabled.
UPDATING - Server-side encryption is being updated.
SSEType (string) --
Server-side encryption type. The only supported value is:
KMS - Server-side encryption that uses Key Management Service. The key is stored in your account and is managed by KMS (KMS charges apply).
KMSMasterKeyArn (string) --
The KMS key ARN used for the KMS encryption.
InaccessibleEncryptionDateTime (datetime) --
Indicates the time, in UNIX epoch date format, when DynamoDB detected that the table's KMS key was inaccessible. This attribute will automatically be cleared when DynamoDB detects that the table's KMS key is accessible again. DynamoDB will initiate the table archival process when table's KMS key remains inaccessible for more than seven days from this date.
ArchivalSummary (dict) --
Contains information about the table archive.
ArchivalDateTime (datetime) --
The date and time when table archival was initiated by DynamoDB, in UNIX epoch time format.
ArchivalReason (string) --
The reason DynamoDB archived the table. Currently, the only possible value is:
INACCESSIBLE_ENCRYPTION_CREDENTIALS - The table was archived due to the table's KMS key being inaccessible for more than seven days. An On-Demand backup was created at the archival time.
ArchivalBackupArn (string) --
The Amazon Resource Name (ARN) of the backup the table was archived to, when applicable in the archival reason. If you wish to restore this backup to the same table name, you will need to delete the original table.
TableClassSummary (dict) --
Contains details of the table class.
TableClass (string) --
The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
LastUpdateDateTime (datetime) --
The date and time at which the table class was last updated.
DeletionProtectionEnabled (boolean) --
Indicates whether deletion protection is enabled (true) or disabled (false) on the table.
OnDemandThroughput (dict) --
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.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.
MaxWriteRequestUnits (integer) --
Maximum number of write request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.
WarmThroughput (dict) --
Describes the warm throughput value of the base table.
ReadUnitsPerSecond (integer) --
Represents the base table's warm throughput value in read units per second.
WriteUnitsPerSecond (integer) --
Represents the base table's warm throughput value in write units per second.
Status (string) --
Represents warm throughput value of the base table.
MultiRegionConsistency (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 (MREC).
STRONG: Indicates that the global table is configured for multi-Region strong consistency (MRSC).
If you don't specify this field, the global table consistency mode defaults to EVENTUAL. For more information about global tables consistency modes, see Consistency modes in DynamoDB developer guide.
{'TableAutoScalingDescription': {'Replicas': {'ReplicaStatus': {'ARCHIVED',
'ARCHIVING',
'REPLICATION_NOT_AUTHORIZED'}},
'TableStatus': {'REPLICATION_NOT_AUTHORIZED'}}}
Describes auto scaling settings across replicas of the global table at once.
See also: AWS API Documentation
Request Syntax
client.describe_table_replica_auto_scaling(
TableName='string'
)
string
[REQUIRED]
The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
dict
Response Syntax
{
'TableAutoScalingDescription': {
'TableName': 'string',
'TableStatus': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED',
'Replicas': [
{
'RegionName': 'string',
'GlobalSecondaryIndexes': [
{
'IndexName': 'string',
'IndexStatus': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE',
'ProvisionedReadCapacityAutoScalingSettings': {
'MinimumUnits': 123,
'MaximumUnits': 123,
'AutoScalingDisabled': True|False,
'AutoScalingRoleArn': 'string',
'ScalingPolicies': [
{
'PolicyName': 'string',
'TargetTrackingScalingPolicyConfiguration': {
'DisableScaleIn': True|False,
'ScaleInCooldown': 123,
'ScaleOutCooldown': 123,
'TargetValue': 123.0
}
},
]
},
'ProvisionedWriteCapacityAutoScalingSettings': {
'MinimumUnits': 123,
'MaximumUnits': 123,
'AutoScalingDisabled': True|False,
'AutoScalingRoleArn': 'string',
'ScalingPolicies': [
{
'PolicyName': 'string',
'TargetTrackingScalingPolicyConfiguration': {
'DisableScaleIn': True|False,
'ScaleInCooldown': 123,
'ScaleOutCooldown': 123,
'TargetValue': 123.0
}
},
]
}
},
],
'ReplicaProvisionedReadCapacityAutoScalingSettings': {
'MinimumUnits': 123,
'MaximumUnits': 123,
'AutoScalingDisabled': True|False,
'AutoScalingRoleArn': 'string',
'ScalingPolicies': [
{
'PolicyName': 'string',
'TargetTrackingScalingPolicyConfiguration': {
'DisableScaleIn': True|False,
'ScaleInCooldown': 123,
'ScaleOutCooldown': 123,
'TargetValue': 123.0
}
},
]
},
'ReplicaProvisionedWriteCapacityAutoScalingSettings': {
'MinimumUnits': 123,
'MaximumUnits': 123,
'AutoScalingDisabled': True|False,
'AutoScalingRoleArn': 'string',
'ScalingPolicies': [
{
'PolicyName': 'string',
'TargetTrackingScalingPolicyConfiguration': {
'DisableScaleIn': True|False,
'ScaleInCooldown': 123,
'ScaleOutCooldown': 123,
'TargetValue': 123.0
}
},
]
},
'ReplicaStatus': 'CREATING'|'CREATION_FAILED'|'UPDATING'|'DELETING'|'ACTIVE'|'REGION_DISABLED'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED'
},
]
}
}
Response Structure
(dict) --
TableAutoScalingDescription (dict) --
Represents the auto scaling properties of the table.
TableName (string) --
The name of the table.
TableStatus (string) --
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.
Replicas (list) --
Represents replicas of the global table.
(dict) --
Represents the auto scaling settings of the replica.
RegionName (string) --
The Region where the replica exists.
GlobalSecondaryIndexes (list) --
Replica-specific global secondary index auto scaling settings.
(dict) --
Represents the auto scaling configuration for a replica global secondary index.
IndexName (string) --
The name of the global secondary index.
IndexStatus (string) --
The current state of the replica global secondary index:
CREATING - The index is being created.
UPDATING - The table/index configuration is being updated. The table/index remains available for data operations when UPDATING
DELETING - The index is being deleted.
ACTIVE - The index is ready for use.
ProvisionedReadCapacityAutoScalingSettings (dict) --
Represents the auto scaling settings for a global table or global secondary index.
MinimumUnits (integer) --
The minimum capacity units that a global table or global secondary index should be scaled down to.
MaximumUnits (integer) --
The maximum capacity units that a global table or global secondary index should be scaled up to.
AutoScalingDisabled (boolean) --
Disabled auto scaling for this global table or global secondary index.
AutoScalingRoleArn (string) --
Role ARN used for configuring the auto scaling policy.
ScalingPolicies (list) --
Information about the scaling policies.
(dict) --
Represents the properties of the scaling policy.
PolicyName (string) --
The name of the scaling policy.
TargetTrackingScalingPolicyConfiguration (dict) --
Represents a target tracking scaling policy configuration.
DisableScaleIn (boolean) --
Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.
ScaleInCooldown (integer) --
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.
ScaleOutCooldown (integer) --
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.
TargetValue (float) --
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
ProvisionedWriteCapacityAutoScalingSettings (dict) --
Represents the auto scaling settings for a global table or global secondary index.
MinimumUnits (integer) --
The minimum capacity units that a global table or global secondary index should be scaled down to.
MaximumUnits (integer) --
The maximum capacity units that a global table or global secondary index should be scaled up to.
AutoScalingDisabled (boolean) --
Disabled auto scaling for this global table or global secondary index.
AutoScalingRoleArn (string) --
Role ARN used for configuring the auto scaling policy.
ScalingPolicies (list) --
Information about the scaling policies.
(dict) --
Represents the properties of the scaling policy.
PolicyName (string) --
The name of the scaling policy.
TargetTrackingScalingPolicyConfiguration (dict) --
Represents a target tracking scaling policy configuration.
DisableScaleIn (boolean) --
Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.
ScaleInCooldown (integer) --
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.
ScaleOutCooldown (integer) --
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.
TargetValue (float) --
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
ReplicaProvisionedReadCapacityAutoScalingSettings (dict) --
Represents the auto scaling settings for a global table or global secondary index.
MinimumUnits (integer) --
The minimum capacity units that a global table or global secondary index should be scaled down to.
MaximumUnits (integer) --
The maximum capacity units that a global table or global secondary index should be scaled up to.
AutoScalingDisabled (boolean) --
Disabled auto scaling for this global table or global secondary index.
AutoScalingRoleArn (string) --
Role ARN used for configuring the auto scaling policy.
ScalingPolicies (list) --
Information about the scaling policies.
(dict) --
Represents the properties of the scaling policy.
PolicyName (string) --
The name of the scaling policy.
TargetTrackingScalingPolicyConfiguration (dict) --
Represents a target tracking scaling policy configuration.
DisableScaleIn (boolean) --
Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.
ScaleInCooldown (integer) --
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.
ScaleOutCooldown (integer) --
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.
TargetValue (float) --
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
ReplicaProvisionedWriteCapacityAutoScalingSettings (dict) --
Represents the auto scaling settings for a global table or global secondary index.
MinimumUnits (integer) --
The minimum capacity units that a global table or global secondary index should be scaled down to.
MaximumUnits (integer) --
The maximum capacity units that a global table or global secondary index should be scaled up to.
AutoScalingDisabled (boolean) --
Disabled auto scaling for this global table or global secondary index.
AutoScalingRoleArn (string) --
Role ARN used for configuring the auto scaling policy.
ScalingPolicies (list) --
Information about the scaling policies.
(dict) --
Represents the properties of the scaling policy.
PolicyName (string) --
The name of the scaling policy.
TargetTrackingScalingPolicyConfiguration (dict) --
Represents a target tracking scaling policy configuration.
DisableScaleIn (boolean) --
Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.
ScaleInCooldown (integer) --
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.
ScaleOutCooldown (integer) --
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.
TargetValue (float) --
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
ReplicaStatus (string) --
The current state of the replica:
CREATING - The replica is being created.
UPDATING - The replica is being updated.
DELETING - The replica is being deleted.
ACTIVE - The replica is ready for use.
{'TableDescription': {'GlobalTableWitnesses': [{'RegionName': 'string',
'WitnessStatus': 'CREATING | '
'DELETING | '
'ACTIVE'}],
'Replicas': {'ReplicaStatus': {'ARCHIVED',
'ARCHIVING',
'REPLICATION_NOT_AUTHORIZED'},
'WarmThroughput': {'Status': {'REPLICATION_NOT_AUTHORIZED'}}},
'TableStatus': {'REPLICATION_NOT_AUTHORIZED'},
'WarmThroughput': {'Status': {'REPLICATION_NOT_AUTHORIZED'}}}}
Creates a new table from an existing backup. Any number of users can execute up to 50 concurrent restores (any type of restore) in a given account.
You can call RestoreTableFromBackup at a maximum rate of 10 times per second.
You must manually set up the following on the restored table:
Auto scaling policies
IAM policies
Amazon CloudWatch metrics and alarms
Tags
Stream settings
Time to Live (TTL) settings
See also: AWS API Documentation
Request Syntax
client.restore_table_from_backup(
TargetTableName='string',
BackupArn='string',
BillingModeOverride='PROVISIONED'|'PAY_PER_REQUEST',
GlobalSecondaryIndexOverride=[
{
'IndexName': 'string',
'KeySchema': [
{
'AttributeName': 'string',
'KeyType': 'HASH'|'RANGE'
},
],
'Projection': {
'ProjectionType': 'ALL'|'KEYS_ONLY'|'INCLUDE',
'NonKeyAttributes': [
'string',
]
},
'ProvisionedThroughput': {
'ReadCapacityUnits': 123,
'WriteCapacityUnits': 123
},
'OnDemandThroughput': {
'MaxReadRequestUnits': 123,
'MaxWriteRequestUnits': 123
},
'WarmThroughput': {
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123
}
},
],
LocalSecondaryIndexOverride=[
{
'IndexName': 'string',
'KeySchema': [
{
'AttributeName': 'string',
'KeyType': 'HASH'|'RANGE'
},
],
'Projection': {
'ProjectionType': 'ALL'|'KEYS_ONLY'|'INCLUDE',
'NonKeyAttributes': [
'string',
]
}
},
],
ProvisionedThroughputOverride={
'ReadCapacityUnits': 123,
'WriteCapacityUnits': 123
},
OnDemandThroughputOverride={
'MaxReadRequestUnits': 123,
'MaxWriteRequestUnits': 123
},
SSESpecificationOverride={
'Enabled': True|False,
'SSEType': 'AES256'|'KMS',
'KMSMasterKeyId': 'string'
}
)
string
[REQUIRED]
The name of the new table to which the backup must be restored.
string
[REQUIRED]
The Amazon Resource Name (ARN) associated with the backup.
string
The billing mode of the restored table.
list
List of global secondary indexes for the restored table. The indexes provided should match existing secondary indexes. You can choose to exclude some or all of the indexes at the time of restore.
(dict) --
Represents the properties of a global secondary index.
IndexName (string) -- [REQUIRED]
The name of the global secondary index. The name must be unique among all other indexes on this table.
KeySchema (list) -- [REQUIRED]
The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
HASH - partition key
RANGE - sort key
(dict) --
Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.
A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.
AttributeName (string) -- [REQUIRED]
The name of a key attribute.
KeyType (string) -- [REQUIRED]
The role that this key attribute will assume:
HASH - partition key
RANGE - sort key
Projection (dict) -- [REQUIRED]
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
ProjectionType (string) --
The set of attributes that are projected into the index:
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.
When using the DynamoDB console, ALL is selected by default.
NonKeyAttributes (list) --
Represents the non-key attribute names which will be projected into the index.
For global and local secondary indexes, the total count of 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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
(string) --
ProvisionedThroughput (dict) --
Represents the provisioned throughput settings for the specified global secondary index. You must use either OnDemandThroughput or ProvisionedThroughput based on your table's capacity mode.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
ReadCapacityUnits (integer) -- [REQUIRED]
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
WriteCapacityUnits (integer) -- [REQUIRED]
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
OnDemandThroughput (dict) --
The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both. You must use either OnDemandThroughput or ProvisionedThroughput based on your table's capacity mode.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.
MaxWriteRequestUnits (integer) --
Maximum number of write request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.
WarmThroughput (dict) --
Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index. If you use this parameter, you must specify ReadUnitsPerSecond, WriteUnitsPerSecond, or both.
ReadUnitsPerSecond (integer) --
Represents the number of read operations your base table can instantaneously support.
WriteUnitsPerSecond (integer) --
Represents the number of write operations your base table can instantaneously support.
list
List of local secondary indexes for the restored table. The indexes provided should match existing secondary indexes. You can choose to exclude some or all of the indexes at the time of restore.
(dict) --
Represents the properties of a local secondary index.
IndexName (string) -- [REQUIRED]
The name of the local secondary index. The name must be unique among all other indexes on this table.
KeySchema (list) -- [REQUIRED]
The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
HASH - partition key
RANGE - sort key
(dict) --
Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.
A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.
AttributeName (string) -- [REQUIRED]
The name of a key attribute.
KeyType (string) -- [REQUIRED]
The role that this key attribute will assume:
HASH - partition key
RANGE - sort key
Projection (dict) -- [REQUIRED]
Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
ProjectionType (string) --
The set of attributes that are projected into the index:
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.
When using the DynamoDB console, ALL is selected by default.
NonKeyAttributes (list) --
Represents the non-key attribute names which will be projected into the index.
For global and local secondary indexes, the total count of 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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
(string) --
dict
Provisioned throughput settings for the restored table.
ReadCapacityUnits (integer) -- [REQUIRED]
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
WriteCapacityUnits (integer) -- [REQUIRED]
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
dict
Sets 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.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.
MaxWriteRequestUnits (integer) --
Maximum number of write request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.
dict
The new server-side encryption settings for the restored table.
Enabled (boolean) --
Indicates whether server-side encryption is done using an Amazon Web Services managed key or an Amazon Web Services owned key. If enabled (true), server-side encryption type is set to KMS and an Amazon Web Services managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to Amazon Web Services owned key.
SSEType (string) --
Server-side encryption type. The only supported value is:
KMS - Server-side encryption that uses Key Management Service. The key is stored in your account and is managed by KMS (KMS charges apply).
KMSMasterKeyId (string) --
The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key alias/aws/dynamodb.
dict
Response Syntax
{
'TableDescription': {
'AttributeDefinitions': [
{
'AttributeName': 'string',
'AttributeType': 'S'|'N'|'B'
},
],
'TableName': 'string',
'KeySchema': [
{
'AttributeName': 'string',
'KeyType': 'HASH'|'RANGE'
},
],
'TableStatus': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED',
'CreationDateTime': datetime(2015, 1, 1),
'ProvisionedThroughput': {
'LastIncreaseDateTime': datetime(2015, 1, 1),
'LastDecreaseDateTime': datetime(2015, 1, 1),
'NumberOfDecreasesToday': 123,
'ReadCapacityUnits': 123,
'WriteCapacityUnits': 123
},
'TableSizeBytes': 123,
'ItemCount': 123,
'TableArn': 'string',
'TableId': 'string',
'BillingModeSummary': {
'BillingMode': 'PROVISIONED'|'PAY_PER_REQUEST',
'LastUpdateToPayPerRequestDateTime': datetime(2015, 1, 1)
},
'LocalSecondaryIndexes': [
{
'IndexName': 'string',
'KeySchema': [
{
'AttributeName': 'string',
'KeyType': 'HASH'|'RANGE'
},
],
'Projection': {
'ProjectionType': 'ALL'|'KEYS_ONLY'|'INCLUDE',
'NonKeyAttributes': [
'string',
]
},
'IndexSizeBytes': 123,
'ItemCount': 123,
'IndexArn': 'string'
},
],
'GlobalSecondaryIndexes': [
{
'IndexName': 'string',
'KeySchema': [
{
'AttributeName': 'string',
'KeyType': 'HASH'|'RANGE'
},
],
'Projection': {
'ProjectionType': 'ALL'|'KEYS_ONLY'|'INCLUDE',
'NonKeyAttributes': [
'string',
]
},
'IndexStatus': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE',
'Backfilling': True|False,
'ProvisionedThroughput': {
'LastIncreaseDateTime': datetime(2015, 1, 1),
'LastDecreaseDateTime': datetime(2015, 1, 1),
'NumberOfDecreasesToday': 123,
'ReadCapacityUnits': 123,
'WriteCapacityUnits': 123
},
'IndexSizeBytes': 123,
'ItemCount': 123,
'IndexArn': 'string',
'OnDemandThroughput': {
'MaxReadRequestUnits': 123,
'MaxWriteRequestUnits': 123
},
'WarmThroughput': {
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123,
'Status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'
}
},
],
'StreamSpecification': {
'StreamEnabled': True|False,
'StreamViewType': 'NEW_IMAGE'|'OLD_IMAGE'|'NEW_AND_OLD_IMAGES'|'KEYS_ONLY'
},
'LatestStreamLabel': 'string',
'LatestStreamArn': 'string',
'GlobalTableVersion': 'string',
'Replicas': [
{
'RegionName': 'string',
'ReplicaStatus': 'CREATING'|'CREATION_FAILED'|'UPDATING'|'DELETING'|'ACTIVE'|'REGION_DISABLED'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED',
'ReplicaStatusDescription': 'string',
'ReplicaStatusPercentProgress': 'string',
'KMSMasterKeyId': 'string',
'ProvisionedThroughputOverride': {
'ReadCapacityUnits': 123
},
'OnDemandThroughputOverride': {
'MaxReadRequestUnits': 123
},
'WarmThroughput': {
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123,
'Status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED'
},
'GlobalSecondaryIndexes': [
{
'IndexName': 'string',
'ProvisionedThroughputOverride': {
'ReadCapacityUnits': 123
},
'OnDemandThroughputOverride': {
'MaxReadRequestUnits': 123
},
'WarmThroughput': {
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123,
'Status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'
}
},
],
'ReplicaInaccessibleDateTime': datetime(2015, 1, 1),
'ReplicaTableClassSummary': {
'TableClass': 'STANDARD'|'STANDARD_INFREQUENT_ACCESS',
'LastUpdateDateTime': datetime(2015, 1, 1)
}
},
],
'GlobalTableWitnesses': [
{
'RegionName': 'string',
'WitnessStatus': 'CREATING'|'DELETING'|'ACTIVE'
},
],
'RestoreSummary': {
'SourceBackupArn': 'string',
'SourceTableArn': 'string',
'RestoreDateTime': datetime(2015, 1, 1),
'RestoreInProgress': True|False
},
'SSEDescription': {
'Status': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'UPDATING',
'SSEType': 'AES256'|'KMS',
'KMSMasterKeyArn': 'string',
'InaccessibleEncryptionDateTime': datetime(2015, 1, 1)
},
'ArchivalSummary': {
'ArchivalDateTime': datetime(2015, 1, 1),
'ArchivalReason': 'string',
'ArchivalBackupArn': 'string'
},
'TableClassSummary': {
'TableClass': 'STANDARD'|'STANDARD_INFREQUENT_ACCESS',
'LastUpdateDateTime': datetime(2015, 1, 1)
},
'DeletionProtectionEnabled': True|False,
'OnDemandThroughput': {
'MaxReadRequestUnits': 123,
'MaxWriteRequestUnits': 123
},
'WarmThroughput': {
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123,
'Status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED'
},
'MultiRegionConsistency': 'EVENTUAL'|'STRONG'
}
}
Response Structure
(dict) --
TableDescription (dict) --
The description of the table created from an existing backup.
AttributeDefinitions (list) --
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.
(dict) --
Represents an attribute for describing the schema for the table and indexes.
AttributeName (string) --
A name for the attribute.
AttributeType (string) --
The data type for the attribute, where:
S - the attribute is of type String
N - the attribute is of type Number
B - the attribute is of type Binary
TableName (string) --
The name of the table.
KeySchema (list) --
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
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
(dict) --
Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.
A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.
AttributeName (string) --
The name of a key attribute.
KeyType (string) --
The role that this key attribute will assume:
HASH - partition key
RANGE - sort key
TableStatus (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.
CreationDateTime (datetime) --
The date and time when the table was created, in UNIX epoch time format.
ProvisionedThroughput (dict) --
The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
LastIncreaseDateTime (datetime) --
The date and time of the last provisioned throughput increase for this table.
LastDecreaseDateTime (datetime) --
The date and time of the last provisioned throughput decrease for this table.
NumberOfDecreasesToday (integer) --
The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
ReadCapacityUnits (integer) --
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.
WriteCapacityUnits (integer) --
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
TableSizeBytes (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.
ItemCount (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.
TableArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the table.
TableId (string) --
Unique identifier for the table for which the backup was created.
BillingModeSummary (dict) --
Contains the details for the read/write capacity mode.
BillingMode (string) --
Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.
PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.
PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.
LastUpdateToPayPerRequestDateTime (datetime) --
Represents the time when PAY_PER_REQUEST was last set as the read/write capacity mode.
LocalSecondaryIndexes (list) --
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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
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.
(dict) --
Represents the properties of a local secondary index.
IndexName (string) --
Represents the name of the local secondary index.
KeySchema (list) --
The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
HASH - partition key
RANGE - sort key
(dict) --
Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.
A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.
AttributeName (string) --
The name of a key attribute.
KeyType (string) --
The role that this key attribute will assume:
HASH - partition key
RANGE - sort key
Projection (dict) --
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
ProjectionType (string) --
The set of attributes that are projected into the index:
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.
When using the DynamoDB console, ALL is selected by default.
NonKeyAttributes (list) --
Represents the non-key attribute names which will be projected into the index.
For global and local secondary indexes, the total count of 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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
(string) --
IndexSizeBytes (integer) --
The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
ItemCount (integer) --
The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
IndexArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the index.
GlobalSecondaryIndexes (list) --
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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
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.
(dict) --
Represents the properties of a global secondary index.
IndexName (string) --
The name of the global secondary index.
KeySchema (list) --
The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
HASH - partition key
RANGE - sort key
(dict) --
Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.
A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.
AttributeName (string) --
The name of a key attribute.
KeyType (string) --
The role that this key attribute will assume:
HASH - partition key
RANGE - sort key
Projection (dict) --
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
ProjectionType (string) --
The set of attributes that are projected into the index:
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.
When using the DynamoDB console, ALL is selected by default.
NonKeyAttributes (list) --
Represents the non-key attribute names which will be projected into the index.
For global and local secondary indexes, the total count of 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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
(string) --
IndexStatus (string) --
The current state 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.
Backfilling (boolean) --
Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.
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.
ProvisionedThroughput (dict) --
Represents the provisioned throughput settings for the specified global secondary index.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
LastIncreaseDateTime (datetime) --
The date and time of the last provisioned throughput increase for this table.
LastDecreaseDateTime (datetime) --
The date and time of the last provisioned throughput decrease for this table.
NumberOfDecreasesToday (integer) --
The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
ReadCapacityUnits (integer) --
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.
WriteCapacityUnits (integer) --
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
IndexSizeBytes (integer) --
The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
ItemCount (integer) --
The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
IndexArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the index.
OnDemandThroughput (dict) --
The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.
MaxWriteRequestUnits (integer) --
Maximum number of write request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.
WarmThroughput (dict) --
Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index.
ReadUnitsPerSecond (integer) --
Represents warm throughput read units per second value for a global secondary index.
WriteUnitsPerSecond (integer) --
Represents warm throughput write units per second value for a global secondary index.
Status (string) --
Represents the warm throughput status being created or updated on a global secondary index. The status can only be UPDATING or ACTIVE.
StreamSpecification (dict) --
The current DynamoDB Streams configuration for the table.
StreamEnabled (boolean) --
Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
StreamViewType (string) --
When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:
KEYS_ONLY - Only the key attributes of the modified item are written to the stream.
NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.
OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.
NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.
LatestStreamLabel (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
LatestStreamArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
GlobalTableVersion (string) --
Represents the version of global tables in use, if the table is replicated across Amazon Web Services Regions.
Replicas (list) --
Represents replicas of the table.
(dict) --
Contains the details of the replica.
RegionName (string) --
The name of the Region.
ReplicaStatus (string) --
The current state of the replica:
CREATING - The replica is being created.
UPDATING - The replica is being updated.
DELETING - The replica is being deleted.
ACTIVE - The replica is ready for use.
REGION_DISABLED - The replica is inaccessible because the Amazon Web Services Region has been disabled.
INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table is inaccessible.
ReplicaStatusDescription (string) --
Detailed information about the replica status.
ReplicaStatusPercentProgress (string) --
Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.
KMSMasterKeyId (string) --
The KMS key of the replica that will be used for KMS encryption.
ProvisionedThroughputOverride (dict) --
Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings.
ReadCapacityUnits (integer) --
Replica-specific read capacity units. If not specified, uses the source table's read capacity settings.
OnDemandThroughputOverride (dict) --
Overrides the maximum on-demand throughput settings for the specified replica table.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified replica table.
WarmThroughput (dict) --
Represents the warm throughput value for this replica.
ReadUnitsPerSecond (integer) --
Represents the base table's warm throughput value in read units per second.
WriteUnitsPerSecond (integer) --
Represents the base table's warm throughput value in write units per second.
Status (string) --
Represents warm throughput value of the base table.
GlobalSecondaryIndexes (list) --
Replica-specific global secondary index settings.
(dict) --
Represents the properties of a replica global secondary index.
IndexName (string) --
The name of the global secondary index.
ProvisionedThroughputOverride (dict) --
If not described, uses the source table GSI's read capacity settings.
ReadCapacityUnits (integer) --
Replica-specific read capacity units. If not specified, uses the source table's read capacity settings.
OnDemandThroughputOverride (dict) --
Overrides the maximum on-demand throughput for the specified global secondary index in the specified replica table.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified replica table.
WarmThroughput (dict) --
Represents the warm throughput of the global secondary index for this replica.
ReadUnitsPerSecond (integer) --
Represents warm throughput read units per second value for a global secondary index.
WriteUnitsPerSecond (integer) --
Represents warm throughput write units per second value for a global secondary index.
Status (string) --
Represents the warm throughput status being created or updated on a global secondary index. The status can only be UPDATING or ACTIVE.
ReplicaInaccessibleDateTime (datetime) --
The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the ReplicaStatus property.
ReplicaTableClassSummary (dict) --
Contains details of the table class.
TableClass (string) --
The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
LastUpdateDateTime (datetime) --
The date and time at which the table class was last updated.
GlobalTableWitnesses (list) --
The witness Region and its current status in the MRSC global table. Only one witness Region can be configured per MRSC global table.
(dict) --
Represents the properties of a witness Region in a MRSC global table.
RegionName (string) --
The name of the Amazon Web Services Region that serves as a witness for the MRSC global table.
WitnessStatus (string) --
The current status of the witness Region in the MRSC global table.
RestoreSummary (dict) --
Contains details for the restore.
SourceBackupArn (string) --
The Amazon Resource Name (ARN) of the backup from which the table was restored.
SourceTableArn (string) --
The ARN of the source table of the backup that is being restored.
RestoreDateTime (datetime) --
Point in time or source backup time.
RestoreInProgress (boolean) --
Indicates if a restore is in progress or not.
SSEDescription (dict) --
The description of the server-side encryption status on the specified table.
Status (string) --
Represents the current state of server-side encryption. The only supported values are:
ENABLED - Server-side encryption is enabled.
UPDATING - Server-side encryption is being updated.
SSEType (string) --
Server-side encryption type. The only supported value is:
KMS - Server-side encryption that uses Key Management Service. The key is stored in your account and is managed by KMS (KMS charges apply).
KMSMasterKeyArn (string) --
The KMS key ARN used for the KMS encryption.
InaccessibleEncryptionDateTime (datetime) --
Indicates the time, in UNIX epoch date format, when DynamoDB detected that the table's KMS key was inaccessible. This attribute will automatically be cleared when DynamoDB detects that the table's KMS key is accessible again. DynamoDB will initiate the table archival process when table's KMS key remains inaccessible for more than seven days from this date.
ArchivalSummary (dict) --
Contains information about the table archive.
ArchivalDateTime (datetime) --
The date and time when table archival was initiated by DynamoDB, in UNIX epoch time format.
ArchivalReason (string) --
The reason DynamoDB archived the table. Currently, the only possible value is:
INACCESSIBLE_ENCRYPTION_CREDENTIALS - The table was archived due to the table's KMS key being inaccessible for more than seven days. An On-Demand backup was created at the archival time.
ArchivalBackupArn (string) --
The Amazon Resource Name (ARN) of the backup the table was archived to, when applicable in the archival reason. If you wish to restore this backup to the same table name, you will need to delete the original table.
TableClassSummary (dict) --
Contains details of the table class.
TableClass (string) --
The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
LastUpdateDateTime (datetime) --
The date and time at which the table class was last updated.
DeletionProtectionEnabled (boolean) --
Indicates whether deletion protection is enabled (true) or disabled (false) on the table.
OnDemandThroughput (dict) --
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.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.
MaxWriteRequestUnits (integer) --
Maximum number of write request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.
WarmThroughput (dict) --
Describes the warm throughput value of the base table.
ReadUnitsPerSecond (integer) --
Represents the base table's warm throughput value in read units per second.
WriteUnitsPerSecond (integer) --
Represents the base table's warm throughput value in write units per second.
Status (string) --
Represents warm throughput value of the base table.
MultiRegionConsistency (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 (MREC).
STRONG: Indicates that the global table is configured for multi-Region strong consistency (MRSC).
If you don't specify this field, the global table consistency mode defaults to EVENTUAL. For more information about global tables consistency modes, see Consistency modes in DynamoDB developer guide.
{'TableDescription': {'GlobalTableWitnesses': [{'RegionName': 'string',
'WitnessStatus': 'CREATING | '
'DELETING | '
'ACTIVE'}],
'Replicas': {'ReplicaStatus': {'ARCHIVED',
'ARCHIVING',
'REPLICATION_NOT_AUTHORIZED'},
'WarmThroughput': {'Status': {'REPLICATION_NOT_AUTHORIZED'}}},
'TableStatus': {'REPLICATION_NOT_AUTHORIZED'},
'WarmThroughput': {'Status': {'REPLICATION_NOT_AUTHORIZED'}}}}
Restores the specified table to the specified point in time within EarliestRestorableDateTime and LatestRestorableDateTime. You can restore your table to any point in time in the last 35 days. You can set the recovery period to any value between 1 and 35 days. Any number of users can execute up to 50 concurrent restores (any type of restore) in a given account.
When you restore using point in time recovery, DynamoDB restores your table data to the state based on the selected date and time (day:hour:minute:second) to a new table.
Along with data, the following are also included on the new restored table using point in time recovery:
Global secondary indexes (GSIs)
Local secondary indexes (LSIs)
Provisioned read and write capacity
Encryption settings
You must manually set up the following on the restored table:
Auto scaling policies
IAM policies
Amazon CloudWatch metrics and alarms
Tags
Stream settings
Time to Live (TTL) settings
Point in time recovery settings
See also: AWS API Documentation
Request Syntax
client.restore_table_to_point_in_time(
SourceTableArn='string',
SourceTableName='string',
TargetTableName='string',
UseLatestRestorableTime=True|False,
RestoreDateTime=datetime(2015, 1, 1),
BillingModeOverride='PROVISIONED'|'PAY_PER_REQUEST',
GlobalSecondaryIndexOverride=[
{
'IndexName': 'string',
'KeySchema': [
{
'AttributeName': 'string',
'KeyType': 'HASH'|'RANGE'
},
],
'Projection': {
'ProjectionType': 'ALL'|'KEYS_ONLY'|'INCLUDE',
'NonKeyAttributes': [
'string',
]
},
'ProvisionedThroughput': {
'ReadCapacityUnits': 123,
'WriteCapacityUnits': 123
},
'OnDemandThroughput': {
'MaxReadRequestUnits': 123,
'MaxWriteRequestUnits': 123
},
'WarmThroughput': {
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123
}
},
],
LocalSecondaryIndexOverride=[
{
'IndexName': 'string',
'KeySchema': [
{
'AttributeName': 'string',
'KeyType': 'HASH'|'RANGE'
},
],
'Projection': {
'ProjectionType': 'ALL'|'KEYS_ONLY'|'INCLUDE',
'NonKeyAttributes': [
'string',
]
}
},
],
ProvisionedThroughputOverride={
'ReadCapacityUnits': 123,
'WriteCapacityUnits': 123
},
OnDemandThroughputOverride={
'MaxReadRequestUnits': 123,
'MaxWriteRequestUnits': 123
},
SSESpecificationOverride={
'Enabled': True|False,
'SSEType': 'AES256'|'KMS',
'KMSMasterKeyId': 'string'
}
)
string
The DynamoDB table that will be restored. This value is an Amazon Resource Name (ARN).
string
Name of the source table that is being restored.
string
[REQUIRED]
The name of the new table to which it must be restored to.
boolean
Restore the table to the latest possible time. LatestRestorableDateTime is typically 5 minutes before the current time.
datetime
Time in the past to restore the table to.
string
The billing mode of the restored table.
list
List of global secondary indexes for the restored table. The indexes provided should match existing secondary indexes. You can choose to exclude some or all of the indexes at the time of restore.
(dict) --
Represents the properties of a global secondary index.
IndexName (string) -- [REQUIRED]
The name of the global secondary index. The name must be unique among all other indexes on this table.
KeySchema (list) -- [REQUIRED]
The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
HASH - partition key
RANGE - sort key
(dict) --
Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.
A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.
AttributeName (string) -- [REQUIRED]
The name of a key attribute.
KeyType (string) -- [REQUIRED]
The role that this key attribute will assume:
HASH - partition key
RANGE - sort key
Projection (dict) -- [REQUIRED]
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
ProjectionType (string) --
The set of attributes that are projected into the index:
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.
When using the DynamoDB console, ALL is selected by default.
NonKeyAttributes (list) --
Represents the non-key attribute names which will be projected into the index.
For global and local secondary indexes, the total count of 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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
(string) --
ProvisionedThroughput (dict) --
Represents the provisioned throughput settings for the specified global secondary index. You must use either OnDemandThroughput or ProvisionedThroughput based on your table's capacity mode.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
ReadCapacityUnits (integer) -- [REQUIRED]
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
WriteCapacityUnits (integer) -- [REQUIRED]
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
OnDemandThroughput (dict) --
The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both. You must use either OnDemandThroughput or ProvisionedThroughput based on your table's capacity mode.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.
MaxWriteRequestUnits (integer) --
Maximum number of write request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.
WarmThroughput (dict) --
Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index. If you use this parameter, you must specify ReadUnitsPerSecond, WriteUnitsPerSecond, or both.
ReadUnitsPerSecond (integer) --
Represents the number of read operations your base table can instantaneously support.
WriteUnitsPerSecond (integer) --
Represents the number of write operations your base table can instantaneously support.
list
List of local secondary indexes for the restored table. The indexes provided should match existing secondary indexes. You can choose to exclude some or all of the indexes at the time of restore.
(dict) --
Represents the properties of a local secondary index.
IndexName (string) -- [REQUIRED]
The name of the local secondary index. The name must be unique among all other indexes on this table.
KeySchema (list) -- [REQUIRED]
The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
HASH - partition key
RANGE - sort key
(dict) --
Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.
A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.
AttributeName (string) -- [REQUIRED]
The name of a key attribute.
KeyType (string) -- [REQUIRED]
The role that this key attribute will assume:
HASH - partition key
RANGE - sort key
Projection (dict) -- [REQUIRED]
Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
ProjectionType (string) --
The set of attributes that are projected into the index:
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.
When using the DynamoDB console, ALL is selected by default.
NonKeyAttributes (list) --
Represents the non-key attribute names which will be projected into the index.
For global and local secondary indexes, the total count of 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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
(string) --
dict
Provisioned throughput settings for the restored table.
ReadCapacityUnits (integer) -- [REQUIRED]
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
WriteCapacityUnits (integer) -- [REQUIRED]
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
dict
Sets 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.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.
MaxWriteRequestUnits (integer) --
Maximum number of write request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.
dict
The new server-side encryption settings for the restored table.
Enabled (boolean) --
Indicates whether server-side encryption is done using an Amazon Web Services managed key or an Amazon Web Services owned key. If enabled (true), server-side encryption type is set to KMS and an Amazon Web Services managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to Amazon Web Services owned key.
SSEType (string) --
Server-side encryption type. The only supported value is:
KMS - Server-side encryption that uses Key Management Service. The key is stored in your account and is managed by KMS (KMS charges apply).
KMSMasterKeyId (string) --
The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key alias/aws/dynamodb.
dict
Response Syntax
{
'TableDescription': {
'AttributeDefinitions': [
{
'AttributeName': 'string',
'AttributeType': 'S'|'N'|'B'
},
],
'TableName': 'string',
'KeySchema': [
{
'AttributeName': 'string',
'KeyType': 'HASH'|'RANGE'
},
],
'TableStatus': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED',
'CreationDateTime': datetime(2015, 1, 1),
'ProvisionedThroughput': {
'LastIncreaseDateTime': datetime(2015, 1, 1),
'LastDecreaseDateTime': datetime(2015, 1, 1),
'NumberOfDecreasesToday': 123,
'ReadCapacityUnits': 123,
'WriteCapacityUnits': 123
},
'TableSizeBytes': 123,
'ItemCount': 123,
'TableArn': 'string',
'TableId': 'string',
'BillingModeSummary': {
'BillingMode': 'PROVISIONED'|'PAY_PER_REQUEST',
'LastUpdateToPayPerRequestDateTime': datetime(2015, 1, 1)
},
'LocalSecondaryIndexes': [
{
'IndexName': 'string',
'KeySchema': [
{
'AttributeName': 'string',
'KeyType': 'HASH'|'RANGE'
},
],
'Projection': {
'ProjectionType': 'ALL'|'KEYS_ONLY'|'INCLUDE',
'NonKeyAttributes': [
'string',
]
},
'IndexSizeBytes': 123,
'ItemCount': 123,
'IndexArn': 'string'
},
],
'GlobalSecondaryIndexes': [
{
'IndexName': 'string',
'KeySchema': [
{
'AttributeName': 'string',
'KeyType': 'HASH'|'RANGE'
},
],
'Projection': {
'ProjectionType': 'ALL'|'KEYS_ONLY'|'INCLUDE',
'NonKeyAttributes': [
'string',
]
},
'IndexStatus': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE',
'Backfilling': True|False,
'ProvisionedThroughput': {
'LastIncreaseDateTime': datetime(2015, 1, 1),
'LastDecreaseDateTime': datetime(2015, 1, 1),
'NumberOfDecreasesToday': 123,
'ReadCapacityUnits': 123,
'WriteCapacityUnits': 123
},
'IndexSizeBytes': 123,
'ItemCount': 123,
'IndexArn': 'string',
'OnDemandThroughput': {
'MaxReadRequestUnits': 123,
'MaxWriteRequestUnits': 123
},
'WarmThroughput': {
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123,
'Status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'
}
},
],
'StreamSpecification': {
'StreamEnabled': True|False,
'StreamViewType': 'NEW_IMAGE'|'OLD_IMAGE'|'NEW_AND_OLD_IMAGES'|'KEYS_ONLY'
},
'LatestStreamLabel': 'string',
'LatestStreamArn': 'string',
'GlobalTableVersion': 'string',
'Replicas': [
{
'RegionName': 'string',
'ReplicaStatus': 'CREATING'|'CREATION_FAILED'|'UPDATING'|'DELETING'|'ACTIVE'|'REGION_DISABLED'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED',
'ReplicaStatusDescription': 'string',
'ReplicaStatusPercentProgress': 'string',
'KMSMasterKeyId': 'string',
'ProvisionedThroughputOverride': {
'ReadCapacityUnits': 123
},
'OnDemandThroughputOverride': {
'MaxReadRequestUnits': 123
},
'WarmThroughput': {
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123,
'Status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED'
},
'GlobalSecondaryIndexes': [
{
'IndexName': 'string',
'ProvisionedThroughputOverride': {
'ReadCapacityUnits': 123
},
'OnDemandThroughputOverride': {
'MaxReadRequestUnits': 123
},
'WarmThroughput': {
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123,
'Status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'
}
},
],
'ReplicaInaccessibleDateTime': datetime(2015, 1, 1),
'ReplicaTableClassSummary': {
'TableClass': 'STANDARD'|'STANDARD_INFREQUENT_ACCESS',
'LastUpdateDateTime': datetime(2015, 1, 1)
}
},
],
'GlobalTableWitnesses': [
{
'RegionName': 'string',
'WitnessStatus': 'CREATING'|'DELETING'|'ACTIVE'
},
],
'RestoreSummary': {
'SourceBackupArn': 'string',
'SourceTableArn': 'string',
'RestoreDateTime': datetime(2015, 1, 1),
'RestoreInProgress': True|False
},
'SSEDescription': {
'Status': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'UPDATING',
'SSEType': 'AES256'|'KMS',
'KMSMasterKeyArn': 'string',
'InaccessibleEncryptionDateTime': datetime(2015, 1, 1)
},
'ArchivalSummary': {
'ArchivalDateTime': datetime(2015, 1, 1),
'ArchivalReason': 'string',
'ArchivalBackupArn': 'string'
},
'TableClassSummary': {
'TableClass': 'STANDARD'|'STANDARD_INFREQUENT_ACCESS',
'LastUpdateDateTime': datetime(2015, 1, 1)
},
'DeletionProtectionEnabled': True|False,
'OnDemandThroughput': {
'MaxReadRequestUnits': 123,
'MaxWriteRequestUnits': 123
},
'WarmThroughput': {
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123,
'Status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED'
},
'MultiRegionConsistency': 'EVENTUAL'|'STRONG'
}
}
Response Structure
(dict) --
TableDescription (dict) --
Represents the properties of a table.
AttributeDefinitions (list) --
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.
(dict) --
Represents an attribute for describing the schema for the table and indexes.
AttributeName (string) --
A name for the attribute.
AttributeType (string) --
The data type for the attribute, where:
S - the attribute is of type String
N - the attribute is of type Number
B - the attribute is of type Binary
TableName (string) --
The name of the table.
KeySchema (list) --
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
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
(dict) --
Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.
A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.
AttributeName (string) --
The name of a key attribute.
KeyType (string) --
The role that this key attribute will assume:
HASH - partition key
RANGE - sort key
TableStatus (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.
CreationDateTime (datetime) --
The date and time when the table was created, in UNIX epoch time format.
ProvisionedThroughput (dict) --
The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
LastIncreaseDateTime (datetime) --
The date and time of the last provisioned throughput increase for this table.
LastDecreaseDateTime (datetime) --
The date and time of the last provisioned throughput decrease for this table.
NumberOfDecreasesToday (integer) --
The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
ReadCapacityUnits (integer) --
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.
WriteCapacityUnits (integer) --
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
TableSizeBytes (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.
ItemCount (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.
TableArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the table.
TableId (string) --
Unique identifier for the table for which the backup was created.
BillingModeSummary (dict) --
Contains the details for the read/write capacity mode.
BillingMode (string) --
Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.
PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.
PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.
LastUpdateToPayPerRequestDateTime (datetime) --
Represents the time when PAY_PER_REQUEST was last set as the read/write capacity mode.
LocalSecondaryIndexes (list) --
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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
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.
(dict) --
Represents the properties of a local secondary index.
IndexName (string) --
Represents the name of the local secondary index.
KeySchema (list) --
The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
HASH - partition key
RANGE - sort key
(dict) --
Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.
A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.
AttributeName (string) --
The name of a key attribute.
KeyType (string) --
The role that this key attribute will assume:
HASH - partition key
RANGE - sort key
Projection (dict) --
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
ProjectionType (string) --
The set of attributes that are projected into the index:
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.
When using the DynamoDB console, ALL is selected by default.
NonKeyAttributes (list) --
Represents the non-key attribute names which will be projected into the index.
For global and local secondary indexes, the total count of 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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
(string) --
IndexSizeBytes (integer) --
The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
ItemCount (integer) --
The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
IndexArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the index.
GlobalSecondaryIndexes (list) --
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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
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.
(dict) --
Represents the properties of a global secondary index.
IndexName (string) --
The name of the global secondary index.
KeySchema (list) --
The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
HASH - partition key
RANGE - sort key
(dict) --
Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.
A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.
AttributeName (string) --
The name of a key attribute.
KeyType (string) --
The role that this key attribute will assume:
HASH - partition key
RANGE - sort key
Projection (dict) --
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
ProjectionType (string) --
The set of attributes that are projected into the index:
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.
When using the DynamoDB console, ALL is selected by default.
NonKeyAttributes (list) --
Represents the non-key attribute names which will be projected into the index.
For global and local secondary indexes, the total count of 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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
(string) --
IndexStatus (string) --
The current state 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.
Backfilling (boolean) --
Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.
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.
ProvisionedThroughput (dict) --
Represents the provisioned throughput settings for the specified global secondary index.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
LastIncreaseDateTime (datetime) --
The date and time of the last provisioned throughput increase for this table.
LastDecreaseDateTime (datetime) --
The date and time of the last provisioned throughput decrease for this table.
NumberOfDecreasesToday (integer) --
The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
ReadCapacityUnits (integer) --
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.
WriteCapacityUnits (integer) --
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
IndexSizeBytes (integer) --
The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
ItemCount (integer) --
The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
IndexArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the index.
OnDemandThroughput (dict) --
The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.
MaxWriteRequestUnits (integer) --
Maximum number of write request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.
WarmThroughput (dict) --
Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index.
ReadUnitsPerSecond (integer) --
Represents warm throughput read units per second value for a global secondary index.
WriteUnitsPerSecond (integer) --
Represents warm throughput write units per second value for a global secondary index.
Status (string) --
Represents the warm throughput status being created or updated on a global secondary index. The status can only be UPDATING or ACTIVE.
StreamSpecification (dict) --
The current DynamoDB Streams configuration for the table.
StreamEnabled (boolean) --
Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
StreamViewType (string) --
When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:
KEYS_ONLY - Only the key attributes of the modified item are written to the stream.
NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.
OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.
NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.
LatestStreamLabel (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
LatestStreamArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
GlobalTableVersion (string) --
Represents the version of global tables in use, if the table is replicated across Amazon Web Services Regions.
Replicas (list) --
Represents replicas of the table.
(dict) --
Contains the details of the replica.
RegionName (string) --
The name of the Region.
ReplicaStatus (string) --
The current state of the replica:
CREATING - The replica is being created.
UPDATING - The replica is being updated.
DELETING - The replica is being deleted.
ACTIVE - The replica is ready for use.
REGION_DISABLED - The replica is inaccessible because the Amazon Web Services Region has been disabled.
INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table is inaccessible.
ReplicaStatusDescription (string) --
Detailed information about the replica status.
ReplicaStatusPercentProgress (string) --
Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.
KMSMasterKeyId (string) --
The KMS key of the replica that will be used for KMS encryption.
ProvisionedThroughputOverride (dict) --
Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings.
ReadCapacityUnits (integer) --
Replica-specific read capacity units. If not specified, uses the source table's read capacity settings.
OnDemandThroughputOverride (dict) --
Overrides the maximum on-demand throughput settings for the specified replica table.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified replica table.
WarmThroughput (dict) --
Represents the warm throughput value for this replica.
ReadUnitsPerSecond (integer) --
Represents the base table's warm throughput value in read units per second.
WriteUnitsPerSecond (integer) --
Represents the base table's warm throughput value in write units per second.
Status (string) --
Represents warm throughput value of the base table.
GlobalSecondaryIndexes (list) --
Replica-specific global secondary index settings.
(dict) --
Represents the properties of a replica global secondary index.
IndexName (string) --
The name of the global secondary index.
ProvisionedThroughputOverride (dict) --
If not described, uses the source table GSI's read capacity settings.
ReadCapacityUnits (integer) --
Replica-specific read capacity units. If not specified, uses the source table's read capacity settings.
OnDemandThroughputOverride (dict) --
Overrides the maximum on-demand throughput for the specified global secondary index in the specified replica table.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified replica table.
WarmThroughput (dict) --
Represents the warm throughput of the global secondary index for this replica.
ReadUnitsPerSecond (integer) --
Represents warm throughput read units per second value for a global secondary index.
WriteUnitsPerSecond (integer) --
Represents warm throughput write units per second value for a global secondary index.
Status (string) --
Represents the warm throughput status being created or updated on a global secondary index. The status can only be UPDATING or ACTIVE.
ReplicaInaccessibleDateTime (datetime) --
The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the ReplicaStatus property.
ReplicaTableClassSummary (dict) --
Contains details of the table class.
TableClass (string) --
The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
LastUpdateDateTime (datetime) --
The date and time at which the table class was last updated.
GlobalTableWitnesses (list) --
The witness Region and its current status in the MRSC global table. Only one witness Region can be configured per MRSC global table.
(dict) --
Represents the properties of a witness Region in a MRSC global table.
RegionName (string) --
The name of the Amazon Web Services Region that serves as a witness for the MRSC global table.
WitnessStatus (string) --
The current status of the witness Region in the MRSC global table.
RestoreSummary (dict) --
Contains details for the restore.
SourceBackupArn (string) --
The Amazon Resource Name (ARN) of the backup from which the table was restored.
SourceTableArn (string) --
The ARN of the source table of the backup that is being restored.
RestoreDateTime (datetime) --
Point in time or source backup time.
RestoreInProgress (boolean) --
Indicates if a restore is in progress or not.
SSEDescription (dict) --
The description of the server-side encryption status on the specified table.
Status (string) --
Represents the current state of server-side encryption. The only supported values are:
ENABLED - Server-side encryption is enabled.
UPDATING - Server-side encryption is being updated.
SSEType (string) --
Server-side encryption type. The only supported value is:
KMS - Server-side encryption that uses Key Management Service. The key is stored in your account and is managed by KMS (KMS charges apply).
KMSMasterKeyArn (string) --
The KMS key ARN used for the KMS encryption.
InaccessibleEncryptionDateTime (datetime) --
Indicates the time, in UNIX epoch date format, when DynamoDB detected that the table's KMS key was inaccessible. This attribute will automatically be cleared when DynamoDB detects that the table's KMS key is accessible again. DynamoDB will initiate the table archival process when table's KMS key remains inaccessible for more than seven days from this date.
ArchivalSummary (dict) --
Contains information about the table archive.
ArchivalDateTime (datetime) --
The date and time when table archival was initiated by DynamoDB, in UNIX epoch time format.
ArchivalReason (string) --
The reason DynamoDB archived the table. Currently, the only possible value is:
INACCESSIBLE_ENCRYPTION_CREDENTIALS - The table was archived due to the table's KMS key being inaccessible for more than seven days. An On-Demand backup was created at the archival time.
ArchivalBackupArn (string) --
The Amazon Resource Name (ARN) of the backup the table was archived to, when applicable in the archival reason. If you wish to restore this backup to the same table name, you will need to delete the original table.
TableClassSummary (dict) --
Contains details of the table class.
TableClass (string) --
The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
LastUpdateDateTime (datetime) --
The date and time at which the table class was last updated.
DeletionProtectionEnabled (boolean) --
Indicates whether deletion protection is enabled (true) or disabled (false) on the table.
OnDemandThroughput (dict) --
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.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.
MaxWriteRequestUnits (integer) --
Maximum number of write request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.
WarmThroughput (dict) --
Describes the warm throughput value of the base table.
ReadUnitsPerSecond (integer) --
Represents the base table's warm throughput value in read units per second.
WriteUnitsPerSecond (integer) --
Represents the base table's warm throughput value in write units per second.
Status (string) --
Represents warm throughput value of the base table.
MultiRegionConsistency (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 (MREC).
STRONG: Indicates that the global table is configured for multi-Region strong consistency (MRSC).
If you don't specify this field, the global table consistency mode defaults to EVENTUAL. For more information about global tables consistency modes, see Consistency modes in DynamoDB developer guide.
{'GlobalTableDescription': {'ReplicationGroup': {'ReplicaStatus': {'ARCHIVED',
'ARCHIVING',
'REPLICATION_NOT_AUTHORIZED'},
'WarmThroughput': {'Status': {'REPLICATION_NOT_AUTHORIZED'}}}}}
Adds or removes replicas in the specified global table. The global table must already exist to be able to use this operation. Any replica to be added must be empty, have the same name as the global table, have the same key schema, have DynamoDB Streams enabled, and have the same provisioned and maximum write capacity units.
If global secondary indexes are specified, then the following conditions must also be met:
The global secondary indexes must have the same name.
The global secondary indexes must have the same hash key and sort key (if present).
The global secondary indexes must have the same provisioned and maximum write capacity units.
See also: AWS API Documentation
Request Syntax
client.update_global_table(
GlobalTableName='string',
ReplicaUpdates=[
{
'Create': {
'RegionName': 'string'
},
'Delete': {
'RegionName': 'string'
}
},
]
)
string
[REQUIRED]
The global table name.
list
[REQUIRED]
A list of Regions that should be added or removed from the global table.
(dict) --
Represents one of the following:
A new replica to be added to an existing global table.
New parameters for an existing replica.
An existing replica to be removed from an existing global table.
Create (dict) --
The parameters required for creating a replica on an existing global table.
RegionName (string) -- [REQUIRED]
The Region of the replica to be added.
Delete (dict) --
The name of the existing replica to be removed.
RegionName (string) -- [REQUIRED]
The Region of the replica to be removed.
dict
Response Syntax
{
'GlobalTableDescription': {
'ReplicationGroup': [
{
'RegionName': 'string',
'ReplicaStatus': 'CREATING'|'CREATION_FAILED'|'UPDATING'|'DELETING'|'ACTIVE'|'REGION_DISABLED'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED',
'ReplicaStatusDescription': 'string',
'ReplicaStatusPercentProgress': 'string',
'KMSMasterKeyId': 'string',
'ProvisionedThroughputOverride': {
'ReadCapacityUnits': 123
},
'OnDemandThroughputOverride': {
'MaxReadRequestUnits': 123
},
'WarmThroughput': {
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123,
'Status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED'
},
'GlobalSecondaryIndexes': [
{
'IndexName': 'string',
'ProvisionedThroughputOverride': {
'ReadCapacityUnits': 123
},
'OnDemandThroughputOverride': {
'MaxReadRequestUnits': 123
},
'WarmThroughput': {
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123,
'Status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'
}
},
],
'ReplicaInaccessibleDateTime': datetime(2015, 1, 1),
'ReplicaTableClassSummary': {
'TableClass': 'STANDARD'|'STANDARD_INFREQUENT_ACCESS',
'LastUpdateDateTime': datetime(2015, 1, 1)
}
},
],
'GlobalTableArn': 'string',
'CreationDateTime': datetime(2015, 1, 1),
'GlobalTableStatus': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING',
'GlobalTableName': 'string'
}
}
Response Structure
(dict) --
GlobalTableDescription (dict) --
Contains the details of the global table.
ReplicationGroup (list) --
The Regions where the global table has replicas.
(dict) --
Contains the details of the replica.
RegionName (string) --
The name of the Region.
ReplicaStatus (string) --
The current state of the replica:
CREATING - The replica is being created.
UPDATING - The replica is being updated.
DELETING - The replica is being deleted.
ACTIVE - The replica is ready for use.
REGION_DISABLED - The replica is inaccessible because the Amazon Web Services Region has been disabled.
INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table is inaccessible.
ReplicaStatusDescription (string) --
Detailed information about the replica status.
ReplicaStatusPercentProgress (string) --
Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.
KMSMasterKeyId (string) --
The KMS key of the replica that will be used for KMS encryption.
ProvisionedThroughputOverride (dict) --
Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings.
ReadCapacityUnits (integer) --
Replica-specific read capacity units. If not specified, uses the source table's read capacity settings.
OnDemandThroughputOverride (dict) --
Overrides the maximum on-demand throughput settings for the specified replica table.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified replica table.
WarmThroughput (dict) --
Represents the warm throughput value for this replica.
ReadUnitsPerSecond (integer) --
Represents the base table's warm throughput value in read units per second.
WriteUnitsPerSecond (integer) --
Represents the base table's warm throughput value in write units per second.
Status (string) --
Represents warm throughput value of the base table.
GlobalSecondaryIndexes (list) --
Replica-specific global secondary index settings.
(dict) --
Represents the properties of a replica global secondary index.
IndexName (string) --
The name of the global secondary index.
ProvisionedThroughputOverride (dict) --
If not described, uses the source table GSI's read capacity settings.
ReadCapacityUnits (integer) --
Replica-specific read capacity units. If not specified, uses the source table's read capacity settings.
OnDemandThroughputOverride (dict) --
Overrides the maximum on-demand throughput for the specified global secondary index in the specified replica table.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified replica table.
WarmThroughput (dict) --
Represents the warm throughput of the global secondary index for this replica.
ReadUnitsPerSecond (integer) --
Represents warm throughput read units per second value for a global secondary index.
WriteUnitsPerSecond (integer) --
Represents warm throughput write units per second value for a global secondary index.
Status (string) --
Represents the warm throughput status being created or updated on a global secondary index. The status can only be UPDATING or ACTIVE.
ReplicaInaccessibleDateTime (datetime) --
The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the ReplicaStatus property.
ReplicaTableClassSummary (dict) --
Contains details of the table class.
TableClass (string) --
The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
LastUpdateDateTime (datetime) --
The date and time at which the table class was last updated.
GlobalTableArn (string) --
The unique identifier of the global table.
CreationDateTime (datetime) --
The creation time of the global table.
GlobalTableStatus (string) --
The current state of the global table:
CREATING - The global table is being created.
UPDATING - The global table is being updated.
DELETING - The global table is being deleted.
ACTIVE - The global table is ready for use.
GlobalTableName (string) --
The global table name.
{'ReplicaSettings': {'ReplicaStatus': {'ARCHIVED',
'ARCHIVING',
'REPLICATION_NOT_AUTHORIZED'}}}
Updates settings for a global table.
See also: AWS API Documentation
Request Syntax
client.update_global_table_settings(
GlobalTableName='string',
GlobalTableBillingMode='PROVISIONED'|'PAY_PER_REQUEST',
GlobalTableProvisionedWriteCapacityUnits=123,
GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate={
'MinimumUnits': 123,
'MaximumUnits': 123,
'AutoScalingDisabled': True|False,
'AutoScalingRoleArn': 'string',
'ScalingPolicyUpdate': {
'PolicyName': 'string',
'TargetTrackingScalingPolicyConfiguration': {
'DisableScaleIn': True|False,
'ScaleInCooldown': 123,
'ScaleOutCooldown': 123,
'TargetValue': 123.0
}
}
},
GlobalTableGlobalSecondaryIndexSettingsUpdate=[
{
'IndexName': 'string',
'ProvisionedWriteCapacityUnits': 123,
'ProvisionedWriteCapacityAutoScalingSettingsUpdate': {
'MinimumUnits': 123,
'MaximumUnits': 123,
'AutoScalingDisabled': True|False,
'AutoScalingRoleArn': 'string',
'ScalingPolicyUpdate': {
'PolicyName': 'string',
'TargetTrackingScalingPolicyConfiguration': {
'DisableScaleIn': True|False,
'ScaleInCooldown': 123,
'ScaleOutCooldown': 123,
'TargetValue': 123.0
}
}
}
},
],
ReplicaSettingsUpdate=[
{
'RegionName': 'string',
'ReplicaProvisionedReadCapacityUnits': 123,
'ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate': {
'MinimumUnits': 123,
'MaximumUnits': 123,
'AutoScalingDisabled': True|False,
'AutoScalingRoleArn': 'string',
'ScalingPolicyUpdate': {
'PolicyName': 'string',
'TargetTrackingScalingPolicyConfiguration': {
'DisableScaleIn': True|False,
'ScaleInCooldown': 123,
'ScaleOutCooldown': 123,
'TargetValue': 123.0
}
}
},
'ReplicaGlobalSecondaryIndexSettingsUpdate': [
{
'IndexName': 'string',
'ProvisionedReadCapacityUnits': 123,
'ProvisionedReadCapacityAutoScalingSettingsUpdate': {
'MinimumUnits': 123,
'MaximumUnits': 123,
'AutoScalingDisabled': True|False,
'AutoScalingRoleArn': 'string',
'ScalingPolicyUpdate': {
'PolicyName': 'string',
'TargetTrackingScalingPolicyConfiguration': {
'DisableScaleIn': True|False,
'ScaleInCooldown': 123,
'ScaleOutCooldown': 123,
'TargetValue': 123.0
}
}
}
},
],
'ReplicaTableClass': 'STANDARD'|'STANDARD_INFREQUENT_ACCESS'
},
]
)
string
[REQUIRED]
The name of the global table
string
The billing mode of the global table. If GlobalTableBillingMode is not specified, the global table defaults to PROVISIONED capacity billing mode.
PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned capacity mode.
PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.
integer
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
dict
Auto scaling settings for managing provisioned write capacity for the global table.
MinimumUnits (integer) --
The minimum capacity units that a global table or global secondary index should be scaled down to.
MaximumUnits (integer) --
The maximum capacity units that a global table or global secondary index should be scaled up to.
AutoScalingDisabled (boolean) --
Disabled auto scaling for this global table or global secondary index.
AutoScalingRoleArn (string) --
Role ARN used for configuring auto scaling policy.
ScalingPolicyUpdate (dict) --
The scaling policy to apply for scaling target global table or global secondary index capacity units.
PolicyName (string) --
The name of the scaling policy.
TargetTrackingScalingPolicyConfiguration (dict) -- [REQUIRED]
Represents a target tracking scaling policy configuration.
DisableScaleIn (boolean) --
Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.
ScaleInCooldown (integer) --
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.
ScaleOutCooldown (integer) --
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.
TargetValue (float) -- [REQUIRED]
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
list
Represents the settings of a global secondary index for a global table that will be modified.
(dict) --
Represents the settings of a global secondary index for a global table that will be modified.
IndexName (string) -- [REQUIRED]
The name of the global secondary index. The name must be unique among all other indexes on this table.
ProvisionedWriteCapacityUnits (integer) --
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
ProvisionedWriteCapacityAutoScalingSettingsUpdate (dict) --
Auto scaling settings for managing a global secondary index's write capacity units.
MinimumUnits (integer) --
The minimum capacity units that a global table or global secondary index should be scaled down to.
MaximumUnits (integer) --
The maximum capacity units that a global table or global secondary index should be scaled up to.
AutoScalingDisabled (boolean) --
Disabled auto scaling for this global table or global secondary index.
AutoScalingRoleArn (string) --
Role ARN used for configuring auto scaling policy.
ScalingPolicyUpdate (dict) --
The scaling policy to apply for scaling target global table or global secondary index capacity units.
PolicyName (string) --
The name of the scaling policy.
TargetTrackingScalingPolicyConfiguration (dict) -- [REQUIRED]
Represents a target tracking scaling policy configuration.
DisableScaleIn (boolean) --
Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.
ScaleInCooldown (integer) --
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.
ScaleOutCooldown (integer) --
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.
TargetValue (float) -- [REQUIRED]
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
list
Represents the settings for a global table in a Region that will be modified.
(dict) --
Represents the settings for a global table in a Region that will be modified.
RegionName (string) -- [REQUIRED]
The Region of the replica to be added.
ReplicaProvisionedReadCapacityUnits (integer) --
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate (dict) --
Auto scaling settings for managing a global table replica's read capacity units.
MinimumUnits (integer) --
The minimum capacity units that a global table or global secondary index should be scaled down to.
MaximumUnits (integer) --
The maximum capacity units that a global table or global secondary index should be scaled up to.
AutoScalingDisabled (boolean) --
Disabled auto scaling for this global table or global secondary index.
AutoScalingRoleArn (string) --
Role ARN used for configuring auto scaling policy.
ScalingPolicyUpdate (dict) --
The scaling policy to apply for scaling target global table or global secondary index capacity units.
PolicyName (string) --
The name of the scaling policy.
TargetTrackingScalingPolicyConfiguration (dict) -- [REQUIRED]
Represents a target tracking scaling policy configuration.
DisableScaleIn (boolean) --
Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.
ScaleInCooldown (integer) --
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.
ScaleOutCooldown (integer) --
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.
TargetValue (float) -- [REQUIRED]
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
ReplicaGlobalSecondaryIndexSettingsUpdate (list) --
Represents the settings of a global secondary index for a global table that will be modified.
(dict) --
Represents the settings of a global secondary index for a global table that will be modified.
IndexName (string) -- [REQUIRED]
The name of the global secondary index. The name must be unique among all other indexes on this table.
ProvisionedReadCapacityUnits (integer) --
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.
ProvisionedReadCapacityAutoScalingSettingsUpdate (dict) --
Auto scaling settings for managing a global secondary index replica's read capacity units.
MinimumUnits (integer) --
The minimum capacity units that a global table or global secondary index should be scaled down to.
MaximumUnits (integer) --
The maximum capacity units that a global table or global secondary index should be scaled up to.
AutoScalingDisabled (boolean) --
Disabled auto scaling for this global table or global secondary index.
AutoScalingRoleArn (string) --
Role ARN used for configuring auto scaling policy.
ScalingPolicyUpdate (dict) --
The scaling policy to apply for scaling target global table or global secondary index capacity units.
PolicyName (string) --
The name of the scaling policy.
TargetTrackingScalingPolicyConfiguration (dict) -- [REQUIRED]
Represents a target tracking scaling policy configuration.
DisableScaleIn (boolean) --
Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.
ScaleInCooldown (integer) --
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.
ScaleOutCooldown (integer) --
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.
TargetValue (float) -- [REQUIRED]
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
ReplicaTableClass (string) --
Replica-specific table class. If not specified, uses the source table's table class.
dict
Response Syntax
{
'GlobalTableName': 'string',
'ReplicaSettings': [
{
'RegionName': 'string',
'ReplicaStatus': 'CREATING'|'CREATION_FAILED'|'UPDATING'|'DELETING'|'ACTIVE'|'REGION_DISABLED'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED',
'ReplicaBillingModeSummary': {
'BillingMode': 'PROVISIONED'|'PAY_PER_REQUEST',
'LastUpdateToPayPerRequestDateTime': datetime(2015, 1, 1)
},
'ReplicaProvisionedReadCapacityUnits': 123,
'ReplicaProvisionedReadCapacityAutoScalingSettings': {
'MinimumUnits': 123,
'MaximumUnits': 123,
'AutoScalingDisabled': True|False,
'AutoScalingRoleArn': 'string',
'ScalingPolicies': [
{
'PolicyName': 'string',
'TargetTrackingScalingPolicyConfiguration': {
'DisableScaleIn': True|False,
'ScaleInCooldown': 123,
'ScaleOutCooldown': 123,
'TargetValue': 123.0
}
},
]
},
'ReplicaProvisionedWriteCapacityUnits': 123,
'ReplicaProvisionedWriteCapacityAutoScalingSettings': {
'MinimumUnits': 123,
'MaximumUnits': 123,
'AutoScalingDisabled': True|False,
'AutoScalingRoleArn': 'string',
'ScalingPolicies': [
{
'PolicyName': 'string',
'TargetTrackingScalingPolicyConfiguration': {
'DisableScaleIn': True|False,
'ScaleInCooldown': 123,
'ScaleOutCooldown': 123,
'TargetValue': 123.0
}
},
]
},
'ReplicaGlobalSecondaryIndexSettings': [
{
'IndexName': 'string',
'IndexStatus': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE',
'ProvisionedReadCapacityUnits': 123,
'ProvisionedReadCapacityAutoScalingSettings': {
'MinimumUnits': 123,
'MaximumUnits': 123,
'AutoScalingDisabled': True|False,
'AutoScalingRoleArn': 'string',
'ScalingPolicies': [
{
'PolicyName': 'string',
'TargetTrackingScalingPolicyConfiguration': {
'DisableScaleIn': True|False,
'ScaleInCooldown': 123,
'ScaleOutCooldown': 123,
'TargetValue': 123.0
}
},
]
},
'ProvisionedWriteCapacityUnits': 123,
'ProvisionedWriteCapacityAutoScalingSettings': {
'MinimumUnits': 123,
'MaximumUnits': 123,
'AutoScalingDisabled': True|False,
'AutoScalingRoleArn': 'string',
'ScalingPolicies': [
{
'PolicyName': 'string',
'TargetTrackingScalingPolicyConfiguration': {
'DisableScaleIn': True|False,
'ScaleInCooldown': 123,
'ScaleOutCooldown': 123,
'TargetValue': 123.0
}
},
]
}
},
],
'ReplicaTableClassSummary': {
'TableClass': 'STANDARD'|'STANDARD_INFREQUENT_ACCESS',
'LastUpdateDateTime': datetime(2015, 1, 1)
}
},
]
}
Response Structure
(dict) --
GlobalTableName (string) --
The name of the global table.
ReplicaSettings (list) --
The Region-specific settings for the global table.
(dict) --
Represents the properties of a replica.
RegionName (string) --
The Region name of the replica.
ReplicaStatus (string) --
The current state of the Region:
CREATING - The Region is being created.
UPDATING - The Region is being updated.
DELETING - The Region is being deleted.
ACTIVE - The Region is ready for use.
ReplicaBillingModeSummary (dict) --
The read/write capacity mode of the replica.
BillingMode (string) --
Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.
PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.
PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.
LastUpdateToPayPerRequestDateTime (datetime) --
Represents the time when PAY_PER_REQUEST was last set as the read/write capacity mode.
ReplicaProvisionedReadCapacityUnits (integer) --
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
ReplicaProvisionedReadCapacityAutoScalingSettings (dict) --
Auto scaling settings for a global table replica's read capacity units.
MinimumUnits (integer) --
The minimum capacity units that a global table or global secondary index should be scaled down to.
MaximumUnits (integer) --
The maximum capacity units that a global table or global secondary index should be scaled up to.
AutoScalingDisabled (boolean) --
Disabled auto scaling for this global table or global secondary index.
AutoScalingRoleArn (string) --
Role ARN used for configuring the auto scaling policy.
ScalingPolicies (list) --
Information about the scaling policies.
(dict) --
Represents the properties of the scaling policy.
PolicyName (string) --
The name of the scaling policy.
TargetTrackingScalingPolicyConfiguration (dict) --
Represents a target tracking scaling policy configuration.
DisableScaleIn (boolean) --
Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.
ScaleInCooldown (integer) --
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.
ScaleOutCooldown (integer) --
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.
TargetValue (float) --
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
ReplicaProvisionedWriteCapacityUnits (integer) --
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
ReplicaProvisionedWriteCapacityAutoScalingSettings (dict) --
Auto scaling settings for a global table replica's write capacity units.
MinimumUnits (integer) --
The minimum capacity units that a global table or global secondary index should be scaled down to.
MaximumUnits (integer) --
The maximum capacity units that a global table or global secondary index should be scaled up to.
AutoScalingDisabled (boolean) --
Disabled auto scaling for this global table or global secondary index.
AutoScalingRoleArn (string) --
Role ARN used for configuring the auto scaling policy.
ScalingPolicies (list) --
Information about the scaling policies.
(dict) --
Represents the properties of the scaling policy.
PolicyName (string) --
The name of the scaling policy.
TargetTrackingScalingPolicyConfiguration (dict) --
Represents a target tracking scaling policy configuration.
DisableScaleIn (boolean) --
Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.
ScaleInCooldown (integer) --
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.
ScaleOutCooldown (integer) --
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.
TargetValue (float) --
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
ReplicaGlobalSecondaryIndexSettings (list) --
Replica global secondary index settings for the global table.
(dict) --
Represents the properties of a global secondary index.
IndexName (string) --
The name of the global secondary index. The name must be unique among all other indexes on this table.
IndexStatus (string) --
The current status of the global secondary index:
CREATING - The global secondary index is being created.
UPDATING - The global secondary index is being updated.
DELETING - The global secondary index is being deleted.
ACTIVE - The global secondary index is ready for use.
ProvisionedReadCapacityUnits (integer) --
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.
ProvisionedReadCapacityAutoScalingSettings (dict) --
Auto scaling settings for a global secondary index replica's read capacity units.
MinimumUnits (integer) --
The minimum capacity units that a global table or global secondary index should be scaled down to.
MaximumUnits (integer) --
The maximum capacity units that a global table or global secondary index should be scaled up to.
AutoScalingDisabled (boolean) --
Disabled auto scaling for this global table or global secondary index.
AutoScalingRoleArn (string) --
Role ARN used for configuring the auto scaling policy.
ScalingPolicies (list) --
Information about the scaling policies.
(dict) --
Represents the properties of the scaling policy.
PolicyName (string) --
The name of the scaling policy.
TargetTrackingScalingPolicyConfiguration (dict) --
Represents a target tracking scaling policy configuration.
DisableScaleIn (boolean) --
Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.
ScaleInCooldown (integer) --
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.
ScaleOutCooldown (integer) --
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.
TargetValue (float) --
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
ProvisionedWriteCapacityUnits (integer) --
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
ProvisionedWriteCapacityAutoScalingSettings (dict) --
Auto scaling settings for a global secondary index replica's write capacity units.
MinimumUnits (integer) --
The minimum capacity units that a global table or global secondary index should be scaled down to.
MaximumUnits (integer) --
The maximum capacity units that a global table or global secondary index should be scaled up to.
AutoScalingDisabled (boolean) --
Disabled auto scaling for this global table or global secondary index.
AutoScalingRoleArn (string) --
Role ARN used for configuring the auto scaling policy.
ScalingPolicies (list) --
Information about the scaling policies.
(dict) --
Represents the properties of the scaling policy.
PolicyName (string) --
The name of the scaling policy.
TargetTrackingScalingPolicyConfiguration (dict) --
Represents a target tracking scaling policy configuration.
DisableScaleIn (boolean) --
Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.
ScaleInCooldown (integer) --
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.
ScaleOutCooldown (integer) --
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.
TargetValue (float) --
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
ReplicaTableClassSummary (dict) --
Contains details of the table class.
TableClass (string) --
The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
LastUpdateDateTime (datetime) --
The date and time at which the table class was last updated.
{'GlobalTableWitnessUpdates': [{'Create': {'RegionName': 'string'},
'Delete': {'RegionName': 'string'}}]}
Response {'TableDescription': {'GlobalTableWitnesses': [{'RegionName': 'string',
'WitnessStatus': 'CREATING | '
'DELETING | '
'ACTIVE'}],
'Replicas': {'ReplicaStatus': {'ARCHIVED',
'ARCHIVING',
'REPLICATION_NOT_AUTHORIZED'},
'WarmThroughput': {'Status': {'REPLICATION_NOT_AUTHORIZED'}}},
'TableStatus': {'REPLICATION_NOT_AUTHORIZED'},
'WarmThroughput': {'Status': {'REPLICATION_NOT_AUTHORIZED'}}}}
Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.
You can only perform one of the following operations at once:
Modify the provisioned throughput settings of the table.
Remove a global secondary index from the table.
Create a new global secondary index on the table. After the index begins backfilling, you can use UpdateTable to perform other operations.
UpdateTable is an asynchronous operation; while it's executing, the table status changes from ACTIVE to UPDATING. While it's UPDATING, you can't issue another UpdateTable request. When the table returns to the ACTIVE state, the UpdateTable operation is complete.
See also: AWS API Documentation
Request Syntax
client.update_table(
AttributeDefinitions=[
{
'AttributeName': 'string',
'AttributeType': 'S'|'N'|'B'
},
],
TableName='string',
BillingMode='PROVISIONED'|'PAY_PER_REQUEST',
ProvisionedThroughput={
'ReadCapacityUnits': 123,
'WriteCapacityUnits': 123
},
GlobalSecondaryIndexUpdates=[
{
'Update': {
'IndexName': 'string',
'ProvisionedThroughput': {
'ReadCapacityUnits': 123,
'WriteCapacityUnits': 123
},
'OnDemandThroughput': {
'MaxReadRequestUnits': 123,
'MaxWriteRequestUnits': 123
},
'WarmThroughput': {
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123
}
},
'Create': {
'IndexName': 'string',
'KeySchema': [
{
'AttributeName': 'string',
'KeyType': 'HASH'|'RANGE'
},
],
'Projection': {
'ProjectionType': 'ALL'|'KEYS_ONLY'|'INCLUDE',
'NonKeyAttributes': [
'string',
]
},
'ProvisionedThroughput': {
'ReadCapacityUnits': 123,
'WriteCapacityUnits': 123
},
'OnDemandThroughput': {
'MaxReadRequestUnits': 123,
'MaxWriteRequestUnits': 123
},
'WarmThroughput': {
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123
}
},
'Delete': {
'IndexName': 'string'
}
},
],
StreamSpecification={
'StreamEnabled': True|False,
'StreamViewType': 'NEW_IMAGE'|'OLD_IMAGE'|'NEW_AND_OLD_IMAGES'|'KEYS_ONLY'
},
SSESpecification={
'Enabled': True|False,
'SSEType': 'AES256'|'KMS',
'KMSMasterKeyId': 'string'
},
ReplicaUpdates=[
{
'Create': {
'RegionName': 'string',
'KMSMasterKeyId': 'string',
'ProvisionedThroughputOverride': {
'ReadCapacityUnits': 123
},
'OnDemandThroughputOverride': {
'MaxReadRequestUnits': 123
},
'GlobalSecondaryIndexes': [
{
'IndexName': 'string',
'ProvisionedThroughputOverride': {
'ReadCapacityUnits': 123
},
'OnDemandThroughputOverride': {
'MaxReadRequestUnits': 123
}
},
],
'TableClassOverride': 'STANDARD'|'STANDARD_INFREQUENT_ACCESS'
},
'Update': {
'RegionName': 'string',
'KMSMasterKeyId': 'string',
'ProvisionedThroughputOverride': {
'ReadCapacityUnits': 123
},
'OnDemandThroughputOverride': {
'MaxReadRequestUnits': 123
},
'GlobalSecondaryIndexes': [
{
'IndexName': 'string',
'ProvisionedThroughputOverride': {
'ReadCapacityUnits': 123
},
'OnDemandThroughputOverride': {
'MaxReadRequestUnits': 123
}
},
],
'TableClassOverride': 'STANDARD'|'STANDARD_INFREQUENT_ACCESS'
},
'Delete': {
'RegionName': 'string'
}
},
],
TableClass='STANDARD'|'STANDARD_INFREQUENT_ACCESS',
DeletionProtectionEnabled=True|False,
MultiRegionConsistency='EVENTUAL'|'STRONG',
GlobalTableWitnessUpdates=[
{
'Create': {
'RegionName': 'string'
},
'Delete': {
'RegionName': 'string'
}
},
],
OnDemandThroughput={
'MaxReadRequestUnits': 123,
'MaxWriteRequestUnits': 123
},
WarmThroughput={
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123
}
)
list
An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions must include the key element(s) of the new index.
(dict) --
Represents an attribute for describing the schema for the table and indexes.
AttributeName (string) -- [REQUIRED]
A name for the attribute.
AttributeType (string) -- [REQUIRED]
The data type for the attribute, where:
S - the attribute is of type String
N - the attribute is of type Number
B - the attribute is of type Binary
string
[REQUIRED]
The name of the table to be updated. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
string
Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.
PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for most DynamoDB workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.
PROVISIONED - We recommend using PROVISIONED for steady workloads with predictable growth where capacity requirements can be reliably forecasted. PROVISIONED sets the billing mode to Provisioned capacity mode.
dict
The new provisioned throughput settings for the specified table or index.
ReadCapacityUnits (integer) -- [REQUIRED]
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
WriteCapacityUnits (integer) -- [REQUIRED]
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
list
An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:
Create - add a new global secondary index to the table.
Update - modify the provisioned throughput settings of an existing global secondary index.
Delete - remove a global secondary index from the table.
You can create or delete only one global secondary index per UpdateTable operation.
For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.
(dict) --
Represents one of the following:
A new global secondary index to be added to an existing table.
New provisioned throughput parameters for an existing global secondary index.
An existing global secondary index to be removed from an existing table.
Update (dict) --
The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.
IndexName (string) -- [REQUIRED]
The name of the global secondary index to be updated.
ProvisionedThroughput (dict) --
Represents the provisioned throughput settings for the specified global secondary index.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
ReadCapacityUnits (integer) -- [REQUIRED]
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
WriteCapacityUnits (integer) -- [REQUIRED]
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
OnDemandThroughput (dict) --
Updates the maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.
MaxWriteRequestUnits (integer) --
Maximum number of write request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.
WarmThroughput (dict) --
Represents the warm throughput value of the new provisioned throughput settings to be applied to a global secondary index.
ReadUnitsPerSecond (integer) --
Represents the number of read operations your base table can instantaneously support.
WriteUnitsPerSecond (integer) --
Represents the number of write operations your base table can instantaneously support.
Create (dict) --
The parameters required for creating a global secondary index on an existing table:
IndexName
KeySchema
AttributeDefinitions
Projection
ProvisionedThroughput
IndexName (string) -- [REQUIRED]
The name of the global secondary index to be created.
KeySchema (list) -- [REQUIRED]
The key schema for the global secondary index.
(dict) --
Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.
A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.
AttributeName (string) -- [REQUIRED]
The name of a key attribute.
KeyType (string) -- [REQUIRED]
The role that this key attribute will assume:
HASH - partition key
RANGE - sort key
Projection (dict) -- [REQUIRED]
Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
ProjectionType (string) --
The set of attributes that are projected into the index:
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.
When using the DynamoDB console, ALL is selected by default.
NonKeyAttributes (list) --
Represents the non-key attribute names which will be projected into the index.
For global and local secondary indexes, the total count of 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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
(string) --
ProvisionedThroughput (dict) --
Represents the provisioned throughput settings for the specified global secondary index.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
ReadCapacityUnits (integer) -- [REQUIRED]
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
WriteCapacityUnits (integer) -- [REQUIRED]
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
OnDemandThroughput (dict) --
The maximum number of read and write units for the global secondary index being created. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both. You must use either OnDemand Throughput or ProvisionedThroughput based on your table's capacity mode.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.
MaxWriteRequestUnits (integer) --
Maximum number of write request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.
WarmThroughput (dict) --
Represents the warm throughput value (in read units per second and write units per second) when creating a secondary index.
ReadUnitsPerSecond (integer) --
Represents the number of read operations your base table can instantaneously support.
WriteUnitsPerSecond (integer) --
Represents the number of write operations your base table can instantaneously support.
Delete (dict) --
The name of an existing global secondary index to be removed.
IndexName (string) -- [REQUIRED]
The name of the global secondary index to be deleted.
dict
Represents the DynamoDB Streams configuration for the table.
StreamEnabled (boolean) -- [REQUIRED]
Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
StreamViewType (string) --
When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:
KEYS_ONLY - Only the key attributes of the modified item are written to the stream.
NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.
OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.
NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.
dict
The new server-side encryption settings for the specified table.
Enabled (boolean) --
Indicates whether server-side encryption is done using an Amazon Web Services managed key or an Amazon Web Services owned key. If enabled (true), server-side encryption type is set to KMS and an Amazon Web Services managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to Amazon Web Services owned key.
SSEType (string) --
Server-side encryption type. The only supported value is:
KMS - Server-side encryption that uses Key Management Service. The key is stored in your account and is managed by KMS (KMS charges apply).
KMSMasterKeyId (string) --
The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key alias/aws/dynamodb.
list
A list of replica update actions (create, delete, or update) for the table.
(dict) --
Represents one of the following:
A new replica to be added to an existing regional table or global table. This request invokes the CreateTableReplica action in the destination Region.
New parameters for an existing replica. This request invokes the UpdateTable action in the destination Region.
An existing replica to be deleted. The request invokes the DeleteTableReplica action in the destination Region, deleting the replica and all if its items in the destination Region.
Create (dict) --
The parameters required for creating a replica for the table.
RegionName (string) -- [REQUIRED]
The Region where the new replica will be created.
KMSMasterKeyId (string) --
The KMS key that should be used for KMS encryption in the new replica. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB KMS key alias/aws/dynamodb.
ProvisionedThroughputOverride (dict) --
Replica-specific provisioned throughput. If not specified, uses the source table's provisioned throughput settings.
ReadCapacityUnits (integer) --
Replica-specific read capacity units. If not specified, uses the source table's read capacity settings.
OnDemandThroughputOverride (dict) --
The maximum on-demand throughput settings for the specified replica table being created. You can only modify MaxReadRequestUnits, because you can't modify MaxWriteRequestUnits for individual replica tables.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified replica table.
GlobalSecondaryIndexes (list) --
Replica-specific global secondary index settings.
(dict) --
Represents the properties of a replica global secondary index.
IndexName (string) -- [REQUIRED]
The name of the global secondary index.
ProvisionedThroughputOverride (dict) --
Replica table GSI-specific provisioned throughput. If not specified, uses the source table GSI's read capacity settings.
ReadCapacityUnits (integer) --
Replica-specific read capacity units. If not specified, uses the source table's read capacity settings.
OnDemandThroughputOverride (dict) --
Overrides the maximum on-demand throughput settings for the specified global secondary index in the specified replica table.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified replica table.
TableClassOverride (string) --
Replica-specific table class. If not specified, uses the source table's table class.
Update (dict) --
The parameters required for updating a replica for the table.
RegionName (string) -- [REQUIRED]
The Region where the replica exists.
KMSMasterKeyId (string) --
The KMS key of the replica that should be used for KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB KMS key alias/aws/dynamodb.
ProvisionedThroughputOverride (dict) --
Replica-specific provisioned throughput. If not specified, uses the source table's provisioned throughput settings.
ReadCapacityUnits (integer) --
Replica-specific read capacity units. If not specified, uses the source table's read capacity settings.
OnDemandThroughputOverride (dict) --
Overrides the maximum on-demand throughput for the replica table.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified replica table.
GlobalSecondaryIndexes (list) --
Replica-specific global secondary index settings.
(dict) --
Represents the properties of a replica global secondary index.
IndexName (string) -- [REQUIRED]
The name of the global secondary index.
ProvisionedThroughputOverride (dict) --
Replica table GSI-specific provisioned throughput. If not specified, uses the source table GSI's read capacity settings.
ReadCapacityUnits (integer) --
Replica-specific read capacity units. If not specified, uses the source table's read capacity settings.
OnDemandThroughputOverride (dict) --
Overrides the maximum on-demand throughput settings for the specified global secondary index in the specified replica table.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified replica table.
TableClassOverride (string) --
Replica-specific table class. If not specified, uses the source table's table class.
Delete (dict) --
The parameters required for deleting a replica for the table.
RegionName (string) -- [REQUIRED]
The Region where the replica exists.
string
The table class of the table to be updated. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
boolean
Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
string
Specifies the consistency mode for a new global table. This parameter is only valid when you create a global table by specifying one or more Create actions in the ReplicaUpdates action list.
You can specify one of the following consistency modes:
EVENTUAL: Configures a new global table for multi-Region eventual consistency (MREC). This is the default consistency mode for global tables.
STRONG: Configures a new global table for multi-Region strong consistency (MRSC).
If you don't specify this field, the global table consistency mode defaults to EVENTUAL. For more information about global tables consistency modes, see Consistency modes in DynamoDB developer guide.
list
A list of witness updates for a MRSC global table. A witness provides a cost-effective alternative to a full replica in a MRSC global table by maintaining replicated change data written to global table replicas. You cannot perform read or write operations on a witness. For each witness, you can request one action:
Create - add a new witness to the global table.
Delete - remove a witness from the global table.
You can create or delete only one witness per UpdateTable operation.
For more information, see Multi-Region strong consistency (MRSC) in the Amazon DynamoDB Developer Guide
(dict) --
Represents one of the following:
A new witness to be added to a new global table.
An existing witness to be removed from an existing global table.
You can configure one witness per MRSC global table.
Create (dict) --
Specifies a witness Region to be added to a new MRSC global table. The witness must be added when creating the MRSC global table.
RegionName (string) -- [REQUIRED]
The Amazon Web Services Region name to be added as a witness Region for the MRSC global table. The witness must be in a different Region than the replicas and within the same Region set:
US Region set: US East (N. Virginia), US East (Ohio), US West (Oregon)
EU Region set: Europe (Ireland), Europe (London), Europe (Paris), Europe (Frankfurt)
AP Region set: Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Osaka)
Delete (dict) --
Specifies a witness Region to be removed from an existing global table. Must be done in conjunction with removing a replica. The deletion of both a witness and replica converts the remaining replica to a single-Region DynamoDB table.
RegionName (string) -- [REQUIRED]
The witness Region name to be removed from the MRSC global table.
dict
Updates the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.
MaxWriteRequestUnits (integer) --
Maximum number of write request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.
dict
Represents the warm throughput (in read units per second and write units per second) for updating a table.
ReadUnitsPerSecond (integer) --
Represents the number of read operations your base table can instantaneously support.
WriteUnitsPerSecond (integer) --
Represents the number of write operations your base table can instantaneously support.
dict
Response Syntax
{
'TableDescription': {
'AttributeDefinitions': [
{
'AttributeName': 'string',
'AttributeType': 'S'|'N'|'B'
},
],
'TableName': 'string',
'KeySchema': [
{
'AttributeName': 'string',
'KeyType': 'HASH'|'RANGE'
},
],
'TableStatus': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED',
'CreationDateTime': datetime(2015, 1, 1),
'ProvisionedThroughput': {
'LastIncreaseDateTime': datetime(2015, 1, 1),
'LastDecreaseDateTime': datetime(2015, 1, 1),
'NumberOfDecreasesToday': 123,
'ReadCapacityUnits': 123,
'WriteCapacityUnits': 123
},
'TableSizeBytes': 123,
'ItemCount': 123,
'TableArn': 'string',
'TableId': 'string',
'BillingModeSummary': {
'BillingMode': 'PROVISIONED'|'PAY_PER_REQUEST',
'LastUpdateToPayPerRequestDateTime': datetime(2015, 1, 1)
},
'LocalSecondaryIndexes': [
{
'IndexName': 'string',
'KeySchema': [
{
'AttributeName': 'string',
'KeyType': 'HASH'|'RANGE'
},
],
'Projection': {
'ProjectionType': 'ALL'|'KEYS_ONLY'|'INCLUDE',
'NonKeyAttributes': [
'string',
]
},
'IndexSizeBytes': 123,
'ItemCount': 123,
'IndexArn': 'string'
},
],
'GlobalSecondaryIndexes': [
{
'IndexName': 'string',
'KeySchema': [
{
'AttributeName': 'string',
'KeyType': 'HASH'|'RANGE'
},
],
'Projection': {
'ProjectionType': 'ALL'|'KEYS_ONLY'|'INCLUDE',
'NonKeyAttributes': [
'string',
]
},
'IndexStatus': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE',
'Backfilling': True|False,
'ProvisionedThroughput': {
'LastIncreaseDateTime': datetime(2015, 1, 1),
'LastDecreaseDateTime': datetime(2015, 1, 1),
'NumberOfDecreasesToday': 123,
'ReadCapacityUnits': 123,
'WriteCapacityUnits': 123
},
'IndexSizeBytes': 123,
'ItemCount': 123,
'IndexArn': 'string',
'OnDemandThroughput': {
'MaxReadRequestUnits': 123,
'MaxWriteRequestUnits': 123
},
'WarmThroughput': {
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123,
'Status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'
}
},
],
'StreamSpecification': {
'StreamEnabled': True|False,
'StreamViewType': 'NEW_IMAGE'|'OLD_IMAGE'|'NEW_AND_OLD_IMAGES'|'KEYS_ONLY'
},
'LatestStreamLabel': 'string',
'LatestStreamArn': 'string',
'GlobalTableVersion': 'string',
'Replicas': [
{
'RegionName': 'string',
'ReplicaStatus': 'CREATING'|'CREATION_FAILED'|'UPDATING'|'DELETING'|'ACTIVE'|'REGION_DISABLED'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED',
'ReplicaStatusDescription': 'string',
'ReplicaStatusPercentProgress': 'string',
'KMSMasterKeyId': 'string',
'ProvisionedThroughputOverride': {
'ReadCapacityUnits': 123
},
'OnDemandThroughputOverride': {
'MaxReadRequestUnits': 123
},
'WarmThroughput': {
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123,
'Status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED'
},
'GlobalSecondaryIndexes': [
{
'IndexName': 'string',
'ProvisionedThroughputOverride': {
'ReadCapacityUnits': 123
},
'OnDemandThroughputOverride': {
'MaxReadRequestUnits': 123
},
'WarmThroughput': {
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123,
'Status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'
}
},
],
'ReplicaInaccessibleDateTime': datetime(2015, 1, 1),
'ReplicaTableClassSummary': {
'TableClass': 'STANDARD'|'STANDARD_INFREQUENT_ACCESS',
'LastUpdateDateTime': datetime(2015, 1, 1)
}
},
],
'GlobalTableWitnesses': [
{
'RegionName': 'string',
'WitnessStatus': 'CREATING'|'DELETING'|'ACTIVE'
},
],
'RestoreSummary': {
'SourceBackupArn': 'string',
'SourceTableArn': 'string',
'RestoreDateTime': datetime(2015, 1, 1),
'RestoreInProgress': True|False
},
'SSEDescription': {
'Status': 'ENABLING'|'ENABLED'|'DISABLING'|'DISABLED'|'UPDATING',
'SSEType': 'AES256'|'KMS',
'KMSMasterKeyArn': 'string',
'InaccessibleEncryptionDateTime': datetime(2015, 1, 1)
},
'ArchivalSummary': {
'ArchivalDateTime': datetime(2015, 1, 1),
'ArchivalReason': 'string',
'ArchivalBackupArn': 'string'
},
'TableClassSummary': {
'TableClass': 'STANDARD'|'STANDARD_INFREQUENT_ACCESS',
'LastUpdateDateTime': datetime(2015, 1, 1)
},
'DeletionProtectionEnabled': True|False,
'OnDemandThroughput': {
'MaxReadRequestUnits': 123,
'MaxWriteRequestUnits': 123
},
'WarmThroughput': {
'ReadUnitsPerSecond': 123,
'WriteUnitsPerSecond': 123,
'Status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED'
},
'MultiRegionConsistency': 'EVENTUAL'|'STRONG'
}
}
Response Structure
(dict) --
Represents the output of an UpdateTable operation.
TableDescription (dict) --
Represents the properties of the table.
AttributeDefinitions (list) --
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.
(dict) --
Represents an attribute for describing the schema for the table and indexes.
AttributeName (string) --
A name for the attribute.
AttributeType (string) --
The data type for the attribute, where:
S - the attribute is of type String
N - the attribute is of type Number
B - the attribute is of type Binary
TableName (string) --
The name of the table.
KeySchema (list) --
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
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
(dict) --
Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.
A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.
AttributeName (string) --
The name of a key attribute.
KeyType (string) --
The role that this key attribute will assume:
HASH - partition key
RANGE - sort key
TableStatus (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.
CreationDateTime (datetime) --
The date and time when the table was created, in UNIX epoch time format.
ProvisionedThroughput (dict) --
The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
LastIncreaseDateTime (datetime) --
The date and time of the last provisioned throughput increase for this table.
LastDecreaseDateTime (datetime) --
The date and time of the last provisioned throughput decrease for this table.
NumberOfDecreasesToday (integer) --
The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
ReadCapacityUnits (integer) --
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.
WriteCapacityUnits (integer) --
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
TableSizeBytes (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.
ItemCount (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.
TableArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the table.
TableId (string) --
Unique identifier for the table for which the backup was created.
BillingModeSummary (dict) --
Contains the details for the read/write capacity mode.
BillingMode (string) --
Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.
PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.
PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.
LastUpdateToPayPerRequestDateTime (datetime) --
Represents the time when PAY_PER_REQUEST was last set as the read/write capacity mode.
LocalSecondaryIndexes (list) --
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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
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.
(dict) --
Represents the properties of a local secondary index.
IndexName (string) --
Represents the name of the local secondary index.
KeySchema (list) --
The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
HASH - partition key
RANGE - sort key
(dict) --
Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.
A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.
AttributeName (string) --
The name of a key attribute.
KeyType (string) --
The role that this key attribute will assume:
HASH - partition key
RANGE - sort key
Projection (dict) --
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
ProjectionType (string) --
The set of attributes that are projected into the index:
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.
When using the DynamoDB console, ALL is selected by default.
NonKeyAttributes (list) --
Represents the non-key attribute names which will be projected into the index.
For global and local secondary indexes, the total count of 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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
(string) --
IndexSizeBytes (integer) --
The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
ItemCount (integer) --
The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
IndexArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the index.
GlobalSecondaryIndexes (list) --
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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
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.
(dict) --
Represents the properties of a global secondary index.
IndexName (string) --
The name of the global secondary index.
KeySchema (list) --
The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
HASH - partition key
RANGE - sort key
(dict) --
Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.
A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.
AttributeName (string) --
The name of a key attribute.
KeyType (string) --
The role that this key attribute will assume:
HASH - partition key
RANGE - sort key
Projection (dict) --
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
ProjectionType (string) --
The set of attributes that are projected into the index:
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.
When using the DynamoDB console, ALL is selected by default.
NonKeyAttributes (list) --
Represents the non-key attribute names which will be projected into the index.
For global and local secondary indexes, the total count of 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. This limit only applies when you specify the ProjectionType of INCLUDE. You still can specify the ProjectionType of ALL to project all attributes from the source table, even if the table has more than 100 attributes.
(string) --
IndexStatus (string) --
The current state 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.
Backfilling (boolean) --
Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.
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.
ProvisionedThroughput (dict) --
Represents the provisioned throughput settings for the specified global secondary index.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
LastIncreaseDateTime (datetime) --
The date and time of the last provisioned throughput increase for this table.
LastDecreaseDateTime (datetime) --
The date and time of the last provisioned throughput decrease for this table.
NumberOfDecreasesToday (integer) --
The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
ReadCapacityUnits (integer) --
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.
WriteCapacityUnits (integer) --
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
IndexSizeBytes (integer) --
The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
ItemCount (integer) --
The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
IndexArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the index.
OnDemandThroughput (dict) --
The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.
MaxWriteRequestUnits (integer) --
Maximum number of write request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.
WarmThroughput (dict) --
Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index.
ReadUnitsPerSecond (integer) --
Represents warm throughput read units per second value for a global secondary index.
WriteUnitsPerSecond (integer) --
Represents warm throughput write units per second value for a global secondary index.
Status (string) --
Represents the warm throughput status being created or updated on a global secondary index. The status can only be UPDATING or ACTIVE.
StreamSpecification (dict) --
The current DynamoDB Streams configuration for the table.
StreamEnabled (boolean) --
Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
StreamViewType (string) --
When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:
KEYS_ONLY - Only the key attributes of the modified item are written to the stream.
NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.
OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.
NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.
LatestStreamLabel (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
LatestStreamArn (string) --
The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
GlobalTableVersion (string) --
Represents the version of global tables in use, if the table is replicated across Amazon Web Services Regions.
Replicas (list) --
Represents replicas of the table.
(dict) --
Contains the details of the replica.
RegionName (string) --
The name of the Region.
ReplicaStatus (string) --
The current state of the replica:
CREATING - The replica is being created.
UPDATING - The replica is being updated.
DELETING - The replica is being deleted.
ACTIVE - The replica is ready for use.
REGION_DISABLED - The replica is inaccessible because the Amazon Web Services Region has been disabled.
INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table is inaccessible.
ReplicaStatusDescription (string) --
Detailed information about the replica status.
ReplicaStatusPercentProgress (string) --
Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.
KMSMasterKeyId (string) --
The KMS key of the replica that will be used for KMS encryption.
ProvisionedThroughputOverride (dict) --
Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings.
ReadCapacityUnits (integer) --
Replica-specific read capacity units. If not specified, uses the source table's read capacity settings.
OnDemandThroughputOverride (dict) --
Overrides the maximum on-demand throughput settings for the specified replica table.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified replica table.
WarmThroughput (dict) --
Represents the warm throughput value for this replica.
ReadUnitsPerSecond (integer) --
Represents the base table's warm throughput value in read units per second.
WriteUnitsPerSecond (integer) --
Represents the base table's warm throughput value in write units per second.
Status (string) --
Represents warm throughput value of the base table.
GlobalSecondaryIndexes (list) --
Replica-specific global secondary index settings.
(dict) --
Represents the properties of a replica global secondary index.
IndexName (string) --
The name of the global secondary index.
ProvisionedThroughputOverride (dict) --
If not described, uses the source table GSI's read capacity settings.
ReadCapacityUnits (integer) --
Replica-specific read capacity units. If not specified, uses the source table's read capacity settings.
OnDemandThroughputOverride (dict) --
Overrides the maximum on-demand throughput for the specified global secondary index in the specified replica table.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified replica table.
WarmThroughput (dict) --
Represents the warm throughput of the global secondary index for this replica.
ReadUnitsPerSecond (integer) --
Represents warm throughput read units per second value for a global secondary index.
WriteUnitsPerSecond (integer) --
Represents warm throughput write units per second value for a global secondary index.
Status (string) --
Represents the warm throughput status being created or updated on a global secondary index. The status can only be UPDATING or ACTIVE.
ReplicaInaccessibleDateTime (datetime) --
The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the ReplicaStatus property.
ReplicaTableClassSummary (dict) --
Contains details of the table class.
TableClass (string) --
The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
LastUpdateDateTime (datetime) --
The date and time at which the table class was last updated.
GlobalTableWitnesses (list) --
The witness Region and its current status in the MRSC global table. Only one witness Region can be configured per MRSC global table.
(dict) --
Represents the properties of a witness Region in a MRSC global table.
RegionName (string) --
The name of the Amazon Web Services Region that serves as a witness for the MRSC global table.
WitnessStatus (string) --
The current status of the witness Region in the MRSC global table.
RestoreSummary (dict) --
Contains details for the restore.
SourceBackupArn (string) --
The Amazon Resource Name (ARN) of the backup from which the table was restored.
SourceTableArn (string) --
The ARN of the source table of the backup that is being restored.
RestoreDateTime (datetime) --
Point in time or source backup time.
RestoreInProgress (boolean) --
Indicates if a restore is in progress or not.
SSEDescription (dict) --
The description of the server-side encryption status on the specified table.
Status (string) --
Represents the current state of server-side encryption. The only supported values are:
ENABLED - Server-side encryption is enabled.
UPDATING - Server-side encryption is being updated.
SSEType (string) --
Server-side encryption type. The only supported value is:
KMS - Server-side encryption that uses Key Management Service. The key is stored in your account and is managed by KMS (KMS charges apply).
KMSMasterKeyArn (string) --
The KMS key ARN used for the KMS encryption.
InaccessibleEncryptionDateTime (datetime) --
Indicates the time, in UNIX epoch date format, when DynamoDB detected that the table's KMS key was inaccessible. This attribute will automatically be cleared when DynamoDB detects that the table's KMS key is accessible again. DynamoDB will initiate the table archival process when table's KMS key remains inaccessible for more than seven days from this date.
ArchivalSummary (dict) --
Contains information about the table archive.
ArchivalDateTime (datetime) --
The date and time when table archival was initiated by DynamoDB, in UNIX epoch time format.
ArchivalReason (string) --
The reason DynamoDB archived the table. Currently, the only possible value is:
INACCESSIBLE_ENCRYPTION_CREDENTIALS - The table was archived due to the table's KMS key being inaccessible for more than seven days. An On-Demand backup was created at the archival time.
ArchivalBackupArn (string) --
The Amazon Resource Name (ARN) of the backup the table was archived to, when applicable in the archival reason. If you wish to restore this backup to the same table name, you will need to delete the original table.
TableClassSummary (dict) --
Contains details of the table class.
TableClass (string) --
The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
LastUpdateDateTime (datetime) --
The date and time at which the table class was last updated.
DeletionProtectionEnabled (boolean) --
Indicates whether deletion protection is enabled (true) or disabled (false) on the table.
OnDemandThroughput (dict) --
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.
MaxReadRequestUnits (integer) --
Maximum number of read request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.
MaxWriteRequestUnits (integer) --
Maximum number of write request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.
WarmThroughput (dict) --
Describes the warm throughput value of the base table.
ReadUnitsPerSecond (integer) --
Represents the base table's warm throughput value in read units per second.
WriteUnitsPerSecond (integer) --
Represents the base table's warm throughput value in write units per second.
Status (string) --
Represents warm throughput value of the base table.
MultiRegionConsistency (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 (MREC).
STRONG: Indicates that the global table is configured for multi-Region strong consistency (MRSC).
If you don't specify this field, the global table consistency mode defaults to EVENTUAL. For more information about global tables consistency modes, see Consistency modes in DynamoDB developer guide.
{'TableAutoScalingDescription': {'Replicas': {'ReplicaStatus': {'ARCHIVED',
'ARCHIVING',
'REPLICATION_NOT_AUTHORIZED'}},
'TableStatus': {'REPLICATION_NOT_AUTHORIZED'}}}
Updates auto scaling settings on your global tables at once.
See also: AWS API Documentation
Request Syntax
client.update_table_replica_auto_scaling(
GlobalSecondaryIndexUpdates=[
{
'IndexName': 'string',
'ProvisionedWriteCapacityAutoScalingUpdate': {
'MinimumUnits': 123,
'MaximumUnits': 123,
'AutoScalingDisabled': True|False,
'AutoScalingRoleArn': 'string',
'ScalingPolicyUpdate': {
'PolicyName': 'string',
'TargetTrackingScalingPolicyConfiguration': {
'DisableScaleIn': True|False,
'ScaleInCooldown': 123,
'ScaleOutCooldown': 123,
'TargetValue': 123.0
}
}
}
},
],
TableName='string',
ProvisionedWriteCapacityAutoScalingUpdate={
'MinimumUnits': 123,
'MaximumUnits': 123,
'AutoScalingDisabled': True|False,
'AutoScalingRoleArn': 'string',
'ScalingPolicyUpdate': {
'PolicyName': 'string',
'TargetTrackingScalingPolicyConfiguration': {
'DisableScaleIn': True|False,
'ScaleInCooldown': 123,
'ScaleOutCooldown': 123,
'TargetValue': 123.0
}
}
},
ReplicaUpdates=[
{
'RegionName': 'string',
'ReplicaGlobalSecondaryIndexUpdates': [
{
'IndexName': 'string',
'ProvisionedReadCapacityAutoScalingUpdate': {
'MinimumUnits': 123,
'MaximumUnits': 123,
'AutoScalingDisabled': True|False,
'AutoScalingRoleArn': 'string',
'ScalingPolicyUpdate': {
'PolicyName': 'string',
'TargetTrackingScalingPolicyConfiguration': {
'DisableScaleIn': True|False,
'ScaleInCooldown': 123,
'ScaleOutCooldown': 123,
'TargetValue': 123.0
}
}
}
},
],
'ReplicaProvisionedReadCapacityAutoScalingUpdate': {
'MinimumUnits': 123,
'MaximumUnits': 123,
'AutoScalingDisabled': True|False,
'AutoScalingRoleArn': 'string',
'ScalingPolicyUpdate': {
'PolicyName': 'string',
'TargetTrackingScalingPolicyConfiguration': {
'DisableScaleIn': True|False,
'ScaleInCooldown': 123,
'ScaleOutCooldown': 123,
'TargetValue': 123.0
}
}
}
},
]
)
list
Represents the auto scaling settings of the global secondary indexes of the replica to be updated.
(dict) --
Represents the auto scaling settings of a global secondary index for a global table that will be modified.
IndexName (string) --
The name of the global secondary index.
ProvisionedWriteCapacityAutoScalingUpdate (dict) --
Represents the auto scaling settings to be modified for a global table or global secondary index.
MinimumUnits (integer) --
The minimum capacity units that a global table or global secondary index should be scaled down to.
MaximumUnits (integer) --
The maximum capacity units that a global table or global secondary index should be scaled up to.
AutoScalingDisabled (boolean) --
Disabled auto scaling for this global table or global secondary index.
AutoScalingRoleArn (string) --
Role ARN used for configuring auto scaling policy.
ScalingPolicyUpdate (dict) --
The scaling policy to apply for scaling target global table or global secondary index capacity units.
PolicyName (string) --
The name of the scaling policy.
TargetTrackingScalingPolicyConfiguration (dict) -- [REQUIRED]
Represents a target tracking scaling policy configuration.
DisableScaleIn (boolean) --
Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.
ScaleInCooldown (integer) --
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.
ScaleOutCooldown (integer) --
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.
TargetValue (float) -- [REQUIRED]
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
string
[REQUIRED]
The name of the global table to be updated. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
dict
Represents the auto scaling settings to be modified for a global table or global secondary index.
MinimumUnits (integer) --
The minimum capacity units that a global table or global secondary index should be scaled down to.
MaximumUnits (integer) --
The maximum capacity units that a global table or global secondary index should be scaled up to.
AutoScalingDisabled (boolean) --
Disabled auto scaling for this global table or global secondary index.
AutoScalingRoleArn (string) --
Role ARN used for configuring auto scaling policy.
ScalingPolicyUpdate (dict) --
The scaling policy to apply for scaling target global table or global secondary index capacity units.
PolicyName (string) --
The name of the scaling policy.
TargetTrackingScalingPolicyConfiguration (dict) -- [REQUIRED]
Represents a target tracking scaling policy configuration.
DisableScaleIn (boolean) --
Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.
ScaleInCooldown (integer) --
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.
ScaleOutCooldown (integer) --
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.
TargetValue (float) -- [REQUIRED]
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
list
Represents the auto scaling settings of replicas of the table that will be modified.
(dict) --
Represents the auto scaling settings of a replica that will be modified.
RegionName (string) -- [REQUIRED]
The Region where the replica exists.
ReplicaGlobalSecondaryIndexUpdates (list) --
Represents the auto scaling settings of global secondary indexes that will be modified.
(dict) --
Represents the auto scaling settings of a global secondary index for a replica that will be modified.
IndexName (string) --
The name of the global secondary index.
ProvisionedReadCapacityAutoScalingUpdate (dict) --
Represents the auto scaling settings to be modified for a global table or global secondary index.
MinimumUnits (integer) --
The minimum capacity units that a global table or global secondary index should be scaled down to.
MaximumUnits (integer) --
The maximum capacity units that a global table or global secondary index should be scaled up to.
AutoScalingDisabled (boolean) --
Disabled auto scaling for this global table or global secondary index.
AutoScalingRoleArn (string) --
Role ARN used for configuring auto scaling policy.
ScalingPolicyUpdate (dict) --
The scaling policy to apply for scaling target global table or global secondary index capacity units.
PolicyName (string) --
The name of the scaling policy.
TargetTrackingScalingPolicyConfiguration (dict) -- [REQUIRED]
Represents a target tracking scaling policy configuration.
DisableScaleIn (boolean) --
Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.
ScaleInCooldown (integer) --
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.
ScaleOutCooldown (integer) --
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.
TargetValue (float) -- [REQUIRED]
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
ReplicaProvisionedReadCapacityAutoScalingUpdate (dict) --
Represents the auto scaling settings to be modified for a global table or global secondary index.
MinimumUnits (integer) --
The minimum capacity units that a global table or global secondary index should be scaled down to.
MaximumUnits (integer) --
The maximum capacity units that a global table or global secondary index should be scaled up to.
AutoScalingDisabled (boolean) --
Disabled auto scaling for this global table or global secondary index.
AutoScalingRoleArn (string) --
Role ARN used for configuring auto scaling policy.
ScalingPolicyUpdate (dict) --
The scaling policy to apply for scaling target global table or global secondary index capacity units.
PolicyName (string) --
The name of the scaling policy.
TargetTrackingScalingPolicyConfiguration (dict) -- [REQUIRED]
Represents a target tracking scaling policy configuration.
DisableScaleIn (boolean) --
Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.
ScaleInCooldown (integer) --
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.
ScaleOutCooldown (integer) --
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.
TargetValue (float) -- [REQUIRED]
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
dict
Response Syntax
{
'TableAutoScalingDescription': {
'TableName': 'string',
'TableStatus': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED',
'Replicas': [
{
'RegionName': 'string',
'GlobalSecondaryIndexes': [
{
'IndexName': 'string',
'IndexStatus': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE',
'ProvisionedReadCapacityAutoScalingSettings': {
'MinimumUnits': 123,
'MaximumUnits': 123,
'AutoScalingDisabled': True|False,
'AutoScalingRoleArn': 'string',
'ScalingPolicies': [
{
'PolicyName': 'string',
'TargetTrackingScalingPolicyConfiguration': {
'DisableScaleIn': True|False,
'ScaleInCooldown': 123,
'ScaleOutCooldown': 123,
'TargetValue': 123.0
}
},
]
},
'ProvisionedWriteCapacityAutoScalingSettings': {
'MinimumUnits': 123,
'MaximumUnits': 123,
'AutoScalingDisabled': True|False,
'AutoScalingRoleArn': 'string',
'ScalingPolicies': [
{
'PolicyName': 'string',
'TargetTrackingScalingPolicyConfiguration': {
'DisableScaleIn': True|False,
'ScaleInCooldown': 123,
'ScaleOutCooldown': 123,
'TargetValue': 123.0
}
},
]
}
},
],
'ReplicaProvisionedReadCapacityAutoScalingSettings': {
'MinimumUnits': 123,
'MaximumUnits': 123,
'AutoScalingDisabled': True|False,
'AutoScalingRoleArn': 'string',
'ScalingPolicies': [
{
'PolicyName': 'string',
'TargetTrackingScalingPolicyConfiguration': {
'DisableScaleIn': True|False,
'ScaleInCooldown': 123,
'ScaleOutCooldown': 123,
'TargetValue': 123.0
}
},
]
},
'ReplicaProvisionedWriteCapacityAutoScalingSettings': {
'MinimumUnits': 123,
'MaximumUnits': 123,
'AutoScalingDisabled': True|False,
'AutoScalingRoleArn': 'string',
'ScalingPolicies': [
{
'PolicyName': 'string',
'TargetTrackingScalingPolicyConfiguration': {
'DisableScaleIn': True|False,
'ScaleInCooldown': 123,
'ScaleOutCooldown': 123,
'TargetValue': 123.0
}
},
]
},
'ReplicaStatus': 'CREATING'|'CREATION_FAILED'|'UPDATING'|'DELETING'|'ACTIVE'|'REGION_DISABLED'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS'|'ARCHIVING'|'ARCHIVED'|'REPLICATION_NOT_AUTHORIZED'
},
]
}
}
Response Structure
(dict) --
TableAutoScalingDescription (dict) --
Returns information about the auto scaling settings of a table with replicas.
TableName (string) --
The name of the table.
TableStatus (string) --
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.
Replicas (list) --
Represents replicas of the global table.
(dict) --
Represents the auto scaling settings of the replica.
RegionName (string) --
The Region where the replica exists.
GlobalSecondaryIndexes (list) --
Replica-specific global secondary index auto scaling settings.
(dict) --
Represents the auto scaling configuration for a replica global secondary index.
IndexName (string) --
The name of the global secondary index.
IndexStatus (string) --
The current state of the replica global secondary index:
CREATING - The index is being created.
UPDATING - The table/index configuration is being updated. The table/index remains available for data operations when UPDATING
DELETING - The index is being deleted.
ACTIVE - The index is ready for use.
ProvisionedReadCapacityAutoScalingSettings (dict) --
Represents the auto scaling settings for a global table or global secondary index.
MinimumUnits (integer) --
The minimum capacity units that a global table or global secondary index should be scaled down to.
MaximumUnits (integer) --
The maximum capacity units that a global table or global secondary index should be scaled up to.
AutoScalingDisabled (boolean) --
Disabled auto scaling for this global table or global secondary index.
AutoScalingRoleArn (string) --
Role ARN used for configuring the auto scaling policy.
ScalingPolicies (list) --
Information about the scaling policies.
(dict) --
Represents the properties of the scaling policy.
PolicyName (string) --
The name of the scaling policy.
TargetTrackingScalingPolicyConfiguration (dict) --
Represents a target tracking scaling policy configuration.
DisableScaleIn (boolean) --
Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.
ScaleInCooldown (integer) --
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.
ScaleOutCooldown (integer) --
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.
TargetValue (float) --
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
ProvisionedWriteCapacityAutoScalingSettings (dict) --
Represents the auto scaling settings for a global table or global secondary index.
MinimumUnits (integer) --
The minimum capacity units that a global table or global secondary index should be scaled down to.
MaximumUnits (integer) --
The maximum capacity units that a global table or global secondary index should be scaled up to.
AutoScalingDisabled (boolean) --
Disabled auto scaling for this global table or global secondary index.
AutoScalingRoleArn (string) --
Role ARN used for configuring the auto scaling policy.
ScalingPolicies (list) --
Information about the scaling policies.
(dict) --
Represents the properties of the scaling policy.
PolicyName (string) --
The name of the scaling policy.
TargetTrackingScalingPolicyConfiguration (dict) --
Represents a target tracking scaling policy configuration.
DisableScaleIn (boolean) --
Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.
ScaleInCooldown (integer) --
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.
ScaleOutCooldown (integer) --
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.
TargetValue (float) --
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
ReplicaProvisionedReadCapacityAutoScalingSettings (dict) --
Represents the auto scaling settings for a global table or global secondary index.
MinimumUnits (integer) --
The minimum capacity units that a global table or global secondary index should be scaled down to.
MaximumUnits (integer) --
The maximum capacity units that a global table or global secondary index should be scaled up to.
AutoScalingDisabled (boolean) --
Disabled auto scaling for this global table or global secondary index.
AutoScalingRoleArn (string) --
Role ARN used for configuring the auto scaling policy.
ScalingPolicies (list) --
Information about the scaling policies.
(dict) --
Represents the properties of the scaling policy.
PolicyName (string) --
The name of the scaling policy.
TargetTrackingScalingPolicyConfiguration (dict) --
Represents a target tracking scaling policy configuration.
DisableScaleIn (boolean) --
Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.
ScaleInCooldown (integer) --
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.
ScaleOutCooldown (integer) --
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.
TargetValue (float) --
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
ReplicaProvisionedWriteCapacityAutoScalingSettings (dict) --
Represents the auto scaling settings for a global table or global secondary index.
MinimumUnits (integer) --
The minimum capacity units that a global table or global secondary index should be scaled down to.
MaximumUnits (integer) --
The maximum capacity units that a global table or global secondary index should be scaled up to.
AutoScalingDisabled (boolean) --
Disabled auto scaling for this global table or global secondary index.
AutoScalingRoleArn (string) --
Role ARN used for configuring the auto scaling policy.
ScalingPolicies (list) --
Information about the scaling policies.
(dict) --
Represents the properties of the scaling policy.
PolicyName (string) --
The name of the scaling policy.
TargetTrackingScalingPolicyConfiguration (dict) --
Represents a target tracking scaling policy configuration.
DisableScaleIn (boolean) --
Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.
ScaleInCooldown (integer) --
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.
ScaleOutCooldown (integer) --
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.
TargetValue (float) --
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
ReplicaStatus (string) --
The current state of the replica:
CREATING - The replica is being created.
UPDATING - The replica is being updated.
DELETING - The replica is being deleted.
ACTIVE - The replica is ready for use.