Skip to content

Commit

Permalink
feat(client-quicksight): New Q embedding supporting Generative Q&A
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed Apr 30, 2024
1 parent df7acb1 commit 90a9ac3
Show file tree
Hide file tree
Showing 36 changed files with 972 additions and 317 deletions.
8 changes: 8 additions & 0 deletions clients/client-quicksight/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1487,6 +1487,14 @@ UpdateRoleCustomPermission

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/UpdateRoleCustomPermissionCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateRoleCustomPermissionCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateRoleCustomPermissionCommandOutput/)

</details>
<details>
<summary>
UpdateSPICECapacityConfiguration
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/quicksight/command/UpdateSPICECapacityConfigurationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateSPICECapacityConfigurationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-quicksight/Interface/UpdateSPICECapacityConfigurationCommandOutput/)

</details>
<details>
<summary>
Expand Down
23 changes: 23 additions & 0 deletions clients/client-quicksight/src/QuickSight.ts
Original file line number Diff line number Diff line change
Expand Up @@ -746,6 +746,11 @@ import {
UpdateRoleCustomPermissionCommandInput,
UpdateRoleCustomPermissionCommandOutput,
} from "./commands/UpdateRoleCustomPermissionCommand";
import {
UpdateSPICECapacityConfigurationCommand,
UpdateSPICECapacityConfigurationCommandInput,
UpdateSPICECapacityConfigurationCommandOutput,
} from "./commands/UpdateSPICECapacityConfigurationCommand";
import {
UpdateTemplateAliasCommand,
UpdateTemplateAliasCommandInput,
Expand Down Expand Up @@ -952,6 +957,7 @@ const commands = {
UpdatePublicSharingSettingsCommand,
UpdateRefreshScheduleCommand,
UpdateRoleCustomPermissionCommand,
UpdateSPICECapacityConfigurationCommand,
UpdateTemplateCommand,
UpdateTemplateAliasCommand,
UpdateTemplatePermissionsCommand,
Expand Down Expand Up @@ -3434,6 +3440,23 @@ export interface QuickSight {
cb: (err: any, data?: UpdateRoleCustomPermissionCommandOutput) => void
): void;

/**
* @see {@link UpdateSPICECapacityConfigurationCommand}
*/
updateSPICECapacityConfiguration(
args: UpdateSPICECapacityConfigurationCommandInput,
options?: __HttpHandlerOptions
): Promise<UpdateSPICECapacityConfigurationCommandOutput>;
updateSPICECapacityConfiguration(
args: UpdateSPICECapacityConfigurationCommandInput,
cb: (err: any, data?: UpdateSPICECapacityConfigurationCommandOutput) => void
): void;
updateSPICECapacityConfiguration(
args: UpdateSPICECapacityConfigurationCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: UpdateSPICECapacityConfigurationCommandOutput) => void
): void;

/**
* @see {@link UpdateTemplateCommand}
*/
Expand Down
6 changes: 6 additions & 0 deletions clients/client-quicksight/src/QuickSightClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -477,6 +477,10 @@ import {
UpdateRoleCustomPermissionCommandInput,
UpdateRoleCustomPermissionCommandOutput,
} from "./commands/UpdateRoleCustomPermissionCommand";
import {
UpdateSPICECapacityConfigurationCommandInput,
UpdateSPICECapacityConfigurationCommandOutput,
} from "./commands/UpdateSPICECapacityConfigurationCommand";
import {
UpdateTemplateAliasCommandInput,
UpdateTemplateAliasCommandOutput,
Expand Down Expand Up @@ -681,6 +685,7 @@ export type ServiceInputTypes =
| UpdatePublicSharingSettingsCommandInput
| UpdateRefreshScheduleCommandInput
| UpdateRoleCustomPermissionCommandInput
| UpdateSPICECapacityConfigurationCommandInput
| UpdateTemplateAliasCommandInput
| UpdateTemplateCommandInput
| UpdateTemplatePermissionsCommandInput
Expand Down Expand Up @@ -857,6 +862,7 @@ export type ServiceOutputTypes =
| UpdatePublicSharingSettingsCommandOutput
| UpdateRefreshScheduleCommandOutput
| UpdateRoleCustomPermissionCommandOutput
| UpdateSPICECapacityConfigurationCommandOutput
| UpdateTemplateAliasCommandOutput
| UpdateTemplateCommandOutput
| UpdateTemplatePermissionsCommandOutput
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ export interface CreateAccountSubscriptionCommandOutput extends CreateAccountSub
* // const { QuickSightClient, CreateAccountSubscriptionCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
* const client = new QuickSightClient(config);
* const input = { // CreateAccountSubscriptionRequest
* Edition: "STANDARD" || "ENTERPRISE" || "ENTERPRISE_AND_Q", // required
* Edition: "STANDARD" || "ENTERPRISE" || "ENTERPRISE_AND_Q",
* AuthenticationMethod: "IAM_AND_QUICKSIGHT" || "IAM_ONLY" || "ACTIVE_DIRECTORY" || "IAM_IDENTITY_CENTER", // required
* AwsAccountId: "STRING_VALUE", // required
* AccountName: "STRING_VALUE", // required
Expand All @@ -73,6 +73,13 @@ export interface CreateAccountSubscriptionCommandOutput extends CreateAccountSub
* ReaderGroup: [
* "STRING_VALUE",
* ],
* AdminProGroup: [
* "STRING_VALUE",
* ],
* AuthorProGroup: [
* "STRING_VALUE",
* ],
* ReaderProGroup: "<GroupsList>",
* FirstName: "STRING_VALUE",
* LastName: "STRING_VALUE",
* EmailAddress: "STRING_VALUE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2923,6 +2923,10 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M
* },
* ],
* },
* ColorConfiguration: { // GaugeChartColorConfiguration
* ForegroundColor: "STRING_VALUE",
* BackgroundColor: "STRING_VALUE",
* },
* Interactions: "<VisualInteractionOptions>",
* },
* ConditionalFormatting: { // GaugeChartConditionalFormatting
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2967,6 +2967,10 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _
* },
* ],
* },
* ColorConfiguration: { // GaugeChartColorConfiguration
* ForegroundColor: "STRING_VALUE",
* BackgroundColor: "STRING_VALUE",
* },
* Interactions: "<VisualInteractionOptions>",
* },
* ConditionalFormatting: { // GaugeChartConditionalFormatting
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ export interface CreateRoleMembershipCommandOutput extends CreateRoleMembershipR
* MemberName: "STRING_VALUE", // required
* AwsAccountId: "STRING_VALUE", // required
* Namespace: "STRING_VALUE", // required
* Role: "ADMIN" || "AUTHOR" || "READER", // required
* Role: "ADMIN" || "AUTHOR" || "READER" || "ADMIN_PRO" || "AUTHOR_PRO" || "READER_PRO", // required
* };
* const command = new CreateRoleMembershipCommand(input);
* const response = await client.send(command);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2917,6 +2917,10 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M
* },
* ],
* },
* ColorConfiguration: { // GaugeChartColorConfiguration
* ForegroundColor: "STRING_VALUE",
* BackgroundColor: "STRING_VALUE",
* },
* Interactions: "<VisualInteractionOptions>",
* },
* ConditionalFormatting: { // GaugeChartConditionalFormatting
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export interface DeleteRoleCustomPermissionCommandOutput extends DeleteRoleCusto
* // const { QuickSightClient, DeleteRoleCustomPermissionCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
* const client = new QuickSightClient(config);
* const input = { // DeleteRoleCustomPermissionRequest
* Role: "ADMIN" || "AUTHOR" || "READER", // required
* Role: "ADMIN" || "AUTHOR" || "READER" || "ADMIN_PRO" || "AUTHOR_PRO" || "READER_PRO", // required
* AwsAccountId: "STRING_VALUE", // required
* Namespace: "STRING_VALUE", // required
* };
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ export interface DeleteRoleMembershipCommandOutput extends DeleteRoleMembershipR
* const client = new QuickSightClient(config);
* const input = { // DeleteRoleMembershipRequest
* MemberName: "STRING_VALUE", // required
* Role: "ADMIN" || "AUTHOR" || "READER", // required
* Role: "ADMIN" || "AUTHOR" || "READER" || "ADMIN_PRO" || "AUTHOR_PRO" || "READER_PRO", // required
* AwsAccountId: "STRING_VALUE", // required
* Namespace: "STRING_VALUE", // required
* };
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2889,6 +2889,10 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi
* // },
* // ],
* // },
* // ColorConfiguration: { // GaugeChartColorConfiguration
* // ForegroundColor: "STRING_VALUE",
* // BackgroundColor: "STRING_VALUE",
* // },
* // Interactions: "<VisualInteractionOptions>",
* // },
* // ConditionalFormatting: { // GaugeChartConditionalFormatting
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2896,6 +2896,10 @@ export interface DescribeDashboardDefinitionCommandOutput
* // },
* // ],
* // },
* // ColorConfiguration: { // GaugeChartColorConfiguration
* // ForegroundColor: "STRING_VALUE",
* // BackgroundColor: "STRING_VALUE",
* // },
* // Interactions: "<VisualInteractionOptions>",
* // },
* // ConditionalFormatting: { // GaugeChartConditionalFormatting
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ export interface DescribeRoleCustomPermissionCommandOutput
* // const { QuickSightClient, DescribeRoleCustomPermissionCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
* const client = new QuickSightClient(config);
* const input = { // DescribeRoleCustomPermissionRequest
* Role: "ADMIN" || "AUTHOR" || "READER", // required
* Role: "ADMIN" || "AUTHOR" || "READER" || "ADMIN_PRO" || "AUTHOR_PRO" || "READER_PRO", // required
* AwsAccountId: "STRING_VALUE", // required
* Namespace: "STRING_VALUE", // required
* };
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2909,6 +2909,10 @@ export interface DescribeTemplateDefinitionCommandOutput extends DescribeTemplat
* // },
* // ],
* // },
* // ColorConfiguration: { // GaugeChartColorConfiguration
* // ForegroundColor: "STRING_VALUE",
* // BackgroundColor: "STRING_VALUE",
* // },
* // Interactions: "<VisualInteractionOptions>",
* // },
* // ConditionalFormatting: { // GaugeChartConditionalFormatting
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ export interface DescribeUserCommandOutput extends DescribeUserResponse, __Metad
* // Arn: "STRING_VALUE",
* // UserName: "STRING_VALUE",
* // Email: "STRING_VALUE",
* // Role: "ADMIN" || "AUTHOR" || "READER" || "RESTRICTED_AUTHOR" || "RESTRICTED_READER",
* // Role: "ADMIN" || "AUTHOR" || "READER" || "RESTRICTED_AUTHOR" || "RESTRICTED_READER" || "ADMIN_PRO" || "AUTHOR_PRO" || "READER_PRO",
* // IdentityType: "IAM" || "QUICKSIGHT" || "IAM_IDENTITY_CENTER",
* // Active: true || false,
* // PrincipalId: "STRING_VALUE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,9 @@ export interface GenerateEmbedUrlForAnonymousUserCommandOutput
* QSearchBar: { // AnonymousUserQSearchBarEmbeddingConfiguration
* InitialTopicId: "STRING_VALUE", // required
* },
* GenerativeQnA: { // AnonymousUserGenerativeQnAEmbeddingConfiguration
* InitialTopicId: "STRING_VALUE", // required
* },
* },
* AllowedDomains: [ // StringList
* "STRING_VALUE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,9 @@ export interface GenerateEmbedUrlForRegisteredUserCommandOutput
* VisualId: "STRING_VALUE", // required
* },
* },
* GenerativeQnA: { // RegisteredUserGenerativeQnAEmbeddingConfiguration
* InitialTopicId: "STRING_VALUE",
* },
* },
* AllowedDomains: [ // StringList
* "STRING_VALUE",
Expand Down
3 changes: 2 additions & 1 deletion clients/client-quicksight/src/commands/ListFoldersCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ import { Command as $Command } from "@smithy/smithy-client";
import { MetadataBearer as __MetadataBearer } from "@smithy/types";

import { commonParams } from "../endpoint/EndpointParameters";
import { ListFoldersRequest, ListFoldersResponse } from "../models/models_3";
import { ListFoldersRequest } from "../models/models_3";
import { ListFoldersResponse } from "../models/models_4";
import { de_ListFoldersCommand, se_ListFoldersCommand } from "../protocols/Aws_restJson1";
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client";
import { MetadataBearer as __MetadataBearer } from "@smithy/types";

import { commonParams } from "../endpoint/EndpointParameters";
import { ListGroupMembershipsRequest, ListGroupMembershipsResponse } from "../models/models_3";
import { ListGroupMembershipsRequest, ListGroupMembershipsResponse } from "../models/models_4";
import { de_ListGroupMembershipsCommand, se_ListGroupMembershipsCommand } from "../protocols/Aws_restJson1";
import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export interface ListRoleMembershipsCommandOutput extends ListRoleMembershipsRes
* // const { QuickSightClient, ListRoleMembershipsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
* const client = new QuickSightClient(config);
* const input = { // ListRoleMembershipsRequest
* Role: "ADMIN" || "AUTHOR" || "READER", // required
* Role: "ADMIN" || "AUTHOR" || "READER" || "ADMIN_PRO" || "AUTHOR_PRO" || "READER_PRO", // required
* NextToken: "STRING_VALUE",
* MaxResults: Number("int"),
* AwsAccountId: "STRING_VALUE", // required
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ export interface ListTopicsCommandOutput extends ListTopicsResponse, __MetadataB
* // Arn: "STRING_VALUE",
* // TopicId: "STRING_VALUE",
* // Name: "STRING_VALUE",
* // UserExperienceVersion: "LEGACY" || "NEW_READER_EXPERIENCE",
* // },
* // ],
* // NextToken: "STRING_VALUE",
Expand Down
2 changes: 1 addition & 1 deletion clients/client-quicksight/src/commands/ListUsersCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBea
* // Arn: "STRING_VALUE",
* // UserName: "STRING_VALUE",
* // Email: "STRING_VALUE",
* // Role: "ADMIN" || "AUTHOR" || "READER" || "RESTRICTED_AUTHOR" || "RESTRICTED_READER",
* // Role: "ADMIN" || "AUTHOR" || "READER" || "RESTRICTED_AUTHOR" || "RESTRICTED_READER" || "ADMIN_PRO" || "AUTHOR_PRO" || "READER_PRO",
* // IdentityType: "IAM" || "QUICKSIGHT" || "IAM_IDENTITY_CENTER",
* // Active: true || false,
* // PrincipalId: "STRING_VALUE",
Expand Down
4 changes: 2 additions & 2 deletions clients/client-quicksight/src/commands/RegisterUserCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ export interface RegisterUserCommandOutput extends RegisterUserResponse, __Metad
* const input = { // RegisterUserRequest
* IdentityType: "IAM" || "QUICKSIGHT" || "IAM_IDENTITY_CENTER", // required
* Email: "STRING_VALUE", // required
* UserRole: "ADMIN" || "AUTHOR" || "READER" || "RESTRICTED_AUTHOR" || "RESTRICTED_READER", // required
* UserRole: "ADMIN" || "AUTHOR" || "READER" || "RESTRICTED_AUTHOR" || "RESTRICTED_READER" || "ADMIN_PRO" || "AUTHOR_PRO" || "READER_PRO", // required
* IamArn: "STRING_VALUE",
* SessionName: "STRING_VALUE",
* AwsAccountId: "STRING_VALUE", // required
Expand All @@ -61,7 +61,7 @@ export interface RegisterUserCommandOutput extends RegisterUserResponse, __Metad
* // Arn: "STRING_VALUE",
* // UserName: "STRING_VALUE",
* // Email: "STRING_VALUE",
* // Role: "ADMIN" || "AUTHOR" || "READER" || "RESTRICTED_AUTHOR" || "RESTRICTED_READER",
* // Role: "ADMIN" || "AUTHOR" || "READER" || "RESTRICTED_AUTHOR" || "RESTRICTED_READER" || "ADMIN_PRO" || "AUTHOR_PRO" || "READER_PRO",
* // IdentityType: "IAM" || "QUICKSIGHT" || "IAM_IDENTITY_CENTER",
* // Active: true || false,
* // PrincipalId: "STRING_VALUE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2909,6 +2909,10 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M
* },
* ],
* },
* ColorConfiguration: { // GaugeChartColorConfiguration
* ForegroundColor: "STRING_VALUE",
* BackgroundColor: "STRING_VALUE",
* },
* Interactions: "<VisualInteractionOptions>",
* },
* ConditionalFormatting: { // GaugeChartConditionalFormatting
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2952,6 +2952,10 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _
* },
* ],
* },
* ColorConfiguration: { // GaugeChartColorConfiguration
* ForegroundColor: "STRING_VALUE",
* BackgroundColor: "STRING_VALUE",
* },
* Interactions: "<VisualInteractionOptions>",
* },
* ConditionalFormatting: { // GaugeChartConditionalFormatting
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ export interface UpdateRoleCustomPermissionCommandOutput extends UpdateRoleCusto
* const client = new QuickSightClient(config);
* const input = { // UpdateRoleCustomPermissionRequest
* CustomPermissionsName: "STRING_VALUE", // required
* Role: "ADMIN" || "AUTHOR" || "READER", // required
* Role: "ADMIN" || "AUTHOR" || "READER" || "ADMIN_PRO" || "AUTHOR_PRO" || "READER_PRO", // required
* AwsAccountId: "STRING_VALUE", // required
* Namespace: "STRING_VALUE", // required
* };
Expand Down
Loading

0 comments on commit 90a9ac3

Please sign in to comment.