Skip to content

Commit 53514f4

Browse files
meyertst-awsmeyertst-aws
authored
Python: KMS, basics (#6963)
* Started KMS scenario, 10 steps completed, working key policies.
1 parent 659f9fc commit 53514f4

16 files changed

+1332
-395
lines changed

‎.doc_gen/metadata/kms_metadata.yaml‎

Lines changed: 104 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,15 @@ kms_TagResource:
3636
- description:
3737
snippet_tags:
3838
- kms.java2_tag.main
39+
Python:
40+
versions:
41+
- sdk_version: 3
42+
github: python/example_code/kms
43+
excerpts:
44+
- description:
45+
snippet_tags:
46+
- python.example_code.kms.KeyManager.decl
47+
- python.example_code.kms.TagResource
3948
PHP:
4049
versions:
4150
- sdk_version: 3
@@ -58,6 +67,15 @@ kms_Sign:
5867
- description:
5968
snippet_tags:
6069
- kms.java2_sign.main
70+
Python:
71+
versions:
72+
- sdk_version: 3
73+
github: python/example_code/kms
74+
excerpts:
75+
- description:
76+
snippet_tags:
77+
- python.example_code.kms.KeyEncrypt.decl
78+
- python.example_code.kms.Sign
6179
PHP:
6280
versions:
6381
- sdk_version: 3
@@ -69,6 +87,19 @@ kms_Sign:
6987
- php.example_code.kms.service.sign
7088
services:
7189
kms: {Sign}
90+
kms_Verify:
91+
languages:
92+
Python:
93+
versions:
94+
- sdk_version: 3
95+
github: python/example_code/kms
96+
excerpts:
97+
- description:
98+
snippet_tags:
99+
- python.example_code.kms.KeyEncrypt.decl
100+
- python.example_code.kms.Verify
101+
services:
102+
kms: {Verify}
72103
kms_CreateKey:
73104
languages:
74105
Kotlin:
@@ -105,7 +136,7 @@ kms_CreateKey:
105136
excerpts:
106137
- description:
107138
snippet_tags:
108-
- python.example_code.kms.KeyManager
139+
- python.example_code.kms.KeyManager.decl
109140
- python.example_code.kms.CreateKey
110141
Ruby:
111142
versions:
@@ -170,7 +201,7 @@ kms_Decrypt:
170201
excerpts:
171202
- description:
172203
snippet_tags:
173-
- python.example_code.kms.KeyEncrypt
204+
- python.example_code.kms.KeyEncrypt.decl
174205
- python.example_code.kms.Decrypt
175206
Ruby:
176207
versions:
@@ -226,7 +257,7 @@ kms_Encrypt:
226257
excerpts:
227258
- description:
228259
snippet_tags:
229-
- python.example_code.kms.KeyEncrypt
260+
- python.example_code.kms.KeyEncrypt.decl
230261
- python.example_code.kms.Encrypt
231262
Ruby:
232263
versions:
@@ -255,7 +286,7 @@ kms_GenerateDataKey:
255286
excerpts:
256287
- description:
257288
snippet_tags:
258-
- python.example_code.kms.KeyManager
289+
- python.example_code.kms.KeyManager.decl
259290
- python.example_code.kms.GenerateDataKey
260291
Rust:
261292
versions:
@@ -336,7 +367,7 @@ kms_ListKeys:
336367
excerpts:
337368
- description:
338369
snippet_tags:
339-
- python.example_code.kms.KeyManager
370+
- python.example_code.kms.KeyManager.decl
340371
- python.example_code.kms.ListKeys
341372
Rust:
342373
versions:
@@ -357,7 +388,7 @@ kms_ReEncrypt:
357388
excerpts:
358389
- description:
359390
snippet_tags:
360-
- python.example_code.kms.KeyEncrypt
391+
- python.example_code.kms.KeyEncrypt.decl
361392
- python.example_code.kms.ReEncrypt
362393
Rust:
363394
versions:
@@ -422,7 +453,7 @@ kms_CreateAlias:
422453
excerpts:
423454
- description:
424455
snippet_tags:
425-
- python.example_code.kms.AliasManager
456+
- python.example_code.kms.AliasManager.decl
426457
- python.example_code.kms.CreateAlias
427458
services:
428459
kms: {CreateAlias}
@@ -471,7 +502,7 @@ kms_CreateGrant:
471502
excerpts:
472503
- description:
473504
snippet_tags:
474-
- python.example_code.kms.GrantManager
505+
- python.example_code.kms.GrantManager.decl
475506
- python.example_code.kms.CreateGrant
476507
services:
477508
kms: {CreateGrant}
@@ -520,7 +551,7 @@ kms_DescribeKey:
520551
excerpts:
521552
- description:
522553
snippet_tags:
523-
- python.example_code.kms.KeyManager
554+
- python.example_code.kms.KeyManager.decl
524555
- python.example_code.kms.DescribeKey
525556
services:
526557
kms: {DescribeKey}
@@ -569,8 +600,8 @@ kms_DisableKey:
569600
excerpts:
570601
- description:
571602
snippet_tags:
572-
- python.example_code.kms.KeyManager
573-
- python.example_code.kms.EnableDisableKey
603+
- python.example_code.kms.KeyManager.decl
604+
- python.example_code.kms.DisableKey
574605
services:
575606
kms: {DisableKey}
576607
kms_EnableKey:
@@ -618,8 +649,8 @@ kms_EnableKey:
618649
excerpts:
619650
- description:
620651
snippet_tags:
621-
- python.example_code.kms.KeyManager
622-
- python.example_code.kms.EnableDisableKey
652+
- python.example_code.kms.KeyManager.decl
653+
- python.example_code.kms.EnableKey
623654
services:
624655
kms: {EnableKey}
625656
kms_ScheduleKeyDeletion:
@@ -650,7 +681,7 @@ kms_ScheduleKeyDeletion:
650681
excerpts:
651682
- description:
652683
snippet_tags:
653-
- python.example_code.kms.KeyManager
684+
- python.example_code.kms.KeyManager.decl
654685
- python.example_code.kms.ScheduleKeyDeletion
655686
services:
656687
kms: {ScheduleKeyDeletion}
@@ -699,7 +730,7 @@ kms_ListAliases:
699730
excerpts:
700731
- description:
701732
snippet_tags:
702-
- python.example_code.kms.AliasManager
733+
- python.example_code.kms.AliasManager.decl
703734
- python.example_code.kms.ListAliases
704735
services:
705736
kms: {ListAliases}
@@ -713,7 +744,7 @@ kms_UpdateAlias:
713744
excerpts:
714745
- description:
715746
snippet_tags:
716-
- python.example_code.kms.AliasManager
747+
- python.example_code.kms.AliasManager.decl
717748
- python.example_code.kms.UpdateAlias
718749
services:
719750
kms: {UpdateAlias}
@@ -745,7 +776,7 @@ kms_DeleteAlias:
745776
excerpts:
746777
- description:
747778
snippet_tags:
748-
- python.example_code.kms.AliasManager
779+
- python.example_code.kms.AliasManager.decl
749780
- python.example_code.kms.DeleteAlias
750781
services:
751782
kms: {DeleteAlias}
@@ -794,7 +825,7 @@ kms_ListGrants:
794825
excerpts:
795826
- description:
796827
snippet_tags:
797-
- python.example_code.kms.GrantManager
828+
- python.example_code.kms.GrantManager.decl
798829
- python.example_code.kms.ListGrants
799830
services:
800831
kms: {ListGrants}
@@ -808,7 +839,7 @@ kms_RetireGrant:
808839
excerpts:
809840
- description:
810841
snippet_tags:
811-
- python.example_code.kms.GrantManager
842+
- python.example_code.kms.GrantManager.decl
812843
- python.example_code.kms.RetireGrant
813844
services:
814845
kms: {RetireGrant}
@@ -840,7 +871,7 @@ kms_RevokeGrant:
840871
excerpts:
841872
- description:
842873
snippet_tags:
843-
- python.example_code.kms.GrantManager
874+
- python.example_code.kms.GrantManager.decl
844875
- python.example_code.kms.RevokeGrant
845876
services:
846877
kms: {RevokeGrant}
@@ -863,7 +894,7 @@ kms_ListKeyPolicies:
863894
excerpts:
864895
- description:
865896
snippet_tags:
866-
- python.example_code.kms.KeyPolicy
897+
- python.example_code.kms.KeyPolicy.decl
867898
- python.example_code.kms.ListKeyPolicies
868899
services:
869900
kms: {ListKeyPolicies}
@@ -877,7 +908,7 @@ kms_GetKeyPolicy:
877908
excerpts:
878909
- description:
879910
snippet_tags:
880-
- python.example_code.kms.KeyPolicy
911+
- python.example_code.kms.KeyPolicy.decl
881912
- python.example_code.kms.GetKeyPolicy
882913
services:
883914
kms: {GetKeyPolicy}
@@ -900,18 +931,11 @@ kms_PutKeyPolicy:
900931
excerpts:
901932
- description:
902933
snippet_tags:
903-
- python.example_code.kms.KeyPolicy
934+
- python.example_code.kms.KeyPolicy.decl
904935
- python.example_code.kms.PutKeyPolicy
905936
services:
906937
kms: {PutKeyPolicy}
907-
kms_Scenario_KeyEncryption:
908-
title: Encrypt and decrypt text with &KMSlong; using an &AWS; SDK
909-
title_abbrev: Encrypt and decrypt text
910-
synopsis_list:
911-
- Encrypt plain text by using a &kms-key;.
912-
- Decrypt ciphertext by using a &kms-key;.
913-
- Reencrypt ciphertext by using a second &kms-key;.
914-
category: Scenarios
938+
kms_EnableKeyRotation:
915939
languages:
916940
Python:
917941
versions:
@@ -921,31 +945,10 @@ kms_Scenario_KeyEncryption:
921945
excerpts:
922946
- description:
923947
snippet_tags:
924-
- python.example_code.kms.Scenario_KeyEncryption
948+
- python.example_code.kms.KeyManager.decl
949+
- python.example_code.kms.EnableKeyRotation
925950
services:
926-
kms: {Encrypt, Decrypt, ReEncrypt}
927-
kms_Scenario_KeyManagement:
928-
title: Manage &kms-keys-long; using an &AWS; SDK
929-
title_abbrev: Manage keys
930-
synopsis_list:
931-
- Create a &kms-key;.
932-
- List &kms-keys; for your account and get details about them.
933-
- Enable and disable &kms-keys;.
934-
- Generate a symmetric data key that can be used for client-side encryption.
935-
- Delete &kms-keys;.
936-
category: Scenarios
937-
languages:
938-
Python:
939-
versions:
940-
- sdk_version: 3
941-
github: python/example_code/kms
942-
sdkguide:
943-
excerpts:
944-
- description:
945-
snippet_tags:
946-
- python.example_code.kms.Scenario_KeyManagement
947-
services:
948-
kms: {CreateKey, ListKeys, DescribeKey, GenerateDataKey, EnableKey, DisableKey, ScheduleKeyDeletion}
951+
kms: {EnableKeyRotation}
949952
kms_Scenario_Basics:
950953
synopsis_list:
951954
- Create a &kms-key;.
@@ -969,6 +972,52 @@ kms_Scenario_Basics:
969972
- description: Define a class that wraps KMS actions.
970973
snippet_tags:
971974
- kms.java2_actions.main
975+
Python:
976+
versions:
977+
- sdk_version: 3
978+
github: python/example_code/kms
979+
sdkguide:
980+
excerpts:
981+
- description:
982+
snippet_tags:
983+
- python.example_code.kms.kms_basics
984+
- description: Wrapper class and methods for &kms-key; management.
985+
snippet_tags:
986+
- python.example_code.kms.KeyManager.decl
987+
- python.example_code.kms.CreateKey
988+
- python.example_code.kms.DescribeKey
989+
- python.example_code.kms.EnableKeyRotation
990+
- python.example_code.kms.CreateAsymmetricKey
991+
- python.example_code.kms.TagResource
992+
- python.example_code.kms.ScheduleKeyDeletion
993+
- description: >
994+
Wrapper class and methods for &kms-key; aliases.
995+
snippet_tags:
996+
- python.example_code.kms.AliasManager.decl
997+
- python.example_code.kms.CreateAlias
998+
- python.example_code.kms.ListAliases
999+
- python.example_code.kms.DeleteAlias
1000+
- description: >
1001+
Wrapper class and methods for &kms-key; encryption.
1002+
snippet_tags:
1003+
- python.example_code.kms.KeyEncrypt.decl
1004+
- python.example_code.kms.Encrypt
1005+
- python.example_code.kms.Decrypt
1006+
- python.example_code.kms.Sign
1007+
- python.example_code.kms.Verify
1008+
- description: >
1009+
Wrapper class and methods for &kms-key; grants.
1010+
snippet_tags:
1011+
- python.example_code.kms.GrantManager.decl
1012+
- python.example_code.kms.CreateGrant
1013+
- python.example_code.kms.ListGrants
1014+
- python.example_code.kms.RevokeGrant
1015+
- description: >
1016+
Wrapper class and methods for &kms-key; policies.
1017+
snippet_tags:
1018+
- python.example_code.kms.KeyPolicy.decl
1019+
- python.example_code.kms.set_new_policy
1020+
- python.example_code.kms.GetKeyPolicy
9721021
PHP:
9731022
versions:
9741023
- sdk_version: 3

0 commit comments

Comments
 (0)