aws-sdk-core 2.0.44 → 2.0.45
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/apis/elasticbeanstalk/2010-12-01/docs-2.json +5 -5
- data/apis/elastictranscoder/2012-09-25/api-2.json +24 -4
- data/apis/elastictranscoder/2012-09-25/docs-2.json +29 -5
- data/apis/kinesis/2013-12-02/api-2.json +7 -1
- data/apis/kinesis/2013-12-02/docs-2.json +24 -17
- data/apis/kms/2014-11-01/api-2.json +105 -2
- data/apis/kms/2014-11-01/docs-2.json +62 -51
- data/bin/aws.rb +1 -1
- data/lib/aws-sdk-core/api/customizer.rb +1 -1
- data/lib/aws-sdk-core/plugins/glacier_checksums.rb +1 -1
- data/lib/aws-sdk-core/version.rb +1 -1
- data/lib/seahorse/client/http/headers.rb +1 -1
- data/lib/seahorse/client/logging/formatter.rb +1 -1
- data/lib/seahorse/client/net_http/handler.rb +1 -1
- data/lib/seahorse/model/shapes.rb +1 -1
- metadata +184 -184
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 0fc52250a5cdccb9f5eaae7a6c915f7bf98f726b
|
|
4
|
+
data.tar.gz: 1b6c7a3e350741033c3a9e2b250d2f12d9ce09c1
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 175b60ac5ee393a551edba97c3c03194622dadca7cde1d453ba86b747f3c61dfdb4e212a2686d17cad999b5a7d889bdce9cecd8bce03a27afc28169101969384
|
|
7
|
+
data.tar.gz: e19b57ecc9bfd415e5ccf606641b8c7c35eaaf23387be915f856c144d69d7ddcbf82d0d219bcde935e390c85a3fbe9bf29efe9ba6d19bdedb07e3280c83cf74a
|
|
@@ -32,7 +32,7 @@
|
|
|
32
32
|
"UpdateEnvironment": "<p> Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment. </p> <p> Attempting to update both the release and configuration is not allowed and AWS Elastic Beanstalk returns an <code>InvalidParameterCombination</code> error. </p> <p> When updating the configuration settings to a new template or individual settings, a draft configuration is created and <a>DescribeConfigurationSettings</a> for this environment returns two setting descriptions with different <code>DeploymentStatus</code> values. </p>",
|
|
33
33
|
"ValidateConfigurationSettings": "<p> Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid. </p> <p> This action returns a list of messages indicating any errors or warnings associated with the selection of option values. </p>"
|
|
34
34
|
},
|
|
35
|
-
"service": "<fullname>AWS Elastic Beanstalk</fullname> <p> This is the AWS Elastic Beanstalk API Reference. This guide provides detailed information about AWS Elastic Beanstalk actions, data types, parameters, and errors. </p> <p>AWS Elastic Beanstalk is a tool that makes it easy for you to create, deploy, and manage scalable, fault-tolerant applications running on Amazon Web Services cloud resources. </p> <p> For more information about this product, go to the <a href=\"http://aws.amazon.com/elasticbeanstalk/\">AWS Elastic Beanstalk</a> details page. The location of the latest AWS Elastic Beanstalk WSDL is <a href=\"http://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl\">http://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl</a>. </p> <p><b>Endpoints</b></p> <p>For a list of region-specific endpoints that AWS Elastic Beanstalk supports, go to <a href=\"http://docs.aws.amazon.com/general/latest/gr/rande.html#elasticbeanstalk_region\">Regions and Endpoints</a> in the <i>Amazon Web Services Glossary</i>.</p>",
|
|
35
|
+
"service": "<fullname>AWS Elastic Beanstalk</fullname> <p> This is the AWS Elastic Beanstalk API Reference. This guide provides detailed information about AWS Elastic Beanstalk actions, data types, parameters, and errors. </p> <p>AWS Elastic Beanstalk is a tool that makes it easy for you to create, deploy, and manage scalable, fault-tolerant applications running on Amazon Web Services cloud resources. </p> <p> For more information about this product, go to the <a href=\"http://aws.amazon.com/elasticbeanstalk/\">AWS Elastic Beanstalk</a> details page. The location of the latest AWS Elastic Beanstalk WSDL is <a href=\"http://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl\">http://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl</a>. To install the Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools that enable you to access the API, go to <a href=\"https://aws.amazon.com/tools/\">Tools for Amazon Web Services</a>. </p> <p><b>Endpoints</b></p> <p>For a list of region-specific endpoints that AWS Elastic Beanstalk supports, go to <a href=\"http://docs.aws.amazon.com/general/latest/gr/rande.html#elasticbeanstalk_region\">Regions and Endpoints</a> in the <i>Amazon Web Services Glossary</i>.</p>",
|
|
36
36
|
"shapes": {
|
|
37
37
|
"AbortEnvironmentUpdateMessage": {
|
|
38
38
|
"base": "<p></p>",
|
|
@@ -42,7 +42,7 @@
|
|
|
42
42
|
"AbortableOperationInProgress": {
|
|
43
43
|
"base": null,
|
|
44
44
|
"refs": {
|
|
45
|
-
"EnvironmentDescription$AbortableOperationInProgress": "<p>
|
|
45
|
+
"EnvironmentDescription$AbortableOperationInProgress": "<p>Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.</p> <p> <code>true:</code> There is an update in progress. </p> <p> <code>false:</code> There are no updates currently in progress. </p>"
|
|
46
46
|
}
|
|
47
47
|
},
|
|
48
48
|
"ApplicationDescription": {
|
|
@@ -570,7 +570,7 @@
|
|
|
570
570
|
"refs": {
|
|
571
571
|
"CreateEnvironmentMessage$Tier": "<p> This specifies the tier to use for creating this environment. </p>",
|
|
572
572
|
"EnvironmentDescription$Tier": "<p>Describes the current tier of this environment.</p>",
|
|
573
|
-
"UpdateEnvironmentMessage$Tier": "<p> This specifies the tier to use to update the environment. </p> <p> Condition:
|
|
573
|
+
"UpdateEnvironmentMessage$Tier": "<p> This specifies the tier to use to update the environment. </p> <p> Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns <code>InvalidParameterValue</code> error. </p>"
|
|
574
574
|
}
|
|
575
575
|
},
|
|
576
576
|
"EventDate": {
|
|
@@ -816,8 +816,8 @@
|
|
|
816
816
|
"ResourceName": {
|
|
817
817
|
"base": null,
|
|
818
818
|
"refs": {
|
|
819
|
-
"ConfigurationOptionSetting$ResourceName":
|
|
820
|
-
"OptionSpecification$ResourceName":
|
|
819
|
+
"ConfigurationOptionSetting$ResourceName": "<p> A unique resource name for a time-based scaling configuration option. </p>",
|
|
820
|
+
"OptionSpecification$ResourceName": "<p> A unique resource name for a time-based scaling configuration option. </p>"
|
|
821
821
|
}
|
|
822
822
|
},
|
|
823
823
|
"RestartAppServerMessage": {
|
|
@@ -695,6 +695,14 @@
|
|
|
695
695
|
"type":"string",
|
|
696
696
|
"pattern":"(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)"
|
|
697
697
|
},
|
|
698
|
+
"AudioBitDepth":{
|
|
699
|
+
"type":"string",
|
|
700
|
+
"pattern":"(^16$)|(^24$)"
|
|
701
|
+
},
|
|
702
|
+
"AudioBitOrder":{
|
|
703
|
+
"type":"string",
|
|
704
|
+
"pattern":"(^LittleEndian$)"
|
|
705
|
+
},
|
|
698
706
|
"AudioBitRate":{
|
|
699
707
|
"type":"string",
|
|
700
708
|
"pattern":"^\\d{1,3}$"
|
|
@@ -705,18 +713,25 @@
|
|
|
705
713
|
},
|
|
706
714
|
"AudioCodec":{
|
|
707
715
|
"type":"string",
|
|
708
|
-
"pattern":"(^AAC$)|(^vorbis$)|(^mp3$)|(^mp2$)"
|
|
716
|
+
"pattern":"(^AAC$)|(^vorbis$)|(^mp3$)|(^mp2$)|(^pcm$)|(^flac$)"
|
|
709
717
|
},
|
|
710
718
|
"AudioCodecOptions":{
|
|
711
719
|
"type":"structure",
|
|
712
720
|
"members":{
|
|
713
|
-
"Profile":{"shape":"AudioCodecProfile"}
|
|
721
|
+
"Profile":{"shape":"AudioCodecProfile"},
|
|
722
|
+
"BitDepth":{"shape":"AudioBitDepth"},
|
|
723
|
+
"BitOrder":{"shape":"AudioBitOrder"},
|
|
724
|
+
"Signed":{"shape":"AudioSigned"}
|
|
714
725
|
}
|
|
715
726
|
},
|
|
716
727
|
"AudioCodecProfile":{
|
|
717
728
|
"type":"string",
|
|
718
729
|
"pattern":"(^auto$)|(^AAC-LC$)|(^HE-AAC$)|(^HE-AACv2$)"
|
|
719
730
|
},
|
|
731
|
+
"AudioPackingMode":{
|
|
732
|
+
"type":"string",
|
|
733
|
+
"pattern":"(^SingleTrack$)|(^OneChannelPerTrack$)|(^OneChannelPerTrackWithMosTo8Tracks$)"
|
|
734
|
+
},
|
|
720
735
|
"AudioParameters":{
|
|
721
736
|
"type":"structure",
|
|
722
737
|
"members":{
|
|
@@ -724,12 +739,17 @@
|
|
|
724
739
|
"SampleRate":{"shape":"AudioSampleRate"},
|
|
725
740
|
"BitRate":{"shape":"AudioBitRate"},
|
|
726
741
|
"Channels":{"shape":"AudioChannels"},
|
|
742
|
+
"AudioPackingMode":{"shape":"AudioPackingMode"},
|
|
727
743
|
"CodecOptions":{"shape":"AudioCodecOptions"}
|
|
728
744
|
}
|
|
729
745
|
},
|
|
730
746
|
"AudioSampleRate":{
|
|
731
747
|
"type":"string",
|
|
732
|
-
"pattern":"(^auto$)|(^22050$)|(^32000$)|(^44100$)|(^48000$)|(^96000$)"
|
|
748
|
+
"pattern":"(^auto$)|(^22050$)|(^32000$)|(^44100$)|(^48000$)|(^96000$)|(^192000$)"
|
|
749
|
+
},
|
|
750
|
+
"AudioSigned":{
|
|
751
|
+
"type":"string",
|
|
752
|
+
"pattern":"(^Signed$)"
|
|
733
753
|
},
|
|
734
754
|
"Base64EncodedString":{
|
|
735
755
|
"type":"string",
|
|
@@ -1437,7 +1457,7 @@
|
|
|
1437
1457
|
},
|
|
1438
1458
|
"PresetContainer":{
|
|
1439
1459
|
"type":"string",
|
|
1440
|
-
"pattern":"(^mp4$)|(^ts$)|(^webm$)|(^mp3$)|(^ogg$)|(^fmp4$)|(^mpg$)|(^flv$)|(^gif$)"
|
|
1460
|
+
"pattern":"(^mp4$)|(^ts$)|(^webm$)|(^mp3$)|(^flac$)|(^oga$)|(^ogg$)|(^fmp4$)|(^mpg$)|(^flv$)|(^gif$)|(^mxf$)"
|
|
1441
1461
|
},
|
|
1442
1462
|
"PresetType":{
|
|
1443
1463
|
"type":"string",
|
|
@@ -68,6 +68,18 @@
|
|
|
68
68
|
"VideoParameters$DisplayAspectRatio": "<p>The value that Elastic Transcoder adds to the metadata in the output file.</p>"
|
|
69
69
|
}
|
|
70
70
|
},
|
|
71
|
+
"AudioBitDepth": {
|
|
72
|
+
"base": null,
|
|
73
|
+
"refs": {
|
|
74
|
+
"AudioCodecOptions$BitDepth": "<p>You can only choose an audio bit depth when you specify <code>flac</code> or <code>pcm</code> for the value of Audio:Codec.</p> <p>The bit depth of a sample is how many bits of information are included in the audio samples. The higher the bit depth, the better the audio, but the larger the file.</p> <p>Valid values are <code>16</code> and <code>24</code>.</p> <p>The most common bit depth is <code>24</code>.</p>"
|
|
75
|
+
}
|
|
76
|
+
},
|
|
77
|
+
"AudioBitOrder": {
|
|
78
|
+
"base": null,
|
|
79
|
+
"refs": {
|
|
80
|
+
"AudioCodecOptions$BitOrder": "<p>You can only choose an audio bit order when you specify <code>pcm</code> for the value of Audio:Codec.</p> <p>The order the bits of a PCM sample are stored in.</p> <p>The supported value is <code>LittleEndian</code>.</p>"
|
|
81
|
+
}
|
|
82
|
+
},
|
|
71
83
|
"AudioBitRate": {
|
|
72
84
|
"base": null,
|
|
73
85
|
"refs": {
|
|
@@ -77,13 +89,13 @@
|
|
|
77
89
|
"AudioChannels": {
|
|
78
90
|
"base": null,
|
|
79
91
|
"refs": {
|
|
80
|
-
"AudioParameters$Channels": "<p>The number of audio channels in the output file.
|
|
92
|
+
"AudioParameters$Channels": "<p>The number of audio channels in the output file. The following values are valid:</p> <p><code>auto</code>, <code>0</code>, <code>1</code>, <code>2</code></p> <p>One channel carries the information played by a single speaker. For example, a stereo track with two channels sends one channel to the left speaker, and the other channel to the right speaker. The output channels are organized into tracks. If you want Elastic Transcoder to automatically detect the number of audio channels in the input file and use that value for the output file, select <code>auto</code>.</p> <p>The output of a specific channel value and inputs are as follows:</p> <ul> <li> <code>auto</code><b> channel specified, with any input:</b> Pass through up to eight input channels.</li> <li> <code>0</code><b> channels specified, with any input:</b> Audio omitted from the output.</li> <li> <code>1</code><b> channel specified, with at least one input channel:</b> Mono sound.</li> <li> <code>2</code><b> channels specified, with any input:</b> Two identical mono channels or stereo. For more information about tracks, see <code>Audio:AudioPackingMode.</code> </li> </ul> <p> For more information about how Elastic Transcoder organizes channels and tracks, see <code>Audio:AudioPackingMode</code>.</p>"
|
|
81
93
|
}
|
|
82
94
|
},
|
|
83
95
|
"AudioCodec": {
|
|
84
96
|
"base": null,
|
|
85
97
|
"refs": {
|
|
86
|
-
"AudioParameters$Codec": "<p>The audio codec for the output file. Valid values include <code>aac</code>, <code>mp2</code>, <code>mp3</code>, and <code>vorbis</code>.</p>"
|
|
98
|
+
"AudioParameters$Codec": "<p>The audio codec for the output file. Valid values include <code>aac</code>, <code>flac</code>, <code>mp2</code>, <code>mp3</code>, <code>pcm</code>, and <code>vorbis</code>.</p>"
|
|
87
99
|
}
|
|
88
100
|
},
|
|
89
101
|
"AudioCodecOptions": {
|
|
@@ -98,6 +110,12 @@
|
|
|
98
110
|
"AudioCodecOptions$Profile": "<p>You can only choose an audio profile when you specify AAC for the value of Audio:Codec.</p> <p>Specify the AAC profile for the output file. Elastic Transcoder supports the following profiles:</p> <ul> <li> <code>auto</code>: If you specify <code>auto</code>, Elastic Transcoder will select the profile based on the bit rate selected for the output file.</li> <li> <code>AAC-LC</code>: The most common AAC profile. Use for bit rates larger than 64 kbps.</li> <li> <code>HE-AAC</code>: Not supported on some older players and devices. Use for bit rates between 40 and 80 kbps.</li> <li> <code>HE-AACv2</code>: Not supported on some players and devices. Use for bit rates less than 48 kbps.</li> </ul> <p>All outputs in a <code>Smooth</code> playlist must have the same value for <code>Profile</code>.</p> <note><p>If you created any presets before AAC profiles were added, Elastic Transcoder automatically updated your presets to use AAC-LC. You can change the value as required.</p></note>"
|
|
99
111
|
}
|
|
100
112
|
},
|
|
113
|
+
"AudioPackingMode": {
|
|
114
|
+
"base": null,
|
|
115
|
+
"refs": {
|
|
116
|
+
"AudioParameters$AudioPackingMode": "<p>The method of organizing audio channels and tracks. Use <code>Audio:Channels</code> to specify the number of channels in your output, and <code>Audio:AudioPackingMode</code> to specify the number of tracks and their relation to the channels. If you do not specify an <code>Audio:AudioPackingMode</code>, Elastic Transcoder uses <code>SingleTrack</code>.</p> <p>The following values are valid:</p> <p><code>SingleTrack</code>, <code>OneChannelPerTrack</code>, and <code>OneChannelPerTrackWithMosTo8Tracks</code></p> <p>When you specify <code>SingleTrack</code>, Elastic Transcoder creates a single track for your output. The track can have up to eight channels. Use <code>SingleTrack</code> for all non-<code>mxf</code> containers.</p> <p>The outputs of <code>SingleTrack</code> for a specific channel value and inputs are as follows:</p> <ul> <li> <code>0</code> <b> channels with any input:</b> Audio omitted from the output</li> <li> <code>1, 2, or auto </code> <b>channels with no audio input:</b> Audio omitted from the output</li> <li> <code>1 </code> <b>channel with any input with audio:</b> One track with one channel, downmixed if necessary</li> <li> <code>2 </code> <b>channels with one track with one channel:</b> One track with two identical channels</li> <li> <code>2 or auto </code> <b>channels with two tracks with one channel each:</b> One track with two channels</li> <li> <code>2 or auto </code> <b>channels with one track with two channels:</b> One track with two channels</li> <li> <code>2 </code> <b>channels with one track with multiple channels:</b> One track with two channels</li> <li> <code>auto </code> <b>channels with one track with one channel:</b> One track with one channel</li> <li> <code>auto </code> <b>channels with one track with multiple channels:</b> One track with multiple channels</li> </ul> <p>When you specify <code>OneChannelPerTrack</code>, Elastic Transcoder creates a new track for every channel in your output. Your output can have up to eight single-channel tracks.</p> <p>The outputs of <code>OneChannelPerTrack</code> for a specific channel value and inputs are as follows:</p> <ul> <li> <code>0 </code> <b>channels with any input:</b> Audio omitted from the output</li> <li> <code>1, 2, or auto </code> <b>channels with no audio input:</b> Audio omitted from the output</li> <li> <code>1 </code> <b>channel with any input with audio:</b> One track with one channel, downmixed if necessary</li> <li> <code>2 </code> <b>channels with one track with one channel:</b> Two tracks with one identical channel each</li> <li> <code>2 or auto </code> <b>channels with two tracks with one channel each:</b> Two tracks with one channel each</li> <li> <code>2 or auto </code> <b>channels with one track with two channels:</b> Two tracks with one channel each</li> <li> <code>2 </code> <b>channels with one track with multiple channels:</b> Two tracks with one channel each</li> <li> <code>auto </code> <b>channels with one track with one channel:</b> One track with one channel</li> <li> <code>auto </code> <b>channels with one track with multiple channels:</b> Up to eight tracks with one channel each</li> </ul> <p>When you specify <code>OneChannelPerTrackWithMosTo8Tracks</code>, Elastic Transcoder creates eight single-channel tracks for your output. All tracks that do not contain audio data from an input channel are MOS, or Mit Out Sound, tracks.</p> <p>The outputs of <code>OneChannelPerTrackWithMosTo8Tracks</code> for a specific channel value and inputs are as follows:</p> <ul> <li> <code>0 </code> <b>channels with any input:</b> Audio omitted from the output</li> <li> <code>1, 2, or auto </code> <b>channels with no audio input:</b> Audio omitted from the output</li> <li> <code>1 </code> <b>channel with any input with audio:</b> One track with one channel, downmixed if necessary, plus six MOS tracks</li> <li> <code>2 </code> <b>channels with one track with one channel:</b> Two tracks with one identical channel each, plus six MOS tracks</li> <li> <code>2 or auto </code> <b>channels with two tracks with one channel each:</b> Two tracks with one channel each, plus six MOS tracks</li> <li> <code>2 or auto </code> <b>channels with one track with two channels:</b> Two tracks with one channel each, plus six MOS tracks</li> <li> <code>2 </code> <b>channels with one track with multiple channels:</b> Two tracks with one channel each, plus six MOS tracks</li> <li> <code>auto </code> <b>channels with one track with one channel:</b> One track with one channel, plus seven MOS tracks</li> <li> <code>auto </code> <b>channels with one track with multiple channels:</b> Up to eight tracks with one channel each, plus MOS tracks until there are eight tracks in all</li> </ul>"
|
|
117
|
+
}
|
|
118
|
+
},
|
|
101
119
|
"AudioParameters": {
|
|
102
120
|
"base": "<p>Parameters required for transcoding audio.</p>",
|
|
103
121
|
"refs": {
|
|
@@ -111,6 +129,12 @@
|
|
|
111
129
|
"AudioParameters$SampleRate": "<p>The sample rate of the audio stream in the output file, in Hertz. Valid values include:</p> <p><code>auto</code>, <code>22050</code>, <code>32000</code>, <code>44100</code>, <code>48000</code>, <code>96000</code></p> <p>If you specify <code>auto</code>, Elastic Transcoder automatically detects the sample rate.</p>"
|
|
112
130
|
}
|
|
113
131
|
},
|
|
132
|
+
"AudioSigned": {
|
|
133
|
+
"base": null,
|
|
134
|
+
"refs": {
|
|
135
|
+
"AudioCodecOptions$Signed": "<p>You can only choose whether an audio sample is signed when you specify <code>pcm</code> for the value of Audio:Codec.</p> <p>Whether audio samples are represented with negative and positive numbers (signed) or only positive numbers (unsigned).</p> <p>The supported value is <code>Signed</code>.</p>"
|
|
136
|
+
}
|
|
137
|
+
},
|
|
114
138
|
"Base64EncodedString": {
|
|
115
139
|
"base": null,
|
|
116
140
|
"refs": {
|
|
@@ -152,7 +176,7 @@
|
|
|
152
176
|
"CaptionFormatFormat": {
|
|
153
177
|
"base": null,
|
|
154
178
|
"refs": {
|
|
155
|
-
"CaptionFormat$Format": "<p>The format you specify determines whether Elastic Transcoder generates an embedded or sidecar caption for this output.</p> <ul> <li> <p><b>Valid Embedded Caption Formats:</b></p> <ul> <li><p><b>For MP3</b>: None</p></li> <li><p><b>For MP4</b>: mov-text</p></li> <li><p><b>For MPEG-TS</b>: None</p></li> <li><p><b>For ogg</b>: None</p></li> <li><p><b>For webm</b>: None</p></li> </ul> </li> <li> <p><b>Valid Sidecar Caption Formats:</b> Elastic Transcoder supports dfxp (first div element only), scc, srt, and webvtt. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.</p> <ul> <li><p><b>For FMP4</b>: dfxp</p></li> <li><p><b>Non-FMP4 outputs</b>: All sidecar types</p></li> </ul> <p><code>fmp4</code> captions have an extension of <code>.ismt</code></p> </li> </ul>"
|
|
179
|
+
"CaptionFormat$Format": "<p>The format you specify determines whether Elastic Transcoder generates an embedded or sidecar caption for this output.</p> <ul> <li> <p><b>Valid Embedded Caption Formats:</b></p> <ul> <li><p><b>for FLAC</b>: None</p></li> <li><p><b>For MP3</b>: None</p></li> <li><p><b>For MP4</b>: mov-text</p></li> <li><p><b>For MPEG-TS</b>: None</p></li> <li><p><b>For ogg</b>: None</p></li> <li><p><b>For webm</b>: None</p></li> </ul> </li> <li> <p><b>Valid Sidecar Caption Formats:</b> Elastic Transcoder supports dfxp (first div element only), scc, srt, and webvtt. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.</p> <ul> <li><p><b>For FMP4</b>: dfxp</p></li> <li><p><b>Non-FMP4 outputs</b>: All sidecar types</p></li> </ul> <p><code>fmp4</code> captions have an extension of <code>.ismt</code></p> </li> </ul>"
|
|
156
180
|
}
|
|
157
181
|
},
|
|
158
182
|
"CaptionFormatPattern": {
|
|
@@ -805,8 +829,8 @@
|
|
|
805
829
|
"PresetContainer": {
|
|
806
830
|
"base": null,
|
|
807
831
|
"refs": {
|
|
808
|
-
"CreatePresetRequest$Container": "<p>The container type for the output file. Valid values include <code>flv</code>, <code>fmp4</code>, <code>gif</code>, <code>mp3</code>, <code>mp4</code>, <code>mpg</code>, <code>ogg</code>, <code>ts</code>, and <code>webm</code>.</p>",
|
|
809
|
-
"Preset$Container": "<p>The container type for the output file. Valid values include <code>flv</code>, <code>fmp4</code>, <code>gif</code>, <code>mp3</code>, <code>mp4</code>, <code>mpg</code>, <code>ogg</code>, <code>ts</code>, and <code>webm</code>.</p>"
|
|
832
|
+
"CreatePresetRequest$Container": "<p>The container type for the output file. Valid values include <code>flac</code>, <code>flv</code>, <code>fmp4</code>, <code>gif</code>, <code>mp3</code>, <code>mp4</code>, <code>mpg</code>, <code>mxf</code>, <code>oga</code>, <code>ogg</code>, <code>ts</code>, and <code>webm</code>.</p>",
|
|
833
|
+
"Preset$Container": "<p>The container type for the output file. Valid values include <code>flac</code>, <code>flv</code>, <code>fmp4</code>, <code>gif</code>, <code>mp3</code>, <code>mp4</code>, <code>mpg</code>, <code>mxf</code>, <code>oga</code>, <code>ogg</code>, <code>ts</code>, and <code>webm</code>.</p>"
|
|
810
834
|
}
|
|
811
835
|
},
|
|
812
836
|
"PresetType": {
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
+
"version":"2.0",
|
|
2
3
|
"metadata":{
|
|
3
4
|
"apiVersion":"2013-12-02",
|
|
4
5
|
"endpointPrefix":"kinesis",
|
|
@@ -392,7 +393,8 @@
|
|
|
392
393
|
"required":["Records"],
|
|
393
394
|
"members":{
|
|
394
395
|
"Records":{"shape":"RecordList"},
|
|
395
|
-
"NextShardIterator":{"shape":"ShardIterator"}
|
|
396
|
+
"NextShardIterator":{"shape":"ShardIterator"},
|
|
397
|
+
"MillisBehindLatest":{"shape":"MillisBehindLatest"}
|
|
396
398
|
}
|
|
397
399
|
},
|
|
398
400
|
"GetShardIteratorInput":{
|
|
@@ -505,6 +507,10 @@
|
|
|
505
507
|
"AdjacentShardToMerge":{"shape":"ShardId"}
|
|
506
508
|
}
|
|
507
509
|
},
|
|
510
|
+
"MillisBehindLatest":{
|
|
511
|
+
"type":"long",
|
|
512
|
+
"min":0
|
|
513
|
+
},
|
|
508
514
|
"PartitionKey":{
|
|
509
515
|
"type":"string",
|
|
510
516
|
"min":1,
|
|
@@ -1,18 +1,19 @@
|
|
|
1
1
|
{
|
|
2
|
+
"version": "2.0",
|
|
2
3
|
"operations": {
|
|
3
4
|
"AddTagsToStream": "<p>Adds or updates tags for the specified Amazon Kinesis stream. Each stream can have up to 10 tags. </p> <p>If tags have already been assigned to the stream, <code>AddTagsToStream</code> overwrites any existing tags that correspond to the specified tag keys.</p>",
|
|
4
|
-
"CreateStream": "<p>Creates a Amazon Kinesis stream. A stream captures and transports data records that are continuously emitted from different data sources or <i>producers</i>. Scale-out within an Amazon Kinesis stream is explicitly supported by means of shards, which are uniquely identified groups of data records in an Amazon Kinesis stream.</p> <p>You specify and control the number of shards that a stream is composed of. Each open shard can support up to 5 read transactions per second, up to a maximum total of 2 MB of data read per second. Each shard can support up to 1000 records written per second, up to a maximum total of 1 MB data written per second. You can add shards to a stream if the amount of data input increases and you can remove shards if the amount of data input decreases.</p> <p>The stream name identifies the stream. The name is scoped to the AWS account used by the application. It is also scoped by region. That is, two streams in two different accounts can have the same name, and two streams in the same account, but in two different regions, can have the same name. </p> <p><code>CreateStream</code> is an asynchronous operation. Upon receiving a <code>CreateStream</code> request, Amazon Kinesis immediately returns and sets the stream status to <code>CREATING</code>. After the stream is created, Amazon Kinesis sets the stream status to <code>ACTIVE</code>. You should perform read and write operations only on an <code>ACTIVE</code> stream. </p> <p>You receive a <code>LimitExceededException</code> when making a <code>CreateStream</code> request if you try to do one of the following:</p> <ul> <li>Have more than five streams in the <code>CREATING</code> state at any point in time.</li> <li>Create more shards than are authorized for your account.</li> </ul> <p>
|
|
5
|
-
"DeleteStream": "<p>Deletes a stream and all its shards and data. You must shut down any applications that are operating on the stream before you delete the stream. If an application attempts to operate on a deleted stream, it will receive the exception <code>ResourceNotFoundException</code>.</p> <p>If the stream is in the <code>ACTIVE</code> state, you can delete it. After a <code>DeleteStream</code> request, the specified stream is in the <code>DELETING</code> state until Amazon Kinesis completes the deletion.</p> <p><b>Note:</b> Amazon Kinesis might continue to accept data read and write operations, such as <a>PutRecord</a>, <a>PutRecords</a>, and <a>GetRecords</a>, on a stream in the <code>DELETING</code> state until the stream deletion is complete.</p> <p>When you delete a stream, any shards in that stream are also deleted, and any tags are dissociated from the stream.</p> <p>You can use the <a>DescribeStream</a> operation to check the state of the stream, which is returned in <code>StreamStatus</code>.</p> <p><
|
|
6
|
-
"DescribeStream": "<p>Describes the specified stream.</p> <p>The information about the stream includes its current status, its Amazon Resource Name (ARN), and an array of shard objects. For each shard object, there is information about the hash key and sequence number ranges that the shard spans, and the IDs of any earlier shards that played in a role in creating the shard. A sequence number is the identifier associated with every record ingested in the Amazon Kinesis stream. The sequence number is assigned when a record is put into the stream.</p> <p>You can limit the number of returned shards using the <code>Limit</code> parameter. The number of shards in a stream may be too large to return from a single call to <code>DescribeStream</code>. You can detect this by using the <code>HasMoreShards</code> flag in the returned output. <code>HasMoreShards</code> is set to <code>true</code> when there is more data available. </p> <p><code>DescribeStream</code> is a paginated operation. If there are more shards available, you can request them using the shard ID of the last shard returned. Specify this ID in the <code>ExclusiveStartShardId</code> parameter in a subsequent request to <code>DescribeStream</code>. </p> <p><
|
|
7
|
-
"GetRecords": "<p>Gets data records from a shard.</p> <p>Specify a shard iterator using the <code>ShardIterator</code> parameter. The shard iterator specifies the position in the shard from which you want to start reading data records sequentially. If there are no records available in the portion of the shard that the iterator points to, <
|
|
8
|
-
"GetShardIterator": "<p>Gets a shard iterator. A shard iterator expires five minutes after it is returned to the requester.</p> <p>A shard iterator specifies the position in the shard from which to start reading data records sequentially. A shard iterator specifies this position using the sequence number of a data record in a shard. A sequence number is the identifier associated with every record ingested in the Amazon Kinesis stream. The sequence number is assigned when a record is put into the stream. </p> <p>You must specify the shard iterator type. For example, you can set the <code>ShardIteratorType</code> parameter to read exactly from the position denoted by a specific sequence number by using the <code>AT_SEQUENCE_NUMBER</code> shard iterator type, or right after the sequence number by using the <code>AFTER_SEQUENCE_NUMBER</code> shard iterator type, using sequence numbers returned by earlier calls to <a>PutRecord</a>, <a>PutRecords</a>, <a>GetRecords</a>, or <a>DescribeStream</a>. You can specify the shard iterator type <code>TRIM_HORIZON</code> in the request to cause <code>ShardIterator</code> to point to the last untrimmed record in the shard in the system, which is the oldest data record in the shard. Or you can point to just after the most recent record in the shard, by using the shard iterator type <code>LATEST</code>, so that you always read the most recent data in the shard. </p> <p>When you repeatedly read from an Amazon Kinesis stream use a <a>GetShardIterator</a> request to get the first shard iterator
|
|
9
|
-
"ListStreams": "<p> Lists your streams.</p> <p> The number of streams may be too large to return from a single call to <code>ListStreams</code>. You can limit the number of returned streams using the <code>Limit</code> parameter. If you do not specify a value for the <code>Limit</code> parameter, Amazon Kinesis uses the default limit, which is currently 10.</p> <p> You can detect if there are more streams available to list by using the <code>HasMoreStreams</code> flag from the returned output. If there are more streams available, you can request more streams by using the name of the last stream returned by the <code>ListStreams</code> request in the <code>ExclusiveStartStreamName</code> parameter in a subsequent request to <code>ListStreams</code>. The group of stream names returned by the subsequent request is then added to the list. You can continue this process until all the stream names have been collected in the list. </p> <p><
|
|
5
|
+
"CreateStream": "<p>Creates a Amazon Kinesis stream. A stream captures and transports data records that are continuously emitted from different data sources or <i>producers</i>. Scale-out within an Amazon Kinesis stream is explicitly supported by means of shards, which are uniquely identified groups of data records in an Amazon Kinesis stream.</p> <p>You specify and control the number of shards that a stream is composed of. Each open shard can support up to 5 read transactions per second, up to a maximum total of 2 MB of data read per second. Each shard can support up to 1000 records written per second, up to a maximum total of 1 MB data written per second. You can add shards to a stream if the amount of data input increases and you can remove shards if the amount of data input decreases.</p> <p>The stream name identifies the stream. The name is scoped to the AWS account used by the application. It is also scoped by region. That is, two streams in two different accounts can have the same name, and two streams in the same account, but in two different regions, can have the same name. </p> <p><code>CreateStream</code> is an asynchronous operation. Upon receiving a <code>CreateStream</code> request, Amazon Kinesis immediately returns and sets the stream status to <code>CREATING</code>. After the stream is created, Amazon Kinesis sets the stream status to <code>ACTIVE</code>. You should perform read and write operations only on an <code>ACTIVE</code> stream. </p> <p>You receive a <code>LimitExceededException</code> when making a <code>CreateStream</code> request if you try to do one of the following:</p> <ul> <li>Have more than five streams in the <code>CREATING</code> state at any point in time.</li> <li>Create more shards than are authorized for your account.</li> </ul> <p>For the default shard limit for an AWS account, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html\">Amazon Kinesis Limits</a>. If you need to increase this limit, <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html\">contact AWS Support</a></p> <p>You can use <code>DescribeStream</code> to check the stream status, which is returned in <code>StreamStatus</code>.</p> <p><a>CreateStream</a> has a limit of 5 transactions per second per account.</p>",
|
|
6
|
+
"DeleteStream": "<p>Deletes a stream and all its shards and data. You must shut down any applications that are operating on the stream before you delete the stream. If an application attempts to operate on a deleted stream, it will receive the exception <code>ResourceNotFoundException</code>.</p> <p>If the stream is in the <code>ACTIVE</code> state, you can delete it. After a <code>DeleteStream</code> request, the specified stream is in the <code>DELETING</code> state until Amazon Kinesis completes the deletion.</p> <p><b>Note:</b> Amazon Kinesis might continue to accept data read and write operations, such as <a>PutRecord</a>, <a>PutRecords</a>, and <a>GetRecords</a>, on a stream in the <code>DELETING</code> state until the stream deletion is complete.</p> <p>When you delete a stream, any shards in that stream are also deleted, and any tags are dissociated from the stream.</p> <p>You can use the <a>DescribeStream</a> operation to check the state of the stream, which is returned in <code>StreamStatus</code>.</p> <p><a>DeleteStream</a> has a limit of 5 transactions per second per account.</p>",
|
|
7
|
+
"DescribeStream": "<p>Describes the specified stream.</p> <p>The information about the stream includes its current status, its Amazon Resource Name (ARN), and an array of shard objects. For each shard object, there is information about the hash key and sequence number ranges that the shard spans, and the IDs of any earlier shards that played in a role in creating the shard. A sequence number is the identifier associated with every record ingested in the Amazon Kinesis stream. The sequence number is assigned when a record is put into the stream.</p> <p>You can limit the number of returned shards using the <code>Limit</code> parameter. The number of shards in a stream may be too large to return from a single call to <code>DescribeStream</code>. You can detect this by using the <code>HasMoreShards</code> flag in the returned output. <code>HasMoreShards</code> is set to <code>true</code> when there is more data available. </p> <p><code>DescribeStream</code> is a paginated operation. If there are more shards available, you can request them using the shard ID of the last shard returned. Specify this ID in the <code>ExclusiveStartShardId</code> parameter in a subsequent request to <code>DescribeStream</code>. </p> <p><a>DescribeStream</a> has a limit of 10 transactions per second per account.</p>",
|
|
8
|
+
"GetRecords": "<p>Gets data records from a shard.</p> <p>Specify a shard iterator using the <code>ShardIterator</code> parameter. The shard iterator specifies the position in the shard from which you want to start reading data records sequentially. If there are no records available in the portion of the shard that the iterator points to, <a>GetRecords</a> returns an empty list. Note that it might take multiple calls to get to a portion of the shard that contains records.</p> <p>You can scale by provisioning multiple shards. Your application should have one thread per shard, each reading continuously from its stream. To read from a stream continually, call <a>GetRecords</a> in a loop. Use <a>GetShardIterator</a> to get the shard iterator to specify in the first <a>GetRecords</a> call. <a>GetRecords</a> returns a new shard iterator in <code>NextShardIterator</code>. Specify the shard iterator returned in <code>NextShardIterator</code> in subsequent calls to <a>GetRecords</a>. Note that if the shard has been closed, the shard iterator can't return more data and <a>GetRecords</a> returns <code>null</code> in <code>NextShardIterator</code>. You can terminate the loop when the shard is closed, or when the shard iterator reaches the record with the sequence number or other attribute that marks it as the last record to process.</p> <p>Each data record can be up to 50 KB in size, and each shard can read up to 2 MB per second. You can ensure that your calls don't exceed the maximum supported size or throughput by using the <code>Limit</code> parameter to specify the maximum number of records that <a>GetRecords</a> can return. Consider your average record size when determining this limit. For example, if your average record size is 40 KB, you can limit the data returned to about 1 MB per call by specifying 25 as the limit.</p> <p>The size of the data returned by <a>GetRecords</a> will vary depending on the utilization of the shard. The maximum size of data that <a>GetRecords</a> can return is 10 MB. If a call returns this amount of data, subsequent calls made within the next 5 seconds throw <code>ProvisionedThroughputExceededException</code>. If there is insufficient provisioned throughput on the shard, subsequent calls made within the next 1 second throw <code>ProvisionedThroughputExceededException</code>. Note that <a>GetRecords</a> won't return any data when it throws an exception. For this reason, we recommend that you wait one second between calls to <a>GetRecords</a>; however, it's possible that the application will get exceptions for longer than 1 second.</p> <p>To detect whether the application is falling behind in processing, you can use the <code>MillisBehindLatest</code> response attribute. You can also monitor the amount of data in a stream using the CloudWatch metrics. For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/monitoring_with_cloudwatch.html\">Monitoring Amazon Kinesis with Amazon CloudWatch</a> in the <i>Amazon Kinesis Developer Guide</i>.</p>",
|
|
9
|
+
"GetShardIterator": "<p>Gets a shard iterator. A shard iterator expires five minutes after it is returned to the requester.</p> <p>A shard iterator specifies the position in the shard from which to start reading data records sequentially. A shard iterator specifies this position using the sequence number of a data record in a shard. A sequence number is the identifier associated with every record ingested in the Amazon Kinesis stream. The sequence number is assigned when a record is put into the stream. </p> <p>You must specify the shard iterator type. For example, you can set the <code>ShardIteratorType</code> parameter to read exactly from the position denoted by a specific sequence number by using the <code>AT_SEQUENCE_NUMBER</code> shard iterator type, or right after the sequence number by using the <code>AFTER_SEQUENCE_NUMBER</code> shard iterator type, using sequence numbers returned by earlier calls to <a>PutRecord</a>, <a>PutRecords</a>, <a>GetRecords</a>, or <a>DescribeStream</a>. You can specify the shard iterator type <code>TRIM_HORIZON</code> in the request to cause <code>ShardIterator</code> to point to the last untrimmed record in the shard in the system, which is the oldest data record in the shard. Or you can point to just after the most recent record in the shard, by using the shard iterator type <code>LATEST</code>, so that you always read the most recent data in the shard. </p> <p>When you repeatedly read from an Amazon Kinesis stream use a <a>GetShardIterator</a> request to get the first shard iterator for use in your first <a>GetRecords</a> request and then use the shard iterator returned by the <a>GetRecords</a> request in <code>NextShardIterator</code> for subsequent reads. A new shard iterator is returned by every <a>GetRecords</a> request in <code>NextShardIterator</code>, which you use in the <code>ShardIterator</code> parameter of the next <a>GetRecords</a> request. </p> <p>If a <a>GetShardIterator</a> request is made too often, you receive a <code>ProvisionedThroughputExceededException</code>. For more information about throughput limits, see <a>GetRecords</a>.</p> <p>If the shard is closed, the iterator can't return more data, and <a>GetShardIterator</a> returns <code>null</code> for its <code>ShardIterator</code>. A shard can be closed using <a>SplitShard</a> or <a>MergeShards</a>.</p> <p><a>GetShardIterator</a> has a limit of 5 transactions per second per account per open shard.</p>",
|
|
10
|
+
"ListStreams": "<p> Lists your streams.</p> <p> The number of streams may be too large to return from a single call to <code>ListStreams</code>. You can limit the number of returned streams using the <code>Limit</code> parameter. If you do not specify a value for the <code>Limit</code> parameter, Amazon Kinesis uses the default limit, which is currently 10.</p> <p> You can detect if there are more streams available to list by using the <code>HasMoreStreams</code> flag from the returned output. If there are more streams available, you can request more streams by using the name of the last stream returned by the <code>ListStreams</code> request in the <code>ExclusiveStartStreamName</code> parameter in a subsequent request to <code>ListStreams</code>. The group of stream names returned by the subsequent request is then added to the list. You can continue this process until all the stream names have been collected in the list. </p> <p><a>ListStreams</a> has a limit of 5 transactions per second per account.</p>",
|
|
10
11
|
"ListTagsForStream": "<p>Lists the tags for the specified Amazon Kinesis stream.</p>",
|
|
11
|
-
"MergeShards": "<p>Merges two adjacent shards in a stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data. Two shards are considered adjacent if the union of the hash key ranges for the two shards form a contiguous set with no gaps. For example, if you have two shards, one with a hash key range of 276...381 and the other with a hash key range of 382...454, then you could merge these two shards into a single shard that would have a hash key range of 276...454. After the merge, the single child shard receives data for all hash key values covered by the two parent shards.</p> <p><code>MergeShards</code> is called when there is a need to reduce the overall capacity of a stream because of excess capacity that is not being used. You must specify the shard to be merged and the adjacent shard for a stream. For more information about merging shards, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-
|
|
12
|
-
"PutRecord": "<p>Puts (writes) a single data record from a producer into an Amazon Kinesis stream. Call <code>PutRecord</code> to send data from the producer into the Amazon Kinesis stream for real-time ingestion and subsequent processing, one record at a time. Each shard can support up to 1000 records written per second, up to a maximum total of 1 MB data written per second.</p> <p>You must specify the name of the stream that captures, stores, and transports the data; a partition key; and the data blob itself.</p> <p>The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.</p> <p>The partition key is used by Amazon Kinesis to distribute data across shards. Amazon Kinesis segregates the data records that belong to a data stream into multiple shards, using the partition key associated with each data record to determine which shard a given data record belongs to. </p> <p>Partition keys are Unicode strings, with a maximum length limit of 256
|
|
13
|
-
"PutRecords": "<p>Puts (writes) multiple data records from a producer into an Amazon Kinesis stream in a single call (also referred to as a <code>PutRecords</code> request). Use this operation to send data from a data producer into the Amazon Kinesis stream for real-time ingestion and processing. Each shard can support up to 1000 records written per second, up to a maximum total of 1 MB data written per second.</p> <p>You must specify the name of the stream that captures, stores, and transports the data; and an array of request <code>Records</code>, with each record in the array requiring a partition key and data blob. </p> <p>The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.</p> <p>The partition key is used by Amazon Kinesis as input to a hash function that maps the partition key and associated data to a specific shard. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream. For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-
|
|
12
|
+
"MergeShards": "<p>Merges two adjacent shards in a stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data. Two shards are considered adjacent if the union of the hash key ranges for the two shards form a contiguous set with no gaps. For example, if you have two shards, one with a hash key range of 276...381 and the other with a hash key range of 382...454, then you could merge these two shards into a single shard that would have a hash key range of 276...454. After the merge, the single child shard receives data for all hash key values covered by the two parent shards.</p> <p><code>MergeShards</code> is called when there is a need to reduce the overall capacity of a stream because of excess capacity that is not being used. You must specify the shard to be merged and the adjacent shard for a stream. For more information about merging shards, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-merge.html\">Merge Two Shards</a> in the <i>Amazon Kinesis Developer Guide</i>.</p> <p>If the stream is in the <code>ACTIVE</code> state, you can call <code>MergeShards</code>. If a stream is in the <code>CREATING</code>, <code>UPDATING</code>, or <code>DELETING</code> state, <code>MergeShards</code> returns a <code>ResourceInUseException</code>. If the specified stream does not exist, <code>MergeShards</code> returns a <code>ResourceNotFoundException</code>. </p> <p>You can use <a>DescribeStream</a> to check the state of the stream, which is returned in <code>StreamStatus</code>.</p> <p><code>MergeShards</code> is an asynchronous operation. Upon receiving a <code>MergeShards</code> request, Amazon Kinesis immediately returns a response and sets the <code>StreamStatus</code> to <code>UPDATING</code>. After the operation is completed, Amazon Kinesis sets the <code>StreamStatus</code> to <code>ACTIVE</code>. Read and write operations continue to work while the stream is in the <code>UPDATING</code> state. </p> <p>You use <a>DescribeStream</a> to determine the shard IDs that are specified in the <code>MergeShards</code> request. </p> <p>If you try to operate on too many streams in parallel using <a>CreateStream</a>, <a>DeleteStream</a>, <code>MergeShards</code> or <a>SplitShard</a>, you will receive a <code>LimitExceededException</code>. </p> <p><code>MergeShards</code> has limit of 5 transactions per second per account.</p>",
|
|
13
|
+
"PutRecord": "<p>Puts (writes) a single data record from a producer into an Amazon Kinesis stream. Call <code>PutRecord</code> to send data from the producer into the Amazon Kinesis stream for real-time ingestion and subsequent processing, one record at a time. Each shard can support up to 1000 records written per second, up to a maximum total of 1 MB data written per second.</p> <p>You must specify the name of the stream that captures, stores, and transports the data; a partition key; and the data blob itself.</p> <p>The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.</p> <p>The partition key is used by Amazon Kinesis to distribute data across shards. Amazon Kinesis segregates the data records that belong to a data stream into multiple shards, using the partition key associated with each data record to determine which shard a given data record belongs to. </p> <p>Partition keys are Unicode strings, with a maximum length limit of 256 characters for each key. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards using the hash key ranges of the shards. You can override hashing the partition key to determine the shard by explicitly specifying a hash value using the <code>ExplicitHashKey</code> parameter. For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-add-data-to-stream.html\">Adding Data to a Stream</a> in the <i>Amazon Kinesis Developer Guide</i>.</p> <p><code>PutRecord</code> returns the shard ID of where the data record was placed and the sequence number that was assigned to the data record.</p> <p>Sequence numbers generally increase over time. To guarantee strictly increasing ordering, use the <code>SequenceNumberForOrdering</code> parameter. For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-add-data-to-stream.html\">Adding Data to a Stream</a> in the <i>Amazon Kinesis Developer Guide</i>.</p> <p>If a <code>PutRecord</code> request cannot be processed because of insufficient provisioned throughput on the shard involved in the request, <code>PutRecord</code> throws <code>ProvisionedThroughputExceededException</code>. </p> <p>Data records are accessible for only 24 hours from the time that they are added to an Amazon Kinesis stream.</p>",
|
|
14
|
+
"PutRecords": "<p>Puts (writes) multiple data records from a producer into an Amazon Kinesis stream in a single call (also referred to as a <code>PutRecords</code> request). Use this operation to send data from a data producer into the Amazon Kinesis stream for real-time ingestion and processing. Each shard can support up to 1000 records written per second, up to a maximum total of 1 MB data written per second.</p> <p>You must specify the name of the stream that captures, stores, and transports the data; and an array of request <code>Records</code>, with each record in the array requiring a partition key and data blob. </p> <p>The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.</p> <p>The partition key is used by Amazon Kinesis as input to a hash function that maps the partition key and associated data to a specific shard. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream. For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-add-data-to-stream.html\">Adding Data to a Stream</a> in the <i>Amazon Kinesis Developer Guide</i>.</p> <p>Each record in the <code>Records</code> array may include an optional parameter, <code>ExplicitHashKey</code>, which overrides the partition key to shard mapping. This parameter allows a data producer to determine explicitly the shard where the record is stored. For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-add-data-to-stream.html#kinesis-using-sdk-java-putrecords\">Adding Multiple Records with PutRecords</a> in the <i>Amazon Kinesis Developer Guide</i>.</p> <p>The <code>PutRecords</code> response includes an array of response <code>Records</code>. Each record in the response array directly correlates with a record in the request array using natural ordering, from the top to the bottom of the request and response. The response <code>Records</code> array always includes the same number of records as the request array.</p> <p>The response <code>Records</code> array includes both successfully and unsuccessfully processed records. Amazon Kinesis attempts to process all records in each <code>PutRecords</code> request. A single record failure does not stop the processing of subsequent records.</p> <p>A successfully-processed record includes <code>ShardId</code> and <code>SequenceNumber</code> values. The <code>ShardId</code> parameter identifies the shard in the stream where the record is stored. The <code>SequenceNumber</code> parameter is an identifier assigned to the put record, unique to all records in the stream.</p> <p>An unsuccessfully-processed record includes <code>ErrorCode</code> and <code>ErrorMessage</code> values. <code>ErrorCode</code> reflects the type of error and can be one of the following values: <code>ProvisionedThroughputExceededException</code> or <code>InternalFailure</code>. <code>ErrorMessage</code> provides more detailed information about the <code>ProvisionedThroughputExceededException</code> exception including the account ID, stream name, and shard ID of the record that was throttled. For more information about partially successful responses, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-add-data-to-stream.html#kinesis-using-sdk-java-putrecords\">Adding Multiple Records with PutRecords</a> in the <i>Amazon Kinesis Developer Guide</i>.</p> <p>Data records are accessible for only 24 hours from the time that they are added to an Amazon Kinesis stream.</p>",
|
|
14
15
|
"RemoveTagsFromStream": "<p>Deletes tags from the specified Amazon Kinesis stream.</p> <p>If you specify a tag that does not exist, it is ignored.</p>",
|
|
15
|
-
"SplitShard": "<p>Splits a shard into two new shards in the stream, to increase the stream's capacity to ingest and transport data. <code>SplitShard</code> is called when there is a need to increase the overall capacity of stream because of an expected increase in the volume of data records being ingested. </p> <p>You can also use <code>SplitShard</code> when a shard appears to be approaching its maximum utilization, for example, when the set of producers sending data into the specific shard are suddenly sending more than previously anticipated. You can also call <code>SplitShard</code> to increase stream capacity, so that more Amazon Kinesis applications can simultaneously read data from the stream for real-time processing. </p> <p>You must specify the shard to be split and the new hash key, which is the position in the shard where the shard gets split in two. In many cases, the new hash key might simply be the average of the beginning and ending hash key, but it can be any hash key value in the range being mapped into the shard. For more information about splitting shards, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-
|
|
16
|
+
"SplitShard": "<p>Splits a shard into two new shards in the stream, to increase the stream's capacity to ingest and transport data. <code>SplitShard</code> is called when there is a need to increase the overall capacity of stream because of an expected increase in the volume of data records being ingested. </p> <p>You can also use <code>SplitShard</code> when a shard appears to be approaching its maximum utilization, for example, when the set of producers sending data into the specific shard are suddenly sending more than previously anticipated. You can also call <code>SplitShard</code> to increase stream capacity, so that more Amazon Kinesis applications can simultaneously read data from the stream for real-time processing. </p> <p>You must specify the shard to be split and the new hash key, which is the position in the shard where the shard gets split in two. In many cases, the new hash key might simply be the average of the beginning and ending hash key, but it can be any hash key value in the range being mapped into the shard. For more information about splitting shards, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-split.html\">Split a Shard</a> in the <i>Amazon Kinesis Developer Guide</i>.</p> <p>You can use <a>DescribeStream</a> to determine the shard ID and hash key values for the <code>ShardToSplit</code> and <code>NewStartingHashKey</code> parameters that are specified in the <code>SplitShard</code> request.</p> <p><code>SplitShard</code> is an asynchronous operation. Upon receiving a <code>SplitShard</code> request, Amazon Kinesis immediately returns a response and sets the stream status to <code>UPDATING</code>. After the operation is completed, Amazon Kinesis sets the stream status to <code>ACTIVE</code>. Read and write operations continue to work while the stream is in the <code>UPDATING</code> state. </p> <p>You can use <code>DescribeStream</code> to check the status of the stream, which is returned in <code>StreamStatus</code>. If the stream is in the <code>ACTIVE</code> state, you can call <code>SplitShard</code>. If a stream is in <code>CREATING</code> or <code>UPDATING</code> or <code>DELETING</code> states, <code>DescribeStream</code> returns a <code>ResourceInUseException</code>.</p> <p>If the specified stream does not exist, <code>DescribeStream</code> returns a <code>ResourceNotFoundException</code>. If you try to create more shards than are authorized for your account, you receive a <code>LimitExceededException</code>. </p> <p>For the default shard limit for an AWS account, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html\">Amazon Kinesis Limits</a>. If you need to increase this limit, <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html\">contact AWS Support</a></p> <p>If you try to operate on too many streams in parallel using <a>CreateStream</a>, <a>DeleteStream</a>, <a>MergeShards</a> or <a>SplitShard</a>, you receive a <code>LimitExceededException</code>. </p> <p><code>SplitShard</code> has limit of 5 transactions per second per account.</p>"
|
|
16
17
|
},
|
|
17
18
|
"service": "<fullname>Amazon Kinesis Service API Reference</fullname> <p>Amazon Kinesis is a managed service that scales elastically for real time processing of streaming big data.</p>",
|
|
18
19
|
"shapes": {
|
|
@@ -87,18 +88,18 @@
|
|
|
87
88
|
}
|
|
88
89
|
},
|
|
89
90
|
"GetRecordsInput": {
|
|
90
|
-
"base": "<p>Represents the input for <
|
|
91
|
+
"base": "<p>Represents the input for <a>GetRecords</a>.</p>",
|
|
91
92
|
"refs": {
|
|
92
93
|
}
|
|
93
94
|
},
|
|
94
95
|
"GetRecordsInputLimit": {
|
|
95
96
|
"base": null,
|
|
96
97
|
"refs": {
|
|
97
|
-
"GetRecordsInput$Limit": "<p>The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, <
|
|
98
|
+
"GetRecordsInput$Limit": "<p>The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, <a>GetRecords</a> throws <code>InvalidArgumentException</code>.</p>"
|
|
98
99
|
}
|
|
99
100
|
},
|
|
100
101
|
"GetRecordsOutput": {
|
|
101
|
-
"base": "<p>Represents the output for <
|
|
102
|
+
"base": "<p>Represents the output for <a>GetRecords</a>.</p>",
|
|
102
103
|
"refs": {
|
|
103
104
|
}
|
|
104
105
|
},
|
|
@@ -175,18 +176,24 @@
|
|
|
175
176
|
"refs": {
|
|
176
177
|
}
|
|
177
178
|
},
|
|
179
|
+
"MillisBehindLatest": {
|
|
180
|
+
"base": null,
|
|
181
|
+
"refs": {
|
|
182
|
+
"GetRecordsOutput$MillisBehindLatest": "<p>The number of milliseconds the <a>GetRecords</a> response is from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates record processing is caught up, and there are no new records to process at this moment.</p>"
|
|
183
|
+
}
|
|
184
|
+
},
|
|
178
185
|
"PartitionKey": {
|
|
179
186
|
"base": null,
|
|
180
187
|
"refs": {
|
|
181
|
-
"PutRecordInput$PartitionKey": "<p>Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256
|
|
182
|
-
"PutRecordsRequestEntry$PartitionKey": "<p>Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256
|
|
188
|
+
"PutRecordInput$PartitionKey": "<p>Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key will map to the same shard within the stream.</p>",
|
|
189
|
+
"PutRecordsRequestEntry$PartitionKey": "<p>Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.</p>",
|
|
183
190
|
"Record$PartitionKey": "<p>Identifies which shard in the stream the data record is assigned to.</p>"
|
|
184
191
|
}
|
|
185
192
|
},
|
|
186
193
|
"PositiveIntegerObject": {
|
|
187
194
|
"base": null,
|
|
188
195
|
"refs": {
|
|
189
|
-
"CreateStreamInput$ShardCount": "<p>The number of shards that the stream will use. The throughput of the stream is a function of the number of shards; more shards are required for greater provisioned throughput.</p> <p
|
|
196
|
+
"CreateStreamInput$ShardCount": "<p>The number of shards that the stream will use. The throughput of the stream is a function of the number of shards; more shards are required for greater provisioned throughput.</p> <p>DefaultShardLimit;</p>",
|
|
190
197
|
"PutRecordsOutput$FailedRecordCount": "<p>The number of unsuccessfully processed records in a <code>PutRecords</code> request.</p>"
|
|
191
198
|
}
|
|
192
199
|
},
|
|
@@ -270,7 +277,7 @@
|
|
|
270
277
|
"base": null,
|
|
271
278
|
"refs": {
|
|
272
279
|
"GetShardIteratorInput$StartingSequenceNumber": "<p>The sequence number of the data record in the shard from which to start reading from.</p>",
|
|
273
|
-
"PutRecordInput$SequenceNumberForOrdering": "<p>Guarantees strictly increasing sequence numbers, for puts from the same client and to the same partition key. Usage: set the <code>SequenceNumberForOrdering</code> of record <i>n</i> to the sequence number of record <i>n-1</i> (as returned in the
|
|
280
|
+
"PutRecordInput$SequenceNumberForOrdering": "<p>Guarantees strictly increasing sequence numbers, for puts from the same client and to the same partition key. Usage: set the <code>SequenceNumberForOrdering</code> of record <i>n</i> to the sequence number of record <i>n-1</i> (as returned in the result when putting record <i>n-1</i>). If this parameter is not set, records will be coarsely ordered based on arrival time.</p>",
|
|
274
281
|
"PutRecordOutput$SequenceNumber": "<p>The sequence number identifier that was assigned to the put data record. The sequence number for the record is unique across all records in the stream. A sequence number is the identifier associated with every record put into the stream.</p>",
|
|
275
282
|
"PutRecordsResultEntry$SequenceNumber": "<p>The sequence number for an individual record result.</p>",
|
|
276
283
|
"Record$SequenceNumber": "<p>The unique identifier for the record in the Amazon Kinesis stream.</p>",
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
+
"version":"2.0",
|
|
2
3
|
"metadata":{
|
|
3
4
|
"apiVersion":"2014-11-01",
|
|
4
5
|
"endpointPrefix":"kms",
|
|
@@ -427,6 +428,15 @@
|
|
|
427
428
|
},
|
|
428
429
|
"exception":true
|
|
429
430
|
},
|
|
431
|
+
{
|
|
432
|
+
"shape":"DisabledException",
|
|
433
|
+
"error":{
|
|
434
|
+
"code":"Disabled",
|
|
435
|
+
"httpStatusCode":409,
|
|
436
|
+
"senderFault":true
|
|
437
|
+
},
|
|
438
|
+
"exception":true
|
|
439
|
+
},
|
|
430
440
|
{
|
|
431
441
|
"shape":"InvalidArnException",
|
|
432
442
|
"error":{
|
|
@@ -526,6 +536,15 @@
|
|
|
526
536
|
},
|
|
527
537
|
"exception":true
|
|
528
538
|
},
|
|
539
|
+
{
|
|
540
|
+
"shape":"DisabledException",
|
|
541
|
+
"error":{
|
|
542
|
+
"code":"Disabled",
|
|
543
|
+
"httpStatusCode":409,
|
|
544
|
+
"senderFault":true
|
|
545
|
+
},
|
|
546
|
+
"exception":true
|
|
547
|
+
},
|
|
529
548
|
{
|
|
530
549
|
"shape":"InvalidArnException",
|
|
531
550
|
"error":{
|
|
@@ -911,6 +930,15 @@
|
|
|
911
930
|
"exception":true,
|
|
912
931
|
"fault":true
|
|
913
932
|
},
|
|
933
|
+
{
|
|
934
|
+
"shape":"InvalidMarkerException",
|
|
935
|
+
"error":{
|
|
936
|
+
"code":"InvalidMarker",
|
|
937
|
+
"httpStatusCode":400,
|
|
938
|
+
"senderFault":true
|
|
939
|
+
},
|
|
940
|
+
"exception":true
|
|
941
|
+
},
|
|
914
942
|
{
|
|
915
943
|
"shape":"KMSInternalException",
|
|
916
944
|
"error":{
|
|
@@ -948,6 +976,15 @@
|
|
|
948
976
|
},
|
|
949
977
|
"exception":true
|
|
950
978
|
},
|
|
979
|
+
{
|
|
980
|
+
"shape":"InvalidArnException",
|
|
981
|
+
"error":{
|
|
982
|
+
"code":"InvalidArn",
|
|
983
|
+
"httpStatusCode":400,
|
|
984
|
+
"senderFault":true
|
|
985
|
+
},
|
|
986
|
+
"exception":true
|
|
987
|
+
},
|
|
951
988
|
{
|
|
952
989
|
"shape":"KMSInternalException",
|
|
953
990
|
"error":{
|
|
@@ -1212,6 +1249,15 @@
|
|
|
1212
1249
|
},
|
|
1213
1250
|
"exception":true
|
|
1214
1251
|
},
|
|
1252
|
+
{
|
|
1253
|
+
"shape":"NotFoundException",
|
|
1254
|
+
"error":{
|
|
1255
|
+
"code":"NotFound",
|
|
1256
|
+
"httpStatusCode":404,
|
|
1257
|
+
"senderFault":true
|
|
1258
|
+
},
|
|
1259
|
+
"exception":true
|
|
1260
|
+
},
|
|
1215
1261
|
{
|
|
1216
1262
|
"shape":"DependencyTimeoutException",
|
|
1217
1263
|
"error":{
|
|
@@ -1257,6 +1303,51 @@
|
|
|
1257
1303
|
"exception":true,
|
|
1258
1304
|
"fault":true
|
|
1259
1305
|
},
|
|
1306
|
+
{
|
|
1307
|
+
"shape":"InvalidArnException",
|
|
1308
|
+
"error":{
|
|
1309
|
+
"code":"InvalidArn",
|
|
1310
|
+
"httpStatusCode":400,
|
|
1311
|
+
"senderFault":true
|
|
1312
|
+
},
|
|
1313
|
+
"exception":true
|
|
1314
|
+
},
|
|
1315
|
+
{
|
|
1316
|
+
"shape":"KMSInternalException",
|
|
1317
|
+
"error":{
|
|
1318
|
+
"code":"KMSInternal",
|
|
1319
|
+
"httpStatusCode":500
|
|
1320
|
+
},
|
|
1321
|
+
"exception":true
|
|
1322
|
+
}
|
|
1323
|
+
]
|
|
1324
|
+
},
|
|
1325
|
+
"UpdateAlias":{
|
|
1326
|
+
"name":"UpdateAlias",
|
|
1327
|
+
"http":{
|
|
1328
|
+
"method":"POST",
|
|
1329
|
+
"requestUri":"/"
|
|
1330
|
+
},
|
|
1331
|
+
"input":{"shape":"UpdateAliasRequest"},
|
|
1332
|
+
"errors":[
|
|
1333
|
+
{
|
|
1334
|
+
"shape":"DependencyTimeoutException",
|
|
1335
|
+
"error":{
|
|
1336
|
+
"code":"DependencyTimeout",
|
|
1337
|
+
"httpStatusCode":503
|
|
1338
|
+
},
|
|
1339
|
+
"exception":true,
|
|
1340
|
+
"fault":true
|
|
1341
|
+
},
|
|
1342
|
+
{
|
|
1343
|
+
"shape":"NotFoundException",
|
|
1344
|
+
"error":{
|
|
1345
|
+
"code":"NotFound",
|
|
1346
|
+
"httpStatusCode":404,
|
|
1347
|
+
"senderFault":true
|
|
1348
|
+
},
|
|
1349
|
+
"exception":true
|
|
1350
|
+
},
|
|
1260
1351
|
{
|
|
1261
1352
|
"shape":"KMSInternalException",
|
|
1262
1353
|
"error":{
|
|
@@ -1974,9 +2065,10 @@
|
|
|
1974
2065
|
},
|
|
1975
2066
|
"RetireGrantRequest":{
|
|
1976
2067
|
"type":"structure",
|
|
1977
|
-
"required":["GrantToken"],
|
|
1978
2068
|
"members":{
|
|
1979
|
-
"GrantToken":{"shape":"GrantTokenType"}
|
|
2069
|
+
"GrantToken":{"shape":"GrantTokenType"},
|
|
2070
|
+
"KeyId":{"shape":"KeyIdType"},
|
|
2071
|
+
"GrantId":{"shape":"GrantIdType"}
|
|
1980
2072
|
}
|
|
1981
2073
|
},
|
|
1982
2074
|
"RevokeGrantRequest":{
|
|
@@ -2002,6 +2094,17 @@
|
|
|
2002
2094
|
},
|
|
2003
2095
|
"exception":true
|
|
2004
2096
|
},
|
|
2097
|
+
"UpdateAliasRequest":{
|
|
2098
|
+
"type":"structure",
|
|
2099
|
+
"required":[
|
|
2100
|
+
"AliasName",
|
|
2101
|
+
"TargetKeyId"
|
|
2102
|
+
],
|
|
2103
|
+
"members":{
|
|
2104
|
+
"AliasName":{"shape":"AliasNameType"},
|
|
2105
|
+
"TargetKeyId":{"shape":"KeyIdType"}
|
|
2106
|
+
}
|
|
2107
|
+
},
|
|
2005
2108
|
"UpdateKeyDescriptionRequest":{
|
|
2006
2109
|
"type":"structure",
|
|
2007
2110
|
"required":[
|