@pgarbe/cdk-ecr-sync 0.5.27 → 0.5.28
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.
- package/.jsii +4 -4
- package/.projenrc.ts +5 -0
- package/CHANGELOG.md +1 -1
- package/lib/ecr-sync.d.ts +1 -0
- package/lib/ecr-sync.d.ts.map +1 -0
- package/lib/ecr-sync.js +1 -1
- package/lib/image.d.ts +1 -0
- package/lib/image.d.ts.map +1 -0
- package/lib/index.d.ts +1 -0
- package/lib/index.d.ts.map +1 -0
- package/lib/lambda/docker-adapter.d.ts +1 -0
- package/lib/lambda/docker-adapter.d.ts.map +1 -0
- package/lib/lambda/ecr-adapter.d.ts +1 -0
- package/lib/lambda/ecr-adapter.d.ts.map +1 -0
- package/lib/lambda/get-image-tags-handler.d.ts +1 -0
- package/lib/lambda/get-image-tags-handler.d.ts.map +1 -0
- package/node_modules/aws-sdk/CHANGELOG.md +101 -1
- package/node_modules/aws-sdk/README.md +1 -1
- package/node_modules/aws-sdk/apis/backup-2018-11-15.min.json +30 -0
- package/node_modules/aws-sdk/apis/backup-2018-11-15.paginators.json +22 -11
- package/node_modules/aws-sdk/apis/braket-2019-09-01.min.json +30 -27
- package/node_modules/aws-sdk/apis/chime-sdk-media-pipelines-2021-07-15.examples.json +5 -0
- package/node_modules/aws-sdk/apis/chime-sdk-media-pipelines-2021-07-15.min.json +330 -0
- package/node_modules/aws-sdk/apis/chime-sdk-media-pipelines-2021-07-15.paginators.json +9 -0
- package/node_modules/aws-sdk/apis/cloudcontrol-2021-09-30.paginators.json +4 -2
- package/node_modules/aws-sdk/apis/cloudcontrol-2021-09-30.waiters2.json +23 -27
- package/node_modules/aws-sdk/apis/cloudfront-2020-05-31.min.json +42 -28
- package/node_modules/aws-sdk/apis/cloudtrail-2013-11-01.min.json +19 -2
- package/node_modules/aws-sdk/apis/codeguru-reviewer-2019-09-19.min.json +15 -8
- package/node_modules/aws-sdk/apis/connect-2017-08-08.min.json +162 -9
- package/node_modules/aws-sdk/apis/connect-2017-08-08.paginators.json +9 -0
- package/node_modules/aws-sdk/apis/datasync-2018-11-09.min.json +20 -19
- package/node_modules/aws-sdk/apis/discovery-2015-11-01.min.json +67 -32
- package/node_modules/aws-sdk/apis/ec2-2016-11-15.min.json +971 -853
- package/node_modules/aws-sdk/apis/ec2-2016-11-15.waiters2.json +18 -0
- package/node_modules/aws-sdk/apis/elasticmapreduce-2009-03-31.min.json +47 -35
- package/node_modules/aws-sdk/apis/evidently-2021-02-01.min.json +1 -0
- package/node_modules/aws-sdk/apis/glue-2017-03-31.min.json +1858 -495
- package/node_modules/aws-sdk/apis/grafana-2020-08-18.min.json +92 -15
- package/node_modules/aws-sdk/apis/iot-2015-05-28.min.json +74 -68
- package/node_modules/aws-sdk/apis/iotsecuretunneling-2018-10-05.min.json +28 -0
- package/node_modules/aws-sdk/apis/iotwireless-2020-11-22.min.json +401 -80
- package/node_modules/aws-sdk/apis/iotwireless-2020-11-22.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/ivschat-2020-07-14.examples.json +5 -0
- package/node_modules/aws-sdk/apis/ivschat-2020-07-14.min.json +443 -0
- package/node_modules/aws-sdk/apis/ivschat-2020-07-14.paginators.json +9 -0
- package/node_modules/aws-sdk/apis/kendra-2019-02-03.min.json +153 -84
- package/node_modules/aws-sdk/apis/kendra-2019-02-03.paginators.json +20 -0
- package/node_modules/aws-sdk/apis/kinesis-video-archived-media-2017-09-30.min.json +64 -0
- package/node_modules/aws-sdk/apis/kinesis-video-archived-media-2017-09-30.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/kinesisvideo-2017-09-30.min.json +145 -8
- package/node_modules/aws-sdk/apis/lightsail-2016-11-28.min.json +59 -18
- package/node_modules/aws-sdk/apis/location-2020-11-19.min.json +17 -12
- package/node_modules/aws-sdk/apis/location-2020-11-19.paginators.json +1 -0
- package/node_modules/aws-sdk/apis/lookoutequipment-2020-12-15.min.json +274 -12
- package/node_modules/aws-sdk/apis/lookoutequipment-2020-12-15.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/mediaconvert-2017-08-29.min.json +136 -120
- package/node_modules/aws-sdk/apis/metadata.json +7 -0
- package/node_modules/aws-sdk/apis/mq-2017-11-27.min.json +22 -7
- package/node_modules/aws-sdk/apis/network-firewall-2020-11-12.min.json +139 -53
- package/node_modules/aws-sdk/apis/outposts-2019-12-03.min.json +56 -0
- package/node_modules/aws-sdk/apis/outposts-2019-12-03.paginators.json +10 -0
- package/node_modules/aws-sdk/apis/rds-2014-10-31.min.json +20 -7
- package/node_modules/aws-sdk/apis/rds-data-2018-08-01.min.json +4 -1
- package/node_modules/aws-sdk/apis/redshift-2012-12-01.min.json +2 -1
- package/node_modules/aws-sdk/apis/rekognition-2016-06-27.min.json +247 -111
- package/node_modules/aws-sdk/apis/resiliencehub-2020-04-30.min.json +125 -74
- package/node_modules/aws-sdk/apis/s3-2006-03-01.examples.json +124 -124
- package/node_modules/aws-sdk/apis/sagemaker-2017-07-24.min.json +722 -689
- package/node_modules/aws-sdk/apis/secretsmanager-2017-10-17.examples.json +3 -3
- package/node_modules/aws-sdk/apis/securityhub-2018-10-26.min.json +20 -18
- package/node_modules/aws-sdk/apis/ssm-2014-11-06.min.json +160 -139
- package/node_modules/aws-sdk/apis/ssm-contacts-2021-05-03.examples.json +1 -1
- package/node_modules/aws-sdk/apis/ssm-incidents-2018-05-10.min.json +48 -37
- package/node_modules/aws-sdk/apis/synthetics-2017-10-11.min.json +8 -3
- package/node_modules/aws-sdk/apis/wafv2-2019-07-29.min.json +196 -130
- package/node_modules/aws-sdk/apis/workspaces-web-2020-07-08.min.json +107 -36
- package/node_modules/aws-sdk/clients/all.d.ts +2 -0
- package/node_modules/aws-sdk/clients/all.js +3 -1
- package/node_modules/aws-sdk/clients/amplify.d.ts +5 -5
- package/node_modules/aws-sdk/clients/auditmanager.d.ts +4 -4
- package/node_modules/aws-sdk/clients/backup.d.ts +25 -1
- package/node_modules/aws-sdk/clients/braket.d.ts +7 -2
- package/node_modules/aws-sdk/clients/chimesdkmediapipelines.d.ts +348 -0
- package/node_modules/aws-sdk/clients/chimesdkmediapipelines.js +18 -0
- package/node_modules/aws-sdk/clients/cloudcontrol.d.ts +3 -3
- package/node_modules/aws-sdk/clients/cloudfront.d.ts +15 -0
- package/node_modules/aws-sdk/clients/cloudtrail.d.ts +17 -17
- package/node_modules/aws-sdk/clients/codegurureviewer.d.ts +18 -5
- package/node_modules/aws-sdk/clients/computeoptimizer.d.ts +3 -3
- package/node_modules/aws-sdk/clients/connect.d.ts +200 -9
- package/node_modules/aws-sdk/clients/datasync.d.ts +7 -2
- package/node_modules/aws-sdk/clients/discovery.d.ts +63 -26
- package/node_modules/aws-sdk/clients/ec2.d.ts +202 -42
- package/node_modules/aws-sdk/clients/eks.d.ts +13 -13
- package/node_modules/aws-sdk/clients/emr.d.ts +24 -0
- package/node_modules/aws-sdk/clients/eventbridge.js +1 -0
- package/node_modules/aws-sdk/clients/evidently.d.ts +8 -4
- package/node_modules/aws-sdk/clients/gamelift.d.ts +67 -67
- package/node_modules/aws-sdk/clients/glue.d.ts +2082 -217
- package/node_modules/aws-sdk/clients/grafana.d.ts +72 -1
- package/node_modules/aws-sdk/clients/guardduty.d.ts +6 -3
- package/node_modules/aws-sdk/clients/iot.d.ts +12 -9
- package/node_modules/aws-sdk/clients/iotsecuretunneling.d.ts +52 -18
- package/node_modules/aws-sdk/clients/iotwireless.d.ts +356 -25
- package/node_modules/aws-sdk/clients/ivschat.d.ts +523 -0
- package/node_modules/aws-sdk/clients/ivschat.js +18 -0
- package/node_modules/aws-sdk/clients/kendra.d.ts +99 -14
- package/node_modules/aws-sdk/clients/kinesisvideo.d.ts +177 -10
- package/node_modules/aws-sdk/clients/kinesisvideoarchivedmedia.d.ts +94 -0
- package/node_modules/aws-sdk/clients/kms.d.ts +22 -22
- package/node_modules/aws-sdk/clients/lambda.d.ts +4 -4
- package/node_modules/aws-sdk/clients/lightsail.d.ts +122 -47
- package/node_modules/aws-sdk/clients/location.d.ts +20 -16
- package/node_modules/aws-sdk/clients/lookoutequipment.d.ts +295 -9
- package/node_modules/aws-sdk/clients/mediaconvert.d.ts +23 -2
- package/node_modules/aws-sdk/clients/mediapackage.d.ts +4 -4
- package/node_modules/aws-sdk/clients/mq.d.ts +16 -1
- package/node_modules/aws-sdk/clients/networkfirewall.d.ts +151 -21
- package/node_modules/aws-sdk/clients/organizations.d.ts +5 -5
- package/node_modules/aws-sdk/clients/outposts.d.ts +79 -22
- package/node_modules/aws-sdk/clients/pricing.d.ts +3 -3
- package/node_modules/aws-sdk/clients/rds.d.ts +37 -1
- package/node_modules/aws-sdk/clients/rdsdataservice.d.ts +22 -7
- package/node_modules/aws-sdk/clients/redshift.d.ts +16 -12
- package/node_modules/aws-sdk/clients/rekognition.d.ts +209 -53
- package/node_modules/aws-sdk/clients/resiliencehub.d.ts +138 -58
- package/node_modules/aws-sdk/clients/s3.d.ts +8 -8
- package/node_modules/aws-sdk/clients/sagemaker.d.ts +224 -174
- package/node_modules/aws-sdk/clients/secretsmanager.d.ts +8 -8
- package/node_modules/aws-sdk/clients/securityhub.d.ts +15 -6
- package/node_modules/aws-sdk/clients/servicecatalog.d.ts +4 -4
- package/node_modules/aws-sdk/clients/ssm.d.ts +29 -1
- package/node_modules/aws-sdk/clients/ssmcontacts.d.ts +2 -2
- package/node_modules/aws-sdk/clients/ssmincidents.d.ts +19 -6
- package/node_modules/aws-sdk/clients/sts.d.ts +2 -2
- package/node_modules/aws-sdk/clients/synthetics.d.ts +7 -3
- package/node_modules/aws-sdk/clients/transfer.d.ts +2 -2
- package/node_modules/aws-sdk/clients/wafv2.d.ts +104 -27
- package/node_modules/aws-sdk/clients/workspacesweb.d.ts +38 -4
- package/node_modules/aws-sdk/dist/aws-sdk-core-react-native.js +2 -2
- package/node_modules/aws-sdk/dist/aws-sdk-react-native.js +897 -792
- package/node_modules/aws-sdk/dist/aws-sdk.js +2020 -1277
- package/node_modules/aws-sdk/dist/aws-sdk.min.js +84 -83
- package/node_modules/aws-sdk/lib/config_service_placeholders.d.ts +4 -0
- package/node_modules/aws-sdk/lib/core.js +1 -1
- package/node_modules/aws-sdk/lib/services/eventbridge.js +19 -0
- package/node_modules/aws-sdk/lib/services/s3util.js +6 -1
- package/node_modules/aws-sdk/package.json +1 -1
- package/package.json +14 -11
- package/releasetag.txt +1 -1
- package/version.txt +1 -1
|
@@ -36,6 +36,14 @@ declare class KinesisVideoArchivedMedia extends Service {
|
|
|
36
36
|
* Retrieves an HTTP Live Streaming (HLS) URL for the stream. You can then open the URL in a browser or media player to view the stream contents. Both the StreamName and the StreamARN parameters are optional, but you must specify either the StreamName or the StreamARN when invoking this API operation. An Amazon Kinesis video stream has the following requirements for providing data through HLS: The media must contain h.264 or h.265 encoded video and, optionally, AAC encoded audio. Specifically, the codec ID of track 1 should be V_MPEG/ISO/AVC (for h.264) or V_MPEG/ISO/HEVC (for h.265). Optionally, the codec ID of track 2 should be A_AAC. Data retention must be greater than 0. The video track of each fragment must contain codec private data in the Advanced Video Coding (AVC) for H.264 format or HEVC for H.265 format (MPEG-4 specification ISO/IEC 14496-15). For information about adapting stream data to a given format, see NAL Adaptation Flags. The audio track (if present) of each fragment must contain codec private data in the AAC format (AAC specification ISO/IEC 13818-7). Kinesis Video Streams HLS sessions contain fragments in the fragmented MPEG-4 form (also called fMP4 or CMAF) or the MPEG-2 form (also called TS chunks, which the HLS specification also supports). For more information about HLS fragment types, see the HLS specification. The following procedure shows how to use HLS with Kinesis Video Streams: Get an endpoint using GetDataEndpoint, specifying GET_HLS_STREAMING_SESSION_URL for the APIName parameter. Retrieve the HLS URL using GetHLSStreamingSessionURL. Kinesis Video Streams creates an HLS streaming session to be used for accessing content in a stream using the HLS protocol. GetHLSStreamingSessionURL returns an authenticated URL (that includes an encrypted session token) for the session's HLS master playlist (the root resource needed for streaming with HLS). Don't share or store this token where an unauthorized entity could access it. The token provides access to the content of the stream. Safeguard the token with the same measures that you would use with your AWS credentials. The media that is made available through the playlist consists only of the requested stream, time range, and format. No other media data (such as frames outside the requested window or alternate bitrates) is made available. Provide the URL (containing the encrypted session token) for the HLS master playlist to a media player that supports the HLS protocol. Kinesis Video Streams makes the HLS media playlist, initialization fragment, and media fragments available through the master playlist URL. The initialization fragment contains the codec private data for the stream, and other data needed to set up the video or audio decoder and renderer. The media fragments contain H.264-encoded video frames or AAC-encoded audio samples. The media player receives the authenticated URL and requests stream metadata and media data normally. When the media player requests data, it calls the following actions: GetHLSMasterPlaylist: Retrieves an HLS master playlist, which contains a URL for the GetHLSMediaPlaylist action for each track, and additional metadata for the media player, including estimated bitrate and resolution. GetHLSMediaPlaylist: Retrieves an HLS media playlist, which contains a URL to access the MP4 initialization fragment with the GetMP4InitFragment action, and URLs to access the MP4 media fragments with the GetMP4MediaFragment actions. The HLS media playlist also contains metadata about the stream that the player needs to play it, such as whether the PlaybackMode is LIVE or ON_DEMAND. The HLS media playlist is typically static for sessions with a PlaybackType of ON_DEMAND. The HLS media playlist is continually updated with new fragments for sessions with a PlaybackType of LIVE. There is a distinct HLS media playlist for the video track and the audio track (if applicable) that contains MP4 media URLs for the specific track. GetMP4InitFragment: Retrieves the MP4 initialization fragment. The media player typically loads the initialization fragment before loading any media fragments. This fragment contains the "fytp" and "moov" MP4 atoms, and the child atoms that are needed to initialize the media player decoder. The initialization fragment does not correspond to a fragment in a Kinesis video stream. It contains only the codec private data for the stream and respective track, which the media player needs to decode the media frames. GetMP4MediaFragment: Retrieves MP4 media fragments. These fragments contain the "moof" and "mdat" MP4 atoms and their child atoms, containing the encoded fragment's media frames and their timestamps. After the first media fragment is made available in a streaming session, any fragments that don't contain the same codec private data cause an error to be returned when those different media fragments are loaded. Therefore, the codec private data should not change between fragments in a session. This also means that the session fails if the fragments in a stream change from having only video to having both audio and video. Data retrieved with this action is billable. See Pricing for details. GetTSFragment: Retrieves MPEG TS fragments containing both initialization and media data for all tracks in the stream. If the ContainerFormat is MPEG_TS, this API is used instead of GetMP4InitFragment and GetMP4MediaFragment to retrieve stream media. Data retrieved with this action is billable. For more information, see Kinesis Video Streams pricing. A streaming session URL must not be shared between players. The service might throttle a session if multiple media players are sharing it. For connection limits, see Kinesis Video Streams Limits. You can monitor the amount of data that the media player consumes by monitoring the GetMP4MediaFragment.OutgoingBytes Amazon CloudWatch metric. For information about using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams. For pricing information, see Amazon Kinesis Video Streams Pricing and AWS Pricing. Charges for both HLS sessions and outgoing AWS data apply. For more information about HLS, see HTTP Live Streaming on the Apple Developer site. If an error is thrown after invoking a Kinesis Video Streams archived media API, in addition to the HTTP status code and the response body, it includes the following pieces of information: x-amz-ErrorType HTTP header – contains a more specific error type in addition to what the HTTP status code provides. x-amz-RequestId HTTP header – if you want to report an issue to AWS, the support team can better diagnose the problem if given the Request Id. Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether errors are retry-able and under what conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again. For more information, see the Errors section at the bottom of this topic, as well as Common Errors.
|
|
37
37
|
*/
|
|
38
38
|
getHLSStreamingSessionURL(callback?: (err: AWSError, data: KinesisVideoArchivedMedia.Types.GetHLSStreamingSessionURLOutput) => void): Request<KinesisVideoArchivedMedia.Types.GetHLSStreamingSessionURLOutput, AWSError>;
|
|
39
|
+
/**
|
|
40
|
+
* Retrieves a list of Images corresponding to each timestamp for a given time range, sampling interval, and image format configuration.
|
|
41
|
+
*/
|
|
42
|
+
getImages(params: KinesisVideoArchivedMedia.Types.GetImagesInput, callback?: (err: AWSError, data: KinesisVideoArchivedMedia.Types.GetImagesOutput) => void): Request<KinesisVideoArchivedMedia.Types.GetImagesOutput, AWSError>;
|
|
43
|
+
/**
|
|
44
|
+
* Retrieves a list of Images corresponding to each timestamp for a given time range, sampling interval, and image format configuration.
|
|
45
|
+
*/
|
|
46
|
+
getImages(callback?: (err: AWSError, data: KinesisVideoArchivedMedia.Types.GetImagesOutput) => void): Request<KinesisVideoArchivedMedia.Types.GetImagesOutput, AWSError>;
|
|
39
47
|
/**
|
|
40
48
|
* Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis video stream. You must first call the GetDataEndpoint API to get an endpoint. Then send the GetMediaForFragmentList requests to this endpoint using the --endpoint-url parameter. For limits, see Kinesis Video Streams Limits. If an error is thrown after invoking a Kinesis Video Streams archived media API, in addition to the HTTP status code and the response body, it includes the following pieces of information: x-amz-ErrorType HTTP header – contains a more specific error type in addition to what the HTTP status code provides. x-amz-RequestId HTTP header – if you want to report an issue to AWS, the support team can better diagnose the problem if given the Request Id. Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether errors are retry-able and under what conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again. For more information, see the Errors section at the bottom of this topic, as well as Common Errors.
|
|
41
49
|
*/
|
|
@@ -104,6 +112,10 @@ declare namespace KinesisVideoArchivedMedia {
|
|
|
104
112
|
EndTimestamp?: Timestamp;
|
|
105
113
|
}
|
|
106
114
|
export type Expires = number;
|
|
115
|
+
export type Format = "JPEG"|"PNG"|string;
|
|
116
|
+
export type FormatConfig = {[key: string]: FormatConfigValue};
|
|
117
|
+
export type FormatConfigKey = "JPEGQuality"|string;
|
|
118
|
+
export type FormatConfigValue = string;
|
|
107
119
|
export interface Fragment {
|
|
108
120
|
/**
|
|
109
121
|
* The unique identifier of the fragment. This value monotonically increases based on the ingestion order.
|
|
@@ -248,6 +260,67 @@ declare namespace KinesisVideoArchivedMedia {
|
|
|
248
260
|
*/
|
|
249
261
|
HLSStreamingSessionURL?: HLSStreamingSessionURL;
|
|
250
262
|
}
|
|
263
|
+
export interface GetImagesInput {
|
|
264
|
+
/**
|
|
265
|
+
* The name of the stream from which to retrieve the images. You must specify either the StreamName or the StreamARN.
|
|
266
|
+
*/
|
|
267
|
+
StreamName?: StreamName;
|
|
268
|
+
/**
|
|
269
|
+
* The Amazon Resource Name (ARN) of the stream from which to retrieve the images. You must specify either the StreamName or the StreamARN.
|
|
270
|
+
*/
|
|
271
|
+
StreamARN?: ResourceARN;
|
|
272
|
+
/**
|
|
273
|
+
* The origin of the Server or Producer timestamps to use to generate the images.
|
|
274
|
+
*/
|
|
275
|
+
ImageSelectorType: ImageSelectorType;
|
|
276
|
+
/**
|
|
277
|
+
* The starting point from which the images should be generated. This StartTimestamp must be within an inclusive range of timestamps for an image to be returned.
|
|
278
|
+
*/
|
|
279
|
+
StartTimestamp: Timestamp;
|
|
280
|
+
/**
|
|
281
|
+
* The end timestamp for the range of images to be generated.
|
|
282
|
+
*/
|
|
283
|
+
EndTimestamp: Timestamp;
|
|
284
|
+
/**
|
|
285
|
+
* The time interval in milliseconds (ms) at which the images need to be generated from the stream. The minimum value that can be provided is 3000 ms. If the timestamp range is less than the sampling interval, the Image from the startTimestamp will be returned if available. The minimum value of 3000 ms is a soft limit. If needed, a lower sampling frequency can be requested.
|
|
286
|
+
*/
|
|
287
|
+
SamplingInterval: SamplingInterval;
|
|
288
|
+
/**
|
|
289
|
+
* The format that will be used to encode the image.
|
|
290
|
+
*/
|
|
291
|
+
Format: Format;
|
|
292
|
+
/**
|
|
293
|
+
* The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The FormatConfig key is the JPEGQuality, which indicates the JPEG quality key to be used to generate the image. The FormatConfig value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression. If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the JPEGQuality key will be set to 80.
|
|
294
|
+
*/
|
|
295
|
+
FormatConfig?: FormatConfig;
|
|
296
|
+
/**
|
|
297
|
+
* The width of the output image that is used in conjunction with the HeightPixels parameter. When both WidthPixels and HeightPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the WidthPixels parameter is provided or if only the HeightPixels is provided, a ValidationException will be thrown. If neither parameter is provided, the original image size from the stream will be returned.
|
|
298
|
+
*/
|
|
299
|
+
WidthPixels?: WidthPixels;
|
|
300
|
+
/**
|
|
301
|
+
* The height of the output image that is used in conjunction with the WidthPixels parameter. When both HeightPixels and WidthPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the HeightPixels parameter is provided, its original aspect ratio will be used to calculate the WidthPixels ratio. If neither parameter is provided, the original image size will be returned.
|
|
302
|
+
*/
|
|
303
|
+
HeightPixels?: HeightPixels;
|
|
304
|
+
/**
|
|
305
|
+
* The maximum number of images to be returned by the API. The default limit is 100 images per API response. The additional results will be paginated.
|
|
306
|
+
*/
|
|
307
|
+
MaxResults?: GetImagesMaxResults;
|
|
308
|
+
/**
|
|
309
|
+
* A token that specifies where to start paginating the next set of Images. This is the GetImages:NextToken from a previously truncated response.
|
|
310
|
+
*/
|
|
311
|
+
NextToken?: NextToken;
|
|
312
|
+
}
|
|
313
|
+
export type GetImagesMaxResults = number;
|
|
314
|
+
export interface GetImagesOutput {
|
|
315
|
+
/**
|
|
316
|
+
* The list of images generated from the video stream. If there is no media available for the given timestamp, the NO_MEDIA error will be listed in the output. If an error occurs while the image is being generated, the MEDIA_ERROR will be listed in the output as the cause of the missing image.
|
|
317
|
+
*/
|
|
318
|
+
Images?: Images;
|
|
319
|
+
/**
|
|
320
|
+
* The encrypted token that was used in the request to get more images.
|
|
321
|
+
*/
|
|
322
|
+
NextToken?: NextToken;
|
|
323
|
+
}
|
|
251
324
|
export interface GetMediaForFragmentListInput {
|
|
252
325
|
/**
|
|
253
326
|
* The name of the stream from which to retrieve fragment media. Specify either this parameter or the StreamARN parameter.
|
|
@@ -298,6 +371,25 @@ declare namespace KinesisVideoArchivedMedia {
|
|
|
298
371
|
*/
|
|
299
372
|
EndTimestamp?: Timestamp;
|
|
300
373
|
}
|
|
374
|
+
export type HeightPixels = number;
|
|
375
|
+
export interface Image {
|
|
376
|
+
/**
|
|
377
|
+
* An attribute of the Image object that is used to extract an image from the video stream. This field is used to manage gaps on images or to better understand the pagination window.
|
|
378
|
+
*/
|
|
379
|
+
TimeStamp?: Timestamp;
|
|
380
|
+
/**
|
|
381
|
+
* The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error. An error will be returned if: There is no media that exists for the specified Timestamp. The media for the specified time does not allow an image to be extracted. In this case the media is audio only, or the incorrect media has been ingested.
|
|
382
|
+
*/
|
|
383
|
+
Error?: ImageError;
|
|
384
|
+
/**
|
|
385
|
+
* An attribute of the Image object that is Base64 encoded.
|
|
386
|
+
*/
|
|
387
|
+
ImageContent?: ImageContent;
|
|
388
|
+
}
|
|
389
|
+
export type ImageContent = string;
|
|
390
|
+
export type ImageError = "NO_MEDIA"|"MEDIA_ERROR"|string;
|
|
391
|
+
export type ImageSelectorType = "PRODUCER_TIMESTAMP"|"SERVER_TIMESTAMP"|string;
|
|
392
|
+
export type Images = Image[];
|
|
301
393
|
export interface ListFragmentsInput {
|
|
302
394
|
/**
|
|
303
395
|
* The name of the stream from which to retrieve a fragment list. Specify either this parameter or the StreamARN parameter.
|
|
@@ -335,6 +427,7 @@ declare namespace KinesisVideoArchivedMedia {
|
|
|
335
427
|
export type NextToken = string;
|
|
336
428
|
export type Payload = Buffer|Uint8Array|Blob|string|Readable;
|
|
337
429
|
export type ResourceARN = string;
|
|
430
|
+
export type SamplingInterval = number;
|
|
338
431
|
export type StreamName = string;
|
|
339
432
|
export type Timestamp = Date;
|
|
340
433
|
export interface TimestampRange {
|
|
@@ -347,6 +440,7 @@ declare namespace KinesisVideoArchivedMedia {
|
|
|
347
440
|
*/
|
|
348
441
|
EndTimestamp: Timestamp;
|
|
349
442
|
}
|
|
443
|
+
export type WidthPixels = number;
|
|
350
444
|
/**
|
|
351
445
|
* 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.
|
|
352
446
|
*/
|
|
@@ -52,19 +52,19 @@ declare class KMS extends Service {
|
|
|
52
52
|
*/
|
|
53
53
|
createGrant(callback?: (err: AWSError, data: KMS.Types.CreateGrantResponse) => void): Request<KMS.Types.CreateGrantResponse, AWSError>;
|
|
54
54
|
/**
|
|
55
|
-
* Creates a unique customer managed KMS key in your Amazon Web Services account and Region.
|
|
55
|
+
* Creates a unique customer managed KMS key in your Amazon Web Services account and Region. In addition to the required parameters, you can use the optional parameters to specify a key policy, description, tags, and other useful elements for any key type. KMS is replacing the term customer master key (CMK) with KMS key and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term. To create different types of KMS keys, use the following guidance: Symmetric encryption KMS key To create a symmetric encryption KMS key, you aren't required to specify any parameters. The default value for KeySpec, SYMMETRIC_DEFAULT, and the default value for KeyUsage, ENCRYPT_DECRYPT, create a symmetric encryption KMS key. If you need a key for basic encryption and decryption or you are creating a KMS key to protect your resources in an Amazon Web Services service, create a symmetric encryption KMS key. The key material in a symmetric encryption key never leaves KMS unencrypted. You can use a symmetric encryption KMS key to encrypt and decrypt data up to 4,096 bytes, but they are typically used to generate data keys and data keys pairs. For details, see GenerateDataKey and GenerateDataKeyPair. Asymmetric KMS keys To create an asymmetric KMS key, use the KeySpec parameter to specify the type of key material in the KMS key. Then, use the KeyUsage parameter to determine whether the KMS key will be used to encrypt and decrypt or sign and verify. You can't change these properties after the KMS key is created. Asymmetric KMS keys contain an RSA key pair or an Elliptic Curve (ECC) key pair. The private key in an asymmetric KMS key never leaves KMS unencrypted. However, you can use the GetPublicKey operation to download the public key so it can be used outside of KMS. KMS keys with RSA key pairs can be used to encrypt or decrypt data or sign and verify messages (but not both). KMS keys with ECC key pairs can be used only to sign and verify messages. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide. HMAC KMS key To create an HMAC KMS key, set the KeySpec parameter to a key spec value for HMAC KMS keys. Then set the KeyUsage parameter to GENERATE_VERIFY_MAC. You must set the key usage even though GENERATE_VERIFY_MAC is the only valid key usage value for HMAC KMS keys. You can't change these properties after the KMS key is created. HMAC KMS keys are symmetric keys that never leave KMS unencrypted. You can use HMAC keys to generate (GenerateMac) and verify (VerifyMac) HMAC codes for messages up to 4096 bytes. HMAC KMS keys are not supported in all Amazon Web Services Regions. If you try to create an HMAC KMS key in an Amazon Web Services Region in which HMAC keys are not supported, the CreateKey operation returns an UnsupportedOperationException. For a list of Regions in which HMAC KMS keys are supported, see HMAC keys in KMS in the Key Management Service Developer Guide. Multi-Region primary keys Imported key material To create a multi-Region primary key in the local Amazon Web Services Region, use the MultiRegion parameter with a value of True. To create a multi-Region replica key, that is, a KMS key with the same key ID and key material as a primary key, but in a different Amazon Web Services Region, use the ReplicateKey operation. To change a replica key to a primary key, and its primary key to a replica key, use the UpdatePrimaryRegion operation. You can create multi-Region KMS keys for all supported KMS key types: symmetric encryption KMS keys, HMAC KMS keys, asymmetric encryption KMS keys, and asymmetric signing KMS keys. You can also create multi-Region keys with imported key material. However, you can't create multi-Region keys in a custom key store. This operation supports multi-Region keys, an KMS feature that lets you create multiple interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide. To import your own key material, begin by creating a symmetric encryption KMS key with no key material. To do this, use the Origin parameter of CreateKey with a value of EXTERNAL. Next, use GetParametersForImport operation to get a public key and import token, and use the public key to encrypt your key material. Then, use ImportKeyMaterial with your import token to import the key material. For step-by-step instructions, see Importing Key Material in the Key Management Service Developer Guide . This feature supports only symmetric encryption KMS keys, including multi-Region symmetric encryption KMS keys. You cannot import key material into any other type of KMS key. To create a multi-Region primary key with imported key material, use the Origin parameter of CreateKey with a value of EXTERNAL and the MultiRegion parameter with a value of True. To create replicas of the multi-Region primary key, use the ReplicateKey operation. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide. Custom key store To create a symmetric encryption KMS key in a custom key store, use the CustomKeyStoreId parameter to specify the custom key store. You must also use the Origin parameter with a value of AWS_CLOUDHSM. The CloudHSM cluster that is associated with the custom key store must have at least two active HSMs in different Availability Zones in the Amazon Web Services Region. Custom key stores support only symmetric encryption KMS keys. You cannot create an HMAC KMS key or an asymmetric KMS key in a custom key store. For information about custom key stores in KMS see Custom key stores in KMS in the Key Management Service Developer Guide . Cross-account use: No. You cannot use this operation to create a KMS key in a different Amazon Web Services account. Required permissions: kms:CreateKey (IAM policy). To use the Tags parameter, kms:TagResource (IAM policy). For examples and information about related permissions, see Allow a user to create KMS keys in the Key Management Service Developer Guide. Related operations: DescribeKey ListKeys ScheduleKeyDeletion
|
|
56
56
|
*/
|
|
57
57
|
createKey(params: KMS.Types.CreateKeyRequest, callback?: (err: AWSError, data: KMS.Types.CreateKeyResponse) => void): Request<KMS.Types.CreateKeyResponse, AWSError>;
|
|
58
58
|
/**
|
|
59
|
-
* Creates a unique customer managed KMS key in your Amazon Web Services account and Region.
|
|
59
|
+
* Creates a unique customer managed KMS key in your Amazon Web Services account and Region. In addition to the required parameters, you can use the optional parameters to specify a key policy, description, tags, and other useful elements for any key type. KMS is replacing the term customer master key (CMK) with KMS key and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term. To create different types of KMS keys, use the following guidance: Symmetric encryption KMS key To create a symmetric encryption KMS key, you aren't required to specify any parameters. The default value for KeySpec, SYMMETRIC_DEFAULT, and the default value for KeyUsage, ENCRYPT_DECRYPT, create a symmetric encryption KMS key. If you need a key for basic encryption and decryption or you are creating a KMS key to protect your resources in an Amazon Web Services service, create a symmetric encryption KMS key. The key material in a symmetric encryption key never leaves KMS unencrypted. You can use a symmetric encryption KMS key to encrypt and decrypt data up to 4,096 bytes, but they are typically used to generate data keys and data keys pairs. For details, see GenerateDataKey and GenerateDataKeyPair. Asymmetric KMS keys To create an asymmetric KMS key, use the KeySpec parameter to specify the type of key material in the KMS key. Then, use the KeyUsage parameter to determine whether the KMS key will be used to encrypt and decrypt or sign and verify. You can't change these properties after the KMS key is created. Asymmetric KMS keys contain an RSA key pair or an Elliptic Curve (ECC) key pair. The private key in an asymmetric KMS key never leaves KMS unencrypted. However, you can use the GetPublicKey operation to download the public key so it can be used outside of KMS. KMS keys with RSA key pairs can be used to encrypt or decrypt data or sign and verify messages (but not both). KMS keys with ECC key pairs can be used only to sign and verify messages. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide. HMAC KMS key To create an HMAC KMS key, set the KeySpec parameter to a key spec value for HMAC KMS keys. Then set the KeyUsage parameter to GENERATE_VERIFY_MAC. You must set the key usage even though GENERATE_VERIFY_MAC is the only valid key usage value for HMAC KMS keys. You can't change these properties after the KMS key is created. HMAC KMS keys are symmetric keys that never leave KMS unencrypted. You can use HMAC keys to generate (GenerateMac) and verify (VerifyMac) HMAC codes for messages up to 4096 bytes. HMAC KMS keys are not supported in all Amazon Web Services Regions. If you try to create an HMAC KMS key in an Amazon Web Services Region in which HMAC keys are not supported, the CreateKey operation returns an UnsupportedOperationException. For a list of Regions in which HMAC KMS keys are supported, see HMAC keys in KMS in the Key Management Service Developer Guide. Multi-Region primary keys Imported key material To create a multi-Region primary key in the local Amazon Web Services Region, use the MultiRegion parameter with a value of True. To create a multi-Region replica key, that is, a KMS key with the same key ID and key material as a primary key, but in a different Amazon Web Services Region, use the ReplicateKey operation. To change a replica key to a primary key, and its primary key to a replica key, use the UpdatePrimaryRegion operation. You can create multi-Region KMS keys for all supported KMS key types: symmetric encryption KMS keys, HMAC KMS keys, asymmetric encryption KMS keys, and asymmetric signing KMS keys. You can also create multi-Region keys with imported key material. However, you can't create multi-Region keys in a custom key store. This operation supports multi-Region keys, an KMS feature that lets you create multiple interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide. To import your own key material, begin by creating a symmetric encryption KMS key with no key material. To do this, use the Origin parameter of CreateKey with a value of EXTERNAL. Next, use GetParametersForImport operation to get a public key and import token, and use the public key to encrypt your key material. Then, use ImportKeyMaterial with your import token to import the key material. For step-by-step instructions, see Importing Key Material in the Key Management Service Developer Guide . This feature supports only symmetric encryption KMS keys, including multi-Region symmetric encryption KMS keys. You cannot import key material into any other type of KMS key. To create a multi-Region primary key with imported key material, use the Origin parameter of CreateKey with a value of EXTERNAL and the MultiRegion parameter with a value of True. To create replicas of the multi-Region primary key, use the ReplicateKey operation. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide. Custom key store To create a symmetric encryption KMS key in a custom key store, use the CustomKeyStoreId parameter to specify the custom key store. You must also use the Origin parameter with a value of AWS_CLOUDHSM. The CloudHSM cluster that is associated with the custom key store must have at least two active HSMs in different Availability Zones in the Amazon Web Services Region. Custom key stores support only symmetric encryption KMS keys. You cannot create an HMAC KMS key or an asymmetric KMS key in a custom key store. For information about custom key stores in KMS see Custom key stores in KMS in the Key Management Service Developer Guide . Cross-account use: No. You cannot use this operation to create a KMS key in a different Amazon Web Services account. Required permissions: kms:CreateKey (IAM policy). To use the Tags parameter, kms:TagResource (IAM policy). For examples and information about related permissions, see Allow a user to create KMS keys in the Key Management Service Developer Guide. Related operations: DescribeKey ListKeys ScheduleKeyDeletion
|
|
60
60
|
*/
|
|
61
61
|
createKey(callback?: (err: AWSError, data: KMS.Types.CreateKeyResponse) => void): Request<KMS.Types.CreateKeyResponse, AWSError>;
|
|
62
62
|
/**
|
|
63
|
-
* Decrypts ciphertext that was encrypted by a KMS key using any of the following operations: Encrypt GenerateDataKey GenerateDataKeyPair GenerateDataKeyWithoutPlaintext GenerateDataKeyPairWithoutPlaintext You can use this operation to decrypt ciphertext that was encrypted under a symmetric encryption KMS key or an asymmetric encryption KMS key. When the KMS key is asymmetric, you must specify the KMS key and the encryption algorithm that was used to encrypt the ciphertext. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide. The Decrypt operation also decrypts ciphertext that was encrypted outside of KMS by the public key in an KMS asymmetric KMS key. However, it cannot decrypt
|
|
63
|
+
* Decrypts ciphertext that was encrypted by a KMS key using any of the following operations: Encrypt GenerateDataKey GenerateDataKeyPair GenerateDataKeyWithoutPlaintext GenerateDataKeyPairWithoutPlaintext You can use this operation to decrypt ciphertext that was encrypted under a symmetric encryption KMS key or an asymmetric encryption KMS key. When the KMS key is asymmetric, you must specify the KMS key and the encryption algorithm that was used to encrypt the ciphertext. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide. The Decrypt operation also decrypts ciphertext that was encrypted outside of KMS by the public key in an KMS asymmetric KMS key. However, it cannot decrypt ciphertext produced by other libraries, such as the Amazon Web Services Encryption SDK or Amazon S3 client-side encryption. These libraries return a ciphertext format that is incompatible with KMS. If the ciphertext was encrypted under a symmetric encryption KMS key, the KeyId parameter is optional. KMS can get this information from metadata that it adds to the symmetric ciphertext blob. This feature adds durability to your implementation by ensuring that authorized users can decrypt ciphertext decades after it was encrypted, even if they've lost track of the key ID. However, specifying the KMS key is always recommended as a best practice. When you use the KeyId parameter to specify a KMS key, KMS only uses the KMS key you specify. If the ciphertext was encrypted under a different KMS key, the Decrypt operation fails. This practice ensures that you use the KMS key that you intend. Whenever possible, use key policies to give users permission to call the Decrypt operation on a particular KMS key, instead of using IAM policies. Otherwise, you might create an IAM user policy that gives the user Decrypt permission on all KMS keys. This user could decrypt ciphertext that was encrypted by KMS keys in other accounts if the key policy for the cross-account KMS key permits it. If you must use an IAM policy for Decrypt permissions, limit the user to particular KMS keys or particular trusted accounts. For details, see Best practices for IAM policies in the Key Management Service Developer Guide. Applications in Amazon Web Services Nitro Enclaves can call this operation by using the Amazon Web Services Nitro Enclaves Development Kit. For information about the supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS in the Key Management Service Developer Guide. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter. Required permissions: kms:Decrypt (key policy) Related operations: Encrypt GenerateDataKey GenerateDataKeyPair ReEncrypt
|
|
64
64
|
*/
|
|
65
65
|
decrypt(params: KMS.Types.DecryptRequest, callback?: (err: AWSError, data: KMS.Types.DecryptResponse) => void): Request<KMS.Types.DecryptResponse, AWSError>;
|
|
66
66
|
/**
|
|
67
|
-
* Decrypts ciphertext that was encrypted by a KMS key using any of the following operations: Encrypt GenerateDataKey GenerateDataKeyPair GenerateDataKeyWithoutPlaintext GenerateDataKeyPairWithoutPlaintext You can use this operation to decrypt ciphertext that was encrypted under a symmetric encryption KMS key or an asymmetric encryption KMS key. When the KMS key is asymmetric, you must specify the KMS key and the encryption algorithm that was used to encrypt the ciphertext. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide. The Decrypt operation also decrypts ciphertext that was encrypted outside of KMS by the public key in an KMS asymmetric KMS key. However, it cannot decrypt
|
|
67
|
+
* Decrypts ciphertext that was encrypted by a KMS key using any of the following operations: Encrypt GenerateDataKey GenerateDataKeyPair GenerateDataKeyWithoutPlaintext GenerateDataKeyPairWithoutPlaintext You can use this operation to decrypt ciphertext that was encrypted under a symmetric encryption KMS key or an asymmetric encryption KMS key. When the KMS key is asymmetric, you must specify the KMS key and the encryption algorithm that was used to encrypt the ciphertext. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide. The Decrypt operation also decrypts ciphertext that was encrypted outside of KMS by the public key in an KMS asymmetric KMS key. However, it cannot decrypt ciphertext produced by other libraries, such as the Amazon Web Services Encryption SDK or Amazon S3 client-side encryption. These libraries return a ciphertext format that is incompatible with KMS. If the ciphertext was encrypted under a symmetric encryption KMS key, the KeyId parameter is optional. KMS can get this information from metadata that it adds to the symmetric ciphertext blob. This feature adds durability to your implementation by ensuring that authorized users can decrypt ciphertext decades after it was encrypted, even if they've lost track of the key ID. However, specifying the KMS key is always recommended as a best practice. When you use the KeyId parameter to specify a KMS key, KMS only uses the KMS key you specify. If the ciphertext was encrypted under a different KMS key, the Decrypt operation fails. This practice ensures that you use the KMS key that you intend. Whenever possible, use key policies to give users permission to call the Decrypt operation on a particular KMS key, instead of using IAM policies. Otherwise, you might create an IAM user policy that gives the user Decrypt permission on all KMS keys. This user could decrypt ciphertext that was encrypted by KMS keys in other accounts if the key policy for the cross-account KMS key permits it. If you must use an IAM policy for Decrypt permissions, limit the user to particular KMS keys or particular trusted accounts. For details, see Best practices for IAM policies in the Key Management Service Developer Guide. Applications in Amazon Web Services Nitro Enclaves can call this operation by using the Amazon Web Services Nitro Enclaves Development Kit. For information about the supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS in the Key Management Service Developer Guide. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter. Required permissions: kms:Decrypt (key policy) Related operations: Encrypt GenerateDataKey GenerateDataKeyPair ReEncrypt
|
|
68
68
|
*/
|
|
69
69
|
decrypt(callback?: (err: AWSError, data: KMS.Types.DecryptResponse) => void): Request<KMS.Types.DecryptResponse, AWSError>;
|
|
70
70
|
/**
|
|
@@ -116,11 +116,11 @@ declare class KMS extends Service {
|
|
|
116
116
|
*/
|
|
117
117
|
disableKey(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
118
118
|
/**
|
|
119
|
-
* Disables automatic rotation of the key material
|
|
119
|
+
* Disables automatic rotation of the key material of the specified symmetric encryption KMS key. Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable or disable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. The key rotation status of these KMS keys is always false. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key. You can enable (EnableKeyRotation) and disable automatic rotation of the key material in customer managed KMS keys. Key material rotation of Amazon Web Services managed KMS keys is not configurable. KMS always rotates the key material for every year. Rotation of Amazon Web Services owned KMS keys varies. In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years to every year. For details, see EnableKeyRotation. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. Required permissions: kms:DisableKeyRotation (key policy) Related operations: EnableKeyRotation GetKeyRotationStatus
|
|
120
120
|
*/
|
|
121
121
|
disableKeyRotation(params: KMS.Types.DisableKeyRotationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
122
122
|
/**
|
|
123
|
-
* Disables automatic rotation of the key material
|
|
123
|
+
* Disables automatic rotation of the key material of the specified symmetric encryption KMS key. Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable or disable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. The key rotation status of these KMS keys is always false. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key. You can enable (EnableKeyRotation) and disable automatic rotation of the key material in customer managed KMS keys. Key material rotation of Amazon Web Services managed KMS keys is not configurable. KMS always rotates the key material for every year. Rotation of Amazon Web Services owned KMS keys varies. In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years to every year. For details, see EnableKeyRotation. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. Required permissions: kms:DisableKeyRotation (key policy) Related operations: EnableKeyRotation GetKeyRotationStatus
|
|
124
124
|
*/
|
|
125
125
|
disableKeyRotation(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
126
126
|
/**
|
|
@@ -140,11 +140,11 @@ declare class KMS extends Service {
|
|
|
140
140
|
*/
|
|
141
141
|
enableKey(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
142
142
|
/**
|
|
143
|
-
* Enables automatic rotation of the key material
|
|
143
|
+
* Enables automatic rotation of the key material of the specified symmetric encryption KMS key. When you enable automatic rotation of acustomer managed KMS key, KMS rotates the key material of the KMS key one year (approximately 365 days) from the enable date and every year thereafter. You can monitor rotation of the key material for your KMS keys in CloudTrail and Amazon CloudWatch. To disable rotation of the key material in a customer managed KMS key, use the DisableKeyRotation operation. Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable or disable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. The key rotation status of these KMS keys is always false. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key. You cannot enable or disable automatic rotation Amazon Web Services managed KMS keys. KMS always rotates the key material of Amazon Web Services managed keys every year. Rotation of Amazon Web Services owned KMS keys varies. In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years (approximately 1,095 days) to every year (approximately 365 days). New Amazon Web Services managed keys are automatically rotated one year after they are created, and approximately every year thereafter. Existing Amazon Web Services managed keys are automatically rotated one year after their most recent rotation, and every year thereafter. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. Required permissions: kms:EnableKeyRotation (key policy) Related operations: DisableKeyRotation GetKeyRotationStatus
|
|
144
144
|
*/
|
|
145
145
|
enableKeyRotation(params: KMS.Types.EnableKeyRotationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
146
146
|
/**
|
|
147
|
-
* Enables automatic rotation of the key material
|
|
147
|
+
* Enables automatic rotation of the key material of the specified symmetric encryption KMS key. When you enable automatic rotation of acustomer managed KMS key, KMS rotates the key material of the KMS key one year (approximately 365 days) from the enable date and every year thereafter. You can monitor rotation of the key material for your KMS keys in CloudTrail and Amazon CloudWatch. To disable rotation of the key material in a customer managed KMS key, use the DisableKeyRotation operation. Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable or disable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. The key rotation status of these KMS keys is always false. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key. You cannot enable or disable automatic rotation Amazon Web Services managed KMS keys. KMS always rotates the key material of Amazon Web Services managed keys every year. Rotation of Amazon Web Services owned KMS keys varies. In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years (approximately 1,095 days) to every year (approximately 365 days). New Amazon Web Services managed keys are automatically rotated one year after they are created, and approximately every year thereafter. Existing Amazon Web Services managed keys are automatically rotated one year after their most recent rotation, and every year thereafter. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. Required permissions: kms:EnableKeyRotation (key policy) Related operations: DisableKeyRotation GetKeyRotationStatus
|
|
148
148
|
*/
|
|
149
149
|
enableKeyRotation(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
150
150
|
/**
|
|
@@ -188,11 +188,11 @@ declare class KMS extends Service {
|
|
|
188
188
|
*/
|
|
189
189
|
generateDataKeyWithoutPlaintext(callback?: (err: AWSError, data: KMS.Types.GenerateDataKeyWithoutPlaintextResponse) => void): Request<KMS.Types.GenerateDataKeyWithoutPlaintextResponse, AWSError>;
|
|
190
190
|
/**
|
|
191
|
-
* Generates a hash-based message authentication code (HMAC) for a message using an HMAC KMS key and a MAC algorithm that the key supports. The MAC algorithm computes the HMAC for the message and the key as described in RFC 2104. You can use the HMAC that this operation generates with the VerifyMac operation to demonstrate that the original message has not changed. Also, because a secret key is used to create the hash, you can verify that the party that generated the hash has the required secret key. This operation is part of KMS support for HMAC KMS keys. For details, see HMAC keys in KMS in the Key Management Service Developer Guide . The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter. Required permissions: kms:GenerateMac (key policy) Related operations: VerifyMac
|
|
191
|
+
* Generates a hash-based message authentication code (HMAC) for a message using an HMAC KMS key and a MAC algorithm that the key supports. The MAC algorithm computes the HMAC for the message and the key as described in RFC 2104. You can use the HMAC that this operation generates with the VerifyMac operation to demonstrate that the original message has not changed. Also, because a secret key is used to create the hash, you can verify that the party that generated the hash has the required secret key. This operation is part of KMS support for HMAC KMS keys. For details, see HMAC keys in KMS in the Key Management Service Developer Guide . Best practices recommend that you limit the time during which any signing mechanism, including an HMAC, is effective. This deters an attack where the actor uses a signed message to establish validity repeatedly or long after the message is superseded. HMAC tags do not include a timestamp, but you can include a timestamp in the token or message to help you detect when its time to refresh the HMAC. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter. Required permissions: kms:GenerateMac (key policy) Related operations: VerifyMac
|
|
192
192
|
*/
|
|
193
193
|
generateMac(params: KMS.Types.GenerateMacRequest, callback?: (err: AWSError, data: KMS.Types.GenerateMacResponse) => void): Request<KMS.Types.GenerateMacResponse, AWSError>;
|
|
194
194
|
/**
|
|
195
|
-
* Generates a hash-based message authentication code (HMAC) for a message using an HMAC KMS key and a MAC algorithm that the key supports. The MAC algorithm computes the HMAC for the message and the key as described in RFC 2104. You can use the HMAC that this operation generates with the VerifyMac operation to demonstrate that the original message has not changed. Also, because a secret key is used to create the hash, you can verify that the party that generated the hash has the required secret key. This operation is part of KMS support for HMAC KMS keys. For details, see HMAC keys in KMS in the Key Management Service Developer Guide . The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter. Required permissions: kms:GenerateMac (key policy) Related operations: VerifyMac
|
|
195
|
+
* Generates a hash-based message authentication code (HMAC) for a message using an HMAC KMS key and a MAC algorithm that the key supports. The MAC algorithm computes the HMAC for the message and the key as described in RFC 2104. You can use the HMAC that this operation generates with the VerifyMac operation to demonstrate that the original message has not changed. Also, because a secret key is used to create the hash, you can verify that the party that generated the hash has the required secret key. This operation is part of KMS support for HMAC KMS keys. For details, see HMAC keys in KMS in the Key Management Service Developer Guide . Best practices recommend that you limit the time during which any signing mechanism, including an HMAC, is effective. This deters an attack where the actor uses a signed message to establish validity repeatedly or long after the message is superseded. HMAC tags do not include a timestamp, but you can include a timestamp in the token or message to help you detect when its time to refresh the HMAC. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter. Required permissions: kms:GenerateMac (key policy) Related operations: VerifyMac
|
|
196
196
|
*/
|
|
197
197
|
generateMac(callback?: (err: AWSError, data: KMS.Types.GenerateMacResponse) => void): Request<KMS.Types.GenerateMacResponse, AWSError>;
|
|
198
198
|
/**
|
|
@@ -212,11 +212,11 @@ declare class KMS extends Service {
|
|
|
212
212
|
*/
|
|
213
213
|
getKeyPolicy(callback?: (err: AWSError, data: KMS.Types.GetKeyPolicyResponse) => void): Request<KMS.Types.GetKeyPolicyResponse, AWSError>;
|
|
214
214
|
/**
|
|
215
|
-
* Gets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified KMS key. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key. The key rotation status for
|
|
215
|
+
* Gets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified KMS key. When you enable automatic rotation for customer managed KMS keys, KMS rotates the key material of the KMS key one year (approximately 365 days) from the enable date and every year thereafter. You can monitor rotation of the key material for your KMS keys in CloudTrail and Amazon CloudWatch. Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable or disable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. The key rotation status of these KMS keys is always false. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.. You can enable (EnableKeyRotation) and disable automatic rotation (DisableKeyRotation) of the key material in customer managed KMS keys. Key material rotation of Amazon Web Services managed KMS keys is not configurable. KMS always rotates the key material in Amazon Web Services managed KMS keys every year. The key rotation status for Amazon Web Services managed KMS keys is always true. In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years to every year. For details, see EnableKeyRotation. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Disabled: The key rotation status does not change when you disable a KMS key. However, while the KMS key is disabled, KMS does not rotate the key material. When you re-enable the KMS key, rotation resumes. If the key material in the re-enabled KMS key hasn't been rotated in one year, KMS rotates it immediately, and every year thereafter. If it's been less than a year since the key material in the re-enabled KMS key was rotated, the KMS key resumes its prior rotation schedule. Pending deletion: While a KMS key is pending deletion, its key rotation status is false and KMS does not rotate the key material. If you cancel the deletion, the original key rotation status returns to true. Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key ARN in the value of the KeyId parameter. Required permissions: kms:GetKeyRotationStatus (key policy) Related operations: DisableKeyRotation EnableKeyRotation
|
|
216
216
|
*/
|
|
217
217
|
getKeyRotationStatus(params: KMS.Types.GetKeyRotationStatusRequest, callback?: (err: AWSError, data: KMS.Types.GetKeyRotationStatusResponse) => void): Request<KMS.Types.GetKeyRotationStatusResponse, AWSError>;
|
|
218
218
|
/**
|
|
219
|
-
* Gets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified KMS key. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key. The key rotation status for
|
|
219
|
+
* Gets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified KMS key. When you enable automatic rotation for customer managed KMS keys, KMS rotates the key material of the KMS key one year (approximately 365 days) from the enable date and every year thereafter. You can monitor rotation of the key material for your KMS keys in CloudTrail and Amazon CloudWatch. Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable or disable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. The key rotation status of these KMS keys is always false. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.. You can enable (EnableKeyRotation) and disable automatic rotation (DisableKeyRotation) of the key material in customer managed KMS keys. Key material rotation of Amazon Web Services managed KMS keys is not configurable. KMS always rotates the key material in Amazon Web Services managed KMS keys every year. The key rotation status for Amazon Web Services managed KMS keys is always true. In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years to every year. For details, see EnableKeyRotation. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Disabled: The key rotation status does not change when you disable a KMS key. However, while the KMS key is disabled, KMS does not rotate the key material. When you re-enable the KMS key, rotation resumes. If the key material in the re-enabled KMS key hasn't been rotated in one year, KMS rotates it immediately, and every year thereafter. If it's been less than a year since the key material in the re-enabled KMS key was rotated, the KMS key resumes its prior rotation schedule. Pending deletion: While a KMS key is pending deletion, its key rotation status is false and KMS does not rotate the key material. If you cancel the deletion, the original key rotation status returns to true. Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key ARN in the value of the KeyId parameter. Required permissions: kms:GetKeyRotationStatus (key policy) Related operations: DisableKeyRotation EnableKeyRotation
|
|
220
220
|
*/
|
|
221
221
|
getKeyRotationStatus(callback?: (err: AWSError, data: KMS.Types.GetKeyRotationStatusResponse) => void): Request<KMS.Types.GetKeyRotationStatusResponse, AWSError>;
|
|
222
222
|
/**
|
|
@@ -340,11 +340,11 @@ declare class KMS extends Service {
|
|
|
340
340
|
*/
|
|
341
341
|
scheduleKeyDeletion(callback?: (err: AWSError, data: KMS.Types.ScheduleKeyDeletionResponse) => void): Request<KMS.Types.ScheduleKeyDeletionResponse, AWSError>;
|
|
342
342
|
/**
|
|
343
|
-
* Creates a digital signature for a message or message digest by using the private key in an asymmetric signing KMS key. To verify the signature, use the Verify operation, or use the public key in the same asymmetric KMS key outside of KMS. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide. Digital signatures are generated and verified by using asymmetric key pair, such as an RSA or ECC pair that is represented by an asymmetric KMS key. The key owner (or an authorized user) uses their private key to sign a message. Anyone with the public key can verify that the message was signed with that particular private key and that the message hasn't changed since it was signed. To use the Sign operation, provide the following information: Use the KeyId parameter to identify an asymmetric KMS key with a KeyUsage value of SIGN_VERIFY. To get the KeyUsage value of a KMS key, use the DescribeKey operation. The caller must have kms:Sign permission on the KMS key. Use the Message parameter to specify the message or message digest to sign. You can submit messages of up to 4096 bytes. To sign a larger message, generate a hash digest of the message, and then provide the hash digest in the Message parameter. To indicate whether the message is a full message or a digest, use the MessageType parameter. Choose a signing algorithm that is compatible with the KMS key. When signing a message, be sure to record the KMS key and the signing algorithm. This information is required to verify the signature.
|
|
343
|
+
* Creates a digital signature for a message or message digest by using the private key in an asymmetric signing KMS key. To verify the signature, use the Verify operation, or use the public key in the same asymmetric KMS key outside of KMS. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide. Digital signatures are generated and verified by using asymmetric key pair, such as an RSA or ECC pair that is represented by an asymmetric KMS key. The key owner (or an authorized user) uses their private key to sign a message. Anyone with the public key can verify that the message was signed with that particular private key and that the message hasn't changed since it was signed. To use the Sign operation, provide the following information: Use the KeyId parameter to identify an asymmetric KMS key with a KeyUsage value of SIGN_VERIFY. To get the KeyUsage value of a KMS key, use the DescribeKey operation. The caller must have kms:Sign permission on the KMS key. Use the Message parameter to specify the message or message digest to sign. You can submit messages of up to 4096 bytes. To sign a larger message, generate a hash digest of the message, and then provide the hash digest in the Message parameter. To indicate whether the message is a full message or a digest, use the MessageType parameter. Choose a signing algorithm that is compatible with the KMS key. When signing a message, be sure to record the KMS key and the signing algorithm. This information is required to verify the signature. Best practices recommend that you limit the time during which any signature is effective. This deters an attack where the actor uses a signed message to establish validity repeatedly or long after the message is superseded. Signatures do not include a timestamp, but you can include a timestamp in the signed message to help you detect when its time to refresh the signature. To verify the signature that this operation generates, use the Verify operation. Or use the GetPublicKey operation to download the public key and then use the public key to verify the signature outside of KMS. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter. Required permissions: kms:Sign (key policy) Related operations: Verify
|
|
344
344
|
*/
|
|
345
345
|
sign(params: KMS.Types.SignRequest, callback?: (err: AWSError, data: KMS.Types.SignResponse) => void): Request<KMS.Types.SignResponse, AWSError>;
|
|
346
346
|
/**
|
|
347
|
-
* Creates a digital signature for a message or message digest by using the private key in an asymmetric signing KMS key. To verify the signature, use the Verify operation, or use the public key in the same asymmetric KMS key outside of KMS. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide. Digital signatures are generated and verified by using asymmetric key pair, such as an RSA or ECC pair that is represented by an asymmetric KMS key. The key owner (or an authorized user) uses their private key to sign a message. Anyone with the public key can verify that the message was signed with that particular private key and that the message hasn't changed since it was signed. To use the Sign operation, provide the following information: Use the KeyId parameter to identify an asymmetric KMS key with a KeyUsage value of SIGN_VERIFY. To get the KeyUsage value of a KMS key, use the DescribeKey operation. The caller must have kms:Sign permission on the KMS key. Use the Message parameter to specify the message or message digest to sign. You can submit messages of up to 4096 bytes. To sign a larger message, generate a hash digest of the message, and then provide the hash digest in the Message parameter. To indicate whether the message is a full message or a digest, use the MessageType parameter. Choose a signing algorithm that is compatible with the KMS key. When signing a message, be sure to record the KMS key and the signing algorithm. This information is required to verify the signature.
|
|
347
|
+
* Creates a digital signature for a message or message digest by using the private key in an asymmetric signing KMS key. To verify the signature, use the Verify operation, or use the public key in the same asymmetric KMS key outside of KMS. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide. Digital signatures are generated and verified by using asymmetric key pair, such as an RSA or ECC pair that is represented by an asymmetric KMS key. The key owner (or an authorized user) uses their private key to sign a message. Anyone with the public key can verify that the message was signed with that particular private key and that the message hasn't changed since it was signed. To use the Sign operation, provide the following information: Use the KeyId parameter to identify an asymmetric KMS key with a KeyUsage value of SIGN_VERIFY. To get the KeyUsage value of a KMS key, use the DescribeKey operation. The caller must have kms:Sign permission on the KMS key. Use the Message parameter to specify the message or message digest to sign. You can submit messages of up to 4096 bytes. To sign a larger message, generate a hash digest of the message, and then provide the hash digest in the Message parameter. To indicate whether the message is a full message or a digest, use the MessageType parameter. Choose a signing algorithm that is compatible with the KMS key. When signing a message, be sure to record the KMS key and the signing algorithm. This information is required to verify the signature. Best practices recommend that you limit the time during which any signature is effective. This deters an attack where the actor uses a signed message to establish validity repeatedly or long after the message is superseded. Signatures do not include a timestamp, but you can include a timestamp in the signed message to help you detect when its time to refresh the signature. To verify the signature that this operation generates, use the Verify operation. Or use the GetPublicKey operation to download the public key and then use the public key to verify the signature outside of KMS. The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide. Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter. Required permissions: kms:Sign (key policy) Related operations: Verify
|
|
348
348
|
*/
|
|
349
349
|
sign(callback?: (err: AWSError, data: KMS.Types.SignResponse) => void): Request<KMS.Types.SignResponse, AWSError>;
|
|
350
350
|
/**
|
|
@@ -541,7 +541,7 @@ declare namespace KMS {
|
|
|
541
541
|
}
|
|
542
542
|
export interface CreateKeyRequest {
|
|
543
543
|
/**
|
|
544
|
-
* The key policy to attach to the KMS key. If you provide a key policy, it must meet the following criteria: If you don't set BypassPolicyLockoutSafetyCheck to
|
|
544
|
+
* The key policy to attach to the KMS key. If you do not specify a key policy, KMS attaches a default key policy to the KMS key. For more information, see Default key policy in the Key Management Service Developer Guide. If you provide a key policy, it must meet the following criteria: If you don't set BypassPolicyLockoutSafetyCheck to True, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the Key Management Service Developer Guide . Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access Management User Guide. A key policy document must conform to the following rules. Up to 32 kilobytes (32768 bytes) Must be UTF-8 encoded The only Unicode characters that are permitted in a key policy document are the horizontal tab (U+0009), linefeed (U+000A), carriage return (U+000D), and characters in the range U+0020 to U+00FF. The Sid element in a key policy statement can include spaces. (Spaces are prohibited in the Sid element of an IAM policy document.) For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide .
|
|
545
545
|
*/
|
|
546
546
|
Policy?: PolicyType;
|
|
547
547
|
/**
|
|
@@ -557,7 +557,7 @@ declare namespace KMS {
|
|
|
557
557
|
*/
|
|
558
558
|
CustomerMasterKeySpec?: CustomerMasterKeySpec;
|
|
559
559
|
/**
|
|
560
|
-
* Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS key with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your KMS key, see Choosing a KMS key type in the Key Management Service Developer Guide . The KeySpec determines whether the KMS key contains a symmetric key or an asymmetric key pair. It also determines the algorithms that the KMS key supports. You can't change the KeySpec after the KMS key is created. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm, kms:MacAlgorithm or kms:Signing Algorithm in the Key Management Service Developer Guide . Amazon Web Services services that are integrated with KMS use symmetric encryption KMS keys to protect your data. These services do not support asymmetric KMS keys or HMAC KMS keys. KMS supports the following key specs for KMS keys: Symmetric encryption key (default) SYMMETRIC_DEFAULT (AES-256-GCM) HMAC keys (symmetric) HMAC_224 HMAC_256 HMAC_384 HMAC_512 Asymmetric RSA key pairs RSA_2048 RSA_3072 RSA_4096 Asymmetric NIST-recommended elliptic curve key pairs ECC_NIST_P256 (secp256r1) ECC_NIST_P384 (secp384r1) ECC_NIST_P521 (secp521r1) Other asymmetric elliptic curve key pairs ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
|
|
560
|
+
* Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS key with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your KMS key, see Choosing a KMS key type in the Key Management Service Developer Guide . The KeySpec determines whether the KMS key contains a symmetric key or an asymmetric key pair. It also determines the cryptographic algorithms that the KMS key supports. You can't change the KeySpec after the KMS key is created. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm, kms:MacAlgorithm or kms:Signing Algorithm in the Key Management Service Developer Guide . Amazon Web Services services that are integrated with KMS use symmetric encryption KMS keys to protect your data. These services do not support asymmetric KMS keys or HMAC KMS keys. KMS supports the following key specs for KMS keys: Symmetric encryption key (default) SYMMETRIC_DEFAULT (AES-256-GCM) HMAC keys (symmetric) HMAC_224 HMAC_256 HMAC_384 HMAC_512 Asymmetric RSA key pairs RSA_2048 RSA_3072 RSA_4096 Asymmetric NIST-recommended elliptic curve key pairs ECC_NIST_P256 (secp256r1) ECC_NIST_P384 (secp384r1) ECC_NIST_P521 (secp521r1) Other asymmetric elliptic curve key pairs ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
|
|
561
561
|
*/
|
|
562
562
|
KeySpec?: KeySpec;
|
|
563
563
|
/**
|
|
@@ -577,7 +577,7 @@ declare namespace KMS {
|
|
|
577
577
|
*/
|
|
578
578
|
Tags?: TagList;
|
|
579
579
|
/**
|
|
580
|
-
* Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions. You cannot change this value after you create the KMS key. For a multi-Region key, set this parameter to True. For a single-Region KMS key, omit this parameter or set it to False. The default value is False. This operation supports multi-Region keys, an KMS feature that lets you create multiple interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide. This value creates a primary key, not a replica. To create a replica key, use the ReplicateKey operation. You can create a symmetric
|
|
580
|
+
* Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions. You cannot change this value after you create the KMS key. For a multi-Region key, set this parameter to True. For a single-Region KMS key, omit this parameter or set it to False. The default value is False. This operation supports multi-Region keys, an KMS feature that lets you create multiple interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide. This value creates a primary key, not a replica. To create a replica key, use the ReplicateKey operation. You can create a multi-Region version of a symmetric encryption KMS key, an HMAC KMS key, an asymmetric KMS key, or a KMS key with imported key material. However, you cannot create a multi-Region key in a custom key store.
|
|
581
581
|
*/
|
|
582
582
|
MultiRegion?: NullableBooleanType;
|
|
583
583
|
}
|
|
@@ -757,7 +757,7 @@ declare namespace KMS {
|
|
|
757
757
|
}
|
|
758
758
|
export interface EnableKeyRotationRequest {
|
|
759
759
|
/**
|
|
760
|
-
* Identifies a symmetric encryption KMS key. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key. Specify the key ID or key ARN of the KMS key. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
|
|
760
|
+
* Identifies a symmetric encryption KMS key. You cannot enable or disable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. The key rotation status of these KMS keys is always false. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key. Specify the key ID or key ARN of the KMS key. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
|
|
761
761
|
*/
|
|
762
762
|
KeyId: KeyIdType;
|
|
763
763
|
}
|
|
@@ -849,7 +849,7 @@ declare namespace KMS {
|
|
|
849
849
|
*/
|
|
850
850
|
EncryptionContext?: EncryptionContextType;
|
|
851
851
|
/**
|
|
852
|
-
* Specifies the symmetric encryption KMS key that encrypts the private key in the data key pair. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.
|
|
852
|
+
* Specifies the symmetric encryption KMS key that encrypts the private key in the data key pair. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation. To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
|
|
853
853
|
*/
|
|
854
854
|
KeyId: KeyIdType;
|
|
855
855
|
/**
|
|
@@ -1494,7 +1494,7 @@ declare namespace KMS {
|
|
|
1494
1494
|
*/
|
|
1495
1495
|
PolicyName: PolicyNameType;
|
|
1496
1496
|
/**
|
|
1497
|
-
* The key policy to attach to the KMS key. The key policy must meet the following criteria: If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the PutKeyPolicy request to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the Key Management Service Developer Guide. Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access Management User Guide.
|
|
1497
|
+
* The key policy to attach to the KMS key. The key policy must meet the following criteria: If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the PutKeyPolicy request to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the Key Management Service Developer Guide. Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access Management User Guide. A key policy document must conform to the following rules. Up to 32 kilobytes (32768 bytes) Must be UTF-8 encoded The only Unicode characters that are permitted in a key policy document are the horizontal tab (U+0009), linefeed (U+000A), carriage return (U+000D), and characters in the range U+0020 to U+00FF. The Sid element in a key policy statement can include spaces. (Spaces are prohibited in the Sid element of an IAM policy document.)
|
|
1498
1498
|
*/
|
|
1499
1499
|
Policy: PolicyType;
|
|
1500
1500
|
/**
|
|
@@ -1569,7 +1569,7 @@ declare namespace KMS {
|
|
|
1569
1569
|
*/
|
|
1570
1570
|
ReplicaRegion: RegionType;
|
|
1571
1571
|
/**
|
|
1572
|
-
* The key policy to attach to the KMS key. This parameter is optional. If you do not provide a key policy, KMS attaches the default key policy to the KMS key. The key policy is not a shared property of multi-Region keys. You can specify the same key policy or a different key policy for each key in a set of related multi-Region keys. KMS does not synchronize this property. If you provide a key policy, it must meet the following criteria: If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must give the caller kms:PutKeyPolicy permission on the replica key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the Key Management Service Developer Guide . Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Identity and Access Management User Guide .
|
|
1572
|
+
* The key policy to attach to the KMS key. This parameter is optional. If you do not provide a key policy, KMS attaches the default key policy to the KMS key. The key policy is not a shared property of multi-Region keys. You can specify the same key policy or a different key policy for each key in a set of related multi-Region keys. KMS does not synchronize this property. If you provide a key policy, it must meet the following criteria: If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must give the caller kms:PutKeyPolicy permission on the replica key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the Key Management Service Developer Guide . Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Identity and Access Management User Guide . A key policy document must conform to the following rules. Up to 32 kilobytes (32768 bytes) Must be UTF-8 encoded The only Unicode characters that are permitted in a key policy document are the horizontal tab (U+0009), linefeed (U+000A), carriage return (U+000D), and characters in the range U+0020 to U+00FF. The Sid element in a key policy statement can include spaces. (Spaces are prohibited in the Sid element of an IAM policy document.)
|
|
1573
1573
|
*/
|
|
1574
1574
|
Policy?: PolicyType;
|
|
1575
1575
|
/**
|
|
@@ -1629,7 +1629,7 @@ declare namespace KMS {
|
|
|
1629
1629
|
*/
|
|
1630
1630
|
KeyId: KeyIdType;
|
|
1631
1631
|
/**
|
|
1632
|
-
* The waiting period, specified in number of days. After the waiting period ends, KMS deletes the KMS key. If the KMS key is a multi-Region primary key with
|
|
1632
|
+
* The waiting period, specified in number of days. After the waiting period ends, KMS deletes the KMS key. If the KMS key is a multi-Region primary key with replica keys, the waiting period begins when the last of its replica keys is deleted. Otherwise, the waiting period begins immediately. This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.
|
|
1633
1633
|
*/
|
|
1634
1634
|
PendingWindowInDays?: PendingWindowInDaysType;
|
|
1635
1635
|
}
|
|
@@ -863,7 +863,7 @@ declare namespace Lambda {
|
|
|
863
863
|
*/
|
|
864
864
|
Enabled?: Enabled;
|
|
865
865
|
/**
|
|
866
|
-
* The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB). Amazon Kinesis - Default 100. Max 10,000. Amazon DynamoDB Streams - Default 100. Max
|
|
866
|
+
* The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB). Amazon Kinesis - Default 100. Max 10,000. Amazon DynamoDB Streams - Default 100. Max 10,000. Amazon Simple Queue Service - Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10. Amazon Managed Streaming for Apache Kafka - Default 100. Max 10,000. Self-Managed Apache Kafka - Default 100. Max 10,000. Amazon MQ (ActiveMQ and RabbitMQ) - Default 100. Max 10,000.
|
|
867
867
|
*/
|
|
868
868
|
BatchSize?: BatchSize;
|
|
869
869
|
/**
|
|
@@ -1293,7 +1293,7 @@ declare namespace Lambda {
|
|
|
1293
1293
|
*/
|
|
1294
1294
|
TumblingWindowInSeconds?: TumblingWindowInSeconds;
|
|
1295
1295
|
/**
|
|
1296
|
-
* (Streams
|
|
1296
|
+
* (Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.
|
|
1297
1297
|
*/
|
|
1298
1298
|
FunctionResponseTypes?: FunctionResponseTypeList;
|
|
1299
1299
|
}
|
|
@@ -2647,7 +2647,7 @@ declare namespace Lambda {
|
|
|
2647
2647
|
export type ReservedConcurrentExecutions = number;
|
|
2648
2648
|
export type ResourceArn = string;
|
|
2649
2649
|
export type RoleArn = string;
|
|
2650
|
-
export type Runtime = "nodejs"|"nodejs4.3"|"nodejs6.10"|"nodejs8.10"|"nodejs10.x"|"nodejs12.x"|"nodejs14.x"|"java8"|"java8.al2"|"java11"|"python2.7"|"python3.6"|"python3.7"|"python3.8"|"python3.9"|"dotnetcore1.0"|"dotnetcore2.0"|"dotnetcore2.1"|"dotnetcore3.1"|"dotnet6"|"nodejs4.3-edge"|"go1.x"|"ruby2.5"|"ruby2.7"|"provided"|"provided.al2"|string;
|
|
2650
|
+
export type Runtime = "nodejs"|"nodejs4.3"|"nodejs6.10"|"nodejs8.10"|"nodejs10.x"|"nodejs12.x"|"nodejs14.x"|"nodejs16.x"|"java8"|"java8.al2"|"java11"|"python2.7"|"python3.6"|"python3.7"|"python3.8"|"python3.9"|"dotnetcore1.0"|"dotnetcore2.0"|"dotnetcore2.1"|"dotnetcore3.1"|"dotnet6"|"nodejs4.3-edge"|"go1.x"|"ruby2.5"|"ruby2.7"|"provided"|"provided.al2"|string;
|
|
2651
2651
|
export type S3Bucket = string;
|
|
2652
2652
|
export type S3Key = string;
|
|
2653
2653
|
export type S3ObjectVersion = string;
|
|
@@ -2790,7 +2790,7 @@ declare namespace Lambda {
|
|
|
2790
2790
|
*/
|
|
2791
2791
|
Enabled?: Enabled;
|
|
2792
2792
|
/**
|
|
2793
|
-
* The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB). Amazon Kinesis - Default 100. Max 10,000. Amazon DynamoDB Streams - Default 100. Max
|
|
2793
|
+
* The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB). Amazon Kinesis - Default 100. Max 10,000. Amazon DynamoDB Streams - Default 100. Max 10,000. Amazon Simple Queue Service - Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10. Amazon Managed Streaming for Apache Kafka - Default 100. Max 10,000. Self-Managed Apache Kafka - Default 100. Max 10,000. Amazon MQ (ActiveMQ and RabbitMQ) - Default 100. Max 10,000.
|
|
2794
2794
|
*/
|
|
2795
2795
|
BatchSize?: BatchSize;
|
|
2796
2796
|
/**
|