feat(client-quicksight): Added ability to tag users upon creation.

aws · Sep 25, 2023 · dacb8c6 · dacb8c6
1 parent c1d80c2
commit dacb8c6
Show file tree

Hide file tree

Showing 8 changed files with 32 additions and 9 deletions.
diff --git a/clients/client-quicksight/src/commands/CreateFolderMembershipCommand.ts b/clients/client-quicksight/src/commands/CreateFolderMembershipCommand.ts
@@ -48,15 +48,15 @@ export interface CreateFolderMembershipCommandOutput extends CreateFolderMembers
  *   AwsAccountId: "STRING_VALUE", // required
  *   FolderId: "STRING_VALUE", // required
  *   MemberId: "STRING_VALUE", // required
- *   MemberType: "DASHBOARD" || "ANALYSIS" || "DATASET", // required
+ *   MemberType: "DASHBOARD" || "ANALYSIS" || "DATASET" || "TOPIC", // required
  * };
  * const command = new CreateFolderMembershipCommand(input);
  * const response = await client.send(command);
  * // { // CreateFolderMembershipResponse
  * //   Status: Number("int"),
  * //   FolderMember: { // FolderMember
  * //     MemberId: "STRING_VALUE",
- * //     MemberType: "DASHBOARD" || "ANALYSIS" || "DATASET",
+ * //     MemberType: "DASHBOARD" || "ANALYSIS" || "DATASET" || "TOPIC",
  * //   },
  * //   RequestId: "STRING_VALUE",
  * // };

diff --git a/clients/client-quicksight/src/commands/DeleteFolderMembershipCommand.ts b/clients/client-quicksight/src/commands/DeleteFolderMembershipCommand.ts
@@ -48,7 +48,7 @@ export interface DeleteFolderMembershipCommandOutput extends DeleteFolderMembers
  *   AwsAccountId: "STRING_VALUE", // required
  *   FolderId: "STRING_VALUE", // required
  *   MemberId: "STRING_VALUE", // required
- *   MemberType: "DASHBOARD" || "ANALYSIS" || "DATASET", // required
+ *   MemberType: "DASHBOARD" || "ANALYSIS" || "DATASET" || "TOPIC", // required
  * };
  * const command = new DeleteFolderMembershipCommand(input);
  * const response = await client.send(command);

diff --git a/clients/client-quicksight/src/commands/RegisterUserCommand.ts b/clients/client-quicksight/src/commands/RegisterUserCommand.ts
@@ -57,6 +57,12 @@ export interface RegisterUserCommandOutput extends RegisterUserResponse, __Metad
  *   ExternalLoginFederationProviderType: "STRING_VALUE",
  *   CustomFederationProviderUrl: "STRING_VALUE",
  *   ExternalLoginId: "STRING_VALUE",
+ *   Tags: [ // TagList
+ *     { // Tag
+ *       Key: "STRING_VALUE", // required
+ *       Value: "STRING_VALUE", // required
+ *     },
+ *   ],
  * };
  * const command = new RegisterUserCommand(input);
  * const response = await client.send(command);

diff --git a/clients/client-quicksight/src/commands/TagResourceCommand.ts b/clients/client-quicksight/src/commands/TagResourceCommand.ts
@@ -46,15 +46,12 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
  * 			that is already associated with the resource, the new tag value that you specify
  * 			replaces the previous value for that tag.</p>
  *          <p>You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data
- * 			set, data source, dashboard, template, and topic. </p>
+ * 			set, data source, dashboard, template, topic, and user. </p>
  *          <p>Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for
  * 			the following:</p>
  *          <ul>
  *             <li>
- *                <p>You can't use tags to track costs for Amazon QuickSight. This isn't
- * 				possible because you can't tag the resources that Amazon QuickSight costs are based
- * 				on, for example Amazon QuickSight storage capacity (SPICE), number of users, type
- * 				of users, and usage metrics.</p>
+ *                <p>Tags are used to track costs for users in Amazon QuickSight. You can't tag other resources that Amazon QuickSight costs are based on, such as storage capacoty (SPICE), session usage, alert consumption, or reporting units.</p>
  *             </li>
  *             <li>
  *                <p>Amazon QuickSight doesn't currently support the tag editor for Resource Groups.</p>

