Skip to content

Commit 7fa97c6

Browse files
aws-sdk-dotnet-automationaws-sdk-dotnet-automation
committed
Added support for optional shard filter parameter in DescribeStream api that allows customers to fetch child shards of a read_only parent shard.
1 parent 85ca8af commit 7fa97c6

File tree

14 files changed

+1415
-4
lines changed

14 files changed

+1415
-4
lines changed

‎docgenerator/AWSSDKDocSamples/DynamoDBStreams.GeneratedSamples.extra.xml‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<docs>
3+
<doc>
4+
<members>
5+
<member name="M:Amazon.DynamoDBStreams.IAmazonDynamoDBStreams.DescribeStream(Amazon.DynamoDBStreams.Model.DescribeStreamRequest)" />
6+
<member name="M:Amazon.DynamoDBStreams.AmazonDynamoDBStreamsClient.DescribeStream(Amazon.DynamoDBStreams.Model.DescribeStreamRequest)" />
7+
<member name="T:Amazon.DynamoDBStreams.Model.DescribeStreamRequest" />
8+
<member name="T:Amazon.DynamoDBStreams.Model.DescribeStreamResponse" />
9+
</members>
10+
<value>
11+
<example>
12+
<para>
13+
The following example describes a stream with a given stream ARN.
14+
</para>
15+
<code
16+
title="To describe a stream with a given stream ARN"
17+
source=".\AWSSDKDocSamples\DynamoDBStreams\DynamoDBStreams.GeneratedSamples.cs"
18+
region="to-describe-a-stream-with-a-given-stream-arn-1473457835200" />
19+
</example>
20+
</value>
21+
</doc>
22+
<doc>
23+
<members>
24+
<member name="M:Amazon.DynamoDBStreams.IAmazonDynamoDBStreams.GetRecords(Amazon.DynamoDBStreams.Model.GetRecordsRequest)" />
25+
<member name="M:Amazon.DynamoDBStreams.AmazonDynamoDBStreamsClient.GetRecords(Amazon.DynamoDBStreams.Model.GetRecordsRequest)" />
26+
<member name="T:Amazon.DynamoDBStreams.Model.GetRecordsRequest" />
27+
<member name="T:Amazon.DynamoDBStreams.Model.GetRecordsResponse" />
28+
</members>
29+
<value>
30+
<example>
31+
<para>
32+
The following example retrieves all the stream records from a shard.
33+
</para>
34+
<code
35+
title="To retrieve all the stream records from a shard"
36+
source=".\AWSSDKDocSamples\DynamoDBStreams\DynamoDBStreams.GeneratedSamples.cs"
37+
region="to-retrieve-all-the-stream-records-from-a-shard-1473707781419" />
38+
</example>
39+
</value>
40+
</doc>
41+
<doc>
42+
<members>
43+
<member name="M:Amazon.DynamoDBStreams.IAmazonDynamoDBStreams.GetShardIterator(Amazon.DynamoDBStreams.Model.GetShardIteratorRequest)" />
44+
<member name="M:Amazon.DynamoDBStreams.AmazonDynamoDBStreamsClient.GetShardIterator(Amazon.DynamoDBStreams.Model.GetShardIteratorRequest)" />
45+
<member name="T:Amazon.DynamoDBStreams.Model.GetShardIteratorRequest" />
46+
<member name="T:Amazon.DynamoDBStreams.Model.GetShardIteratorResponse" />
47+
</members>
48+
<value>
49+
<example>
50+
<para>
51+
The following example returns a shard iterator for the provided stream ARN and shard ID.
52+
</para>
53+
<code
54+
title="To obtain a shard iterator for the provided stream ARN and shard ID"
55+
source=".\AWSSDKDocSamples\DynamoDBStreams\DynamoDBStreams.GeneratedSamples.cs"
56+
region="to-obtain-a-shard-iterator-for-the-provided-stream-arn-and-shard-id-1473459941476" />
57+
</example>
58+
</value>
59+
</doc>
60+
<doc>
61+
<members>
62+
<member name="M:Amazon.DynamoDBStreams.IAmazonDynamoDBStreams.ListStreams(Amazon.DynamoDBStreams.Model.ListStreamsRequest)" />
63+
<member name="M:Amazon.DynamoDBStreams.AmazonDynamoDBStreamsClient.ListStreams(Amazon.DynamoDBStreams.Model.ListStreamsRequest)" />
64+
<member name="T:Amazon.DynamoDBStreams.Model.ListStreamsRequest" />
65+
<member name="T:Amazon.DynamoDBStreams.Model.ListStreamsResponse" />
66+
</members>
67+
<value>
68+
<example>
69+
<para>
70+
The following example lists all of the stream ARNs.
71+
</para>
72+
<code
73+
title="To list all of the stream ARNs "
74+
source=".\AWSSDKDocSamples\DynamoDBStreams\DynamoDBStreams.GeneratedSamples.cs"
75+
region="to-list-all-of-the-stream-arns--1473459534285" />
76+
</example>
77+
</value>
78+
</doc>
79+
</docs>

