aws-sdk 2.583.0 → 2.587.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (59) hide show
  1. package/CHANGELOG.md +26 -1
  2. package/README.md +1 -1
  3. package/apis/apigatewayv2-2018-11-29.min.json +632 -201
  4. package/apis/ebs-2019-11-02.examples.json +5 -0
  5. package/apis/ebs-2019-11-02.min.json +195 -0
  6. package/apis/ebs-2019-11-02.paginators.json +14 -0
  7. package/apis/kafka-2018-11-14.min.json +170 -34
  8. package/apis/kendra-2019-02-03.min.json +2 -1
  9. package/apis/kinesis-video-signaling-2019-12-04.examples.json +5 -0
  10. package/apis/kinesis-video-signaling-2019-12-04.min.json +79 -0
  11. package/apis/kinesis-video-signaling-2019-12-04.paginators.json +4 -0
  12. package/apis/kinesisvideo-2017-09-30.min.json +281 -8
  13. package/apis/kinesisvideo-2017-09-30.paginators.json +6 -0
  14. package/apis/lambda-2015-03-31.min.json +217 -25
  15. package/apis/lambda-2015-03-31.paginators.json +6 -0
  16. package/apis/metadata.json +8 -0
  17. package/apis/rds-2014-10-31.min.json +495 -101
  18. package/apis/rds-2014-10-31.paginators.json +18 -0
  19. package/apis/rekognition-2016-06-27.min.json +409 -85
  20. package/apis/rekognition-2016-06-27.paginators.json +12 -0
  21. package/apis/rekognition-2016-06-27.waiters2.json +45 -0
  22. package/apis/sagemaker-2017-07-24.min.json +3471 -472
  23. package/apis/sagemaker-2017-07-24.paginators.json +128 -16
  24. package/apis/sagemaker-2017-07-24.waiters2.json +30 -0
  25. package/apis/ssm-2014-11-06.min.json +94 -71
  26. package/apis/states-2016-11-23.min.json +92 -55
  27. package/clients/all.d.ts +2 -0
  28. package/clients/all.js +3 -1
  29. package/clients/apigatewayv2.d.ts +856 -1161
  30. package/clients/applicationautoscaling.d.ts +32 -32
  31. package/clients/browser_default.d.ts +1 -0
  32. package/clients/browser_default.js +2 -1
  33. package/clients/ebs.d.ts +211 -0
  34. package/clients/ebs.js +18 -0
  35. package/clients/kafka.d.ts +152 -0
  36. package/clients/kendra.d.ts +7 -3
  37. package/clients/kinesisvideo.d.ts +312 -1
  38. package/clients/kinesisvideosignalingchannels.d.ts +121 -0
  39. package/clients/kinesisvideosignalingchannels.js +18 -0
  40. package/clients/kms.d.ts +6 -6
  41. package/clients/lambda.d.ts +199 -2
  42. package/clients/quicksight.d.ts +223 -223
  43. package/clients/rds.d.ts +549 -0
  44. package/clients/rekognition.d.ts +423 -8
  45. package/clients/rekognition.js +1 -0
  46. package/clients/sagemaker.d.ts +4588 -610
  47. package/clients/ssm.d.ts +42 -6
  48. package/clients/stepfunctions.d.ts +54 -0
  49. package/dist/aws-sdk-core-react-native.js +2 -2
  50. package/dist/aws-sdk-react-native.js +1182 -1102
  51. package/dist/aws-sdk.js +2265 -859
  52. package/dist/aws-sdk.min.js +35 -35
  53. package/lib/config.d.ts +12 -0
  54. package/lib/config_service_placeholders.d.ts +4 -0
  55. package/lib/core.js +1 -1
  56. package/lib/services/s3.js +5 -4
  57. package/lib/services/sts.js +2 -4
  58. package/package.json +1 -1
  59. package/scripts/region-checker/whitelist.js +5 -5
