@aws-sdk/client-dynamodb

import type { ApproximateCreationDateTimePrecision, AttributeAction, BackupStatus, BackupType, BackupTypeFilter, BatchStatementErrorCodeEnum, BillingMode, ComparisonOperator, ConditionalOperator, ContinuousBackupsStatus, ContributorInsightsAction, ContributorInsightsMode, ContributorInsightsStatus, DestinationStatus, ExportFormat, ExportStatus, ExportType, ExportViewType, GlobalTableSettingsReplicationMode, GlobalTableStatus, ImportStatus, IndexStatus, InputCompressionType, InputFormat, KeyType, MultiRegionConsistency, PointInTimeRecoveryStatus, ProjectionType, ReplicaStatus, ReturnConsumedCapacity, ReturnItemCollectionMetrics, ReturnValue, ReturnValuesOnConditionCheckFailure, S3SseAlgorithm, ScalarAttributeType, Select, SSEStatus, SSEType, StreamViewType, TableClass, TableStatus, TimeToLiveStatus, WitnessStatus } from "./enums"; /** * Contains details of a table archival operation. * @public */ export interface ArchivalSummary { /** * The date and time when table archival was initiated by DynamoDB, in UNIX epoch time * format. * @public */ ArchivalDateTime?: Date | undefined; /** * The reason DynamoDB archived the table. Currently, the only possible value is: * <ul> * <li> * * <code>INACCESSIBLE_ENCRYPTION_CREDENTIALS</code> - 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. * </li> * </ul> * @public */ ArchivalReason?: string | undefined; /** * 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. * @public */ ArchivalBackupArn?: string | undefined; } /** * Represents an attribute for describing the schema for the table and indexes. * @public */ export interface AttributeDefinition { /** * A name for the attribute. * @public */ AttributeName: string | undefined; /** * The data type for the attribute, where: * <ul> * <li> * * <code>S</code> - the attribute is of type String * </li> * <li> * * <code>N</code> - the attribute is of type Number * </li> * <li> * * <code>B</code> - the attribute is of type Binary * </li> * </ul> * @public */ AttributeType: ScalarAttributeType | undefined; } /** * Represents the properties of a target tracking scaling policy. * @public */ export interface AutoScalingTargetTrackingScalingPolicyConfigurationDescription { /** * 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. * @public */ DisableScaleIn?: boolean | undefined; /** * 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. * @public */ ScaleInCooldown?: number | undefined; /** * 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. * @public */ ScaleOutCooldown?: number | undefined; /** * 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). * @public */ TargetValue: number | undefined; } /** * Represents the properties of the scaling policy. * @public */ export interface AutoScalingPolicyDescription { /** * The name of the scaling policy. * @public */ PolicyName?: string | undefined; /** * Represents a target tracking scaling policy configuration. * @public */ TargetTrackingScalingPolicyConfiguration?: AutoScalingTargetTrackingScalingPolicyConfigurationDescription | undefined; } /** * Represents the settings of a target tracking scaling policy that will be * modified. * @public */ export interface AutoScalingTargetTrackingScalingPolicyConfigurationUpdate { /** * 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. * @public */ DisableScaleIn?: boolean | undefined; /** * 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. * @public */ ScaleInCooldown?: number | undefined; /** * 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. * @public */ ScaleOutCooldown?: number | undefined; /** * 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). * @public */ TargetValue: number | undefined; } /** * Represents the auto scaling policy to be modified. * @public */ export interface AutoScalingPolicyUpdate { /** * The name of the scaling policy. * @public */ PolicyName?: string | undefined; /** * Represents a target tracking scaling policy configuration. * @public */ TargetTrackingScalingPolicyConfiguration: AutoScalingTargetTrackingScalingPolicyConfigurationUpdate | undefined; } /** * Represents the auto scaling settings for a global table or global secondary * index. * @public */ export interface AutoScalingSettingsDescription { /** * The minimum capacity units that a global table or global secondary index should be * scaled down to. * @public */ MinimumUnits?: number | undefined; /** * The maximum capacity units that a global table or global secondary index should be * scaled up to. * @public */ MaximumUnits?: number | undefined; /** * Disabled auto scaling for this global table or global secondary index. * @public */ AutoScalingDisabled?: boolean | undefined; /** * Role ARN used for configuring the auto scaling policy. * @public */ AutoScalingRoleArn?: string | undefined; /** * Information about the scaling policies. * @public */ ScalingPolicies?: AutoScalingPolicyDescription[] | undefined; } /** * Represents the auto scaling settings to be modified for a global table or global * secondary index. * @public */ export interface AutoScalingSettingsUpdate { /** * The minimum capacity units that a global table or global secondary index should be * scaled down to. * @public */ MinimumUnits?: number | undefined; /** * The maximum capacity units that a global table or global secondary index should be * scaled up to. * @public */ MaximumUnits?: number | undefined; /** * Disabled auto scaling for this global table or global secondary index. * @public */ AutoScalingDisabled?: boolean | undefined; /** * Role ARN used for configuring auto scaling policy. * @public */ AutoScalingRoleArn?: string | undefined; /** * The scaling policy to apply for scaling target global table or global secondary index * capacity units. * @public */ ScalingPolicyUpdate?: AutoScalingPolicyUpdate | undefined; } /** * Contains the details of the backup created for the table. * @public */ export interface BackupDetails { /** * ARN associated with the backup. * @public */ BackupArn: string | undefined; /** * Name of the requested backup. * @public */ BackupName: string | undefined; /** * Size of the backup in bytes. DynamoDB updates this value approximately every six * hours. Recent changes might not be reflected in this value. * @public */ BackupSizeBytes?: number | undefined; /** * Backup can be in one of the following states: CREATING, ACTIVE, DELETED. * @public */ BackupStatus: BackupStatus | undefined; /** * BackupType: * <ul> * <li> * * <code>USER</code> - You create and manage these using the on-demand backup * feature. * </li> * <li> * * <code>SYSTEM</code> - If you delete a table with point-in-time recovery enabled, * a <code>SYSTEM</code> backup is automatically created and is retained for 35 * days (at no additional cost). System backups allow you to restore the deleted * table to the state it was in just before the point of deletion. * </li> * <li> * * <code>AWS_BACKUP</code> - On-demand backup created by you from Backup service. * </li> * </ul> * @public */ BackupType: BackupType | undefined; /** * Time at which the backup was created. This is the request time of the backup. * @public */ BackupCreationDateTime: Date | undefined; /** * Time at which the automatic on-demand backup created by DynamoDB will * expire. This <code>SYSTEM</code> on-demand backup expires automatically 35 days after * its creation. * @public */ BackupExpiryDateTime?: Date | undefined; } /** * 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 <code>KeySchemaElement</code> represents exactly one attribute of the primary key. * For example, a simple primary key would be represented by one * <code>KeySchemaElement</code> (for the partition key). A composite primary key would * require one <code>KeySchemaElement</code> for the partition key, and another * <code>KeySchemaElement</code> for the sort key. * A <code>KeySchemaElement</code> 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. * @public */ export interface KeySchemaElement { /** * The name of a key attribute. * @public */ AttributeName: string | undefined; /** * The role that this key attribute will assume: * <ul> * <li> * * <code>HASH</code> - partition key * </li> * <li> * * <code>RANGE</code> - sort key * </li> * </ul> * <note> * The partition key of an item is also known as its hash * attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across * partitions, based on their partition key values. * The sort key of an item is also known as its range attribute. * The term "range attribute" derives from the way DynamoDB stores items with * the same partition key physically close together, in sorted order by the sort key * value. * </note> * @public */ KeyType: KeyType | undefined; } /** * Sets the maximum number of read and write units for the specified on-demand table. If * you use this parameter, you must specify <code>MaxReadRequestUnits</code>, * <code>MaxWriteRequestUnits</code>, or both. * @public */ export interface OnDemandThroughput { /** * Maximum number of read request units for the specified table. * To specify a maximum <code>OnDemandThroughput</code> on your table, set the value of * <code>MaxReadRequestUnits</code> as greater than or equal to 1. To remove the * maximum <code>OnDemandThroughput</code> that is currently set on your table, set the * value of <code>MaxReadRequestUnits</code> to -1. * @public */ MaxReadRequestUnits?: number | undefined; /** * Maximum number of write request units for the specified table. * To specify a maximum <code>OnDemandThroughput</code> on your table, set the value of * <code>MaxWriteRequestUnits</code> as greater than or equal to 1. To remove the * maximum <code>OnDemandThroughput</code> that is currently set on your table, set the * value of <code>MaxWriteRequestUnits</code> to -1. * @public */ MaxWriteRequestUnits?: number | undefined; } /** * Represents the provisioned throughput settings for the specified global secondary * index. You must use <code>ProvisionedThroughput</code> or * <code>OnDemandThroughput</code> based on your table’s capacity mode. * For current minimum and maximum provisioned throughput values, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Service, * Account, and Table Quotas</a> in the Amazon DynamoDB Developer * Guide. * @public */ export interface ProvisionedThroughput { /** * The maximum number of strongly consistent reads consumed per second before DynamoDB * returns a <code>ThrottlingException</code>. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html">Specifying * Read and Write Requirements</a> in the Amazon DynamoDB Developer * Guide. * If read/write capacity mode is <code>PAY_PER_REQUEST</code> the value is set to * 0. * @public */ ReadCapacityUnits: number | undefined; /** * The maximum number of writes consumed per second before DynamoDB returns a * <code>ThrottlingException</code>. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html">Specifying * Read and Write Requirements</a> in the Amazon DynamoDB Developer * Guide. * If read/write capacity mode is <code>PAY_PER_REQUEST</code> the value is set to * 0. * @public */ WriteCapacityUnits: number | undefined; } /** * Contains the details of the table when the backup was created. * @public */ export interface SourceTableDetails { /** * The name of the table for which the backup was created. * @public */ TableName: string | undefined; /** * Unique identifier for the table for which the backup was created. * @public */ TableId: string | undefined; /** * ARN of the table for which backup was created. * @public */ TableArn?: string | undefined; /** * Size of the table in bytes. Note that this is an approximate value. * @public */ TableSizeBytes?: number | undefined; /** * Schema of the table. * @public */ KeySchema: KeySchemaElement[] | undefined; /** * Time when the source table was created. * @public */ TableCreationDateTime: Date | undefined; /** * Read IOPs and Write IOPS on the table when the backup was created. * @public */ ProvisionedThroughput: ProvisionedThroughput | undefined; /** * Sets the maximum number of read and write units for the specified on-demand table. If * you use this parameter, you must specify <code>MaxReadRequestUnits</code>, * <code>MaxWriteRequestUnits</code>, or both. * @public */ OnDemandThroughput?: OnDemandThroughput | undefined; /** * Number of items in the table. Note that this is an approximate value. * @public */ ItemCount?: number | undefined; /** * Controls how you are charged for read and write throughput and how you manage * capacity. This setting can be changed later. * <ul> * <li> * * <code>PROVISIONED</code> - Sets the read/write capacity mode to * <code>PROVISIONED</code>. We recommend using <code>PROVISIONED</code> for * predictable workloads. * </li> * <li> * * <code>PAY_PER_REQUEST</code> - Sets the read/write capacity mode to * <code>PAY_PER_REQUEST</code>. We recommend using * <code>PAY_PER_REQUEST</code> for unpredictable workloads. * </li> * </ul> * @public */ BillingMode?: BillingMode | undefined; } /** * 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. * @public */ export interface Projection { /** * The set of attributes that are projected into the index: * <ul> * <li> * * <code>KEYS_ONLY</code> - Only the index and primary keys are projected into the * index. * </li> * <li> * * <code>INCLUDE</code> - In addition to the attributes described in * <code>KEYS_ONLY</code>, the secondary index will include other non-key * attributes that you specify. * </li> * <li> * * <code>ALL</code> - All of the table attributes are projected into the * index. * </li> * </ul> * When using the DynamoDB console, <code>ALL</code> is selected by default. * @public */ ProjectionType?: ProjectionType | undefined; /** * Represents the non-key attribute names which will be projected into the index. * For global and local secondary indexes, the total count of * <code>NonKeyAttributes</code> 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 <code>INCLUDE</code>. You still can specify the * ProjectionType of <code>ALL</code> to project all attributes from the source table, even * if the table has more than 100 attributes. * @public */ NonKeyAttributes?: string[] | undefined; } /** * Represents the properties of a global secondary index for the table when the backup * was created. * @public */ export interface GlobalSecondaryIndexInfo { /** * The name of the global secondary index. * @public */ IndexName?: string | undefined; /** * The complete key schema for a global secondary index, which consists of one or more * pairs of attribute names and key types: * <ul> * <li> * * <code>HASH</code> - partition key * </li> * <li> * * <code>RANGE</code> - sort key * </li> * </ul> * <note> * The partition key of an item is also known as its hash * attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across * partitions, based on their partition key values. * The sort key of an item is also known as its range attribute. * The term "range attribute" derives from the way DynamoDB stores items with * the same partition key physically close together, in sorted order by the sort key * value. * </note> * @public */ KeySchema?: KeySchemaElement[] | undefined; /** * 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. * @public */ Projection?: Projection | undefined; /** * Represents the provisioned throughput settings for the specified global secondary * index. * @public */ ProvisionedThroughput?: ProvisionedThroughput | undefined; /** * Sets the maximum number of read and write units for the specified on-demand table. If * you use this parameter, you must specify <code>MaxReadRequestUnits</code>, * <code>MaxWriteRequestUnits</code>, or both. * @public */ OnDemandThroughput?: OnDemandThroughput | undefined; } /** * Represents the properties of a local secondary index for the table when the backup was * created. * @public */ export interface LocalSecondaryIndexInfo { /** * Represents the name of the local secondary index. * @public */ IndexName?: string | undefined; /** * The complete key schema for a local secondary index, which consists of one or more * pairs of attribute names and key types: * <ul> * <li> * * <code>HASH</code> - partition key * </li> * <li> * * <code>RANGE</code> - sort key * </li> * </ul> * <note> * The partition key of an item is also known as its hash * attribute. The term "hash attribute" derives from DynamoDB's usage of * an internal hash function to evenly distribute data items across partitions, based * on their partition key values. * The sort key of an item is also known as its range attribute. * The term "range attribute" derives from the way DynamoDB stores items with the same * partition key physically close together, in sorted order by the sort key * value. * </note> * @public */ KeySchema?: KeySchemaElement[] | undefined; /** * 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. * @public */ Projection?: Projection | undefined; } /** * The description of the server-side encryption status on the specified table. * @public */ export interface SSEDescription { /** * Represents the current state of server-side encryption. The only supported values * are: * <ul> * <li> * * <code>ENABLED</code> - Server-side encryption is enabled. * </li> * <li> * * <code>UPDATING</code> - Server-side encryption is being updated. * </li> * </ul> * @public */ Status?: SSEStatus | undefined; /** * Server-side encryption type. The only supported value is: * <ul> * <li> * * <code>KMS</code> - Server-side encryption that uses Key Management Service. The * key is stored in your account and is managed by KMS (KMS charges apply). * </li> * </ul> * @public */ SSEType?: SSEType | undefined; /** * The KMS key ARN used for the KMS encryption. * @public */ KMSMasterKeyArn?: string | undefined; /** * 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. * @public */ InaccessibleEncryptionDateTime?: Date | undefined; } /** * Represents the DynamoDB Streams configuration for a table in DynamoDB. * @public */ export interface StreamSpecification { /** * Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the * table. * @public */ StreamEnabled: boolean | undefined; /** * When an item in the table is modified, <code>StreamViewType</code> determines what * information is written to the stream for this table. Valid values for * <code>StreamViewType</code> are: * <ul> * <li> * * <code>KEYS_ONLY</code> - Only the key attributes of the modified item are * written to the stream. * </li> * <li> * * <code>NEW_IMAGE</code> - The entire item, as it appears after it was modified, * is written to the stream. * </li> * <li> * * <code>OLD_IMAGE</code> - The entire item, as it appeared before it was modified, * is written to the stream. * </li> * <li> * * <code>NEW_AND_OLD_IMAGES</code> - Both the new and the old item images of the * item are written to the stream. * </li> * </ul> * @public */ StreamViewType?: StreamViewType | undefined; } /** * The description of the Time to Live (TTL) status on the specified table. * @public */ export interface TimeToLiveDescription { /** * The TTL status for the table. * @public */ TimeToLiveStatus?: TimeToLiveStatus | undefined; /** * The name of the TTL attribute for items in the table. * @public */ AttributeName?: string | undefined; } /** * Contains the details of the features enabled on the table when the backup was created. * For example, LSIs, GSIs, streams, TTL. * @public */ export interface SourceTableFeatureDetails { /** * Represents the LSI properties for the table when the backup was created. It includes * the IndexName, KeySchema and Projection for the LSIs on the table at the time of backup. * * @public */ LocalSecondaryIndexes?: LocalSecondaryIndexInfo[] | undefined; /** * Represents the GSI properties for the table when the backup was created. It includes * the IndexName, KeySchema, Projection, and ProvisionedThroughput for the GSIs on the * table at the time of backup. * @public */ GlobalSecondaryIndexes?: GlobalSecondaryIndexInfo[] | undefined; /** * Stream settings on the table when the backup was created. * @public */ StreamDescription?: StreamSpecification | undefined; /** * Time to Live settings on the table when the backup was created. * @public */ TimeToLiveDescription?: TimeToLiveDescription | undefined; /** * The description of the server-side encryption status on the table when the backup was * created. * @public */ SSEDescription?: SSEDescription | undefined; } /** * Contains the description of the backup created for the table. * @public */ export interface BackupDescription { /** * Contains the details of the backup created for the table. * @public */ BackupDetails?: BackupDetails | undefined; /** * Contains the details of the table when the backup was created. * @public */ SourceTableDetails?: SourceTableDetails | undefined; /** * Contains the details of the features enabled on the table when the backup was created. * For example, LSIs, GSIs, streams, TTL. * @public */ SourceTableFeatureDetails?: SourceTableFeatureDetails | undefined; } /** * Contains details for the backup. * @public */ export interface BackupSummary { /** * Name of the table. * @public */ TableName?: string | undefined; /** * Unique identifier for the table. * @public */ TableId?: string | undefined; /** * ARN associated with the table. * @public */ TableArn?: string | undefined; /** * ARN associated with the backup. * @public */ BackupArn?: string | undefined; /** * Name of the specified backup. * @public */ BackupName?: string | undefined; /** * Time at which the backup was created. * @public */ BackupCreationDateTime?: Date | undefined; /** * Time at which the automatic on-demand backup created by DynamoDB will * expire. This <code>SYSTEM</code> on-demand backup expires automatically 35 days after * its creation. * @public */ BackupExpiryDateTime?: Date | undefined; /** * Backup can be in one of the following states: CREATING, ACTIVE, DELETED. * @public */ BackupStatus?: BackupStatus | undefined; /** * BackupType: * <ul> * <li> * * <code>USER</code> - You create and manage these using the on-demand backup * feature. * </li> * <li> * * <code>SYSTEM</code> - If you delete a table with point-in-time recovery enabled, * a <code>SYSTEM</code> backup is automatically created and is retained for 35 * days (at no additional cost). System backups allow you to restore the deleted * table to the state it was in just before the point of deletion. * </li> * <li> * * <code>AWS_BACKUP</code> - On-demand backup created by you from Backup service. * </li> * </ul> * @public */ BackupType?: BackupType | undefined; /** * Size of the backup in bytes. * @public */ BackupSizeBytes?: number | undefined; } /** * Represents the amount of provisioned throughput capacity consumed on a table or an * index. * @public */ export interface Capacity { /** * The total number of read capacity units consumed on a table or an index. * @public */ ReadCapacityUnits?: number | undefined; /** * The total number of write capacity units consumed on a table or an index. * @public */ WriteCapacityUnits?: number | undefined; /** * The total number of capacity units consumed on a table or an index. * @public */ CapacityUnits?: number | undefined; } /** * The capacity units consumed by an operation. The data returned includes the total * provisioned throughput consumed, along with statistics for the table and any indexes * involved in the operation. <code>ConsumedCapacity</code> is only returned if the request * asked for it. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/provisioned-capacity-mode.html">Provisioned capacity mode</a> in the Amazon DynamoDB Developer * Guide. * @public */ export interface ConsumedCapacity { /** * The name of the table that was affected by the operation. If you had specified the * Amazon Resource Name (ARN) of a table in the input, you'll see the table ARN in the response. * @public */ TableName?: string | undefined; /** * The total number of capacity units consumed by the operation. * @public */ CapacityUnits?: number | undefined; /** * The total number of read capacity units consumed by the operation. * @public */ ReadCapacityUnits?: number | undefined; /** * The total number of write capacity units consumed by the operation. * @public */ WriteCapacityUnits?: number | undefined; /** * The amount of throughput consumed on the table affected by the operation. * @public */ Table?: Capacity | undefined; /** * The amount of throughput consumed on each local index affected by the * operation. * @public */ LocalSecondaryIndexes?: Record<string, Capacity> | undefined; /** * The amount of throughput consumed on each global index affected by the * operation. * @public */ GlobalSecondaryIndexes?: Record<string, Capacity> | undefined; } /** * Represents the specific reason why a DynamoDB request was throttled and the * ARN of the impacted resource. This helps identify exactly what resource is being throttled, * what type of operation caused it, and why the throttling occurred. * @public */ export interface ThrottlingReason { /** * The reason for throttling. The throttling reason follows a specific format: * <code>ResourceType+OperationType+LimitType</code>: * <ul> * <li> * Resource Type (What is being throttled): Table or Index * </li> * <li> * Operation Type (What kind of operation): Read or Write * </li> * <li> * Limit Type (Why the throttling occurred): * <ul> * <li> * * <code>ProvisionedThroughputExceeded</code>: The request rate is * exceeding the <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/provisioned-capacity-mode.html">provisioned throughput capacity</a> (read or write capacity * units) configured for a table or a global secondary index (GSI) in * provisioned capacity mode. * </li> * <li> * * <code>AccountLimitExceeded</code>: The request rate has caused a table * or global secondary index (GSI) in on-demand mode to exceed the <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ServiceQuotas.html#default-limits-throughput">per-table account-level service quotas</a> for read/write * throughput in the current Amazon Web Services Region. * </li> * <li> * * <code>KeyRangeThroughputExceeded</code>: The request rate directed at * a specific partition key value has exceeded the <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html">internal partition-level throughput limits</a>, indicating * uneven access patterns across the table's or GSI's key space. * </li> * <li> * * <code>MaxOnDemandThroughputExceeded</code>: The request rate has * exceeded the <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/on-demand-capacity-mode-max-throughput.html">configured maximum throughput limits</a> set for a table or * index in on-demand capacity mode. * </li> * </ul> * </li> * </ul> * Examples of complete throttling reasons: * <ul> * <li> * TableReadProvisionedThroughputExceeded * </li> * <li> * IndexWriteAccountLimitExceeded * </li> * </ul> * This helps identify exactly what resource is being throttled, what type of operation * caused it, and why the throttling occurred. * @public */ reason?: string | undefined; /** * The Amazon Resource Name (ARN) of the DynamoDB table or index that experienced the * throttling event. * @public */ resource?: string | undefined; } /** * Contains the details for the read/write capacity mode. This page talks about * <code>PROVISIONED</code> and <code>PAY_PER_REQUEST</code> billing modes. For more * information about these modes, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html">Read/write capacity mode</a>. * <note> * You may need to switch to on-demand mode at least once in order to return a * <code>BillingModeSummary</code> response. * </note> * @public */ export interface BillingModeSummary { /** * Controls how you are charged for read and write throughput and how you manage * capacity. This setting can be changed later. * <ul> * <li> * * <code>PROVISIONED</code> - Sets the read/write capacity mode to * <code>PROVISIONED</code>. We recommend using <code>PROVISIONED</code> for * predictable workloads. * </li> * <li> * * <code>PAY_PER_REQUEST</code> - Sets the read/write capacity mode to * <code>PAY_PER_REQUEST</code>. We recommend using * <code>PAY_PER_REQUEST</code> for unpredictable workloads. * </li> * </ul> * @public */ BillingMode?: BillingMode | undefined; /** * Represents the time when <code>PAY_PER_REQUEST</code> was last set as the read/write * capacity mode. * @public */ LastUpdateToPayPerRequestDateTime?: Date | undefined; } /** * The description of the point in time settings applied to the table. * @public */ export interface PointInTimeRecoveryDescription { /** * The current state of point in time recovery: * <ul> * <li> * * <code>ENABLED</code> - Point in time recovery is enabled. * </li> * <li> * * <code>DISABLED</code> - Point in time recovery is disabled. * </li> * </ul> * @public */ PointInTimeRecoveryStatus?: PointInTimeRecoveryStatus | undefined; /** * The number of preceding days for which continuous backups are taken and maintained. * Your table data is only recoverable to any point-in-time from within the configured * recovery period. This parameter is optional. * @public */ RecoveryPeriodInDays?: number | undefined; /** * Specifies the earliest point in time you can restore your table to. You can restore * your table to any point in time during the last 35 days. * @public */ EarliestRestorableDateTime?: Date | undefined; /** * * <code>LatestRestorableDateTime</code> is typically 5 minutes before the current time. * * @public */ LatestRestorableDateTime?: Date | undefined; } /** * Represents the continuous backups and point in time recovery settings on the * table. * @public */ export interface ContinuousBackupsDescription { /** * * <code>ContinuousBackupsStatus</code> can be one of the following states: ENABLED, * DISABLED * @public */ ContinuousBackupsStatus: ContinuousBackupsStatus | undefined; /** * The description of the point in time recovery settings applied to the table. * @public */ PointInTimeRecoveryDescription?: PointInTimeRecoveryDescription | undefined; } /** * Represents a Contributor Insights summary entry. * @public */ export interface ContributorInsightsSummary { /** * Name of the table associated with the summary. * @public */ TableName?: string | undefined; /** * Name of the index associated with the summary, if any. * @public */ IndexName?: string | undefined; /** * Describes the current status for contributor insights for the given table and index, * if applicable. * @public */ ContributorInsightsStatus?: ContributorInsightsStatus | undefined; /** * Indicates the current mode of CloudWatch Contributor Insights, specifying whether it * tracks all access and throttled events or throttled events only for the DynamoDB * table or index. * @public */ ContributorInsightsMode?: ContributorInsightsMode | undefined; } /** * @public */ export interface CreateBackupInput { /** * The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this * parameter. * @public */ TableName: string | undefined; /** * Specified name for the backup. * @public */ BackupName: string | undefined; } /** * @public */ export interface CreateBackupOutput { /** * Contains the details of the backup created for the table. * @public */ BackupDetails?: BackupDetails | undefined; } /** * Provides visibility into the number of read and write operations your table or * secondary index can instantaneously support. The settings can be modified using the * <code>UpdateTable</code> operation to meet the throughput requirements of an * upcoming peak event. * @public */ export interface WarmThroughput { /** * Represents the number of read operations your base table can instantaneously * support. * @public */ ReadUnitsPerSecond?: number | undefined; /** * Represents the number of write operations your base table can instantaneously * support. * @public */ WriteUnitsPerSecond?: number | undefined; } /** * Represents a new global secondary index to be added to an existing table. * @public */ export interface CreateGlobalSecondaryIndexAction { /** * The name of the global secondary index to be created. * @public */ IndexName: string | undefined; /** * The key schema for the global secondary index. * Global secondary index supports up to 4 partition and up to 4 sort keys. * @public */ KeySchema: KeySchemaElement[] | undefined; /** * 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. * @public */ Projection: Projection | undefined; /** * Represents the provisioned throughput settings for the specified global secondary * index. * For current minimum and maximum provisioned throughput values, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Service, * Account, and Table Quotas</a> in the Amazon DynamoDB Developer * Guide. * @public */ ProvisionedThroughput?: ProvisionedThroughput | undefined; /** * The maximum number of read and write units for the global secondary index being * created. If you use this parameter, you must specify <code>MaxReadRequestUnits</code>, * <code>MaxWriteRequestUnits</code>, or both. You must use either <code>OnDemand * Throughput</code> or <code>ProvisionedThroughput</code> based on your table's * capacity mode. * @public */ OnDemandThroughput?: OnDemandThroughput | undefined; /** * Represents the warm throughput value (in read units per