‎docgenerator/AWSSDKDocSamples/DynamoDBStreams/DynamoDBStreams.GeneratedSamples.cs‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
using System;
2+
using System.Collections.Generic;
3+
using System.Linq;
4+
using System.Text;
5+
using System.Threading.Tasks;
6+
7+
using Amazon.DynamoDBStreams;
8+
using Amazon.DynamoDBStreams.Model;
9+
10+
namespace AWSSDKDocSamples.Amazon.DynamoDBStreams.Generated
11+
{
12+
class DynamoDBStreamsSamples : ISample
13+
{
14+
public void DynamoDBStreamsDescribeStream()
15+
{
16+
#region to-describe-a-stream-with-a-given-stream-arn-1473457835200
17+
18+
var client = new AmazonDynamoDBStreamsClient();
19+
var response = client.DescribeStream(new DescribeStreamRequest
20+
{
21+
StreamArn = "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252"
22+
});
23+
24+
StreamDescription streamDescription = response.StreamDescription;
25+
26+
#endregion
27+
}
28+
29+
public void DynamoDBStreamsGetRecords()
30+
{
31+
#region to-retrieve-all-the-stream-records-from-a-shard-1473707781419
32+
33+
var client = new AmazonDynamoDBStreamsClient();
34+
var response = client.GetRecords(new GetRecordsRequest
35+
{
36+
ShardIterator = "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252|1|AAAAAAAAAAEvJp6D+zaQ... <remaining characters omitted> ..."
37+
});
38+
39+
string nextShardIterator = response.NextShardIterator;
40+
List<Record> records = response.Records;
41+
42+
#endregion
43+
}
44+
45+
public void DynamoDBStreamsGetShardIterator()
46+
{
47+
#region to-obtain-a-shard-iterator-for-the-provided-stream-arn-and-shard-id-1473459941476
48+
49+
var client = new AmazonDynamoDBStreamsClient();
50+
var response = client.GetShardIterator(new GetShardIteratorRequest
51+
{
52+
ShardId = "00000001414576573621-f55eea83",
53+
ShardIteratorType = "TRIM_HORIZON",
54+
StreamArn = "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252"
55+
});
56+
57+
string shardIterator = response.ShardIterator;
58+
59+
#endregion
60+
}
61+
62+
public void DynamoDBStreamsListStreams()
63+
{
64+
#region to-list-all-of-the-stream-arns--1473459534285
65+
66+
var client = new AmazonDynamoDBStreamsClient();
67+
var response = client.ListStreams(new ListStreamsRequest
68+
{
69+
});
70+
71+
List<StreamSummary> streams = response.Streams;
72+
73+
#endregion
74+
}
75+
76+
77+
# region ISample Members
78+
public virtual void Run()
79+
{
80+
81+
}
82+
# endregion
83+
84+
}
85+
}

0 commit comments

Comments
 (0)