Added support for optional shard filter parameter in DescribeStream api that allows customers to fetch child shards of a read_only parent shard.

Author: aws-sdk-dotnet-automation

generator/ServiceModels/streams.dynamodb/streams.dynamodb-2012-08-10.api.json

@@ -5,12 +5,14 @@
     "endpointPrefix":"streams.dynamodb",
     "jsonVersion":"1.0",
     "protocol":"json",
+    "protocols":["json"],
     "serviceFullName":"Amazon DynamoDB Streams",
     "serviceId":"DynamoDB Streams",
     "signatureVersion":"v4",
     "signingName":"dynamodb",
     "targetPrefix":"DynamoDBStreams_20120810",
-    "uid":"streams-dynamodb-2012-08-10"
+    "uid":"streams-dynamodb-2012-08-10",
+    "auth":["aws.auth#sigv4"]
   },
   "operations":{
     "DescribeStream":{
@@ -152,6 +154,10 @@
         "ExclusiveStartShardId":{
           "shape":"ShardId",
           "documentation":"<p>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. </p>"
+        },
+        "ShardFilter":{
+          "shape":"ShardFilter",
+          "documentation":"<p>This optional field contains the filter definition for the <code>DescribeStream</code> API.</p>"
         }
       },
       "documentation":"<p>Represents the input of a <code>DescribeStream</code> operation.</p>"
@@ -470,6 +476,24 @@
       "type":"list",
       "member":{"shape":"Shard"}
     },
