AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Get-KINShardList-StreamName <String>-ExclusiveStartShardId <String>-ShardFilter_ShardId <String>-StreamCreationTimestamp <DateTime>-ShardFilter_Timestamp <DateTime>-ShardFilter_Type <ShardFilterType>-MaxResult <Int32>-NextToken <String>-Select <String>-PassThru <SwitchParameter>-NoAutoIteration <SwitchParameter>
ExclusiveStartShardId
.If you don't specify this parameter, the default behavior is for ListShards
to list the shards starting with the first one in the stream.You cannot specify this parameter if you specify NextToken
. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
ListShards
. The maximum number of shards to return in a single call. The default value is 1000. If you specify a value greater than 1000, at most 1000 results are returned. When the number of shards to be listed is greater than the value of MaxResults
, the response contains a NextToken
value that you can use in a subsequent call to ListShards
to list the next set of shards.Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | MaxItems, MaxResults |
MaxResults
parameter, or if you explicitly specify a value for MaxResults
that is less than the number of shards in the data stream, the response includes a pagination token named NextToken
. You can specify this NextToken
value in a subsequent call to ListShards
to list the next set of shards.Don't specify StreamName
or StreamCreationTimestamp
if you specify NextToken
because the latter unambiguously identifies the stream.You can optionally specify a value for the MaxResults
parameter when you specify NextToken
. If you specify a MaxResults
value that is less than the number of shards that the operation returns if you don't specify MaxResults
, the response will contain a new NextToken
value. You can use the new NextToken
value in a subsequent call to the ListShards
operation.NextToken
in the response to a call to ListShards
, you have 300 seconds to use that value. If you specify an expired token in a call to ListShards
, you get ExpiredNextTokenException
.Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
shardID
speified in the ShardFilter
parameter. This property can only be used if the AFTER_SHARD_ID
shard type is specified. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
ShardFilter
parameter. A timestamp is a Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.480. This property can only be used if FROM_TIMESTAMP
or AT_TIMESTAMP
shard types are specified. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
ShardFilter
parameter. This is a required property of the ShardFilter
parameter.You can specify the following valid values: AFTER_SHARD_ID
- the response includes all the shards, starting with the shard whose ID immediately follows the ShardId
that you provided.AT_TRIM_HORIZON
- the response includes all the shards that were open at TRIM_HORIZON
.FROM_TRIM_HORIZON
- (default), the response includes all the shards within the retention period of the data stream (trim to tip).AT_LATEST
- the response includes only the currently open shards of the data stream.AT_TIMESTAMP
- the response includes all shards whose start timestamp is less than or equal to the given timestamp and end timestamp is greater than or equal to the given timestamp or still open. FROM_TIMESTAMP
- the response incldues all closed shards whose end timestamp is greater than or equal to the given timestamp and also all open shards. Corrected to TRIM_HORIZON
of the data stream if FROM_TIMESTAMP
is less than the TRIM_HORIZON
value.Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
NextToken
parameter. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
NextToken
parameter. Required? | False |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AK |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AWSProfilesLocation, ProfilesLocation |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | StoredCredentials, AWSProfileName |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | RegionToCall |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SK, SecretAccessKey |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ST |
AWS Tools for PowerShell: 2.x.y.z