@@ -11,6 +11,14 @@ declare class KinesisVideo extends Service {
11
11
  */
12
12
  constructor(options?: KinesisVideo.Types.ClientConfiguration)
13
13
  config: Config & KinesisVideo.Types.ClientConfiguration;
14
+ /**
15
+ * Creates a signaling channel. CreateSignalingChannel is an asynchronous operation.
16
+ */
17
+ createSignalingChannel(params: KinesisVideo.Types.CreateSignalingChannelInput, callback?: (err: AWSError, data: KinesisVideo.Types.CreateSignalingChannelOutput) => void): Request<KinesisVideo.Types.CreateSignalingChannelOutput, AWSError>;
18
+ /**
19
+ * Creates a signaling channel. CreateSignalingChannel is an asynchronous operation.
20
+ */
21
+ createSignalingChannel(callback?: (err: AWSError, data: KinesisVideo.Types.CreateSignalingChannelOutput) => void): Request<KinesisVideo.Types.CreateSignalingChannelOutput, AWSError>;
14
22
  /**
15
23
  * Creates a new Kinesis video stream. When you create a new stream, Kinesis Video Streams assigns it a version number. When you change the stream's metadata, Kinesis Video Streams updates the version. CreateStream is an asynchronous operation. For information about how the service works, see How it Works. You must have permissions for the KinesisVideo:CreateStream action.
16
24
  */
@@ -19,6 +27,14 @@ declare class KinesisVideo extends Service {
19
27
  * Creates a new Kinesis video stream. When you create a new stream, Kinesis Video Streams assigns it a version number. When you change the stream's metadata, Kinesis Video Streams updates the version. CreateStream is an asynchronous operation. For information about how the service works, see How it Works. You must have permissions for the KinesisVideo:CreateStream action.
20
28
  */
21
29
  createStream(callback?: (err: AWSError, data: KinesisVideo.Types.CreateStreamOutput) => void): Request<KinesisVideo.Types.CreateStreamOutput, AWSError>;
30
+ /**
31
+ * Deletes a specified signaling channel. DeleteSignalingChannel is an asynchronous operation. If you don't specify the channel's current version, the most recent version is deleted.
32
+ */
33
+ deleteSignalingChannel(params: KinesisVideo.Types.DeleteSignalingChannelInput, callback?: (err: AWSError, data: KinesisVideo.Types.DeleteSignalingChannelOutput) => void): Request<KinesisVideo.Types.DeleteSignalingChannelOutput, AWSError>;
34
+ /**
35
+ * Deletes a specified signaling channel. DeleteSignalingChannel is an asynchronous operation. If you don't specify the channel's current version, the most recent version is deleted.
36
+ */
37
+ deleteSignalingChannel(callback?: (err: AWSError, data: KinesisVideo.Types.DeleteSignalingChannelOutput) => void): Request<KinesisVideo.Types.DeleteSignalingChannelOutput, AWSError>;
22
38
  /**
23
39
  * Deletes a Kinesis video stream and the data contained in the stream. This method marks the stream for deletion, and makes the data in the stream inaccessible immediately. To ensure that you have the latest version of the stream before deleting it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the DescribeStream API. This operation requires permission for the KinesisVideo:DeleteStream action.
24
40
  */
@@ -27,6 +43,14 @@ declare class KinesisVideo extends Service {
27
43
  * Deletes a Kinesis video stream and the data contained in the stream. This method marks the stream for deletion, and makes the data in the stream inaccessible immediately. To ensure that you have the latest version of the stream before deleting it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the DescribeStream API. This operation requires permission for the KinesisVideo:DeleteStream action.
28
44
  */
29
45
  deleteStream(callback?: (err: AWSError, data: KinesisVideo.Types.DeleteStreamOutput) => void): Request<KinesisVideo.Types.DeleteStreamOutput, AWSError>;
46
+ /**
47
+ * Returns the most current information about the signaling channel. You must specify either the name or the ARN of the channel that you want to describe.
48
+ */
49
+ describeSignalingChannel(params: KinesisVideo.Types.DescribeSignalingChannelInput, callback?: (err: AWSError, data: KinesisVideo.Types.DescribeSignalingChannelOutput) => void): Request<KinesisVideo.Types.DescribeSignalingChannelOutput, AWSError>;
50
+ /**
51
+ * Returns the most current information about the signaling channel. You must specify either the name or the ARN of the channel that you want to describe.
52
+ */
53
+ describeSignalingChannel(callback?: (err: AWSError, data: KinesisVideo.Types.DescribeSignalingChannelOutput) => void): Request<KinesisVideo.Types.DescribeSignalingChannelOutput, AWSError>;
30
54
  /**
31
55
  * Returns the most current information about the specified stream. You must specify either the StreamName or the StreamARN.
32
56
  */
@@ -43,6 +67,22 @@ declare class KinesisVideo extends Service {
43
67
  * Gets an endpoint for a specified stream for either reading or writing. Use this endpoint in your application to read from the specified stream (using the GetMedia or GetMediaForFragmentList operations) or write to it (using the PutMedia operation). The returned endpoint does not have the API name appended. The client needs to add the API name to the returned endpoint. In the request, specify the stream either by StreamName or StreamARN.
44
68
  */
45
69
  getDataEndpoint(callback?: (err: AWSError, data: KinesisVideo.Types.GetDataEndpointOutput) => void): Request<KinesisVideo.Types.GetDataEndpointOutput, AWSError>;
70
+ /**
71
+ * Provides an endpoint for the specified signaling channel to send and receive messages. This API uses the SingleMasterChannelEndpointConfiguration input parameter, which consists of the Protocols and Role properties. Protocols is used to determine the communication mechanism. For example, specifying WSS as the protocol, results in this API producing a secure websocket endpoint, and specifying HTTPS as the protocol, results in this API generating an HTTPS endpoint. Role determines the messaging permissions. A MASTER role results in this API generating an endpoint that a client can use to communicate with any of the viewers on the channel. A VIEWER role results in this API generating an endpoint that a client can use to communicate only with a MASTER.
72
+ */
73
+ getSignalingChannelEndpoint(params: KinesisVideo.Types.GetSignalingChannelEndpointInput, callback?: (err: AWSError, data: KinesisVideo.Types.GetSignalingChannelEndpointOutput) => void): Request<KinesisVideo.Types.GetSignalingChannelEndpointOutput, AWSError>;
74
+ /**
75
+ * Provides an endpoint for the specified signaling channel to send and receive messages. This API uses the SingleMasterChannelEndpointConfiguration input parameter, which consists of the Protocols and Role properties. Protocols is used to determine the communication mechanism. For example, specifying WSS as the protocol, results in this API producing a secure websocket endpoint, and specifying HTTPS as the protocol, results in this API generating an HTTPS endpoint. Role determines the messaging permissions. A MASTER role results in this API generating an endpoint that a client can use to communicate with any of the viewers on the channel. A VIEWER role results in this API generating an endpoint that a client can use to communicate only with a MASTER.
76
+ */
77
+ getSignalingChannelEndpoint(callback?: (err: AWSError, data: KinesisVideo.Types.GetSignalingChannelEndpointOutput) => void): Request<KinesisVideo.Types.GetSignalingChannelEndpointOutput, AWSError>;
78
+ /**
79
+ * Returns an array of ChannelInfo objects. Each object describes a signaling channel. To retrieve only those channels that satisfy a specific condition, you can specify a ChannelNameCondition.
80
+ */
81
+ listSignalingChannels(params: KinesisVideo.Types.ListSignalingChannelsInput, callback?: (err: AWSError, data: KinesisVideo.Types.ListSignalingChannelsOutput) => void): Request<KinesisVideo.Types.ListSignalingChannelsOutput, AWSError>;
82
+ /**
83
+ * Returns an array of ChannelInfo objects. Each object describes a signaling channel. To retrieve only those channels that satisfy a specific condition, you can specify a ChannelNameCondition.
84
+ */
85
+ listSignalingChannels(callback?: (err: AWSError, data: KinesisVideo.Types.ListSignalingChannelsOutput) => void): Request<KinesisVideo.Types.ListSignalingChannelsOutput, AWSError>;
46
86
  /**
47
87
  * Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams that satisfy a specific condition, you can specify a StreamNameCondition.
48
88
  */
@@ -51,6 +91,14 @@ declare class KinesisVideo extends Service {
51
91
  * Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams that satisfy a specific condition, you can specify a StreamNameCondition.
52
92
  */
53
93
  listStreams(callback?: (err: AWSError, data: KinesisVideo.Types.ListStreamsOutput) => void): Request<KinesisVideo.Types.ListStreamsOutput, AWSError>;
94
+ /**
95
+ * Returns a list of tags associated with the specified signaling channel.
96
+ */
97
+ listTagsForResource(params: KinesisVideo.Types.ListTagsForResourceInput, callback?: (err: AWSError, data: KinesisVideo.Types.ListTagsForResourceOutput) => void): Request<KinesisVideo.Types.ListTagsForResourceOutput, AWSError>;
98
+ /**
99
+ * Returns a list of tags associated with the specified signaling channel.
100
+ */
101
+ listTagsForResource(callback?: (err: AWSError, data: KinesisVideo.Types.ListTagsForResourceOutput) => void): Request<KinesisVideo.Types.ListTagsForResourceOutput, AWSError>;
54
102
  /**
55
103
  * Returns a list of tags associated with the specified stream. In the request, you must specify either the StreamName or the StreamARN.
56
104
  */
@@ -59,6 +107,14 @@ declare class KinesisVideo extends Service {
59
107
  * Returns a list of tags associated with the specified stream. In the request, you must specify either the StreamName or the StreamARN.
60
108
  */
61
109
  listTagsForStream(callback?: (err: AWSError, data: KinesisVideo.Types.ListTagsForStreamOutput) => void): Request<KinesisVideo.Types.ListTagsForStreamOutput, AWSError>;
110
+ /**
111
+ * Adds one or more tags to a signaling channel. A tag is a key-value pair (the value is optional) that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
112
+ */
113
+ tagResource(params: KinesisVideo.Types.TagResourceInput, callback?: (err: AWSError, data: KinesisVideo.Types.TagResourceOutput) => void): Request<KinesisVideo.Types.TagResourceOutput, AWSError>;
114
+ /**
115
+ * Adds one or more tags to a signaling channel. A tag is a key-value pair (the value is optional) that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
116
+ */
117
+ tagResource(callback?: (err: AWSError, data: KinesisVideo.Types.TagResourceOutput) => void): Request<KinesisVideo.Types.TagResourceOutput, AWSError>;
62
118
  /**
63
119
  * Adds one or more tags to a stream. A tag is a key-value pair (the value is optional) that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide. You must provide either the StreamName or the StreamARN. This operation requires permission for the KinesisVideo:TagStream action. Kinesis video streams support up to 50 tags.
64
120
  */
@@ -67,6 +123,14 @@ declare class KinesisVideo extends Service {
67
123
  * Adds one or more tags to a stream. A tag is a key-value pair (the value is optional) that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide. You must provide either the StreamName or the StreamARN. This operation requires permission for the KinesisVideo:TagStream action. Kinesis video streams support up to 50 tags.
68
124
  */
69
125
  tagStream(callback?: (err: AWSError, data: KinesisVideo.Types.TagStreamOutput) => void): Request<KinesisVideo.Types.TagStreamOutput, AWSError>;
126
+ /**
127
+ * Removes one or more tags from a signaling channel. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored.
128
+ */
129
+ untagResource(params: KinesisVideo.Types.UntagResourceInput, callback?: (err: AWSError, data: KinesisVideo.Types.UntagResourceOutput) => void): Request<KinesisVideo.Types.UntagResourceOutput, AWSError>;
130
+ /**
131
+ * Removes one or more tags from a signaling channel. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored.
132
+ */
133
+ untagResource(callback?: (err: AWSError, data: KinesisVideo.Types.UntagResourceOutput) => void): Request<KinesisVideo.Types.UntagResourceOutput, AWSError>;
70
134
  /**
71
135
  * Removes one or more tags from a stream. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored. In the request, you must provide the StreamName or StreamARN.
72
136
  */
@@ -83,6 +147,14 @@ declare class KinesisVideo extends Service {
83
147
  * Increases or decreases the stream's data retention period by the value that you specify. To indicate whether you want to increase or decrease the data retention period, specify the Operation parameter in the request body. In the request, you must specify either the StreamName or the StreamARN. The retention period that you specify replaces the current value. This operation requires permission for the KinesisVideo:UpdateDataRetention action. Changing the data retention period affects the data in the stream as follows: If the data retention period is increased, existing data is retained for the new retention period. For example, if the data retention period is increased from one hour to seven hours, all existing data is retained for seven hours. If the data retention period is decreased, existing data is retained for the new retention period. For example, if the data retention period is decreased from seven hours to one hour, all existing data is retained for one hour, and any data older than one hour is deleted immediately.
84
148
  */
85
149
  updateDataRetention(callback?: (err: AWSError, data: KinesisVideo.Types.UpdateDataRetentionOutput) => void): Request<KinesisVideo.Types.UpdateDataRetentionOutput, AWSError>;
150
+ /**
151
+ * Updates the existing signaling channel. This is an asynchronous operation and takes time to complete. If the MessageTtlSeconds value is updated (either increased or reduced), then it only applies to new messages sent via this channel after it's been updated. Existing messages are still expire as per the previous MessageTtlSeconds value.
152
+ */
153
+ updateSignalingChannel(params: KinesisVideo.Types.UpdateSignalingChannelInput, callback?: (err: AWSError, data: KinesisVideo.Types.UpdateSignalingChannelOutput) => void): Request<KinesisVideo.Types.UpdateSignalingChannelOutput, AWSError>;
154
+ /**
155
+ * Updates the existing signaling channel. This is an asynchronous operation and takes time to complete. If the MessageTtlSeconds value is updated (either increased or reduced), then it only applies to new messages sent via this channel after it's been updated. Existing messages are still expire as per the previous MessageTtlSeconds value.
156
+ */
157
+ updateSignalingChannel(callback?: (err: AWSError, data: KinesisVideo.Types.UpdateSignalingChannelOutput) => void): Request<KinesisVideo.Types.UpdateSignalingChannelOutput, AWSError>;
86
158
  /**
87
159
  * Updates stream metadata, such as the device name and media type. You must provide the stream name or the Amazon Resource Name (ARN) of the stream. To make sure that you have the latest version of the stream before updating it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the DescribeStream API. UpdateStream is an asynchronous operation, and takes time to complete.
88
160
  */
@@ -94,7 +166,76 @@ declare class KinesisVideo extends Service {
94
166
  }
95
167
  declare namespace KinesisVideo {
96
168
  export type APIName = "PUT_MEDIA"|"GET_MEDIA"|"LIST_FRAGMENTS"|"GET_MEDIA_FOR_FRAGMENT_LIST"|"GET_HLS_STREAMING_SESSION_URL"|"GET_DASH_STREAMING_SESSION_URL"|string;
169
+ export interface ChannelInfo {
170
+ /**
171
+ * The name of the signaling channel.
172
+ */
173
+ ChannelName?: ChannelName;
174
+ /**
175
+ * The ARN of the signaling channel.
176
+ */
177
+ ChannelARN?: ResourceARN;
178
+ /**
179
+ * The type of the signaling channel.
180
+ */
181
+ ChannelType?: ChannelType;
182
+ /**
183
+ * Current status of the signaling channel.
184
+ */
185
+ ChannelStatus?: Status;
186
+ /**
187
+ * The time at which the signaling channel was created.
188
+ */
189
+ CreationTime?: Timestamp;
190
+ /**
191
+ * A structure that contains the configuration for the SINGLE_MASTER channel type.
192
+ */
193
+ SingleMasterConfiguration?: SingleMasterConfiguration;
194
+ /**
195
+ * The current version of the signaling channel.
196
+ */
197
+ Version?: Version;
198
+ }
199
+ export type ChannelInfoList = ChannelInfo[];
200
+ export type ChannelName = string;
201
+ export interface ChannelNameCondition {
202
+ /**
203
+ * A comparison operator. Currently, you can only specify the BEGINS_WITH operator, which finds signaling channels whose names begin with a given prefix.
204
+ */
205
+ ComparisonOperator?: ComparisonOperator;
206
+ /**
207
+ * A value to compare.
208
+ */
209
+ ComparisonValue?: ChannelName;
210
+ }
211
+ export type ChannelProtocol = "WSS"|"HTTPS"|string;
212
+ export type ChannelRole = "MASTER"|"VIEWER"|string;
213
+ export type ChannelType = "SINGLE_MASTER"|string;
97
214
  export type ComparisonOperator = "BEGINS_WITH"|string;
215
+ export interface CreateSignalingChannelInput {
216
+ /**
217
+ * A name for the signaling channel that you are creating. It must be unique for each account and region.
218
+ */
219
+ ChannelName: ChannelName;
220
+ /**
221
+ * A type of the signaling channel that you are creating. Currently, SINGLE_MASTER is the only supported channel type.
222
+ */
223
+ ChannelType?: ChannelType;
224
+ /**
225
+ * A structure containing the configuration for the SINGLE_MASTER channel type.
226
+ */
227
+ SingleMasterConfiguration?: SingleMasterConfiguration;
228
+ /**
229
+ * A set of tags (key/value pairs) that you want to associate with this channel.
230
+ */
231
+ Tags?: TagOnCreateList;
232
+ }
233
+ export interface CreateSignalingChannelOutput {
234
+ /**
235
+ * The ARN of the created channel.
236
+ */
237
+ ChannelARN?: ResourceARN;
238
+ }
98
239
  export interface CreateStreamInput {
99
240
  /**
100
241
  * The name of the device that is writing to the stream. In the current implementation, Kinesis Video Streams does not use this name.
@@ -105,7 +246,7 @@ declare namespace KinesisVideo {
105
246
  */
106
247
  StreamName: StreamName;
107
248
  /**
108
- * The media type of the stream. Consumers of the stream can use this information when processing the stream. For more information about media types, see Media Types. If you choose to specify the MediaType, see Naming Requirements for guidelines. This parameter is optional; the default value is null (or empty in JSON).
249
+ * The media type of the stream. Consumers of the stream can use this information when processing the stream. For more information about media types, see Media Types. If you choose to specify the MediaType, see Naming Requirements for guidelines. Example valid values include "video/h264" and "video/h264,audio/aac". This parameter is optional; the default value is null (or empty in JSON).
109
250
  */
110
251
  MediaType?: MediaType;
111
252
  /**
@@ -130,6 +271,18 @@ declare namespace KinesisVideo {
130
271
  export type DataEndpoint = string;
131
272
  export type DataRetentionChangeInHours = number;
132
273
  export type DataRetentionInHours = number;
274
+ export interface DeleteSignalingChannelInput {
275
+ /**
276
+ * The ARN of the signaling channel that you want to delete.
277
+ */
278
+ ChannelARN: ResourceARN;
279
+ /**
280
+ * The current version of the signaling channel that you want to delete. You can obtain the current version by invoking the DescribeSignalingChannel or ListSignalingChannels APIs.
281
+ */
282
+ CurrentVersion?: Version;
283
+ }
284
+ export interface DeleteSignalingChannelOutput {
285
+ }
133
286
  export interface DeleteStreamInput {
134
287
  /**
135
288
  * The Amazon Resource Name (ARN) of the stream that you want to delete.
@@ -142,6 +295,22 @@ declare namespace KinesisVideo {
142
295
  }
143
296
  export interface DeleteStreamOutput {
144
297
  }
298
+ export interface DescribeSignalingChannelInput {
299
+ /**
300
+ * The name of the signaling channel that you want to describe.
301
+ */
302
+ ChannelName?: ChannelName;
303
+ /**
304
+ * The ARN of the signaling channel that you want to describe.
305
+ */
306
+ ChannelARN?: ResourceARN;
307
+ }
308
+ export interface DescribeSignalingChannelOutput {
309
+ /**
310
+ * A structure that encapsulates the specified signaling channel's metadata and properties.
311
+ */
312
+ ChannelInfo?: ChannelInfo;
313
+ }
145
314
  export interface DescribeStreamInput {
146
315
  /**
147
316
  * The name of the stream.
@@ -179,7 +348,48 @@ declare namespace KinesisVideo {
179
348
  */
180
349
  DataEndpoint?: DataEndpoint;
181
350
  }
351
+ export interface GetSignalingChannelEndpointInput {
352
+ /**
353
+ * The ARN of the signalling channel for which you want to get an endpoint.
354
+ */
355
+ ChannelARN: ResourceARN;
356
+ /**
357
+ * A structure containing the endpoint configuration for the SINGLE_MASTER channel type.
358
+ */
359
+ SingleMasterChannelEndpointConfiguration?: SingleMasterChannelEndpointConfiguration;
360
+ }
361
+ export interface GetSignalingChannelEndpointOutput {
362
+ /**
363
+ * A list of endpoints for the specified signaling channel.
364
+ */
365
+ ResourceEndpointList?: ResourceEndpointList;
366
+ }
182
367
  export type KmsKeyId = string;
368
+ export type ListOfProtocols = ChannelProtocol[];
369
+ export interface ListSignalingChannelsInput {
370
+ /**
371
+ * The maximum number of channels to return in the response. The default is 500.
372
+ */
373
+ MaxResults?: ListStreamsInputLimit;
374
+ /**
375
+ * If you specify this parameter, when the result of a ListSignalingChannels operation is truncated, the call returns the NextToken in the response. To get another batch of channels, provide this token in your next request.
376
+ */
377
+ NextToken?: NextToken;
378
+ /**
379
+ * Optional: Returns only the channels that satisfy a specific condition.
380
+ */
381
+ ChannelNameCondition?: ChannelNameCondition;
382
+ }
383
+ export interface ListSignalingChannelsOutput {
384
+ /**
385
+ * An array of ChannelInfo objects.
386
+ */
387
+ ChannelInfoList?: ChannelInfoList;
388
+ /**
389
+ * If the response is truncated, the call returns this element with a token. To get the next batch of streams, use this token in your next request.
390
+ */
391
+ NextToken?: NextToken;
392
+ }
183
393
  export interface ListStreamsInput {
184
394
  /**
185
395
  * The maximum number of streams to return in the response. The default is 10,000.
@@ -205,6 +415,26 @@ declare namespace KinesisVideo {
205
415
  */
206
416
  NextToken?: NextToken;
207
417
  }
418
+ export interface ListTagsForResourceInput {
419
+ /**
420
+ * If you specify this parameter and the result of a ListTagsForResource call is truncated, the response includes a token that you can use in the next request to fetch the next batch of tags.
421
+ */
422
+ NextToken?: NextToken;
423
+ /**
424
+ * The ARN of the signaling channel for which you want to list tags.
425
+ */
426
+ ResourceARN: ResourceARN;
427
+ }
428
+ export interface ListTagsForResourceOutput {
429
+ /**
430
+ * If you specify this parameter and the result of a ListTagsForResource call is truncated, the response includes a token that you can use in the next request to fetch the next set of tags.
431
+ */
432
+ NextToken?: NextToken;
433
+ /**
434
+ * A map of tag keys and values associated with the specified signaling channel.
435
+ */
436
+ Tags?: ResourceTags;
437
+ }
208
438
  export interface ListTagsForStreamInput {
209
439
  /**
210
440
  * If you specify this parameter and the result of a ListTagsForStream call is truncated, the response includes a token that you can use in the next request to fetch the next batch of tags.
@@ -230,9 +460,38 @@ declare namespace KinesisVideo {
230
460
  Tags?: ResourceTags;
231
461
  }
232
462
  export type MediaType = string;
463
+ export type MessageTtlSeconds = number;
233
464
  export type NextToken = string;
234
465
  export type ResourceARN = string;
466
+ export type ResourceEndpoint = string;
467
+ export type ResourceEndpointList = ResourceEndpointListItem[];
468
+ export interface ResourceEndpointListItem {
469
+ /**
470
+ * The protocol of the signaling channel returned by the GetSignalingChannelEndpoint API.
471
+ */
472
+ Protocol?: ChannelProtocol;
473
+ /**
474
+ * The endpoint of the signaling channel returned by the GetSignalingChannelEndpoint API.
475
+ */
476
+ ResourceEndpoint?: ResourceEndpoint;
477
+ }
235
478
  export type ResourceTags = {[key: string]: TagValue};
479
+ export interface SingleMasterChannelEndpointConfiguration {
480
+ /**
481
+ * This property is used to determine the nature of communication over this SINGLE_MASTER signaling channel. If WSS is specified, this API returns a websocket endpoint. If HTTPS is specified, this API returns an HTTPS endpoint.
482
+ */
483
+ Protocols?: ListOfProtocols;
484
+ /**
485
+ * This property is used to determine messaging permissions in this SINGLE_MASTER signaling channel. If MASTER is specified, this API returns an endpoint that a client can use to receive offers from and send answers to any of the viewers on this signaling channel. If VIEWER is specified, this API returns an endpoint that a client can use only to send offers to another MASTER client on this signaling channel.
486
+ */
487
+ Role?: ChannelRole;
488
+ }
489
+ export interface SingleMasterConfiguration {
490
+ /**
491
+ * The period of time a signaling channel retains underlivered messages before they are discarded.
492
+ */
493
+ MessageTtlSeconds?: MessageTtlSeconds;
494
+ }
236
495
  export type Status = "CREATING"|"ACTIVE"|"UPDATING"|"DELETING"|string;
237
496
  export interface StreamInfo {
238
497
  /**
@@ -284,8 +543,32 @@ declare namespace KinesisVideo {
284
543
  */
285
544
  ComparisonValue?: StreamName;
286
545
  }
546
+ export interface Tag {
547
+ /**
548
+ * The key of the tag that is associated with the specified signaling channel.
549
+ */
550
+ Key: TagKey;
551
+ /**
552
+ * The value of the tag that is associated with the specified signaling channel.
553
+ */
554
+ Value: TagValue;
555
+ }
287
556
  export type TagKey = string;
288
557
  export type TagKeyList = TagKey[];
558
+ export type TagList = Tag[];
559
+ export type TagOnCreateList = Tag[];
560
+ export interface TagResourceInput {
561
+ /**
562
+ * The ARN of the signaling channel to which you want to add tags.
563
+ */
564
+ ResourceARN: ResourceARN;
565
+ /**
566
+ * A list of tags to associate with the specified signaling channel. Each tag is a key-value pair.
567
+ */
568
+ Tags: TagList;
569
+ }
570
+ export interface TagResourceOutput {
571
+ }
289
572
  export interface TagStreamInput {
290
573
  /**
291
574
  * The Amazon Resource Name (ARN) of the resource that you want to add the tag or tags to.
@@ -304,6 +587,18 @@ declare namespace KinesisVideo {
304
587
  }
305
588
  export type TagValue = string;
306
589
  export type Timestamp = Date;
590
+ export interface UntagResourceInput {
591
+ /**
592
+ * The ARN of the signaling channel from which you want to remove tags.
593
+ */
594
+ ResourceARN: ResourceARN;
595
+ /**
596
+ * A list of the keys of the tags that you want to remove.
597
+ */
598
+ TagKeyList: TagKeyList;
599
+ }
600
+ export interface UntagResourceOutput {
601
+ }
307
602
  export interface UntagStreamInput {
308
603
  /**
309
604
  * The Amazon Resource Name (ARN) of the stream that you want to remove tags from.
@@ -345,6 +640,22 @@ declare namespace KinesisVideo {
345
640
  export type UpdateDataRetentionOperation = "INCREASE_DATA_RETENTION"|"DECREASE_DATA_RETENTION"|string;
346
641
  export interface UpdateDataRetentionOutput {
347
642
  }
643
+ export interface UpdateSignalingChannelInput {
644
+ /**
645
+ * The ARN of the signaling channel that you want to update.
646
+ */
647
+ ChannelARN: ResourceARN;
648
+ /**
649
+ * The current version of the signaling channel that you want to update.
650
+ */
651
+ CurrentVersion: Version;
652
+ /**
653
+ * The structure containing the configuration for the SINGLE_MASTER type of the signaling channel that you want to update.
654
+ */
655
+ SingleMasterConfiguration?: SingleMasterConfiguration;
656
+ }
657
+ export interface UpdateSignalingChannelOutput {
658
+ }
348
659
  export interface UpdateStreamInput {
349
660
  /**
350
661
  * The name of the stream whose metadata you want to update. The stream name is an identifier for the stream, and must be unique for each account and region.
@@ -0,0 +1,121 @@
1
+ import {Request} from '../lib/request';
2
+ import {Response} from '../lib/response';
3
+ import {AWSError} from '../lib/error';
4
+ import {Service} from '../lib/service';
5
+ import {ServiceConfigurationOptions} from '../lib/service';
6
+ import {ConfigBase as Config} from '../lib/config';
7
+ interface Blob {}
8
+ declare class KinesisVideoSignalingChannels extends Service {
9
+ /**
10
+ * Constructs a service object. This object has one method for each API operation.
11
+ */
12
+ constructor(options?: KinesisVideoSignalingChannels.Types.ClientConfiguration)
13
+ config: Config & KinesisVideoSignalingChannels.Types.ClientConfiguration;
14
+ /**
15
+ * Gets the Interactive Connectivity Establishment (ICE) server configuration information, including URIs, username, and password which can be used to configure the WebRTC connection. The ICE component uses this configuration information to setup the WebRTC connection, including authenticating with the Traversal Using Relays around NAT (TURN) relay server. TURN is a protocol that is used to improve the connectivity of peer-to-peer applications. By providing a cloud-based relay service, TURN ensures that a connection can be established even when one or more peers are incapable of a direct peer-to-peer connection. For more information, see A REST API For Access To TURN Services. You can invoke this API to establish a fallback mechanism in case either of the peers is unable to establish a direct peer-to-peer connection over a signaling channel. You must specify either a signaling channel ARN or the client ID in order to invoke this API.
16
+ */
17
+ getIceServerConfig(params: KinesisVideoSignalingChannels.Types.GetIceServerConfigRequest, callback?: (err: AWSError, data: KinesisVideoSignalingChannels.Types.GetIceServerConfigResponse) => void): Request<KinesisVideoSignalingChannels.Types.GetIceServerConfigResponse, AWSError>;
18
+ /**
19
+ * Gets the Interactive Connectivity Establishment (ICE) server configuration information, including URIs, username, and password which can be used to configure the WebRTC connection. The ICE component uses this configuration information to setup the WebRTC connection, including authenticating with the Traversal Using Relays around NAT (TURN) relay server. TURN is a protocol that is used to improve the connectivity of peer-to-peer applications. By providing a cloud-based relay service, TURN ensures that a connection can be established even when one or more peers are incapable of a direct peer-to-peer connection. For more information, see A REST API For Access To TURN Services. You can invoke this API to establish a fallback mechanism in case either of the peers is unable to establish a direct peer-to-peer connection over a signaling channel. You must specify either a signaling channel ARN or the client ID in order to invoke this API.
20
+ */
21
+ getIceServerConfig(callback?: (err: AWSError, data: KinesisVideoSignalingChannels.Types.GetIceServerConfigResponse) => void): Request<KinesisVideoSignalingChannels.Types.GetIceServerConfigResponse, AWSError>;
22
+ /**
23
+ * This API allows you to connect WebRTC-enabled devices with Alexa display devices. When invoked, it sends the Alexa Session Description Protocol (SDP) offer to the master peer. The offer is delivered as soon as the master is connected to the specified signaling channel. This API returns the SDP answer from the connected master. If the master is not connected to the signaling channel, redelivery requests are made until the message expires.
24
+ */
25
+ sendAlexaOfferToMaster(params: KinesisVideoSignalingChannels.Types.SendAlexaOfferToMasterRequest, callback?: (err: AWSError, data: KinesisVideoSignalingChannels.Types.SendAlexaOfferToMasterResponse) => void): Request<KinesisVideoSignalingChannels.Types.SendAlexaOfferToMasterResponse, AWSError>;
26
+ /**
27
+ * This API allows you to connect WebRTC-enabled devices with Alexa display devices. When invoked, it sends the Alexa Session Description Protocol (SDP) offer to the master peer. The offer is delivered as soon as the master is connected to the specified signaling channel. This API returns the SDP answer from the connected master. If the master is not connected to the signaling channel, redelivery requests are made until the message expires.
28
+ */
29
+ sendAlexaOfferToMaster(callback?: (err: AWSError, data: KinesisVideoSignalingChannels.Types.SendAlexaOfferToMasterResponse) => void): Request<KinesisVideoSignalingChannels.Types.SendAlexaOfferToMasterResponse, AWSError>;
30
+ }
31
+ declare namespace KinesisVideoSignalingChannels {
32
+ export type Answer = string;
33
+ export type ClientId = string;
34
+ export interface GetIceServerConfigRequest {
35
+ /**
36
+ * The ARN of the signaling channel to be used for the peer-to-peer connection between configured peers.
37
+ */
38
+ ChannelARN: ResourceARN;
39
+ /**
40
+ * Unique identifier for the viewer. Must be unique within the signaling channel.
41
+ */
42
+ ClientId?: ClientId;
43
+ /**
44
+ * Specifies the desired service. Currently, TURN is the only valid value.
45
+ */
46
+ Service?: Service;
47
+ /**
48
+ * An optional user ID to be associated with the credentials.
49
+ */
50
+ Username?: Username;
51
+ }
52
+ export interface GetIceServerConfigResponse {
53
+ /**
54
+ * The list of ICE server information objects.
55
+ */
56
+ IceServerList?: IceServerList;
57
+ }
58
+ export interface IceServer {
59
+ /**
60
+ * An array of URIs, in the form specified in the I-D.petithuguenin-behave-turn-uris spec. These URIs provide the different addresses and/or protocols that can be used to reach the TURN server.
61
+ */
62
+ Uris?: Uris;
63
+ /**
64
+ * A username to login to the ICE server.
65
+ */
66
+ Username?: Username;
67
+ /**
68
+ * A password to login to the ICE server.
69
+ */
70
+ Password?: Password;
71
+ /**
72
+ * The period of time, in seconds, during which the username and password are valid.
73
+ */
74
+ Ttl?: Ttl;
75
+ }
76
+ export type IceServerList = IceServer[];
77
+ export type MessagePayload = string;
78
+ export type Password = string;
79
+ export type ResourceARN = string;
80
+ export interface SendAlexaOfferToMasterRequest {
81
+ /**
82
+ * The ARN of the signaling channel by which Alexa and the master peer communicate.
83
+ */
84
+ ChannelARN: ResourceARN;
85
+ /**
86
+ * The unique identifier for the sender client.
87
+ */
88
+ SenderClientId: ClientId;
89
+ /**
90
+ * The base64-encoded SDP offer content.
91
+ */
92
+ MessagePayload: MessagePayload;
93
+ }
94
+ export interface SendAlexaOfferToMasterResponse {
95
+ /**
96
+ * The base64-encoded SDP answer content.
97
+ */
98
+ Answer?: Answer;
99
+ }
100
+ export type Service = "TURN"|string;
101
+ export type Ttl = number;
102
+ export type Uri = string;
103
+ export type Uris = Uri[];
104
+ export type Username = string;
105
+ /**
106
+ * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
107
+ */
108
+ export type apiVersion = "2019-12-04"|"latest"|string;
109
+ export interface ClientApiVersions {
110
+ /**
111
+ * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
112
+ */
113
+ apiVersion?: apiVersion;
114
+ }
115
+ export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
116
+ /**
117
+ * Contains interfaces for use with the KinesisVideoSignalingChannels client.
118
+ */
119
+ export import Types = KinesisVideoSignalingChannels;
120
+ }
121
+ export = KinesisVideoSignalingChannels;
@@ -0,0 +1,18 @@
1
+ require('../lib/node_loader');
2
+ var AWS = require('../lib/core');
3
+ var Service = AWS.Service;
4
+ var apiLoader = AWS.apiLoader;
5
+
6
+ apiLoader.services['kinesisvideosignalingchannels'] = {};
7
+ AWS.KinesisVideoSignalingChannels = Service.defineService('kinesisvideosignalingchannels', ['2019-12-04']);
8
+ Object.defineProperty(apiLoader.services['kinesisvideosignalingchannels'], '2019-12-04', {
9
+ get: function get() {
10
+ var model = require('../apis/kinesis-video-signaling-2019-12-04.min.json');
11
+ model.paginators = require('../apis/kinesis-video-signaling-2019-12-04.paginators.json').pagination;
12
+ return model;
13
+ },
14
+ enumerable: true,
15
+ configurable: true
16
+ });
17
+
18
+ module.exports = AWS.KinesisVideoSignalingChannels;
package/clients/kms.d.ts CHANGED
@@ -372,11 +372,11 @@ declare class KMS extends Service {
372
372
  */
373
373
  updateKeyDescription(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
374
374
  /**
375
- * Verifies a digital signature that was generated by the Sign operation. This operation requires an asymmetric CMK with a KeyUsage value of SIGN_VERIFY. Verification confirms that an authorized user signed the message with the specified key and signing algorithm, and the message hasn't changed since it was signed. A digital signature is generated by using the private key in an asymmetric CMK. The signature is verified by using the public key in the same asymmetric CMK. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide. To verify a digital signature, you can use the Verify operation. Specify the same asymmetric CMK that was used by the Sign operation to generate the digital signature. You can also verify the digital signature by using the public key of the CMK outside of AWS KMS. Use the GetPublicKey operation to download the public key in the asymmetric CMK and then use the public key to verify the signature outside of AWS KMS. The advantage of using the Verify operation is that it is performed within AWS KMS. As a result, it's easy to call, the operation is performed within the FIPS boundary, it is logged in AWS CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use the CMK to verify signatures. The result of the Verify operation, which is represented by its HTTP status code, does not indicate whether the signature verification succeeded or failed. To determine whether the signature was verified, see the SignatureValid field in the response. The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
375
+ * Verifies a digital signature that was generated by the Sign operation. Verification confirms that an authorized user signed the message with the specified CMK and signing algorithm, and the message hasn't changed since it was signed. If the signature is verified, the value of the SignatureValid field in the response is True. If the signature verification fails, the Verify operation fails with an KMSInvalidSignatureException exception. A digital signature is generated by using the private key in an asymmetric CMK. The signature is verified by using the public key in the same asymmetric CMK. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide. To verify a digital signature, you can use the Verify operation. Specify the same asymmetric CMK, message, and signing algorithm that were used to produce the signature. You can also verify the digital signature by using the public key of the CMK outside of AWS KMS. Use the GetPublicKey operation to download the public key in the asymmetric CMK and then use the public key to verify the signature outside of AWS KMS. The advantage of using the Verify operation is that it is performed within AWS KMS. As a result, it's easy to call, the operation is performed within the FIPS boundary, it is logged in AWS CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use the CMK to verify signatures. The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
376
376
  */
377
377
  verify(params: KMS.Types.VerifyRequest, callback?: (err: AWSError, data: KMS.Types.VerifyResponse) => void): Request<KMS.Types.VerifyResponse, AWSError>;
378
378
  /**
379
- * Verifies a digital signature that was generated by the Sign operation. This operation requires an asymmetric CMK with a KeyUsage value of SIGN_VERIFY. Verification confirms that an authorized user signed the message with the specified key and signing algorithm, and the message hasn't changed since it was signed. A digital signature is generated by using the private key in an asymmetric CMK. The signature is verified by using the public key in the same asymmetric CMK. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide. To verify a digital signature, you can use the Verify operation. Specify the same asymmetric CMK that was used by the Sign operation to generate the digital signature. You can also verify the digital signature by using the public key of the CMK outside of AWS KMS. Use the GetPublicKey operation to download the public key in the asymmetric CMK and then use the public key to verify the signature outside of AWS KMS. The advantage of using the Verify operation is that it is performed within AWS KMS. As a result, it's easy to call, the operation is performed within the FIPS boundary, it is logged in AWS CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use the CMK to verify signatures. The result of the Verify operation, which is represented by its HTTP status code, does not indicate whether the signature verification succeeded or failed. To determine whether the signature was verified, see the SignatureValid field in the response. The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
379
+ * Verifies a digital signature that was generated by the Sign operation. Verification confirms that an authorized user signed the message with the specified CMK and signing algorithm, and the message hasn't changed since it was signed. If the signature is verified, the value of the SignatureValid field in the response is True. If the signature verification fails, the Verify operation fails with an KMSInvalidSignatureException exception. A digital signature is generated by using the private key in an asymmetric CMK. The signature is verified by using the public key in the same asymmetric CMK. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide. To verify a digital signature, you can use the Verify operation. Specify the same asymmetric CMK, message, and signing algorithm that were used to produce the signature. You can also verify the digital signature by using the public key of the CMK outside of AWS KMS. Use the GetPublicKey operation to download the public key in the asymmetric CMK and then use the public key to verify the signature outside of AWS KMS. The advantage of using the Verify operation is that it is performed within AWS KMS. As a result, it's easy to call, the operation is performed within the FIPS boundary, it is logged in AWS CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use the CMK to verify signatures. The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
380
380
  */
381
381
  verify(callback?: (err: AWSError, data: KMS.Types.VerifyResponse) => void): Request<KMS.Types.VerifyResponse, AWSError>;
382
382
  }
@@ -1575,11 +1575,11 @@ declare namespace KMS {
1575
1575
  }
1576
1576
  export interface VerifyRequest {
1577
1577
  /**
1578
- * Identifies the asymmetric CMK that will be used to verify the signature. This must be the same CMK that was used to generate the signature. If you specify a different CMK, the value of the SignatureValid field in the response will be False. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name: alias/ExampleAlias Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
1578
+ * Identifies the asymmetric CMK that will be used to verify the signature. This must be the same CMK that was used to generate the signature. If you specify a different CMK, the signature verification fails. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name: alias/ExampleAlias Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
1579
1579
  */
1580
1580
  KeyId: KeyIdType;
1581
1581
  /**
1582
- * Specifies the message that was signed, or a hash digest of that message. Messages can be 0-4096 bytes. To verify a larger message, provide a hash digest of the message. If the digest of the message specified here is different from the message digest that was signed, the SignatureValid value in the response will be False.
1582
+ * Specifies the message that was signed, or a hash digest of that message. Messages can be 0-4096 bytes. To verify a larger message, provide a hash digest of the message. If the digest of the message specified here is different from the message digest that was signed, the signature verification fails.
1583
1583
  */
1584
1584
  Message: PlaintextType;
1585
1585
  /**
@@ -1591,7 +1591,7 @@ declare namespace KMS {
1591
1591
  */
1592
1592
  Signature: CiphertextType;
1593
1593
  /**
1594
- * The signing algorithm that was used to sign the message. If you submit a different algorithm, the value of the SignatureValid field in the response will be False.
1594
+ * The signing algorithm that was used to sign the message. If you submit a different algorithm, the signature verification fails.
1595
1595
  */
1596
1596
  SigningAlgorithm: SigningAlgorithmSpec;
1597
1597
  /**
@@ -1605,7 +1605,7 @@ declare namespace KMS {
1605
1605
  */
1606
1606
  KeyId?: KeyIdType;
1607
1607
  /**
1608
- * A Boolean value that indicates whether the signature was verified. A value of True indicates that the Signature was produced by signing the Message with the specified KeyID and SigningAlgorithm. A value of False indicates that the message, the algorithm, or the key changed since the message was signed.
1608
+ * A Boolean value that indicates whether the signature was verified. A value of True indicates that the Signature was produced by signing the Message with the specified KeyID and SigningAlgorithm. If the signature is not verified, the Verify operation fails with a KMSInvalidSignatureException exception.
1609
1609
  */
1610
1610
  SignatureValid?: BooleanType;
1611
1611
  /**