aws-sdk-kms 1.0.0.rc2 → 1.0.0.rc3
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.
- checksums.yaml +4 -4
- data/lib/aws-sdk-kms.rb +1 -1
- data/lib/aws-sdk-kms/client.rb +273 -53
- data/lib/aws-sdk-kms/client_api.rb +77 -0
- data/lib/aws-sdk-kms/types.rb +370 -80
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d348ec6df574b88ba7fc4422404e1ec80da36ef7
|
4
|
+
data.tar.gz: 598efd7147127f5b74f0a5ecd87ae843467f6464
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5f26941c3677b5eef0bb57068ec8fe9c67d604d2921f82ef688a230184212e30b99abf939684067807cf99059fab819ffbefede2960e0c2c55d5b87331f1c5f5
|
7
|
+
data.tar.gz: d3787c2cad1583842acbb9cbb360ca572dd3724d79474f0148e145f200bba3686e46d11641acfa99f20a1889bc02de9453aa6253777f03a346686002198e0bec
|
data/lib/aws-sdk-kms.rb
CHANGED
data/lib/aws-sdk-kms/client.rb
CHANGED
@@ -194,6 +194,8 @@ module Aws::KMS
|
|
194
194
|
#
|
195
195
|
# resp.key_id #=> String
|
196
196
|
#
|
197
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CancelKeyDeletion AWS API Documentation
|
198
|
+
#
|
197
199
|
# @overload cancel_key_deletion(params = {})
|
198
200
|
# @param [Hash] params ({})
|
199
201
|
def cancel_key_deletion(params = {}, options = {})
|
@@ -240,6 +242,8 @@ module Aws::KMS
|
|
240
242
|
# target_key_id: "KeyIdType", # required
|
241
243
|
# })
|
242
244
|
#
|
245
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateAlias AWS API Documentation
|
246
|
+
#
|
243
247
|
# @overload create_alias(params = {})
|
244
248
|
# @param [Hash] params ({})
|
245
249
|
def create_alias(params = {}, options = {})
|
@@ -373,6 +377,8 @@ module Aws::KMS
|
|
373
377
|
# resp.grant_token #=> String
|
374
378
|
# resp.grant_id #=> String
|
375
379
|
#
|
380
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateGrant AWS API Documentation
|
381
|
+
#
|
376
382
|
# @overload create_grant(params = {})
|
377
383
|
# @param [Hash] params ({})
|
378
384
|
def create_grant(params = {}, options = {})
|
@@ -404,14 +410,14 @@ module Aws::KMS
|
|
404
410
|
# `BypassPolicyLockoutSafetyCheck` to true, the policy must meet the
|
405
411
|
# following criteria:
|
406
412
|
#
|
407
|
-
# * It must allow the principal making the `CreateKey` request
|
408
|
-
# subsequent PutKeyPolicy request on the CMK. This reduces
|
409
|
-
# likelihood that the CMK becomes unmanageable. For more
|
410
|
-
# refer to the scenario in the [Default Key Policy][1]
|
411
|
-
# *AWS Key Management Service Developer Guide*.
|
413
|
+
# * It must allow the principal that is making the `CreateKey` request
|
414
|
+
# to make a subsequent PutKeyPolicy request on the CMK. This reduces
|
415
|
+
# the likelihood that the CMK becomes unmanageable. For more
|
416
|
+
# information, refer to the scenario in the [Default Key Policy][1]
|
417
|
+
# section in the *AWS Key Management Service Developer Guide*.
|
412
418
|
#
|
413
|
-
# * The
|
414
|
-
# visible to AWS KMS. When you create a new AWS principal (for
|
419
|
+
# * The principals that are specified in the key policy must exist and
|
420
|
+
# be visible to AWS KMS. When you create a new AWS principal (for
|
415
421
|
# example, an IAM user or role), you might need to enforce a delay
|
416
422
|
# before specifying the new principal in a key policy because the new
|
417
423
|
# principal might not immediately be visible to AWS KMS. For more
|
@@ -469,8 +475,8 @@ module Aws::KMS
|
|
469
475
|
# Guide*.
|
470
476
|
#
|
471
477
|
# Use this parameter only when you include a policy in the request and
|
472
|
-
# you intend to prevent the principal making the request from
|
473
|
-
# subsequent PutKeyPolicy request on the CMK.
|
478
|
+
# you intend to prevent the principal that is making the request from
|
479
|
+
# making a subsequent PutKeyPolicy request on the CMK.
|
474
480
|
#
|
475
481
|
# The default value is false.
|
476
482
|
#
|
@@ -478,6 +484,15 @@ module Aws::KMS
|
|
478
484
|
#
|
479
485
|
# [1]: http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam
|
480
486
|
#
|
487
|
+
# @option params [Array<Types::Tag>] :tags
|
488
|
+
# One or more tags. Each tag consists of a tag key and a tag value. Tag
|
489
|
+
# keys and tag values are both required, but tag values can be empty
|
490
|
+
# (null) strings.
|
491
|
+
#
|
492
|
+
# Use this parameter to tag the CMK when it is created. Alternately, you
|
493
|
+
# can omit this parameter and instead tag the CMK after it is created
|
494
|
+
# using TagResource.
|
495
|
+
#
|
481
496
|
# @return [Types::CreateKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
482
497
|
#
|
483
498
|
# * {Types::CreateKeyResponse#key_metadata #key_metadata} => Types::KeyMetadata
|
@@ -490,6 +505,12 @@ module Aws::KMS
|
|
490
505
|
# key_usage: "ENCRYPT_DECRYPT", # accepts ENCRYPT_DECRYPT
|
491
506
|
# origin: "AWS_KMS", # accepts AWS_KMS, EXTERNAL
|
492
507
|
# bypass_policy_lockout_safety_check: false,
|
508
|
+
# tags: [
|
509
|
+
# {
|
510
|
+
# tag_key: "TagKeyType", # required
|
511
|
+
# tag_value: "TagValueType", # required
|
512
|
+
# },
|
513
|
+
# ],
|
493
514
|
# })
|
494
515
|
#
|
495
516
|
# @example Response structure
|
@@ -507,6 +528,8 @@ module Aws::KMS
|
|
507
528
|
# resp.key_metadata.origin #=> String, one of "AWS_KMS", "EXTERNAL"
|
508
529
|
# resp.key_metadata.expiration_model #=> String, one of "KEY_MATERIAL_EXPIRES", "KEY_MATERIAL_DOES_NOT_EXPIRE"
|
509
530
|
#
|
531
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateKey AWS API Documentation
|
532
|
+
#
|
510
533
|
# @overload create_key(params = {})
|
511
534
|
# @param [Hash] params ({})
|
512
535
|
def create_key(params = {}, options = {})
|
@@ -575,6 +598,8 @@ module Aws::KMS
|
|
575
598
|
# resp.key_id #=> String
|
576
599
|
# resp.plaintext #=> String
|
577
600
|
#
|
601
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/Decrypt AWS API Documentation
|
602
|
+
#
|
578
603
|
# @overload decrypt(params = {})
|
579
604
|
# @param [Hash] params ({})
|
580
605
|
def decrypt(params = {}, options = {})
|
@@ -598,6 +623,8 @@ module Aws::KMS
|
|
598
623
|
# alias_name: "AliasNameType", # required
|
599
624
|
# })
|
600
625
|
#
|
626
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeleteAlias AWS API Documentation
|
627
|
+
#
|
601
628
|
# @overload delete_alias(params = {})
|
602
629
|
# @param [Hash] params ({})
|
603
630
|
def delete_alias(params = {}, options = {})
|
@@ -641,6 +668,8 @@ module Aws::KMS
|
|
641
668
|
# key_id: "KeyIdType", # required
|
642
669
|
# })
|
643
670
|
#
|
671
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeleteImportedKeyMaterial AWS API Documentation
|
672
|
+
#
|
644
673
|
# @overload delete_imported_key_material(params = {})
|
645
674
|
# @param [Hash] params ({})
|
646
675
|
def delete_imported_key_material(params = {}, options = {})
|
@@ -702,6 +731,8 @@ module Aws::KMS
|
|
702
731
|
# resp.key_metadata.origin #=> String, one of "AWS_KMS", "EXTERNAL"
|
703
732
|
# resp.key_metadata.expiration_model #=> String, one of "KEY_MATERIAL_EXPIRES", "KEY_MATERIAL_DOES_NOT_EXPIRE"
|
704
733
|
#
|
734
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DescribeKey AWS API Documentation
|
735
|
+
#
|
705
736
|
# @overload describe_key(params = {})
|
706
737
|
# @param [Hash] params ({})
|
707
738
|
def describe_key(params = {}, options = {})
|
@@ -738,6 +769,8 @@ module Aws::KMS
|
|
738
769
|
# key_id: "KeyIdType", # required
|
739
770
|
# })
|
740
771
|
#
|
772
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DisableKey AWS API Documentation
|
773
|
+
#
|
741
774
|
# @overload disable_key(params = {})
|
742
775
|
# @param [Hash] params ({})
|
743
776
|
def disable_key(params = {}, options = {})
|
@@ -765,6 +798,8 @@ module Aws::KMS
|
|
765
798
|
# key_id: "KeyIdType", # required
|
766
799
|
# })
|
767
800
|
#
|
801
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DisableKeyRotation AWS API Documentation
|
802
|
+
#
|
768
803
|
# @overload disable_key_rotation(params = {})
|
769
804
|
# @param [Hash] params ({})
|
770
805
|
def disable_key_rotation(params = {}, options = {})
|
@@ -792,6 +827,8 @@ module Aws::KMS
|
|
792
827
|
# key_id: "KeyIdType", # required
|
793
828
|
# })
|
794
829
|
#
|
830
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/EnableKey AWS API Documentation
|
831
|
+
#
|
795
832
|
# @overload enable_key(params = {})
|
796
833
|
# @param [Hash] params ({})
|
797
834
|
def enable_key(params = {}, options = {})
|
@@ -819,6 +856,8 @@ module Aws::KMS
|
|
819
856
|
# key_id: "KeyIdType", # required
|
820
857
|
# })
|
821
858
|
#
|
859
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/EnableKeyRotation AWS API Documentation
|
860
|
+
#
|
822
861
|
# @overload enable_key_rotation(params = {})
|
823
862
|
# @param [Hash] params ({})
|
824
863
|
def enable_key_rotation(params = {}, options = {})
|
@@ -910,6 +949,8 @@ module Aws::KMS
|
|
910
949
|
# resp.ciphertext_blob #=> String
|
911
950
|
# resp.key_id #=> String
|
912
951
|
#
|
952
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/Encrypt AWS API Documentation
|
953
|
+
#
|
913
954
|
# @overload encrypt(params = {})
|
914
955
|
# @param [Hash] params ({})
|
915
956
|
def encrypt(params = {}, options = {})
|
@@ -1041,6 +1082,8 @@ module Aws::KMS
|
|
1041
1082
|
# resp.plaintext #=> String
|
1042
1083
|
# resp.key_id #=> String
|
1043
1084
|
#
|
1085
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKey AWS API Documentation
|
1086
|
+
#
|
1044
1087
|
# @overload generate_data_key(params = {})
|
1045
1088
|
# @param [Hash] params ({})
|
1046
1089
|
def generate_data_key(params = {}, options = {})
|
@@ -1137,6 +1180,8 @@ module Aws::KMS
|
|
1137
1180
|
# resp.ciphertext_blob #=> String
|
1138
1181
|
# resp.key_id #=> String
|
1139
1182
|
#
|
1183
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyWithoutPlaintext AWS API Documentation
|
1184
|
+
#
|
1140
1185
|
# @overload generate_data_key_without_plaintext(params = {})
|
1141
1186
|
# @param [Hash] params ({})
|
1142
1187
|
def generate_data_key_without_plaintext(params = {}, options = {})
|
@@ -1163,6 +1208,8 @@ module Aws::KMS
|
|
1163
1208
|
#
|
1164
1209
|
# resp.plaintext #=> String
|
1165
1210
|
#
|
1211
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateRandom AWS API Documentation
|
1212
|
+
#
|
1166
1213
|
# @overload generate_random(params = {})
|
1167
1214
|
# @param [Hash] params ({})
|
1168
1215
|
def generate_random(params = {}, options = {})
|
@@ -1202,6 +1249,8 @@ module Aws::KMS
|
|
1202
1249
|
#
|
1203
1250
|
# resp.policy #=> String
|
1204
1251
|
#
|
1252
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyPolicy AWS API Documentation
|
1253
|
+
#
|
1205
1254
|
# @overload get_key_policy(params = {})
|
1206
1255
|
# @param [Hash] params ({})
|
1207
1256
|
def get_key_policy(params = {}, options = {})
|
@@ -1236,6 +1285,8 @@ module Aws::KMS
|
|
1236
1285
|
#
|
1237
1286
|
# resp.key_rotation_enabled #=> Boolean
|
1238
1287
|
#
|
1288
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyRotationStatus AWS API Documentation
|
1289
|
+
#
|
1239
1290
|
# @overload get_key_rotation_status(params = {})
|
1240
1291
|
# @param [Hash] params ({})
|
1241
1292
|
def get_key_rotation_status(params = {}, options = {})
|
@@ -1314,6 +1365,8 @@ module Aws::KMS
|
|
1314
1365
|
# resp.public_key #=> String
|
1315
1366
|
# resp.parameters_valid_to #=> Time
|
1316
1367
|
#
|
1368
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetParametersForImport AWS API Documentation
|
1369
|
+
#
|
1317
1370
|
# @overload get_parameters_for_import(params = {})
|
1318
1371
|
# @param [Hash] params ({})
|
1319
1372
|
def get_parameters_for_import(params = {}, options = {})
|
@@ -1397,6 +1450,8 @@ module Aws::KMS
|
|
1397
1450
|
# expiration_model: "KEY_MATERIAL_EXPIRES", # accepts KEY_MATERIAL_EXPIRES, KEY_MATERIAL_DOES_NOT_EXPIRE
|
1398
1451
|
# })
|
1399
1452
|
#
|
1453
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ImportKeyMaterial AWS API Documentation
|
1454
|
+
#
|
1400
1455
|
# @overload import_key_material(params = {})
|
1401
1456
|
# @param [Hash] params ({})
|
1402
1457
|
def import_key_material(params = {}, options = {})
|
@@ -1407,18 +1462,17 @@ module Aws::KMS
|
|
1407
1462
|
# Lists all of the key aliases in the account.
|
1408
1463
|
#
|
1409
1464
|
# @option params [Integer] :limit
|
1410
|
-
#
|
1411
|
-
#
|
1412
|
-
#
|
1465
|
+
# Use this parameter to specify the maximum number of items to return.
|
1466
|
+
# When this value is present, AWS KMS does not return more than the
|
1467
|
+
# specified number of items, but it might return fewer.
|
1413
1468
|
#
|
1414
1469
|
# This value is optional. If you include a value, it must be between 1
|
1415
1470
|
# and 100, inclusive. If you do not include a value, it defaults to 50.
|
1416
1471
|
#
|
1417
1472
|
# @option params [String] :marker
|
1418
|
-
# Use this parameter
|
1419
|
-
#
|
1420
|
-
#
|
1421
|
-
# just received.
|
1473
|
+
# Use this parameter in a subsequent request after you receive a
|
1474
|
+
# response with truncated results. Set it to the value of `NextMarker`
|
1475
|
+
# from the truncated response you just received.
|
1422
1476
|
#
|
1423
1477
|
# @return [Types::ListAliasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1424
1478
|
#
|
@@ -1442,6 +1496,8 @@ module Aws::KMS
|
|
1442
1496
|
# resp.next_marker #=> String
|
1443
1497
|
# resp.truncated #=> Boolean
|
1444
1498
|
#
|
1499
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListAliases AWS API Documentation
|
1500
|
+
#
|
1445
1501
|
# @overload list_aliases(params = {})
|
1446
1502
|
# @param [Hash] params ({})
|
1447
1503
|
def list_aliases(params = {}, options = {})
|
@@ -1452,18 +1508,17 @@ module Aws::KMS
|
|
1452
1508
|
# List the grants for a specified key.
|
1453
1509
|
#
|
1454
1510
|
# @option params [Integer] :limit
|
1455
|
-
#
|
1456
|
-
#
|
1457
|
-
#
|
1511
|
+
# Use this parameter to specify the maximum number of items to return.
|
1512
|
+
# When this value is present, AWS KMS does not return more than the
|
1513
|
+
# specified number of items, but it might return fewer.
|
1458
1514
|
#
|
1459
1515
|
# This value is optional. If you include a value, it must be between 1
|
1460
1516
|
# and 100, inclusive. If you do not include a value, it defaults to 50.
|
1461
1517
|
#
|
1462
1518
|
# @option params [String] :marker
|
1463
|
-
# Use this parameter
|
1464
|
-
#
|
1465
|
-
#
|
1466
|
-
# just received.
|
1519
|
+
# Use this parameter in a subsequent request after you receive a
|
1520
|
+
# response with truncated results. Set it to the value of `NextMarker`
|
1521
|
+
# from the truncated response you just received.
|
1467
1522
|
#
|
1468
1523
|
# @option params [required, String] :key_id
|
1469
1524
|
# A unique identifier for the customer master key. This value can be a
|
@@ -1508,6 +1563,8 @@ module Aws::KMS
|
|
1508
1563
|
# resp.next_marker #=> String
|
1509
1564
|
# resp.truncated #=> Boolean
|
1510
1565
|
#
|
1566
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListGrants AWS API Documentation
|
1567
|
+
#
|
1511
1568
|
# @overload list_grants(params = {})
|
1512
1569
|
# @param [Hash] params ({})
|
1513
1570
|
def list_grants(params = {}, options = {})
|
@@ -1527,9 +1584,9 @@ module Aws::KMS
|
|
1527
1584
|
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
1528
1585
|
#
|
1529
1586
|
# @option params [Integer] :limit
|
1530
|
-
#
|
1531
|
-
#
|
1532
|
-
#
|
1587
|
+
# Use this parameter to specify the maximum number of items to return.
|
1588
|
+
# When this value is present, AWS KMS does not return more than the
|
1589
|
+
# specified number of items, but it might return fewer.
|
1533
1590
|
#
|
1534
1591
|
# This value is optional. If you include a value, it must be between 1
|
1535
1592
|
# and 1000, inclusive. If you do not include a value, it defaults to
|
@@ -1538,10 +1595,9 @@ module Aws::KMS
|
|
1538
1595
|
# Currently only 1 policy can be attached to a key.
|
1539
1596
|
#
|
1540
1597
|
# @option params [String] :marker
|
1541
|
-
# Use this parameter
|
1542
|
-
#
|
1543
|
-
#
|
1544
|
-
# just received.
|
1598
|
+
# Use this parameter in a subsequent request after you receive a
|
1599
|
+
# response with truncated results. Set it to the value of `NextMarker`
|
1600
|
+
# from the truncated response you just received.
|
1545
1601
|
#
|
1546
1602
|
# @return [Types::ListKeyPoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1547
1603
|
#
|
@@ -1564,6 +1620,8 @@ module Aws::KMS
|
|
1564
1620
|
# resp.next_marker #=> String
|
1565
1621
|
# resp.truncated #=> Boolean
|
1566
1622
|
#
|
1623
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeyPolicies AWS API Documentation
|
1624
|
+
#
|
1567
1625
|
# @overload list_key_policies(params = {})
|
1568
1626
|
# @param [Hash] params ({})
|
1569
1627
|
def list_key_policies(params = {}, options = {})
|
@@ -1574,19 +1632,18 @@ module Aws::KMS
|
|
1574
1632
|
# Lists the customer master keys.
|
1575
1633
|
#
|
1576
1634
|
# @option params [Integer] :limit
|
1577
|
-
#
|
1578
|
-
#
|
1579
|
-
#
|
1635
|
+
# Use this parameter to specify the maximum number of items to return.
|
1636
|
+
# When this value is present, AWS KMS does not return more than the
|
1637
|
+
# specified number of items, but it might return fewer.
|
1580
1638
|
#
|
1581
1639
|
# This value is optional. If you include a value, it must be between 1
|
1582
1640
|
# and 1000, inclusive. If you do not include a value, it defaults to
|
1583
1641
|
# 100.
|
1584
1642
|
#
|
1585
1643
|
# @option params [String] :marker
|
1586
|
-
# Use this parameter
|
1587
|
-
#
|
1588
|
-
#
|
1589
|
-
# just received.
|
1644
|
+
# Use this parameter in a subsequent request after you receive a
|
1645
|
+
# response with truncated results. Set it to the value of `NextMarker`
|
1646
|
+
# from the truncated response you just received.
|
1590
1647
|
#
|
1591
1648
|
# @return [Types::ListKeysResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1592
1649
|
#
|
@@ -1609,6 +1666,8 @@ module Aws::KMS
|
|
1609
1666
|
# resp.next_marker #=> String
|
1610
1667
|
# resp.truncated #=> Boolean
|
1611
1668
|
#
|
1669
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeys AWS API Documentation
|
1670
|
+
#
|
1612
1671
|
# @overload list_keys(params = {})
|
1613
1672
|
# @param [Hash] params ({})
|
1614
1673
|
def list_keys(params = {}, options = {})
|
@@ -1616,6 +1675,66 @@ module Aws::KMS
|
|
1616
1675
|
req.send_request(options)
|
1617
1676
|
end
|
1618
1677
|
|
1678
|
+
# Returns a list of all tags for the specified customer master key
|
1679
|
+
# (CMK).
|
1680
|
+
#
|
1681
|
+
# @option params [required, String] :key_id
|
1682
|
+
# A unique identifier for the CMK whose tags you are listing. You can
|
1683
|
+
# use the unique key ID or the Amazon Resource Name (ARN) of the CMK.
|
1684
|
+
# Examples:
|
1685
|
+
#
|
1686
|
+
# * Unique key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
1687
|
+
#
|
1688
|
+
# * Key ARN:
|
1689
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
1690
|
+
#
|
1691
|
+
# @option params [Integer] :limit
|
1692
|
+
# Use this parameter to specify the maximum number of items to return.
|
1693
|
+
# When this value is present, AWS KMS does not return more than the
|
1694
|
+
# specified number of items, but it might return fewer.
|
1695
|
+
#
|
1696
|
+
# This value is optional. If you include a value, it must be between 1
|
1697
|
+
# and 50, inclusive. If you do not include a value, it defaults to 50.
|
1698
|
+
#
|
1699
|
+
# @option params [String] :marker
|
1700
|
+
# Use this parameter in a subsequent request after you receive a
|
1701
|
+
# response with truncated results. Set it to the value of `NextMarker`
|
1702
|
+
# from the truncated response you just received.
|
1703
|
+
#
|
1704
|
+
# Do not attempt to construct this value. Use only the value of
|
1705
|
+
# `NextMarker` from the truncated response you just received.
|
1706
|
+
#
|
1707
|
+
# @return [Types::ListResourceTagsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1708
|
+
#
|
1709
|
+
# * {Types::ListResourceTagsResponse#tags #tags} => Array<Types::Tag>
|
1710
|
+
# * {Types::ListResourceTagsResponse#next_marker #next_marker} => String
|
1711
|
+
# * {Types::ListResourceTagsResponse#truncated #truncated} => Boolean
|
1712
|
+
#
|
1713
|
+
# @example Request syntax with placeholder values
|
1714
|
+
#
|
1715
|
+
# resp = client.list_resource_tags({
|
1716
|
+
# key_id: "KeyIdType", # required
|
1717
|
+
# limit: 1,
|
1718
|
+
# marker: "MarkerType",
|
1719
|
+
# })
|
1720
|
+
#
|
1721
|
+
# @example Response structure
|
1722
|
+
#
|
1723
|
+
# resp.tags #=> Array
|
1724
|
+
# resp.tags[0].tag_key #=> String
|
1725
|
+
# resp.tags[0].tag_value #=> String
|
1726
|
+
# resp.next_marker #=> String
|
1727
|
+
# resp.truncated #=> Boolean
|
1728
|
+
#
|
1729
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListResourceTags AWS API Documentation
|
1730
|
+
#
|
1731
|
+
# @overload list_resource_tags(params = {})
|
1732
|
+
# @param [Hash] params ({})
|
1733
|
+
def list_resource_tags(params = {}, options = {})
|
1734
|
+
req = build_request(:list_resource_tags, params)
|
1735
|
+
req.send_request(options)
|
1736
|
+
end
|
1737
|
+
|
1619
1738
|
# Returns a list of all grants for which the grant's
|
1620
1739
|
# `RetiringPrincipal` matches the one specified.
|
1621
1740
|
#
|
@@ -1623,18 +1742,17 @@ module Aws::KMS
|
|
1623
1742
|
# retire a grant, use RetireGrant.
|
1624
1743
|
#
|
1625
1744
|
# @option params [Integer] :limit
|
1626
|
-
#
|
1627
|
-
#
|
1628
|
-
#
|
1745
|
+
# Use this parameter to specify the maximum number of items to return.
|
1746
|
+
# When this value is present, AWS KMS does not return more than the
|
1747
|
+
# specified number of items, but it might return fewer.
|
1629
1748
|
#
|
1630
1749
|
# This value is optional. If you include a value, it must be between 1
|
1631
1750
|
# and 100, inclusive. If you do not include a value, it defaults to 50.
|
1632
1751
|
#
|
1633
1752
|
# @option params [String] :marker
|
1634
|
-
# Use this parameter
|
1635
|
-
#
|
1636
|
-
#
|
1637
|
-
# just received.
|
1753
|
+
# Use this parameter in a subsequent request after you receive a
|
1754
|
+
# response with truncated results. Set it to the value of `NextMarker`
|
1755
|
+
# from the truncated response you just received.
|
1638
1756
|
#
|
1639
1757
|
# @option params [required, String] :retiring_principal
|
1640
1758
|
# The retiring principal for which to list grants.
|
@@ -1684,6 +1802,8 @@ module Aws::KMS
|
|
1684
1802
|
# resp.next_marker #=> String
|
1685
1803
|
# resp.truncated #=> Boolean
|
1686
1804
|
#
|
1805
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListRetirableGrants AWS API Documentation
|
1806
|
+
#
|
1687
1807
|
# @overload list_retirable_grants(params = {})
|
1688
1808
|
# @param [Hash] params ({})
|
1689
1809
|
def list_retirable_grants(params = {}, options = {})
|
@@ -1722,14 +1842,14 @@ module Aws::KMS
|
|
1722
1842
|
# If you do not set `BypassPolicyLockoutSafetyCheck` to true, the policy
|
1723
1843
|
# must meet the following criteria:
|
1724
1844
|
#
|
1725
|
-
# * It must allow the principal making the `PutKeyPolicy`
|
1726
|
-
# make a subsequent `PutKeyPolicy` request on the CMK. This
|
1727
|
-
# the likelihood that the CMK becomes unmanageable. For more
|
1845
|
+
# * It must allow the principal that is making the `PutKeyPolicy`
|
1846
|
+
# request to make a subsequent `PutKeyPolicy` request on the CMK. This
|
1847
|
+
# reduces the likelihood that the CMK becomes unmanageable. For more
|
1728
1848
|
# information, refer to the scenario in the [Default Key Policy][1]
|
1729
1849
|
# section in the *AWS Key Management Service Developer Guide*.
|
1730
1850
|
#
|
1731
|
-
# * The
|
1732
|
-
# visible to AWS KMS. When you create a new AWS principal (for
|
1851
|
+
# * The principals that are specified in the key policy must exist and
|
1852
|
+
# be visible to AWS KMS. When you create a new AWS principal (for
|
1733
1853
|
# example, an IAM user or role), you might need to enforce a delay
|
1734
1854
|
# before specifying the new principal in a key policy because the new
|
1735
1855
|
# principal might not immediately be visible to AWS KMS. For more
|
@@ -1754,9 +1874,9 @@ module Aws::KMS
|
|
1754
1874
|
# Policy][1] section in the *AWS Key Management Service Developer
|
1755
1875
|
# Guide*.
|
1756
1876
|
#
|
1757
|
-
# Use this parameter only when you intend to prevent the principal
|
1758
|
-
# making the request from making a subsequent `PutKeyPolicy` request
|
1759
|
-
# the CMK.
|
1877
|
+
# Use this parameter only when you intend to prevent the principal that
|
1878
|
+
# is making the request from making a subsequent `PutKeyPolicy` request
|
1879
|
+
# on the CMK.
|
1760
1880
|
#
|
1761
1881
|
# The default value is false.
|
1762
1882
|
#
|
@@ -1775,6 +1895,8 @@ module Aws::KMS
|
|
1775
1895
|
# bypass_policy_lockout_safety_check: false,
|
1776
1896
|
# })
|
1777
1897
|
#
|
1898
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/PutKeyPolicy AWS API Documentation
|
1899
|
+
#
|
1778
1900
|
# @overload put_key_policy(params = {})
|
1779
1901
|
# @param [Hash] params ({})
|
1780
1902
|
def put_key_policy(params = {}, options = {})
|
@@ -1862,6 +1984,8 @@ module Aws::KMS
|
|
1862
1984
|
# resp.source_key_id #=> String
|
1863
1985
|
# resp.key_id #=> String
|
1864
1986
|
#
|
1987
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ReEncrypt AWS API Documentation
|
1988
|
+
#
|
1865
1989
|
# @overload re_encrypt(params = {})
|
1866
1990
|
# @param [Hash] params ({})
|
1867
1991
|
def re_encrypt(params = {}, options = {})
|
@@ -1917,6 +2041,8 @@ module Aws::KMS
|
|
1917
2041
|
# grant_id: "GrantIdType",
|
1918
2042
|
# })
|
1919
2043
|
#
|
2044
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/RetireGrant AWS API Documentation
|
2045
|
+
#
|
1920
2046
|
# @overload retire_grant(params = {})
|
1921
2047
|
# @param [Hash] params ({})
|
1922
2048
|
def retire_grant(params = {}, options = {})
|
@@ -1950,6 +2076,8 @@ module Aws::KMS
|
|
1950
2076
|
# grant_id: "GrantIdType", # required
|
1951
2077
|
# })
|
1952
2078
|
#
|
2079
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/RevokeGrant AWS API Documentation
|
2080
|
+
#
|
1953
2081
|
# @overload revoke_grant(params = {})
|
1954
2082
|
# @param [Hash] params ({})
|
1955
2083
|
def revoke_grant(params = {}, options = {})
|
@@ -2017,6 +2145,8 @@ module Aws::KMS
|
|
2017
2145
|
# resp.key_id #=> String
|
2018
2146
|
# resp.deletion_date #=> Time
|
2019
2147
|
#
|
2148
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ScheduleKeyDeletion AWS API Documentation
|
2149
|
+
#
|
2020
2150
|
# @overload schedule_key_deletion(params = {})
|
2021
2151
|
# @param [Hash] params ({})
|
2022
2152
|
def schedule_key_deletion(params = {}, options = {})
|
@@ -2024,6 +2154,92 @@ module Aws::KMS
|
|
2024
2154
|
req.send_request(options)
|
2025
2155
|
end
|
2026
2156
|
|
2157
|
+
# Adds or overwrites one or more tags for the specified customer master
|
2158
|
+
# key (CMK).
|
2159
|
+
#
|
2160
|
+
# Each tag consists of a tag key and a tag value. Tag keys and tag
|
2161
|
+
# values are both required, but tag values can be empty (null) strings.
|
2162
|
+
#
|
2163
|
+
# You cannot use the same tag key more than once per CMK. For example,
|
2164
|
+
# consider a CMK with one tag whose tag key is `Purpose` and tag value
|
2165
|
+
# is `Test`. If you send a `TagResource` request for this CMK with a tag
|
2166
|
+
# key of `Purpose` and a tag value of `Prod`, it does not create a
|
2167
|
+
# second tag. Instead, the original tag is overwritten with the new tag
|
2168
|
+
# value.
|
2169
|
+
#
|
2170
|
+
# @option params [required, String] :key_id
|
2171
|
+
# A unique identifier for the CMK you are tagging. You can use the
|
2172
|
+
# unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
|
2173
|
+
#
|
2174
|
+
# * Unique key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
2175
|
+
#
|
2176
|
+
# * Key ARN:
|
2177
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
2178
|
+
#
|
2179
|
+
# @option params [required, Array<Types::Tag>] :tags
|
2180
|
+
# One or more tags. Each tag consists of a tag key and a tag value.
|
2181
|
+
#
|
2182
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2183
|
+
#
|
2184
|
+
# @example Request syntax with placeholder values
|
2185
|
+
#
|
2186
|
+
# resp = client.tag_resource({
|
2187
|
+
# key_id: "KeyIdType", # required
|
2188
|
+
# tags: [ # required
|
2189
|
+
# {
|
2190
|
+
# tag_key: "TagKeyType", # required
|
2191
|
+
# tag_value: "TagValueType", # required
|
2192
|
+
# },
|
2193
|
+
# ],
|
2194
|
+
# })
|
2195
|
+
#
|
2196
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/TagResource AWS API Documentation
|
2197
|
+
#
|
2198
|
+
# @overload tag_resource(params = {})
|
2199
|
+
# @param [Hash] params ({})
|
2200
|
+
def tag_resource(params = {}, options = {})
|
2201
|
+
req = build_request(:tag_resource, params)
|
2202
|
+
req.send_request(options)
|
2203
|
+
end
|
2204
|
+
|
2205
|
+
# Removes the specified tag or tags from the specified customer master
|
2206
|
+
# key (CMK).
|
2207
|
+
#
|
2208
|
+
# To remove a tag, you specify the tag key for each tag to remove. You
|
2209
|
+
# do not specify the tag value. To overwrite the tag value for an
|
2210
|
+
# existing tag, use TagResource.
|
2211
|
+
#
|
2212
|
+
# @option params [required, String] :key_id
|
2213
|
+
# A unique identifier for the CMK from which you are removing tags. You
|
2214
|
+
# can use the unique key ID or the Amazon Resource Name (ARN) of the
|
2215
|
+
# CMK. Examples:
|
2216
|
+
#
|
2217
|
+
# * Unique key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
2218
|
+
#
|
2219
|
+
# * Key ARN:
|
2220
|
+
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
2221
|
+
#
|
2222
|
+
# @option params [required, Array<String>] :tag_keys
|
2223
|
+
# One or more tag keys. Specify only the tag keys, not the tag values.
|
2224
|
+
#
|
2225
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2226
|
+
#
|
2227
|
+
# @example Request syntax with placeholder values
|
2228
|
+
#
|
2229
|
+
# resp = client.untag_resource({
|
2230
|
+
# key_id: "KeyIdType", # required
|
2231
|
+
# tag_keys: ["TagKeyType"], # required
|
2232
|
+
# })
|
2233
|
+
#
|
2234
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UntagResource AWS API Documentation
|
2235
|
+
#
|
2236
|
+
# @overload untag_resource(params = {})
|
2237
|
+
# @param [Hash] params ({})
|
2238
|
+
def untag_resource(params = {}, options = {})
|
2239
|
+
req = build_request(:untag_resource, params)
|
2240
|
+
req.send_request(options)
|
2241
|
+
end
|
2242
|
+
|
2027
2243
|
# Updates an alias to map it to a different key.
|
2028
2244
|
#
|
2029
2245
|
# An alias is not a property of a key. Therefore, an alias can be mapped
|
@@ -2067,6 +2283,8 @@ module Aws::KMS
|
|
2067
2283
|
# target_key_id: "KeyIdType", # required
|
2068
2284
|
# })
|
2069
2285
|
#
|
2286
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateAlias AWS API Documentation
|
2287
|
+
#
|
2070
2288
|
# @overload update_alias(params = {})
|
2071
2289
|
# @param [Hash] params ({})
|
2072
2290
|
def update_alias(params = {}, options = {})
|
@@ -2098,6 +2316,8 @@ module Aws::KMS
|
|
2098
2316
|
# description: "DescriptionType", # required
|
2099
2317
|
# })
|
2100
2318
|
#
|
2319
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateKeyDescription AWS API Documentation
|
2320
|
+
#
|
2101
2321
|
# @overload update_key_description(params = {})
|
2102
2322
|
# @param [Hash] params ({})
|
2103
2323
|
def update_key_description(params = {}, options = {})
|
@@ -2118,7 +2338,7 @@ module Aws::KMS
|
|
2118
2338
|
params: params,
|
2119
2339
|
config: config)
|
2120
2340
|
context[:gem_name] = 'aws-sdk-kms'
|
2121
|
-
context[:gem_version] = '1.0.0.
|
2341
|
+
context[:gem_version] = '1.0.0.rc3'
|
2122
2342
|
Seahorse::Client::Request.new(handlers, context)
|
2123
2343
|
end
|
2124
2344
|
|