+    "ShardFilter":{
+      "type":"structure",
+      "members":{
+        "Type":{
+          "shape":"ShardFilterType",
+          "documentation":"<p>Contains the type of filter to be applied on the <code>DescribeStream</code> API. Currently, the only value this parameter accepts is <code>CHILD_SHARDS</code>.</p>"
+        },
+        "ShardId":{
+          "shape":"ShardId",
+          "documentation":"<p>Contains the <code>shardId</code> of the parent shard for which you are requesting child shards.</p> <p> <i>Sample request:</i> </p>"
+        }
+      },
+      "documentation":"<p>This optional field contains the filter definition for the <code>DescribeStream</code> API.</p>"
+    },
+    "ShardFilterType":{
+      "type":"string",
+      "enum":["CHILD_SHARDS"]
+    },
     "ShardId":{
       "type":"string",
       "max":65,
@@ -563,7 +587,7 @@
       "members":{
         "ApproximateCreationDateTime":{
           "shape":"Date",
-          "documentation":"<p>The approximate date and time when the stream record was created, in <a href=\"http://www.epochconverter.com/\">UNIX epoch time</a> format and rounded down to the closest second.</p>"
+          "documentation":"<p>The approximate date and time when the stream record was created, in <a href=\"https://www.iso.org/iso-8601-date-and-time-format.html\">ISO 8601</a> format and rounded down to the closest second.</p>"
         },
         "Keys":{
           "shape":"AttributeMap",

generator/ServiceModels/streams.dynamodb/streams.dynamodb-2012-08-10.docs.json

@@ -0,0 +1,3 @@
+{
+  "pagination": {}
+}

generator/ServiceModels/streams.dynamodb/streams.dynamodb-2012-08-10.normal.json

@@ -52,6 +52,7 @@ public partial class DescribeStreamRequest : AmazonDynamoDBStreamsRequest
     {
         private string _exclusiveStartShardId;
         private int? _limit;
+        private ShardFilter _shardFilter;
         private string _streamArn;
 
         /// <summary>
@@ -93,6 +94,24 @@ internal bool IsSetLimit()
             return this._limit.HasValue; 
         }
 
+        /// <summary>
+        /// Gets and sets the property ShardFilter. 
+        /// <para>
+        /// This optional field contains the filter definition for the <c>DescribeStream</c> API.
+        /// </para>
+        /// </summary>
+        public ShardFilter ShardFilter
+        {
+            get { return this._shardFilter; }
+            set { this._shardFilter = value; }
+        }
+
+        // Check to see if ShardFilter property is set
+        internal bool IsSetShardFilter()
+        {
+            return this._shardFilter != null;
+        }
+
         /// <summary>
         /// Gets and sets the property StreamArn. 
         /// <para>

generator/ServiceModels/streams.dynamodb/streams.dynamodb-2012-08-10.paginators.json

@@ -81,6 +81,17 @@ public IRequest Marshall(DescribeStreamRequest publicRequest)
                     context.Writer.Write(publicRequest.Limit);
                 }
 
+                if(publicRequest.IsSetShardFilter())
+                {
+                    context.Writer.WritePropertyName("ShardFilter");
+                    context.Writer.WriteObjectStart();
+
+                    var marshaller = ShardFilterMarshaller.Instance;
+                    marshaller.Marshall(publicRequest.ShardFilter, context);
+
+                    context.Writer.WriteObjectEnd();
+                }
+
                 if(publicRequest.IsSetStreamArn())
                 {
                     context.Writer.WritePropertyName("StreamArn");

sdk/src/Services/DynamoDBv2/Generated/Model/DescribeStreamRequest.cs

@@ -0,0 +1,71 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ * 
+ *  http://aws.amazon.com/apache2.0
+ * 
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+/*
+ * Do not modify this file. This file is generated from the streams.dynamodb-2012-08-10.normal.json service model.
+ */
+using System;
+using System.Collections.Generic;
+using System.Globalization;
+using System.IO;
+using System.Text;
+using System.Xml.Serialization;
+
+using Amazon.DynamoDBv2.Model;
+using Amazon.Runtime;
+using Amazon.Runtime.Internal;
+using Amazon.Runtime.Internal.Transform;
+using Amazon.Runtime.Internal.Util;
+using ThirdParty.Json.LitJson;
+
+#pragma warning disable CS0612,CS0618
+namespace Amazon.DynamoDBv2.Model.Internal.MarshallTransformations
+{
+    /// <summary>
+    /// ShardFilter Marshaller
+    /// </summary>
+    public class ShardFilterMarshaller : IRequestMarshaller<ShardFilter, JsonMarshallerContext> 
+    {
+        /// <summary>
+        /// Unmarshaller the response from the service to the response class.
+        /// </summary>  
+        /// <param name="requestObject"></param>
+        /// <param name="context"></param>
+        /// <returns></returns>
+        public void Marshall(ShardFilter requestObject, JsonMarshallerContext context)
+        {
+            if(requestObject == null)
+                return;
+            if(requestObject.IsSetShardId())
+            {
+                context.Writer.WritePropertyName("ShardId");
+                context.Writer.Write(requestObject.ShardId);
+            }
+
+            if(requestObject.IsSetType())
+            {
+                context.Writer.WritePropertyName("Type");
+                context.Writer.Write(requestObject.Type);
+            }
+
+        }
+
+        /// <summary>
+        /// Singleton Marshaller.
+        /// </summary>
+        public readonly static ShardFilterMarshaller Instance = new ShardFilterMarshaller();
+
+    }
+}

sdk/src/Services/DynamoDBv2/Generated/Model/Internal/MarshallTransformations/DescribeStreamRequestMarshaller.cs

@@ -0,0 +1,84 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ * 
+ *  http://aws.amazon.com/apache2.0
+ * 
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+/*
+ * Do not modify this file. This file is generated from the streams.dynamodb-2012-08-10.normal.json service model.
+ */
+using System;
+using System.Collections.Generic;
+using System.Xml.Serialization;
+using System.Text;
+using System.IO;
+using System.Net;
+
+using Amazon.Runtime;
+using Amazon.Runtime.Internal;
+
+#pragma warning disable CS0612,CS0618,CS1570
+namespace Amazon.DynamoDBv2.Model
+{
+    /// <summary>
+    /// This optional field contains the filter definition for the <c>DescribeStream</c> API.
+    /// </summary>
+    public partial class ShardFilter
+    {
+        private string _shardId;
+        private ShardFilterType _type;
+
+        /// <summary>
+        /// Gets and sets the property ShardId. 
+        /// <para>
+        /// Contains the <c>shardId</c> of the parent shard for which you are requesting child
+        /// shards.
+        /// </para>
+        ///  
+        /// <para>
+        ///  <i>Sample request:</i> 
+        /// </para>
+        /// </summary>
+        [AWSProperty(Min=28, Max=65)]
+        public string ShardId
+        {
+            get { return this._shardId; }
+            set { this._shardId = value; }
+        }
+
+        // Check to see if ShardId property is set
+        internal bool IsSetShardId()
+        {
+            return this._shardId != null;
+        }
+
+        /// <summary>
+        /// Gets and sets the property Type. 
+        /// <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>
+        /// </summary>
+        public ShardFilterType Type
+        {
+            get { return this._type; }
+            set { this._type = value; }
+        }
+
+        // Check to see if Type property is set
+        internal bool IsSetType()
+        {
+            return this._type != null;
+        }
+
+    }
+}

sdk/src/Services/DynamoDBv2/Generated/Model/Internal/MarshallTransformations/ShardFilterMarshaller.cs

@@ -46,8 +46,8 @@ public partial class StreamRecord
         /// <summary>
         /// Gets and sets the property ApproximateCreationDateTime. 
         /// <para>
-        /// The approximate date and time when the stream record was created, in <a href="http://www.epochconverter.com/">UNIX
-        /// epoch time</a> format and rounded down to the closest second.
+        /// The approximate date and time when the stream record was created, in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO
+        /// 8601</a> format and rounded down to the closest second.
         /// </para>
         /// </summary>
         public DateTime ApproximateCreationDateTime

sdk/src/Services/DynamoDBv2/Generated/Model/ShardFilter.cs

@@ -78,6 +78,52 @@ public static implicit operator OperationType(string value)
     }
 
 
+    /// <summary>
+    /// Constants used for properties of type ShardFilterType.
+    /// </summary>
+    public class ShardFilterType : ConstantClass
+    {
+
+        /// <summary>
+        /// Constant CHILD_SHARDS for ShardFilterType
+        /// </summary>
+        public static readonly ShardFilterType CHILD_SHARDS = new ShardFilterType("CHILD_SHARDS");
+
+        /// <summary>
+        /// This constant constructor does not need to be called if the constant
+        /// you are attempting to use is already defined as a static instance of 
+        /// this class.
+        /// This constructor should be used to construct constants that are not
+        /// defined as statics, for instance if attempting to use a feature that is
+        /// newer than the current version of the SDK.
+        /// </summary>
+        public ShardFilterType(string value)
+            : base(value)
+        {
+        }
+
+        /// <summary>
+        /// Finds the constant for the unique value.
+        /// </summary>
+        /// <param name="value">The unique value for the constant</param>
+        /// <returns>The constant for the unique value</returns>
+        public static ShardFilterType FindValue(string value)
+        {
+            return FindValue<ShardFilterType>(value);
+        }
+
+        /// <summary>
+        /// Utility method to convert strings to the constant class.
+        /// </summary>
+        /// <param name="value">The string value to convert to the constant class.</param>
+        /// <returns></returns>
+        public static implicit operator ShardFilterType(string value)
+        {
+            return FindValue(value);
+        }
+    }
+
+
     /// <summary>
     /// Constants used for properties of type ShardIteratorType.
     /// </summary>