diff --git a/clients/client-quicksight/src/models/models_2.ts b/clients/client-quicksight/src/models/models_2.ts
@@ -5724,6 +5724,7 @@ export const MemberType = {
   ANALYSIS: "ANALYSIS",
   DASHBOARD: "DASHBOARD",
   DATASET: "DATASET",
+  TOPIC: "TOPIC",
 } as const;
 
 /**

diff --git a/clients/client-quicksight/src/models/models_3.ts b/clients/client-quicksight/src/models/models_3.ts
@@ -8442,6 +8442,12 @@ export interface RegisterUserRequest {
    * <p>The identity ID for a user in the external login provider.</p>
    */
   ExternalLoginId?: string;
+
+  /**
+   * @public
+   * <p>The tags to associate with the user.</p>
+   */
+  Tags?: Tag[];
 }
 
 /**

diff --git a/clients/client-quicksight/src/protocols/Aws_restJson1.ts b/clients/client-quicksight/src/protocols/Aws_restJson1.ts
@@ -5637,6 +5637,7 @@ export const se_RegisterUserCommand = async (
       IamArn: [],
       IdentityType: [],
       SessionName: [],
+      Tags: (_) => _json(_),
       UserName: [],
       UserRole: [],
     })

diff --git a/codegen/sdk-codegen/aws-models/quicksight.json b/codegen/sdk-codegen/aws-models/quicksight.json
@@ -30287,6 +30287,12 @@
           "traits": {
             "smithy.api#enumValue": "DATASET"
           }
+        },
+        "TOPIC": {
+          "target": "smithy.api#Unit",
+          "traits": {
+            "smithy.api#enumValue": "TOPIC"
+          }
         }
       }
     },
@@ -36380,6 +36386,12 @@
           "traits": {
             "smithy.api#documentation": "<p>The identity ID for a user in the external login provider.</p>"
           }
+        },
+        "Tags": {
+          "target": "com.amazonaws.quicksight#TagList",
+          "traits": {
+            "smithy.api#documentation": "<p>The tags to associate with the user.</p>"
+          }
         }
       },
       "traits": {
@@ -42341,7 +42353,7 @@
         }
       ],
       "traits": {
-        "smithy.api#documentation": "<p>Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource. </p>\n         <p>Tags can help you organize and categorize your resources. You can also use them to\n\t\t\tscope user permissions, by granting a user permission to access or change only resources\n\t\t\twith certain tag values. You can use the <code>TagResource</code> operation with a\n\t\t\tresource that already has tags. If you specify a new tag key for the resource, this tag\n\t\t\tis appended to the list of tags associated with the resource. If you specify a tag key\n\t\t\tthat is already associated with the resource, the new tag value that you specify\n\t\t\treplaces the previous value for that tag.</p>\n         <p>You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data\n\t\t\tset, data source, dashboard, template, and topic. </p>\n         <p>Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for\n\t\t\tthe following:</p>\n         <ul>\n            <li>\n               <p>You can't use tags to track costs for Amazon QuickSight. This isn't\n\t\t\t\tpossible because you can't tag the resources that Amazon QuickSight costs are based \n\t\t\t\ton, for example Amazon QuickSight storage capacity (SPICE), number of users, type \n\t\t\t\tof users, and usage metrics.</p>\n            </li>\n            <li>\n               <p>Amazon QuickSight doesn't currently support the tag editor for Resource Groups.</p>\n            </li>\n         </ul>",
+        "smithy.api#documentation": "<p>Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource. </p>\n         <p>Tags can help you organize and categorize your resources. You can also use them to\n\t\t\tscope user permissions, by granting a user permission to access or change only resources\n\t\t\twith certain tag values. You can use the <code>TagResource</code> operation with a\n\t\t\tresource that already has tags. If you specify a new tag key for the resource, this tag\n\t\t\tis appended to the list of tags associated with the resource. If you specify a tag key\n\t\t\tthat is already associated with the resource, the new tag value that you specify\n\t\t\treplaces the previous value for that tag.</p>\n         <p>You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data\n\t\t\tset, data source, dashboard, template, topic, and user. </p>\n         <p>Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for\n\t\t\tthe following:</p>\n         <ul>\n            <li>\n               <p>Tags are used to track costs for users in Amazon QuickSight. You can't tag other resources that Amazon QuickSight costs are based on, such as storage capacoty (SPICE), session usage, alert consumption, or reporting units.</p>\n            </li>\n            <li>\n               <p>Amazon QuickSight doesn't currently support the tag editor for Resource Groups.</p>\n            </li>\n         </ul>",
         "smithy.api#http": {
           "method": "POST",
           "uri": "/resources/{ResourceArn}/tags",