PHP: KMS Basics follow

awsdocs · Oct 8, 2024 · c3b0097 · c3b0097
1 parent 7714007
commit c3b0097
Show file tree

Hide file tree

Showing 14 changed files with 4,083 additions and 219 deletions.
diff --git a/.doc_gen/metadata/kms_metadata.yaml b/.doc_gen/metadata/kms_metadata.yaml
@@ -1,8 +1,8 @@
 # zexi 0.4.0
 kms_Hello:
-  title: Hello &kms-key;
-  title_abbrev: Hello &kms-key;
-  synopsis: get started using &kms-key;.
+  title: Hello &KMSlong;
+  title_abbrev: Hello &KMS;
+  synopsis: get started using &KMSlong;.
   category: Hello
   languages:
     Java:
@@ -14,8 +14,17 @@ kms_Hello:
             - description:
               snippet_tags:
                 - kms.java2_list_keys.main
+    PHP:
+      versions:
+        - sdk_version: 3
+          github: php/example_code/kms
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - php.example_code.kms.basics.helloService
   services:
-    kms: {listKeysPaginator}
+    kms: {ListKeys}
 kms_TagResource:
   languages:
     Java:
@@ -27,6 +36,15 @@ kms_TagResource:
             - description:
               snippet_tags:
                 - kms.java2_tag.main
+    PHP:
+      versions:
+        - sdk_version: 3
+          github: php/example_code/kms
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - php.example_code.kms.service.tagResource
   services:
     kms: {TagResource}
 kms_Sign:
@@ -40,6 +58,15 @@ kms_Sign:
             - description:
               snippet_tags:
                 - kms.java2_sign.main
+    PHP:
+      versions:
+        - sdk_version: 3
+          github: php/example_code/kms
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - php.example_code.kms.service.sign
   services:
     kms: {Sign}
 kms_CreateKey:
@@ -62,6 +89,15 @@ kms_CreateKey:
             - description:
               snippet_tags:
                 - kms.java2_create_key.main
+    PHP:
+      versions:
+        - sdk_version: 3
+          github: php/example_code/kms
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - php.example_code.kms.service.createKey
     Python:
       versions:
         - sdk_version: 3
@@ -118,6 +154,15 @@ kms_Decrypt:
             - description:
               snippet_tags:
                 - kms.java2_decrypt_data.main
+    PHP:
+      versions:
+        - sdk_version: 3
+          github: php/example_code/kms
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - php.example_code.kms.service.decrypt
     Python:
       versions:
         - sdk_version: 3
@@ -165,6 +210,15 @@ kms_Encrypt:
             - description:
               snippet_tags:
                 - kms.java2_encrypt_data.main
+    PHP:
+      versions:
+        - sdk_version: 3
+          github: php/example_code/kms
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - php.example_code.kms.service.encrypt
     Python:
       versions:
         - sdk_version: 3
@@ -266,6 +320,15 @@ kms_ListKeys:
             - description:
               snippet_tags:
                 - KMS.dotnetv3.ListKeysExample
+    PHP:
+      versions:
+        - sdk_version: 3
+          github: php/example_code/kms
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - php.example_code.kms.service.listKeys
     Python:
       versions:
         - sdk_version: 3
@@ -343,6 +406,15 @@ kms_CreateAlias:
             - description:
               snippet_tags:
                 - kms.dotnetv3.CreateAliasExample
+    PHP:
+      versions:
+        - sdk_version: 3
+          github: php/example_code/kms
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - php.example_code.kms.service.createAlias
     Python:
       versions:
         - sdk_version: 3
@@ -383,6 +455,15 @@ kms_CreateGrant:
             - description:
               snippet_tags:
                 - KMS.dotnetv3.CreateGrantExample
+    PHP:
+      versions:
+        - sdk_version: 3
+          github: php/example_code/kms
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - php.example_code.kms.service.createGrant
     Python:
       versions:
         - sdk_version: 3
@@ -423,6 +504,15 @@ kms_DescribeKey:
             - description:
               snippet_tags:
                 - KMS.dotnetv3.DescribeKeyExample
+    PHP:
+      versions:
+        - sdk_version: 3
+          github: php/example_code/kms
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - php.example_code.kms.service.describeKey
     Python:
       versions:
         - sdk_version: 3
@@ -463,6 +553,15 @@ kms_DisableKey:
             - description:
               snippet_tags:
                 - KMS.dotnetv3.DisableKeyExample
+    PHP:
+      versions:
+        - sdk_version: 3
+          github: php/example_code/kms
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - php.example_code.kms.service.disableKey
     Python:
       versions:
         - sdk_version: 3
@@ -503,6 +602,15 @@ kms_EnableKey:
             - description:
               snippet_tags:
                 - KMS.dotnetv3.EnableKeyExample
+    PHP:
+      versions:
+        - sdk_version: 3
+          github: php/example_code/kms
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - php.example_code.kms.service.enableKey
     Python:
       versions:
         - sdk_version: 3
@@ -525,6 +633,15 @@ kms_ScheduleKeyDeletion:
             - description:
               snippet_tags:
                 - kms.java2_delete_key.main
