AWS.Tools.DynamoDBv2.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.DynamoDBv2</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.DDB.AddDDBIndexSchemaCmdlet"> <summary> <para> Adds a new Amazon DynamoDB local or global secondary index schema property to the supplied object, or returns a new object initialized with the index schema. </para> <para> The default behavior of this cmdlet is to create a local secondary index. To specify that the index is global, use the -Global switch and also add the ReadCapacity and WriteCapacity parameters to indicate the required throughput for the index. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.AddDDBIndexSchemaCmdlet.Schema"> <summary> A previously constructed TableSchema object to which the new index schema element will be added. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.AddDDBIndexSchemaCmdlet.IndexName"> <summary> The name of the secondary index. Must be unique only for this table that will be created. If an index with the same name already exists on the pipelined object an error is thrown. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.AddDDBIndexSchemaCmdlet.RangeKeyName"> <summary> The name of the range key to add to the secondary index. This is a mandatory parameter for local indexes. Global indexes can be defined with either a range key or a hash key, either of which can be any attribute in the table. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.AddDDBIndexSchemaCmdlet.RangeKeyDataType"> <summary> The data type of the range key as specified by the Amazon DynamoDB api. This is a mandatory parameter for local indexes. Global indexes can be defined with either a range key or a hash key, either of which can be any attribute in the table. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.AddDDBIndexSchemaCmdlet.ProjectionType"> <summary> 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. Valid values: 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 are specified with the -NonKeyAttribute parameter. ALL - All of the table attributes are projected into the index. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.AddDDBIndexSchemaCmdlet.NonKeyAttribute"> <summary> A collection of one or more non-key attribute names that are projected into the index. The total count of attributes specified in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.AddDDBIndexSchemaCmdlet.Global"> <summary> If set, specifies that the index components described by the parameters should be added as a global secondary index entry. The ReadCapacity and WriteCapacity parameters are also required when defining a global index. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.AddDDBIndexSchemaCmdlet.HashKeyName"> <summary> The name of the hash key for the global secondary index. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.AddDDBIndexSchemaCmdlet.HashKeyDataType"> <summary> The data type of the hash key for the global index, as specified by the Amazon DynamoDB api. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.AddDDBIndexSchemaCmdlet.ReadCapacity"> <summary> The provisioned throughput setting for read operations on the secondary index if the index is global (the -Global switch is specified). Ignored for local secondary indexes (the default). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.AddDDBIndexSchemaCmdlet.WriteCapacity"> <summary> The provisioned throughput setting for write operations on the secondary index if the index is global (the -Global switch is specified). Ignored for local secondary indexes (the default). </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.AddDDBKeySchemaCmdlet"> <summary> Adds a new Amazon DynamoDB KeySchemaElement instance to the supplied TableSchema object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.AddDDBKeySchemaCmdlet.Schema"> <summary> A previously constructed object to which the new key schema element will be added to any attached KeySchema property collection. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.AddDDBKeySchemaCmdlet.KeyName"> <summary> The name of the key to be applied to the schema. If a key with the specified name already exists an error is thrown. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.AddDDBKeySchemaCmdlet.KeyType"> <summary> The key type. Valid values are "HASH" or "RANGE". If not specified, "HASH" is assumed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.AddDDBKeySchemaCmdlet.KeyDataType"> <summary> <para> The data type of the key as specified by the Amazon DynamoDB api. If an attribute entry for the key already exists in the attribute definitions of the supplied schema object, this parameter can be omitted otherwise an attribute will be added and defined as the declared type. </para> <para> Valid values for data type: "S" string, "N" number or "B" binary. </para> </summary> </member> <member name="M:Amazon.PowerShell.Cmdlets.DDB.DDBSchemaCmdletHelper.TableSchemaFromParameter(System.Object)"> <summary> Returns the schema object to manipulate. </summary> <param name="inputObjectParameter"> The pipeline object supplied as the value of the -Schema parameter or piped into cmdlet. </param> <returns> The supplied object as TableSchema. </returns> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.NewDDBTableCmdlet"> <summary> <para>The <i>CreateTable</i> operation adds a new table to your account. In an AWS 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.</para><para><i>CreateTable</i> is an asynchronous operation. Upon receiving a <i>CreateTable</i> request, Amazon DynamoDB immediately returns a response with a <i>TableStatus</i> of <c>CREATING</c> . After the table is created, Amazon DynamoDB sets the <i>TableStatus</i> to <c>ACTIVE</c> . You can perform read and write operations only on an <c>ACTIVE</c> table. </para><para>If you want to create multiple tables with local secondary indexes on them, you must create them sequentially. Only one table with local secondary indexes can be in the <c>CREATING</c> state at any given time.</para><para>You can use the <i>DescribeTable</i> API to check the table status.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.NewDDBTableCmdlet.TableName"> <summary> <para> The name of the table to create. </para> <para> <b>Constraints:</b><list type="definition"><item><term>Length</term><description>3 - 255</description></item><item><term>Pattern</term><description>[a-zA-Z0-9_.-]+</description></item></list> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.NewDDBTableCmdlet.Schema"> <summary> TableSchema object containing the attribute and key schema information for the new table using the Write-DDBKeySchema and Write-DDBIndexSchema cmdlets. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.NewDDBTableCmdlet.ReadCapacity"> <summary> <para> The maximum number of strongly consistent reads consumed per second before Amazon DynamoDB returns a <i>ThrottlingException</i>. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithDDTables.html#ProvisionedThroughput">Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> <b>Constraints:</b><list type="definition"><item><term>Range</term><description>1 - </description></item></list> </para> <para> The settings can be modified using the <i>Update-DDBTable</i> cmdlet. For current minimum and maximum provisioned throughput values, see Limits in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.NewDDBTableCmdlet.WriteCapacity"> <summary> <para> The maximum number of strongly consistent writes consumed per second before Amazon DynamoDB returns a <i>ThrottlingException</i>. For more information, see <a href="http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithDDTables.html#ProvisionedThroughput">Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> <para> <b>Constraints:</b><list type="definition"><item><term>Range</term><description>1 - </description></item></list> </para> <para> The settings can be modified using the <i>Update-DDBTable</i> cmdlet. For current minimum and maximum provisioned throughput values, see Limits in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.NewDDBTableCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.NewDDBTableSchemaCmdlet"> <summary> Returns a new TableSchema object for constructing an Amazon DynamoDB key schema for use with New-DDBTable. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.AddDDBResourceTagCmdlet"> <summary> Associate a set of tags with an Amazon DynamoDB resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking. You can call TagResource up to five times per second, per account. <para> For an overview on tagging DynamoDB resources, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html">Tagging for DynamoDB</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.AddDDBResourceTagCmdlet.ResourceArn"> <summary> <para> <para>Identifies the Amazon DynamoDB resource to which tags should be added. This value is an Amazon Resource Name (ARN).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.AddDDBResourceTagCmdlet.Tag"> <summary> <para> <para>The tags to be assigned to the Amazon DynamoDB resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.AddDDBResourceTagCmdlet.PassThru"> <summary> Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.AddDDBResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.GetDDBBackupCmdlet"> <summary> Describes an existing backup of a table. <para> You can call <code>DescribeBackup</code> at a maximum rate of 10 times per second. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBBackupCmdlet.BackupArn"> <summary> <para> <para>The Amazon Resource Name (ARN) associated with the backup.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.GetDDBBackupListCmdlet"> <summary> List backups associated with an AWS account. To list backups for a given table, specify <code>TableName</code>. <code>ListBackups</code> returns a paginated list of results with at most 1 MB worth of items in a page. You can also specify a limit for the maximum number of entries to be returned in a page. <para> In the request, start time is inclusive, but end time is exclusive. Note that these limits are for the time at which the original backup was requested. </para><para> You can call <code>ListBackups</code> a maximum of five times per second. </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBBackupListCmdlet.BackupType"> <summary> <para> <para>The backups from the table specified by <code>BackupType</code> are listed.</para><para>Where <code>BackupType</code> can be:</para><ul><li><para><code>USER</code> - On-demand backup created by you.</para></li><li><para><code>SYSTEM</code> - On-demand backup automatically created by DynamoDB.</para></li><li><para><code>ALL</code> - All types of on-demand backups (USER and SYSTEM).</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBBackupListCmdlet.TableName"> <summary> <para> <para>The backups from the table specified by <code>TableName</code> are listed. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBBackupListCmdlet.TimeRangeLowerBound"> <summary> <para> <para>Only backups created after this time are listed. <code>TimeRangeLowerBound</code> is inclusive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBBackupListCmdlet.TimeRangeUpperBound"> <summary> <para> <para>Only backups created before this time are listed. <code>TimeRangeUpperBound</code> is exclusive. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBBackupListCmdlet.ExclusiveStartBackupArn"> <summary> <para> <para><code>LastEvaluatedBackupArn</code> is the Amazon Resource Name (ARN) of the backup last evaluated when the current page of results was returned, inclusive of the current page of results. This value may be specified as the <code>ExclusiveStartBackupArn</code> of a new <code>ListBackups</code> operation in order to fetch the next page of results. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.LastEvaluatedBackupArn, for subsequent calls, to this parameter. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBBackupListCmdlet.Limit"> <summary> <para> <para>Maximum number of backups to return at once.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.GetDDBContinuousBackupCmdlet"> <summary> Checks the status of continuous backups and point in time recovery on the specified table. Continuous backups are <code>ENABLED</code> on all tables at table creation. If point in time recovery is enabled, <code>PointInTimeRecoveryStatus</code> will be set to ENABLED. <para> After continuous backups and point in time recovery are enabled, you can restore to any point in time within <code>EarliestRestorableDateTime</code> and <code>LatestRestorableDateTime</code>. </para><para><code>LatestRestorableDateTime</code> is typically 5 minutes before the current time. You can restore your table to any point in time during the last 35 days. </para><para> You can call <code>DescribeContinuousBackups</code> at a maximum rate of 10 times per second. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBContinuousBackupCmdlet.TableName"> <summary> <para> <para>Name of the table for which the customer wants to check the continuous backups and point in time recovery settings.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.GetDDBEndpointCmdlet"> <summary> Returns the regional endpoint information. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.GetDDBGlobalTableCmdlet"> <summary> Returns information about the specified global table. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBGlobalTableCmdlet.GlobalTableName"> <summary> <para> <para>The name of the global table.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.GetDDBGlobalTableListCmdlet"> <summary> Lists all global tables that have a replica in the specified Region.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBGlobalTableListCmdlet.RegionName"> <summary> <para> <para>Lists the global tables in a specific Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBGlobalTableListCmdlet.ExclusiveStartGlobalTableName"> <summary> <para> <para>The first global table name that this operation will evaluate.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.LastEvaluatedGlobalTableName, for subsequent calls, to this parameter. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBGlobalTableListCmdlet.Limit"> <summary> <para> <para>The maximum number of table names to return.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.GetDDBGlobalTableSettingCmdlet"> <summary> Describes Region-specific settings for a global table. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBGlobalTableSettingCmdlet.GlobalTableName"> <summary> <para> <para>The name of the global table to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.GetDDBItemTransactionallyCmdlet"> <summary> <code>TransactGetItems</code> is a synchronous operation that atomically retrieves multiple items from one or more tables (but not from indexes) in a single account and Region. A <code>TransactGetItems</code> call can contain up to 25 <code>TransactGetItem</code> objects, each of which contains a <code>Get</code> structure that specifies an item to retrieve from a table in the account and Region. A call to <code>TransactGetItems</code> cannot retrieve items from tables in more than one AWS account or Region. The aggregate size of the items in the transaction cannot exceed 4 MB. <note><para> All AWS Regions and AWS GovCloud (US) support up to 25 items per transaction with up to 4 MB of data, except the following AWS Regions: </para><ul><li><para> China (Beijing) </para></li><li><para> China (Ningxia) </para></li></ul><para> The China (Beijing) and China (Ningxia) Regions support up to 10 items per transaction with up to 4 MB of data. </para></note><para> DynamoDB rejects the entire <code>TransactGetItems</code> request if any of the following is true: </para><ul><li><para> A conflicting operation is in the process of updating an item to be read. </para></li><li><para> There is insufficient provisioned capacity for the transaction to be completed. </para></li><li><para> There is a user error, such as an invalid data format. </para></li><li><para> The aggregate size of the items in the transaction cannot exceed 4 MB. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBItemTransactionallyCmdlet.ReturnConsumedCapacity"> <summary> <para> <para>A value of <code>TOTAL</code> causes consumed capacity information to be returned, and a value of <code>NONE</code> prevents that information from being returned. No other value is valid.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBItemTransactionallyCmdlet.TransactItem"> <summary> <para> <para>An ordered array of up to 25 <code>TransactGetItem</code> objects, each of which contains a <code>Get</code> structure.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.GetDDBProvisionLimitCmdlet"> <summary> Returns the current provisioned-capacity limits for your AWS account in a Region, both for the Region as a whole and for any one DynamoDB table that you create there. <para> When you establish an AWS account, the account has initial limits on the maximum read capacity units and write capacity units that you can provision across all of your DynamoDB tables in a given Region. Also, there are per-table limits that apply when you create a table there. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Limits</a> page in the <i>Amazon DynamoDB Developer Guide</i>. </para><para> Although you can increase these limits by filing a case at <a href="https://console.aws.amazon.com/support/home#/">AWS Support Center</a>, obtaining the increase is not instantaneous. The <code>DescribeLimits</code> action lets you write code to compare the capacity you are currently using to those limits imposed by your account so that you have enough time to apply for an increase before you hit a limit. </para><para> For example, you could use one of the AWS SDKs to do the following: </para><ol><li><para> Call <code>DescribeLimits</code> for a particular Region to obtain your current account limits on provisioned capacity there. </para></li><li><para> Create a variable to hold the aggregate read capacity units provisioned for all your tables in that Region, and one to hold the aggregate write capacity units. Zero them both. </para></li><li><para> Call <code>ListTables</code> to obtain a list of all your DynamoDB tables. </para></li><li><para> For each table name listed by <code>ListTables</code>, do the following: </para><ul><li><para> Call <code>DescribeTable</code> with the table name. </para></li><li><para> Use the data returned by <code>DescribeTable</code> to add the read capacity units and write capacity units provisioned for the table itself to your variables. </para></li><li><para> If the table has one or more global secondary indexes (GSIs), loop over these GSIs and add their provisioned capacity values to your variables as well. </para></li></ul></li><li><para> Report the account limits for that Region returned by <code>DescribeLimits</code>, along with the total current provisioned capacity levels you have calculated. </para></li></ol><para> This will let you see whether you are getting close to your account-level limits. </para><para> The per-table limits apply only when you are creating a new table. They restrict the sum of the provisioned capacity of the new table itself and all its global secondary indexes. </para><para> For existing tables and their GSIs, DynamoDB doesn't let you increase provisioned capacity extremely rapidly. But the only upper limit that applies is that the aggregate provisioned capacity over all your tables and GSIs cannot exceed either of the per-account limits. </para><note><para><code>DescribeLimits</code> should only be called periodically. You can expect throttling errors if you call it more than once in a minute. </para></note><para> The <code>DescribeLimits</code> Request element has no content. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.GetDDBResourceTagCmdlet"> <summary> List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10 times per second, per account. <para> For an overview on tagging DynamoDB resources, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html">Tagging for DynamoDB</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon DynamoDB resource with tags to be listed. This value is an Amazon Resource Name (ARN).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBResourceTagCmdlet.NextToken"> <summary> <para> <para>An optional string that, if supplied, must be copied from the output of a previous call to ListTagOfResource. When provided in this manner, this API fetches the next page of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.GetDDBStreamCmdlet"> <summary> Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table. <note><para> You can call <code>DescribeStream</code> at a maximum rate of 10 times per second. </para></note><para> Each shard in the stream has a <code>SequenceNumberRange</code> associated with it. If the <code>SequenceNumberRange</code> has a <code>StartingSequenceNumber</code> but no <code>EndingSequenceNumber</code>, then the shard is still open (able to receive more stream records). If both <code>StartingSequenceNumber</code> and <code>EndingSequenceNumber</code> are present, then that shard is closed and can no longer receive more data. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBStreamCmdlet.ExclusiveStartShardId"> <summary> <para> <para>The shard ID of the first item that this operation will evaluate. Use the value that was returned for <code>LastEvaluatedShardId</code> in the previous operation. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBStreamCmdlet.StreamArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBStreamCmdlet.Limit"> <summary> <para> <para>The maximum number of shard objects to return. The upper limit is 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.GetDDBStreamListCmdlet"> <summary> Returns an array of stream ARNs associated with the current account and endpoint. If the <code>TableName</code> parameter is present, then <code>ListStreams</code> will return only the streams ARNs for that table. <note><para> You can call <code>ListStreams</code> at a maximum rate of 5 times per second. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBStreamListCmdlet.ExclusiveStartStreamArn"> <summary> <para> <para>The ARN (Amazon Resource Name) of the first item that this operation will evaluate. Use the value that was returned for <code>LastEvaluatedStreamArn</code> in the previous operation. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBStreamListCmdlet.TableName"> <summary> <para> <para>If this parameter is provided, then only the streams associated with this table name are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBStreamListCmdlet.Limit"> <summary> <para> <para>The maximum number of streams to return. The upper limit is 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.GetDDBTableCmdlet"> <summary> 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. <note><para> If you issue a <code>DescribeTable</code> request immediately after a <code>CreateTable</code> request, DynamoDB might return a <code>ResourceNotFoundException</code>. This is because <code>DescribeTable</code> uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the <code>DescribeTable</code> request again. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBTableCmdlet.TableName"> <summary> <para> <para>The name of the table to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.GetDDBTableListCmdlet"> <summary> Returns an array of table names associated with the current account and endpoint. The output from <code>ListTables</code> is paginated, with each page returning a maximum of 100 table names.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBTableListCmdlet.ExclusiveStartTableName"> <summary> <para> <para>The first table name that this operation will evaluate. Use the value that was returned for <code>LastEvaluatedTableName</code> in a previous operation, so that you can obtain the next page of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.LastEvaluatedTableName, for subsequent calls, to this parameter. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBTableListCmdlet.Limit"> <summary> <para> <para>A maximum number of table names to return. If this parameter is not specified, the limit is 100.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.GetDDBTimeToLiveCmdlet"> <summary> Gives a description of the Time to Live (TTL) status on the specified table. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.GetDDBTimeToLiveCmdlet.TableName"> <summary> <para> <para>The name of the table to be described.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.NewDDBBackupCmdlet"> <summary> Creates a backup for an existing table. <para> Each time you create an on-demand backup, the entire table data is backed up. There is no limit to the number of on-demand backups that can be taken. </para><para> When you create an on-demand backup, a time marker of the request is cataloged, and the backup is created asynchronously, by applying all changes until the time of the request to the last full table snapshot. Backup requests are processed instantaneously and become available for restore within minutes. </para><para> You can call <code>CreateBackup</code> at a maximum rate of 50 times per second. </para><para> All backups in DynamoDB work without consuming any provisioned throughput on the table. </para><para> If you submit a backup request on 2018-12-14 at 14:25:00, the backup is guaranteed to contain all data committed to the table up to 14:24:00, and data committed after 14:26:00 will not be. The backup might contain data modifications made between 14:24:00 and 14:26:00. On-demand backup does not support causal consistency. </para><para> Along with data, the following are also included on the backups: </para><ul><li><para> Global secondary indexes (GSIs) </para></li><li><para> Local secondary indexes (LSIs) </para></li><li><para> Streams </para></li><li><para> Provisioned read and write capacity </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.NewDDBBackupCmdlet.BackupName"> <summary> <para> <para>Specified name for the backup.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.NewDDBBackupCmdlet.TableName"> <summary> <para> <para>The name of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.NewDDBBackupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.NewDDBGlobalTableCmdlet"> <summary> 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. <para> If you want to add a new replica table to a global table, each of the following conditions must be true: </para><ul><li><para> The table must have the same primary key as all of the other replicas. </para></li><li><para> The table must have the same name as all of the other replicas. </para></li><li><para> The table must have DynamoDB Streams enabled, with the stream containing both the new and the old images of the item. </para></li><li><para> None of the replica tables in the global table can contain any data. </para></li></ul><para> If global secondary indexes are specified, then the following conditions must also be met: </para><ul><li><para> The global secondary indexes must have the same name. </para></li><li><para> The global secondary indexes must have the same hash key and sort key (if present). </para></li></ul><important><para> Write capacity settings should be set consistently across your replica tables and secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the write capacity settings for all of your global tables replicas and indexes. </para><para> If you prefer to manage write capacity settings manually, you should provision equal replicated write capacity units to your replica tables. You should also provision equal replicated write capacity units to matching secondary indexes across your global table. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.NewDDBGlobalTableCmdlet.GlobalTableName"> <summary> <para> <para>The global table name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.NewDDBGlobalTableCmdlet.ReplicationGroup"> <summary> <para> <para>The Regions where the global table needs to be created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.NewDDBGlobalTableCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.RemoveDDBBackupCmdlet"> <summary> Deletes an existing backup of a table. <para> You can call <code>DeleteBackup</code> at a maximum rate of 10 times per second. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.RemoveDDBBackupCmdlet.BackupArn"> <summary> <para> <para>The ARN associated with the backup.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.RemoveDDBBackupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.RemoveDDBResourceTagCmdlet"> <summary> Removes the association of tags from an Amazon DynamoDB resource. You can call <code>UntagResource</code> up to five times per second, per account. <para> For an overview on tagging DynamoDB resources, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html">Tagging for DynamoDB</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.RemoveDDBResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The DynamoDB resource that the tags will be removed from. This value is an Amazon Resource Name (ARN).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.RemoveDDBResourceTagCmdlet.TagKey"> <summary> <para> <para>A list of tag keys. Existing tags of the resource whose keys are members of this list will be removed from the DynamoDB resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.RemoveDDBResourceTagCmdlet.PassThru"> <summary> Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.RemoveDDBResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.RemoveDDBTableCmdlet"> <summary> The <code>DeleteTable</code> operation deletes a table and all of its items. After a <code>DeleteTable</code> request, the specified table is in the <code>DELETING</code> state until DynamoDB completes the deletion. If the table is in the <code>ACTIVE</code> state, you can delete it. If a table is in <code>CREATING</code> or <code>UPDATING</code> states, then DynamoDB returns a <code>ResourceInUseException</code>. If the specified table does not exist, DynamoDB returns a <code>ResourceNotFoundException</code>. If table is already in the <code>DELETING</code> state, no error is returned. <note><para> DynamoDB might continue to accept data read and write operations, such as <code>GetItem</code> and <code>PutItem</code>, on a table in the <code>DELETING</code> state until the table deletion is complete. </para></note><para> When you delete a table, any indexes on that table are also deleted. </para><para> If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the <code>DISABLED</code> state, and the stream is automatically deleted after 24 hours. </para><para> Use the <code>DescribeTable</code> action to check the status of the table. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.RemoveDDBTableCmdlet.TableName"> <summary> <para> <para>The name of the table to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.RemoveDDBTableCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.RestoreDDBTableFromBackupCmdlet"> <summary> Creates a new table from an existing backup. Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account. <para> You can call <code>RestoreTableFromBackup</code> at a maximum rate of 10 times per second. </para><para> You must manually set up the following on the restored table: </para><ul><li><para> Auto scaling policies </para></li><li><para> IAM policies </para></li><li><para> Amazon CloudWatch metrics and alarms </para></li><li><para> Tags </para></li><li><para> Stream settings </para></li><li><para> Time to Live (TTL) settings </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.RestoreDDBTableFromBackupCmdlet.BackupArn"> <summary> <para> <para>The Amazon Resource Name (ARN) associated with the backup.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.RestoreDDBTableFromBackupCmdlet.TargetTableName"> <summary> <para> <para>The name of the new table to which the backup must be restored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.RestoreDDBTableFromBackupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.RestoreDDBTableToPointInTimeCmdlet"> <summary> Restores the specified table to the specified point in time within <code>EarliestRestorableDateTime</code> and <code>LatestRestorableDateTime</code>. You can restore your table to any point in time during the last 35 days. Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account. <para> 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. </para><para> Along with data, the following are also included on the new restored table using point in time recovery: </para><ul><li><para> Global secondary indexes (GSIs) </para></li><li><para> Local secondary indexes (LSIs) </para></li><li><para> Provisioned read and write capacity </para></li><li><para> Encryption settings </para><important><para> All these settings come from the current settings of the source table at the time of restore. </para></important></li></ul><para> You must manually set up the following on the restored table: </para><ul><li><para> Auto scaling policies </para></li><li><para> IAM policies </para></li><li><para> Amazon CloudWatch metrics and alarms </para></li><li><para> Tags </para></li><li><para> Stream settings </para></li><li><para> Time to Live (TTL) settings </para></li><li><para> Point in time recovery settings </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.RestoreDDBTableToPointInTimeCmdlet.RestoreDateTime"> <summary> <para> <para>Time in the past to restore the table to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.RestoreDDBTableToPointInTimeCmdlet.SourceTableName"> <summary> <para> <para>Name of the source table that is being restored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.RestoreDDBTableToPointInTimeCmdlet.TargetTableName"> <summary> <para> <para>The name of the new table to which it must be restored to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.RestoreDDBTableToPointInTimeCmdlet.UseLatestRestorableTime"> <summary> <para> <para>Restore the table to the latest possible time. <code>LatestRestorableDateTime</code> is typically 5 minutes before the current time. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.RestoreDDBTableToPointInTimeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBContinuousBackupCmdlet"> <summary> <code>UpdateContinuousBackups</code> enables or disables point in time recovery for the specified table. A successful <code>UpdateContinuousBackups</code> call returns the current <code>ContinuousBackupsDescription</code>. Continuous backups are <code>ENABLED</code> on all tables at table creation. If point in time recovery is enabled, <code>PointInTimeRecoveryStatus</code> will be set to ENABLED. <para> Once continuous backups and point in time recovery are enabled, you can restore to any point in time within <code>EarliestRestorableDateTime</code> and <code>LatestRestorableDateTime</code>. </para><para><code>LatestRestorableDateTime</code> is typically 5 minutes before the current time. You can restore your table to any point in time during the last 35 days. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBContinuousBackupCmdlet.PointInTimeRecoverySpecification_PointInTimeRecoveryEnabled"> <summary> <para> <para>Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBContinuousBackupCmdlet.TableName"> <summary> <para> <para>The name of the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBContinuousBackupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBGlobalTableCmdlet"> <summary> 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. <note><para> Although you can use <code>UpdateGlobalTable</code> to add replicas and remove replicas in a single request, for simplicity we recommend that you issue separate requests for adding or removing replicas. </para></note><para> If global secondary indexes are specified, then the following conditions must also be met: </para><ul><li><para> The global secondary indexes must have the same name. </para></li><li><para> The global secondary indexes must have the same hash key and sort key (if present). </para></li><li><para> The global secondary indexes must have the same provisioned and maximum write capacity units. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBGlobalTableCmdlet.GlobalTableName"> <summary> <para> <para>The global table name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBGlobalTableCmdlet.ReplicaUpdate"> <summary> <para> <para>A list of Regions that should be added or removed from the global table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBGlobalTableCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBGlobalTableSettingCmdlet"> <summary> Updates settings for a global table. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBGlobalTableSettingCmdlet.GlobalTableBillingMode"> <summary> <para> <para>The billing mode of the global table. If <code>GlobalTableBillingMode</code> is not specified, the global table defaults to <code>PROVISIONED</code> capacity billing mode.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBGlobalTableSettingCmdlet.GlobalTableGlobalSecondaryIndexSettingsUpdate"> <summary> <para> <para>Represents the settings of a global secondary index for a global table that will be modified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBGlobalTableSettingCmdlet.GlobalTableName"> <summary> <para> <para>The name of the global table</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBGlobalTableSettingCmdlet.GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate"> <summary> <para> <para>Auto scaling settings for managing provisioned write capacity for the global table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBGlobalTableSettingCmdlet.GlobalTableProvisionedWriteCapacityUnit"> <summary> <para> <para>The maximum number of writes consumed per second before DynamoDB returns a <code>ThrottlingException.</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBGlobalTableSettingCmdlet.ReplicaSettingsUpdate"> <summary> <para> <para>Represents the settings for a global table in a Region that will be modified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBGlobalTableSettingCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBTableCmdlet"> <summary> Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table. <para> You can only perform one of the following operations at once: </para><ul><li><para> Modify the provisioned throughput settings of the table. </para></li><li><para> Enable or disable DynamoDB Streams on the table. </para></li><li><para> Remove a global secondary index from the table. </para></li><li><para> Create a new global secondary index on the table. After the index begins backfilling, you can use <code>UpdateTable</code> to perform other operations. </para></li></ul><para><code>UpdateTable</code> is an asynchronous operation; while it is executing, the table status changes from <code>ACTIVE</code> to <code>UPDATING</code>. While it is <code>UPDATING</code>, you cannot issue another <code>UpdateTable</code> request. When the table returns to the <code>ACTIVE</code> state, the <code>UpdateTable</code> operation is complete. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBTableCmdlet.AttributeDefinition"> <summary> <para> <para>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, <code>AttributeDefinitions</code> must include the key element(s) of the new index.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBTableCmdlet.BillingMode"> <summary> <para> <para>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.</para><ul><li><para><code>PROVISIONED</code> - Sets the billing mode to <code>PROVISIONED</code>. We recommend using <code>PROVISIONED</code> for predictable workloads.</para></li><li><para><code>PAY_PER_REQUEST</code> - Sets the billing mode to <code>PAY_PER_REQUEST</code>. We recommend using <code>PAY_PER_REQUEST</code> for unpredictable workloads. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBTableCmdlet.SSESpecification_Enabled"> <summary> <para> <para>Indicates whether server-side encryption is done using an AWS managed CMK or an AWS owned CMK. If enabled (true), server-side encryption type is set to <code>KMS</code> and an AWS managed CMK is used (AWS KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned CMK.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBTableCmdlet.GlobalSecondaryIndexUpdate"> <summary> <para> <para>An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:</para><ul><li><para><code>Create</code> - add a new global secondary index to the table.</para></li><li><para><code>Update</code> - modify the provisioned throughput settings of an existing global secondary index.</para></li><li><para><code>Delete</code> - remove a global secondary index from the table.</para></li></ul><para>For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GSI.OnlineOps.html">Managing Global Secondary Indexes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBTableCmdlet.SSESpecification_KMSMasterKeyId"> <summary> <para> <para>The KMS Customer Master Key (CMK) which should be used for the KMS encryption. To specify a CMK, 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 Customer Master Key alias/aws/dynamodb.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBTableCmdlet.ReadCapacity"> <summary> <para> <para>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/WorkingWithTables.html#ProvisionedThroughput">Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>.</para><para>If read/write capacity mode is <code>PAY_PER_REQUEST</code> the value is set to 0.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBTableCmdlet.SSESpecification_SSEType"> <summary> <para> <para>Server-side encryption type. The only supported value is:</para><ul><li><para><code>KMS</code> - Server-side encryption which uses AWS Key Management Service. Key is stored in your account and is managed by AWS KMS (KMS charges apply).</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBTableCmdlet.StreamSpecification_StreamEnabled"> <summary> <para> <para>Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBTableCmdlet.StreamSpecification_StreamViewType"> <summary> <para> <para> 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:</para><ul><li><para><code>KEYS_ONLY</code> - Only the key attributes of the modified item are written to the stream.</para></li><li><para><code>NEW_IMAGE</code> - The entire item, as it appears after it was modified, is written to the stream.</para></li><li><para><code>OLD_IMAGE</code> - The entire item, as it appeared before it was modified, is written to the stream.</para></li><li><para><code>NEW_AND_OLD_IMAGES</code> - Both the new and the old item images of the item are written to the stream.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBTableCmdlet.TableName"> <summary> <para> <para>The name of the table to be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBTableCmdlet.WriteCapacity"> <summary> <para> <para>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/WorkingWithTables.html#ProvisionedThroughput">Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>.</para><para>If read/write capacity mode is <code>PAY_PER_REQUEST</code> the value is set to 0.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBTableCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBTimeToLiveCmdlet"> <summary> The <code>UpdateTimeToLive</code> method enables or disables Time to Live (TTL) for the specified table. A successful <code>UpdateTimeToLive</code> call returns the current <code>TimeToLiveSpecification</code>. It can take up to one hour for the change to fully process. Any additional <code>UpdateTimeToLive</code> calls for the same table during this one hour duration result in a <code>ValidationException</code>. <para> TTL compares the current time in epoch time format to the time stored in the TTL attribute of an item. If the epoch time value stored in the attribute is less than the current time, the item is marked as expired and subsequently deleted. </para><note><para> The epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC. </para></note><para> DynamoDB deletes expired items on a best-effort basis to ensure availability of throughput for other data operations. </para><important><para> DynamoDB typically deletes expired items within two days of expiration. The exact duration within which an item gets deleted after expiration is specific to the nature of the workload. Items that have expired and not been deleted will still show up in reads, queries, and scans. </para></important><para> As items are deleted, they are removed from any local secondary index and global secondary index immediately in the same eventually consistent way as a standard delete operation. </para><para> For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html">Time To Live</a> in the Amazon DynamoDB Developer Guide. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBTimeToLiveCmdlet.TimeToLiveSpecification_AttributeName"> <summary> <para> <para>The name of the TTL attribute used to store the expiration time for items in the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBTimeToLiveCmdlet.TimeToLiveSpecification_Enabled"> <summary> <para> <para>Indicates whether TTL is to be enabled (true) or disabled (false) on the table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBTimeToLiveCmdlet.TableName"> <summary> <para> <para>The name of the table to be configured.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.UpdateDDBTimeToLiveCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.WriteDDBItemTransactionallyCmdlet"> <summary> <code>TransactWriteItems</code> is a synchronous write operation that groups up to 25 action requests. These actions can target items in different tables, but not in different AWS accounts or Regions, and no two actions can target the same item. For example, you cannot both <code>ConditionCheck</code> and <code>Update</code> the same item. The aggregate size of the items in the transaction cannot exceed 4 MB. <note><para> All AWS Regions and AWS GovCloud (US) support up to 25 items per transaction with up to 4 MB of data, except the following AWS Regions: </para><ul><li><para> China (Beijing) </para></li><li><para> China (Ningxia) </para></li></ul><para> The China (Beijing) and China (Ningxia) Regions support up to 10 items per transaction with up to 4 MB of data. </para></note><para> The actions are completed atomically so that either all of them succeed, or all of them fail. They are defined by the following objects: </para><ul><li><para><code>Put</code> Initiates a <code>PutItem</code> operation to write a new item. This structure specifies the primary key of the item to be written, the name of the table to write it in, an optional condition expression that must be satisfied for the write to succeed, a list of the item's attributes, and a field indicating whether to retrieve the item's attributes if the condition is not met. </para></li><li><para><code>Update</code> Initiates an <code>UpdateItem</code> operation to update an existing item. This structure specifies the primary key of the item to be updated, the name of the table where it resides, an optional condition expression that must be satisfied for the update to succeed, an expression that defines one or more attributes to be updated, and a field indicating whether to retrieve the item's attributes if the condition is not met. </para></li><li><para><code>Delete</code> Initiates a <code>DeleteItem</code> operation to delete an existing item. This structure specifies the primary key of the item to be deleted, the name of the table where it resides, an optional condition expression that must be satisfied for the deletion to succeed, and a field indicating whether to retrieve the item's attributes if the condition is not met. </para></li><li><para><code>ConditionCheck</code> Applies a condition to an item that is not being modified by the transaction. This structure specifies the primary key of the item to be checked, the name of the table where it resides, a condition expression that must be satisfied for the transaction to succeed, and a field indicating whether to retrieve the item's attributes if the condition is not met. </para></li></ul><para> DynamoDB rejects the entire <code>TransactWriteItems</code> request if any of the following is true: </para><ul><li><para> A condition in one of the condition expressions is not met. </para></li><li><para> An ongoing operation is in the process of updating the same item. </para></li><li><para> There is insufficient provisioned capacity for the transaction to be completed. </para></li><li><para> An item size becomes too large (bigger than 400 KB), a local secondary index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction. </para></li><li><para> The aggregate size of the items in the transaction exceeds 4 MB. </para></li><li><para> There is a user error, such as an invalid data format. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.WriteDDBItemTransactionallyCmdlet.ClientRequestToken"> <summary> <para> <para>Providing a <code>ClientRequestToken</code> makes the call to <code>TransactWriteItems</code> idempotent, meaning that multiple identical calls have the same effect as one single call.</para><para>Although multiple identical calls using the same client request token produce the same result on the server (no side effects), the responses to the calls might not be the same. If the <code>ReturnConsumedCapacity></code> parameter is set, then the initial <code>TransactWriteItems</code> call returns the amount of write capacity units consumed in making the changes. Subsequent <code>TransactWriteItems</code> calls with the same client token return the number of read capacity units consumed in reading the item.</para><para>A client request token is valid for 10 minutes after the first request that uses it is completed. After 10 minutes, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 10 minutes, or the result might not be idempotent.</para><para>If you submit a request with the same client token but a change in other parameters within the 10-minute idempotency window, DynamoDB returns an <code>IdempotentParameterMismatch</code> exception.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.WriteDDBItemTransactionallyCmdlet.ReturnConsumedCapacity"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.WriteDDBItemTransactionallyCmdlet.ReturnItemCollectionMetric"> <summary> <para> <para>Determines whether item collection metrics are returned. If set to <code>SIZE</code>, the response includes statistics about item collections (if any), that were modified during the operation and are returned in the response. If set to <code>NONE</code> (the default), no statistics are returned. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.WriteDDBItemTransactionallyCmdlet.TransactItem"> <summary> <para> <para>An ordered array of up to 25 <code>TransactWriteItem</code> objects, each of which contains a <code>ConditionCheck</code>, <code>Put</code>, <code>Update</code>, or <code>Delete</code> object. These can operate on items in different tables, but the tables must reside in the same AWS account and Region, and no two of them can operate on the same item. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDB.WriteDDBItemTransactionallyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDB.Model.TableSchema"> <summary> Model class carrying details of an Amazon DynamoDB table schema under construction for use with the New-DDBTable cmdlet. This class is accepted as pipeline input by the schema builder cmdlets (Write-DDBAttributeSchema, Write-DDBKeySchema and Write-DDBIndexSchema). </summary> </member> <member name="M:Amazon.PowerShell.Cmdlets.DDB.Model.TableSchema.#ctor(Amazon.PowerShell.Cmdlets.DDB.Model.TableSchema)"> <summary> Constructs a new table schema from a deep copy of the suppled object. Note that ICloneable is not supported on the coreclr platform, so we chose not to make the type derive from ICloneable but retained the Clone method. </summary> <param name="source"></param> </member> <member name="M:Amazon.PowerShell.Cmdlets.DDB.Model.TableSchema.SetLocalSecondaryIndex(System.String,System.String,System.String,System.String,System.String[])"> <summary> Adds a new local secondary index or updates an index if it has been defined already </summary> <param name="indexName"></param> <param name="rangeKeyName"></param> <param name="rangeKeyDataType"></param> <param name="projectionType"></param> <param name="nonKeyAttributes"></param> </member> <member name="M:Amazon.PowerShell.Cmdlets.DDB.Model.TableSchema.SetGlobalSecondaryIndex(System.String,System.String,System.String,System.String,System.String,System.Int64,System.Int64,System.String,System.String[])"> <summary> Adds a new global secondary index or updates an index if it has been defined already. </summary> <param name="indexName"></param> <param name="hashKeyName"></param> <param name="hashKeyDataType"></param> <param name="rangeKeyName"></param> <param name="rangeKeyDataType"></param> <param name="readCapacityUnits"></param> <param name="writeCapacityUnits"></param> <param name="projectionType"></param> <param name="nonKeyAttributes"></param> </member> </members> </doc> |