AWS.Tools.KeyspacesStreams.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.KeyspacesStreams</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.KST.GetKSTRecordCmdlet"> <summary> Retrieves data records from a specified shard in an Amazon Keyspaces data stream. This operation returns a collection of data records from the shard, including the primary key columns and information about modifications made to the captured table data. Each record represents a single data modification in the Amazon Keyspaces table and includes metadata about when the change occurred. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KST.GetKSTRecordCmdlet.ShardIterator"> <summary> <para> <para> The unique identifier of the shard iterator. A shard iterator specifies the position in the shard from which you want to start reading data records sequentially. You obtain this value by calling the <c>GetShardIterator</c> operation. Each shard iterator is valid for 5 minutes after creation. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KST.GetKSTRecordCmdlet.MaxResult"> <summary> <para> <para> The maximum number of records to return in a single <c>GetRecords</c> request. Default value is 1000. You can specify a limit between 1 and 10000, but the actual number returned might be less than the specified maximum if the size of the data for the returned records exceeds the internal size limit. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KST.GetKSTRecordCmdlet.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.KeyspacesStreams.Model.GetRecordsResponse). Specifying the name of a property of type Amazon.KeyspacesStreams.Model.GetRecordsResponse 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="P:Amazon.PowerShell.Cmdlets.KST.GetKSTRecordCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ShardIterator parameter. The -PassThru parameter is deprecated, use -Select '^ShardIterator' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KST.GetKSTShardIteratorCmdlet"> <summary> Returns a shard iterator that serves as a bookmark for reading data from a specific position in an Amazon Keyspaces data stream's shard. The shard iterator specifies the shard position from which to start reading data records sequentially. You can specify whether to begin reading at the latest record, the oldest record, or at a particular sequence number within the shard. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KST.GetKSTShardIteratorCmdlet.SequenceNumber"> <summary> <para> <para> The sequence number of the data record in the shard from which to start reading. Required if <c>ShardIteratorType</c> is <c>AT_SEQUENCE_NUMBER</c> or <c>AFTER_SEQUENCE_NUMBER</c>. This parameter is ignored for other iterator types. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KST.GetKSTShardIteratorCmdlet.ShardId"> <summary> <para> <para> The identifier of the shard within the stream. The shard ID uniquely identifies a subset of the stream's data records that you want to access. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KST.GetKSTShardIteratorCmdlet.ShardIteratorType"> <summary> <para> <para> Determines how the shard iterator is positioned. Must be one of the following:</para><ul><li><para><c>TRIM_HORIZON</c> - Start reading at the last untrimmed record in the shard, which is the oldest data record in the shard.</para></li><li><para><c>AT_SEQUENCE_NUMBER</c> - Start reading exactly from the specified sequence number.</para></li><li><para><c>AFTER_SEQUENCE_NUMBER</c> - Start reading right after the specified sequence number.</para></li><li><para><c>LATEST</c> - Start reading just after the most recent record in the shard, so that you always read the most recent data.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KST.GetKSTShardIteratorCmdlet.StreamArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the stream for which to get the shard iterator. The ARN uniquely identifies the stream within Amazon Keyspaces. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KST.GetKSTShardIteratorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ShardIterator'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KeyspacesStreams.Model.GetShardIteratorResponse). Specifying the name of a property of type Amazon.KeyspacesStreams.Model.GetShardIteratorResponse 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="P:Amazon.PowerShell.Cmdlets.KST.GetKSTShardIteratorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ShardId parameter. The -PassThru parameter is deprecated, use -Select '^ShardId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KST.GetKSTStreamCmdlet"> <summary> Returns detailed information about a specific data capture stream for an Amazon Keyspaces table. The information includes the stream's Amazon Resource Name (ARN), creation time, current status, retention period, shard composition, and associated table details. This operation helps you monitor and manage the configuration of your Amazon Keyspaces data streams.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KST.GetKSTStreamCmdlet.ShardFilter_ShardId"> <summary> <para> <para>The identifier of a specific shard used to filter results based on the specified filter type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KST.GetKSTStreamCmdlet.StreamArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the stream for which detailed information is requested. This uniquely identifies the specific stream you want to get information about. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KST.GetKSTStreamCmdlet.ShardFilter_Type"> <summary> <para> <para>The type of shard filter to use, which determines how the shardId parameter is interpreted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KST.GetKSTStreamCmdlet.MaxResult"> <summary> <para> <para> The maximum number of shard objects to return in a single <c>GetStream</c> request. Default value is 100. The minimum value is 1 and the maximum value is 1000. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KST.GetKSTStreamCmdlet.NextToken"> <summary> <para> <para> An optional pagination token provided by a previous <c>GetStream</c> operation. If this parameter is specified, the response includes only records beyond the token, up to the value specified by <c>maxResults</c>. </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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KST.GetKSTStreamCmdlet.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.KeyspacesStreams.Model.GetStreamResponse). Specifying the name of a property of type Amazon.KeyspacesStreams.Model.GetStreamResponse 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="P:Amazon.PowerShell.Cmdlets.KST.GetKSTStreamCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StreamArn parameter. The -PassThru parameter is deprecated, use -Select '^StreamArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KST.GetKSTStreamCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KST.GetKSTStreamListCmdlet"> <summary> Returns a list of all data capture streams associated with your Amazon Keyspaces account or for a specific keyspace or table. The response includes information such as stream ARNs, table associations, creation timestamps, and current status. This operation helps you discover and manage all active data streams in your Amazon Keyspaces environment.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KST.GetKSTStreamListCmdlet.KeyspaceName"> <summary> <para> <para> The name of the keyspace for which to list streams. If specified, only streams associated with tables in this keyspace are returned. If omitted, streams from all keyspaces are included in the results. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KST.GetKSTStreamListCmdlet.TableName"> <summary> <para> <para> The name of the table for which to list streams. Must be used together with <c>keyspaceName</c>. If specified, only streams associated with this specific table are returned. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KST.GetKSTStreamListCmdlet.MaxResult"> <summary> <para> <para> The maximum number of streams to return in a single <c>ListStreams</c> request. Default value is 100. The minimum value is 1 and the maximum value is 1000. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KST.GetKSTStreamListCmdlet.NextToken"> <summary> <para> <para> An optional pagination token provided by a previous <c>ListStreams</c> operation. If this parameter is specified, the response includes only records beyond the token, up to the value specified by <c>maxResults</c>. </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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KST.GetKSTStreamListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Streams'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KeyspacesStreams.Model.ListStreamsResponse). Specifying the name of a property of type Amazon.KeyspacesStreams.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> <member name="P:Amazon.PowerShell.Cmdlets.KST.GetKSTStreamListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> </members> </doc> |