+    PHP:
+      versions:
+        - sdk_version: 3
+          github: php/example_code/kms
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - php.example_code.kms.service.scheduleKeyDeletion
     Python:
       versions:
         - sdk_version: 3
@@ -566,6 +683,15 @@ kms_ListAliases:
             - description:
               snippet_tags:
                 - KMS.dotnetv3.ListAliasesExample
+    PHP:
+      versions:
+        - sdk_version: 3
+          github: php/example_code/kms
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - php.example_code.kms.service.listAliases
     Python:
       versions:
         - sdk_version: 3
@@ -602,6 +728,15 @@ kms_DeleteAlias:
             - description:
               snippet_tags:
                 - kms.java2_delete_alias.main
+    PHP:
+      versions:
+        - sdk_version: 3
+          github: php/example_code/kms
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - php.example_code.kms.service.deleteAlias
     Python:
       versions:
         - sdk_version: 3
@@ -643,6 +778,15 @@ kms_ListGrants:
             - description:
               snippet_tags:
                 - KMS.dotnetv3.ListGrantsExample
+    PHP:
+      versions:
+        - sdk_version: 3
+          github: php/example_code/kms
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - php.example_code.kms.service.listGrants
     Python:
       versions:
         - sdk_version: 3
@@ -679,6 +823,15 @@ kms_RevokeGrant:
             - description:
               snippet_tags:
                 - kms.java2_revoke_grant.main
+    PHP:
+      versions:
+        - sdk_version: 3
+          github: php/example_code/kms
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - php.example_code.kms.service.revokeGrant
     Python:
       versions:
         - sdk_version: 3
@@ -730,6 +883,15 @@ kms_GetKeyPolicy:
     kms: {GetKeyPolicy}
 kms_PutKeyPolicy:
   languages:
+    PHP:
+      versions:
+        - sdk_version: 3
+          github: php/example_code/kms
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - php.example_code.kms.service.putKeyPolicy
     Python:
       versions:
         - sdk_version: 3
@@ -743,7 +905,7 @@ kms_PutKeyPolicy:
   services:
     kms: {PutKeyPolicy}
 kms_Scenario_KeyEncryption:
-  title: Encrypt and decrypt text with &kms-keys-long; using an &AWS; SDK
+  title: Encrypt and decrypt text with &KMSlong; using an &AWS; SDK
   title_abbrev: Encrypt and decrypt text
   synopsis_list:
     - Encrypt plain text by using a &kms-key;.
@@ -785,8 +947,6 @@ kms_Scenario_KeyManagement:
   services:
     kms: {CreateKey, ListKeys, DescribeKey, GenerateDataKey, EnableKey, DisableKey, ScheduleKeyDeletion}
 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.
@@ -809,6 +969,15 @@ kms_Scenario_Basics:
             - description: Define a class that wraps KMS actions.
               snippet_tags:
                 - kms.java2_actions.main   
+    PHP:
+      versions:
+        - sdk_version: 3
+          github: php/example_code/kms
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - php.example_code.kms.Basics
+                - php.example_code.kms.service.KmsService
   services:
-    kms: {CreateKey, ListKeys, DescribeKey, GenerateDataKey, EnableKey, Sign, DisableKey, ScheduleKeyDeletion}
-
+    kms: {CreateKey, Decrypt, Encrypt, ListAliases, CreateAlias, CreateGrant, DescribeKey, DisableKey, EnableKey, ListKeys, ListGrants, GetKeyPolicy, RevokeGrant, ListGrants, ScheduleKeyDeletion, TagResource, Sign}
diff --git a/javav2/example_code/kms/README.md b/javav2/example_code/kms/README.md
@@ -31,14 +31,14 @@ For prerequisites, see the [README](../../README.md#Prerequisites) in the `javav
 
 ### Get started
 
-- [Hello KMS key](src/main/java/com/example/kms/HelloKMS.java#L6) (`listKeysPaginator`)
+- [Hello AWS KMS](src/main/java/com/example/kms/HelloKMS.java#L6) (`ListKeys`)
 
 
 ### Basics
 
 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
@@ -75,12 +75,12 @@ Code excerpts that show you how to call individual service functions.
 <!--custom.instructions.start-->
 <!--custom.instructions.end-->
 
-#### Hello KMS key
+#### Hello AWS KMS
 
-This example shows you how to get started using KMS key.
+This example shows you how to get started using AWS Key Management Service (AWS KMS).
 
 
-#### Learn KMS key core operations
+#### Learn the basics
 
 This example shows you how to do the following:
 

diff --git a/php/composer.json b/php/composer.json
@@ -1,7 +1,8 @@
 {
     "require": {
         "aws/aws-sdk-php": "^3.209",
-        "ext-zip": "*"
+        "ext-zip": "*",
+        "ext-readline": "*"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.5",

diff --git a/php/example_code/composer.json b/php/example_code/composer.json
@@ -23,6 +23,7 @@
       "DynamoDb\\PartiQL_Basics\\": "dynamodb/partiql_basics",
       "Glue\\": "glue/",
       "Iam\\": "iam/",
+      "Kms\\": "kms/",
       "Lambda\\": "lambda/",
       "S3\\": "s3/"
     },