• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1{
2  "version": "1.0",
3  "examples": {
4    "DescribeStream": [
5      {
6        "input": {
7          "StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252"
8        },
9        "output": {
10          "StreamDescription": {
11            "CreationRequestDateTime": "Wed May 20 13:51:10 PDT 2015",
12            "KeySchema": [
13              {
14                "AttributeName": "ForumName",
15                "KeyType": "HASH"
16              },
17              {
18                "AttributeName": "Subject",
19                "KeyType": "RANGE"
20              }
21            ],
22            "Shards": [
23              {
24                "SequenceNumberRange": {
25                  "EndingSequenceNumber": "20500000000000000910398",
26                  "StartingSequenceNumber": "20500000000000000910398"
27                },
28                "ShardId": "shardId-00000001414562045508-2bac9cd2"
29              },
30              {
31                "ParentShardId": "shardId-00000001414562045508-2bac9cd2",
32                "SequenceNumberRange": {
33                  "EndingSequenceNumber": "820400000000000001192334",
34                  "StartingSequenceNumber": "820400000000000001192334"
35                },
36                "ShardId": "shardId-00000001414576573621-f55eea83"
37              },
38              {
39                "ParentShardId": "shardId-00000001414576573621-f55eea83",
40                "SequenceNumberRange": {
41                  "EndingSequenceNumber": "1683700000000000001135967",
42                  "StartingSequenceNumber": "1683700000000000001135967"
43                },
44                "ShardId": "shardId-00000001414592258131-674fd923"
45              },
46              {
47                "ParentShardId": "shardId-00000001414592258131-674fd923",
48                "SequenceNumberRange": {
49                  "StartingSequenceNumber": "2574600000000000000935255"
50                },
51                "ShardId": "shardId-00000001414608446368-3a1afbaf"
52              }
53            ],
54            "StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252",
55            "StreamLabel": "2015-05-20T20:51:10.252",
56            "StreamStatus": "ENABLED",
57            "StreamViewType": "NEW_AND_OLD_IMAGES",
58            "TableName": "Forum"
59          }
60        },
61        "comments": {
62          "input": {
63          },
64          "output": {
65          }
66        },
67        "description": "The following example describes a stream with a given stream ARN.",
68        "id": "to-describe-a-stream-with-a-given-stream-arn-1473457835200",
69        "title": "To describe a stream with a given stream ARN"
70      }
71    ],
72    "GetRecords": [
73      {
74        "input": {
75          "ShardIterator": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252|1|AAAAAAAAAAEvJp6D+zaQ...  <remaining characters omitted> ..."
76        },
77        "output": {
78          "NextShardIterator": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252|1|AAAAAAAAAAGQBYshYDEe ... <remaining characters omitted> ...",
79          "Records": [
80            {
81              "awsRegion": "us-west-2",
82              "dynamodb": {
83                "ApproximateCreationDateTime": "1.46480646E9",
84                "Keys": {
85                  "ForumName": {
86                    "S": "DynamoDB"
87                  },
88                  "Subject": {
89                    "S": "DynamoDB Thread 3"
90                  }
91                },
92                "SequenceNumber": "300000000000000499659",
93                "SizeBytes": 41,
94                "StreamViewType": "KEYS_ONLY"
95              },
96              "eventID": "e2fd9c34eff2d779b297b26f5fef4206",
97              "eventName": "INSERT",
98              "eventSource": "aws:dynamodb",
99              "eventVersion": "1.0"
100            },
101            {
102              "awsRegion": "us-west-2",
103              "dynamodb": {
104                "ApproximateCreationDateTime": "1.46480527E9",
105                "Keys": {
106                  "ForumName": {
107                    "S": "DynamoDB"
108                  },
109                  "Subject": {
110                    "S": "DynamoDB Thread 1"
111                  }
112                },
113                "SequenceNumber": "400000000000000499660",
114                "SizeBytes": 41,
115                "StreamViewType": "KEYS_ONLY"
116              },
117              "eventID": "4b25bd0da9a181a155114127e4837252",
118              "eventName": "MODIFY",
119              "eventSource": "aws:dynamodb",
120              "eventVersion": "1.0"
121            },
122            {
123              "awsRegion": "us-west-2",
124              "dynamodb": {
125                "ApproximateCreationDateTime": "1.46480646E9",
126                "Keys": {
127                  "ForumName": {
128                    "S": "DynamoDB"
129                  },
130                  "Subject": {
131                    "S": "DynamoDB Thread 2"
132                  }
133                },
134                "SequenceNumber": "500000000000000499661",
135                "SizeBytes": 41,
136                "StreamViewType": "KEYS_ONLY"
137              },
138              "eventID": "740280c73a3df7842edab3548a1b08ad",
139              "eventName": "REMOVE",
140              "eventSource": "aws:dynamodb",
141              "eventVersion": "1.0"
142            }
143          ]
144        },
145        "comments": {
146          "input": {
147          },
148          "output": {
149          }
150        },
151        "description": "The following example retrieves all the stream records from a shard.",
152        "id": "to-retrieve-all-the-stream-records-from-a-shard-1473707781419",
153        "title": "To retrieve all the stream records from a shard"
154      }
155    ],
156    "GetShardIterator": [
157      {
158        "input": {
159          "ShardId": "00000001414576573621-f55eea83",
160          "ShardIteratorType": "TRIM_HORIZON",
161          "StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252"
162        },
163        "output": {
164          "ShardIterator": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252|1|AAAAAAAAAAEvJp6D+zaQ...  <remaining characters omitted> ..."
165        },
166        "comments": {
167          "input": {
168          },
169          "output": {
170          }
171        },
172        "description": "The following example returns a shard iterator for the provided stream ARN and shard ID.",
173        "id": "to-obtain-a-shard-iterator-for-the-provided-stream-arn-and-shard-id-1473459941476",
174        "title": "To obtain a shard iterator for the provided stream ARN and shard ID"
175      }
176    ],
177    "ListStreams": [
178      {
179        "input": {
180        },
181        "output": {
182          "Streams": [
183            {
184              "StreamArn": "arn:aws:dynamodb:us-wesst-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252",
185              "StreamLabel": "2015-05-20T20:51:10.252",
186              "TableName": "Forum"
187            },
188            {
189              "StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:50:02.714",
190              "StreamLabel": "2015-05-20T20:50:02.714",
191              "TableName": "Forum"
192            },
193            {
194              "StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-19T23:03:50.641",
195              "StreamLabel": "2015-05-19T23:03:50.641",
196              "TableName": "Forum"
197            }
198          ]
199        },
200        "comments": {
201          "input": {
202          },
203          "output": {
204          }
205        },
206        "description": "The following example lists all of the stream ARNs.",
207        "id": "to-list-all-of-the-stream-arns--1473459534285",
208        "title": "To list all of the stream ARNs "
209      }
210    ]
211  }
212}
213