AWS.Tools.DynamoDBStreams.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.DynamoDBStreams</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.DDBS.GetDDBSStreamCmdlet"> <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 <c>DescribeStream</c> at a maximum rate of 10 times per second. </para></note><para> Each shard in the stream has a <c>SequenceNumberRange</c> associated with it. If the <c>SequenceNumberRange</c> has a <c>StartingSequenceNumber</c> but no <c>EndingSequenceNumber</c>, then the shard is still open (able to receive more stream records). If both <c>StartingSequenceNumber</c> and <c>EndingSequenceNumber</c> are present, then that shard is closed and can no longer receive more data. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDBS.GetDDBSStreamCmdlet.ExclusiveStartShardId"> <summary> <para> <para>The shard ID of the first item that this operation will evaluate. Use the value that was returned for <c>LastEvaluatedShardId</c> in the previous operation. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDBS.GetDDBSStreamCmdlet.ShardFilter_ShardId"> <summary> <para> <para>Contains the <c>shardId</c> of the parent shard for which you are requesting child shards.</para><para><i>Sample request:</i></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDBS.GetDDBSStreamCmdlet.StreamArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDBS.GetDDBSStreamCmdlet.ShardFilter_Type"> <summary> <para> <para>Contains the type of filter to be applied on the <c>DescribeStream</c> API. Currently, the only value this parameter accepts is <c>CHILD_SHARDS</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDBS.GetDDBSStreamCmdlet.Limit"> <summary> <para> <para>The maximum number of shard objects to return. The upper limit is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDBS.GetDDBSStreamCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StreamDescription'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DynamoDBStreams.Model.DescribeStreamResponse). Specifying the name of a property of type Amazon.DynamoDBStreams.Model.DescribeStreamResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.DDBS.GetDDBSStreamListCmdlet"> <summary> Returns an array of stream ARNs associated with the current account and endpoint. If the <c>TableName</c> parameter is present, then <c>ListStreams</c> will return only the streams ARNs for that table. <note><para> You can call <c>ListStreams</c> at a maximum rate of 5 times per second. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDBS.GetDDBSStreamListCmdlet.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 <c>LastEvaluatedStreamArn</c> in the previous operation. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDBS.GetDDBSStreamListCmdlet.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.DDBS.GetDDBSStreamListCmdlet.Limit"> <summary> <para> <para>The maximum number of streams to return. The upper limit is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.DDBS.GetDDBSStreamListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DynamoDBStreams.Model.ListStreamsResponse). Specifying the name of a property of type Amazon.DynamoDBStreams.Model.ListStreamsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> </members> </doc> |