Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Python: KMS, basics #6963

Merged
161 changes: 104 additions & 57 deletions .doc_gen/metadata/kms_metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,15 @@ kms_TagResource:
- description:
snippet_tags:
- kms.java2_tag.main
Python:
versions:
- sdk_version: 3
github: python/example_code/kms
excerpts:
- description:
snippet_tags:
- python.example_code.kms.KeyManager.decl
- python.example_code.kms.TagResource
services:
kms: {TagResource}
kms_Sign:
Expand All @@ -40,8 +49,30 @@ kms_Sign:
- description:
snippet_tags:
- kms.java2_sign.main
Python:
versions:
- sdk_version: 3
github: python/example_code/kms
excerpts:
- description:
snippet_tags:
- python.example_code.kms.KeyEncrypt.decl
- python.example_code.kms.Sign
services:
kms: {Sign}
kms_Verify:
languages:
Python:
versions:
- sdk_version: 3
github: python/example_code/kms
excerpts:
- description:
snippet_tags:
- python.example_code.kms.KeyEncrypt.decl
- python.example_code.kms.Verify
services:
kms: {Verify}
kms_CreateKey:
languages:
Kotlin:
Expand Down Expand Up @@ -69,7 +100,7 @@ kms_CreateKey:
excerpts:
- description:
snippet_tags:
- python.example_code.kms.KeyManager
- python.example_code.kms.KeyManager.decl
- python.example_code.kms.CreateKey
Ruby:
versions:
Expand Down Expand Up @@ -125,7 +156,7 @@ kms_Decrypt:
excerpts:
- description:
snippet_tags:
- python.example_code.kms.KeyEncrypt
- python.example_code.kms.KeyEncrypt.decl
- python.example_code.kms.Decrypt
Ruby:
versions:
Expand Down Expand Up @@ -172,7 +203,7 @@ kms_Encrypt:
excerpts:
- description:
snippet_tags:
- python.example_code.kms.KeyEncrypt
- python.example_code.kms.KeyEncrypt.decl
- python.example_code.kms.Encrypt
Ruby:
versions:
Expand Down Expand Up @@ -201,7 +232,7 @@ kms_GenerateDataKey:
excerpts:
- description:
snippet_tags:
- python.example_code.kms.KeyManager
- python.example_code.kms.KeyManager.decl
- python.example_code.kms.GenerateDataKey
Rust:
versions:
Expand Down Expand Up @@ -273,7 +304,7 @@ kms_ListKeys:
excerpts:
- description:
snippet_tags:
- python.example_code.kms.KeyManager
- python.example_code.kms.KeyManager.decl
- python.example_code.kms.ListKeys
Rust:
versions:
Expand All @@ -294,7 +325,7 @@ kms_ReEncrypt:
excerpts:
- description:
snippet_tags:
- python.example_code.kms.KeyEncrypt
- python.example_code.kms.KeyEncrypt.decl
- python.example_code.kms.ReEncrypt
Rust:
versions:
Expand Down Expand Up @@ -350,7 +381,7 @@ kms_CreateAlias:
excerpts:
- description:
snippet_tags:
- python.example_code.kms.AliasManager
- python.example_code.kms.AliasManager.decl
- python.example_code.kms.CreateAlias
services:
kms: {CreateAlias}
Expand Down Expand Up @@ -390,7 +421,7 @@ kms_CreateGrant:
excerpts:
- description:
snippet_tags:
- python.example_code.kms.GrantManager
- python.example_code.kms.GrantManager.decl
- python.example_code.kms.CreateGrant
services:
kms: {CreateGrant}
Expand Down Expand Up @@ -430,7 +461,7 @@ kms_DescribeKey:
excerpts:
- description:
snippet_tags:
- python.example_code.kms.KeyManager
- python.example_code.kms.KeyManager.decl
- python.example_code.kms.DescribeKey
services:
kms: {DescribeKey}
Expand Down Expand Up @@ -470,8 +501,8 @@ kms_DisableKey:
excerpts:
- description:
snippet_tags:
- python.example_code.kms.KeyManager
- python.example_code.kms.EnableDisableKey
- python.example_code.kms.KeyManager.decl
- python.example_code.kms.DisableKey
services:
kms: {DisableKey}
kms_EnableKey:
Expand Down Expand Up @@ -510,8 +541,8 @@ kms_EnableKey:
excerpts:
- description:
snippet_tags:
- python.example_code.kms.KeyManager
- python.example_code.kms.EnableDisableKey
- python.example_code.kms.KeyManager.decl
- python.example_code.kms.EnableKey
services:
kms: {EnableKey}
kms_ScheduleKeyDeletion:
Expand All @@ -533,7 +564,7 @@ kms_ScheduleKeyDeletion:
excerpts:
- description:
snippet_tags:
- python.example_code.kms.KeyManager
- python.example_code.kms.KeyManager.decl
- python.example_code.kms.ScheduleKeyDeletion
services:
kms: {ScheduleKeyDeletion}
Expand Down Expand Up @@ -573,7 +604,7 @@ kms_ListAliases:
excerpts:
- description:
snippet_tags:
- python.example_code.kms.AliasManager
- python.example_code.kms.AliasManager.decl
- python.example_code.kms.ListAliases
services:
kms: {ListAliases}
Expand All @@ -587,7 +618,7 @@ kms_UpdateAlias:
excerpts:
- description:
snippet_tags:
- python.example_code.kms.AliasManager
- python.example_code.kms.AliasManager.decl
- python.example_code.kms.UpdateAlias
services:
kms: {UpdateAlias}
Expand All @@ -610,7 +641,7 @@ kms_DeleteAlias:
excerpts:
- description:
snippet_tags:
- python.example_code.kms.AliasManager
- python.example_code.kms.AliasManager.decl
- python.example_code.kms.DeleteAlias
services:
kms: {DeleteAlias}
Expand Down Expand Up @@ -650,7 +681,7 @@ kms_ListGrants:
excerpts:
- description:
snippet_tags:
- python.example_code.kms.GrantManager
- python.example_code.kms.GrantManager.decl
- python.example_code.kms.ListGrants
services:
kms: {ListGrants}
Expand All @@ -664,7 +695,7 @@ kms_RetireGrant:
excerpts:
- description:
snippet_tags:
- python.example_code.kms.GrantManager
- python.example_code.kms.GrantManager.decl
- python.example_code.kms.RetireGrant
services:
kms: {RetireGrant}
Expand All @@ -687,7 +718,7 @@ kms_RevokeGrant:
excerpts:
- description:
snippet_tags:
- python.example_code.kms.GrantManager
- python.example_code.kms.GrantManager.decl
- python.example_code.kms.RevokeGrant
services:
kms: {RevokeGrant}
Expand All @@ -710,7 +741,7 @@ kms_ListKeyPolicies:
excerpts:
- description:
snippet_tags:
- python.example_code.kms.KeyPolicy
- python.example_code.kms.KeyPolicy.decl
- python.example_code.kms.ListKeyPolicies
services:
kms: {ListKeyPolicies}
Expand All @@ -724,7 +755,7 @@ kms_GetKeyPolicy:
excerpts:
- description:
snippet_tags:
- python.example_code.kms.KeyPolicy
- python.example_code.kms.KeyPolicy.decl
- python.example_code.kms.GetKeyPolicy
services:
kms: {GetKeyPolicy}
Expand All @@ -738,18 +769,11 @@ kms_PutKeyPolicy:
excerpts:
- description:
snippet_tags:
- python.example_code.kms.KeyPolicy
- python.example_code.kms.KeyPolicy.decl
- python.example_code.kms.PutKeyPolicy
services:
kms: {PutKeyPolicy}
kms_Scenario_KeyEncryption:
title: Encrypt and decrypt text with &kms-keys-long; using an &AWS; SDK
title_abbrev: Encrypt and decrypt text
synopsis_list:
- Encrypt plain text by using a &kms-key;.
- Decrypt ciphertext by using a &kms-key;.
- Reencrypt ciphertext by using a second &kms-key;.
category: Scenarios
kms_EnableKeyRotation:
languages:
Python:
versions:
Expand All @@ -759,34 +783,11 @@ kms_Scenario_KeyEncryption:
excerpts:
- description:
snippet_tags:
- python.example_code.kms.Scenario_KeyEncryption
- python.example_code.kms.KeyManager.decl
- python.example_code.kms.EnableKeyRotation
services:
kms: {Encrypt, Decrypt, ReEncrypt}
kms_Scenario_KeyManagement:
title: Manage &kms-keys-long; using an &AWS; SDK
title_abbrev: Manage keys
synopsis_list:
- Create a &kms-key;.
- List &kms-keys; for your account and get details about them.
- Enable and disable &kms-keys;.
- Generate a symmetric data key that can be used for client-side encryption.
- Delete &kms-keys;.
category: Scenarios
languages:
Python:
versions:
- sdk_version: 3
github: python/example_code/kms
sdkguide:
excerpts:
- description:
snippet_tags:
- python.example_code.kms.Scenario_KeyManagement
services:
kms: {CreateKey, ListKeys, DescribeKey, GenerateDataKey, EnableKey, DisableKey, ScheduleKeyDeletion}
kms: {EnableKeyRotation}
kms_Scenario_Basics:
title: Learn core operations for &kms-key; using an &AWS; SDK
title_abbrev: Learn &kms-key; core operations
synopsis_list:
- Create a &kms-key;.
- List &kms-keys; for your account and get details about them.
Expand All @@ -809,6 +810,52 @@ kms_Scenario_Basics:
- description: Define a class that wraps KMS actions.
snippet_tags:
- kms.java2_actions.main
Python:
versions:
- sdk_version: 3
github: python/example_code/kms
sdkguide:
excerpts:
- description:
snippet_tags:
- python.example_code.kms.kms_basics
- description: Wrapper class and methods for &kms-key; management.
snippet_tags:
- python.example_code.kms.KeyManager.decl
- python.example_code.kms.CreateKey
- python.example_code.kms.DescribeKey
- python.example_code.kms.EnableKeyRotation
- python.example_code.kms.CreateAsymmetricKey
- python.example_code.kms.TagResource
- python.example_code.kms.ScheduleKeyDeletion
- description: >
Wrapper class and methods for &kms-key; aliases.
snippet_tags:
- python.example_code.kms.AliasManager.decl
- python.example_code.kms.CreateAlias
- python.example_code.kms.ListAliases
- python.example_code.kms.DeleteAlias
- description: >
Wrapper class and methods for &kms-key; encryption.
snippet_tags:
- python.example_code.kms.KeyEncrypt.decl
- python.example_code.kms.Encrypt
- python.example_code.kms.Decrypt
- python.example_code.kms.Sign
- python.example_code.kms.Verify
- description: >
Wrapper class and methods for &kms-key; grants.
snippet_tags:
- python.example_code.kms.GrantManager.decl
- python.example_code.kms.CreateGrant
- python.example_code.kms.ListGrants
- python.example_code.kms.RevokeGrant
- description: >
Wrapper class and methods for &kms-key; policies.
snippet_tags:
- python.example_code.kms.KeyPolicy.decl
- python.example_code.kms.set_new_policy
- python.example_code.kms.GetKeyPolicy
services:
kms: {CreateKey, ListKeys, DescribeKey, GenerateDataKey, EnableKey, Sign, DisableKey, ScheduleKeyDeletion}

4 changes: 2 additions & 2 deletions javav2/example_code/kms/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ For prerequisites, see the [README](../../README.md#Prerequisites) in the `javav

Code examples that show you how to perform the essential operations within a service.

- [Learn KMS key core operations](src/main/java/com/example/kms/scenario/KMSScenario.java)
- [Learn the basics](src/main/java/com/example/kms/scenario/KMSScenario.java)


### Single actions
Expand Down Expand Up @@ -80,7 +80,7 @@ Code excerpts that show you how to call individual service functions.
This example shows you how to get started using KMS key.


#### Learn KMS key core operations
#### Learn the basics

This example shows you how to do the following:

Expand Down
Loading
Loading