Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.
+ */ + public createRefreshSchedule( + args: CreateRefreshScheduleCommandInput, + options?: __HttpHandlerOptions + ): PromiseCreates a template either from a TemplateDefinition or from an existing Amazon QuickSight analysis or template. You can use the resulting
@@ -1428,6 +1501,39 @@ export class QuickSight extends QuickSightClient {
}
}
+ /**
+ * @public
+ *
Deletes the dataset refresh properties of the dataset.
+ */ + public deleteDataSetRefreshProperties( + args: DeleteDataSetRefreshPropertiesCommandInput, + options?: __HttpHandlerOptions + ): PromiseDeletes the data source permanently. This operation breaks @@ -1653,6 +1759,39 @@ export class QuickSight extends QuickSightClient { } } + /** + * @public + *
Deletes a refresh schedule from a dataset.
+ */ + public deleteRefreshSchedule( + args: DeleteRefreshScheduleCommandInput, + options?: __HttpHandlerOptions + ): PromiseDeletes a template.
@@ -2281,6 +2420,39 @@ export class QuickSight extends QuickSightClient { } } + /** + * @public + *Describes the refresh properties of a dataset.
+ */ + public describeDataSetRefreshProperties( + args: DescribeDataSetRefreshPropertiesCommandInput, + options?: __HttpHandlerOptions + ): PromiseDescribes a data source.
@@ -2646,6 +2818,39 @@ export class QuickSight extends QuickSightClient { } } + /** + * @public + *Provides a summary of a refresh schedule.
+ */ + public describeRefreshSchedule( + args: DescribeRefreshScheduleCommandInput, + options?: __HttpHandlerOptions + ): PromiseDescribes a template's metadata.
@@ -3544,6 +3749,39 @@ export class QuickSight extends QuickSightClient { } } + /** + * @public + *Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.
+ */ + public listRefreshSchedules( + args: ListRefreshSchedulesCommandInput, + options?: __HttpHandlerOptions + ): PromiseLists the tags assigned to a resource.
@@ -3829,6 +4067,39 @@ export class QuickSight extends QuickSightClient { } } + /** + * @public + *Creates or updates the dataset refresh properties for the dataset.
+ */ + public putDataSetRefreshProperties( + args: PutDataSetRefreshPropertiesCommandInput, + options?: __HttpHandlerOptions + ): PromiseCreates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Amazon QuickSight API, Amazon QuickSight generates a registration URL. The user accesses this registration URL to create their account. Amazon QuickSight doesn't send a registration email to users who are registered from the Amazon QuickSight API. If you want new users to receive a registration email, then add those users in the Amazon QuickSight console. For more information on registering a new user in the Amazon QuickSight console, see Inviting users to access Amazon QuickSight.
@@ -4750,6 +5021,39 @@ export class QuickSight extends QuickSightClient { } } + /** + * @public + *Updates a refresh schedule for a dataset.
+ */ + public updateRefreshSchedule( + args: UpdateRefreshScheduleCommandInput, + options?: __HttpHandlerOptions + ): PromiseUpdates a template from an existing Amazon QuickSight analysis or another template.
diff --git a/clients/client-quicksight/src/QuickSightClient.ts b/clients/client-quicksight/src/QuickSightClient.ts index d397d4f88427..c9bd4dfb8917 100644 --- a/clients/client-quicksight/src/QuickSightClient.ts +++ b/clients/client-quicksight/src/QuickSightClient.ts @@ -78,6 +78,10 @@ import { } from "./commands/CreateIAMPolicyAssignmentCommand"; import { CreateIngestionCommandInput, CreateIngestionCommandOutput } from "./commands/CreateIngestionCommand"; import { CreateNamespaceCommandInput, CreateNamespaceCommandOutput } from "./commands/CreateNamespaceCommand"; +import { + CreateRefreshScheduleCommandInput, + CreateRefreshScheduleCommandOutput, +} from "./commands/CreateRefreshScheduleCommand"; import { CreateTemplateAliasCommandInput, CreateTemplateAliasCommandOutput, @@ -96,6 +100,10 @@ import { import { DeleteAnalysisCommandInput, DeleteAnalysisCommandOutput } from "./commands/DeleteAnalysisCommand"; import { DeleteDashboardCommandInput, DeleteDashboardCommandOutput } from "./commands/DeleteDashboardCommand"; import { DeleteDataSetCommandInput, DeleteDataSetCommandOutput } from "./commands/DeleteDataSetCommand"; +import { + DeleteDataSetRefreshPropertiesCommandInput, + DeleteDataSetRefreshPropertiesCommandOutput, +} from "./commands/DeleteDataSetRefreshPropertiesCommand"; import { DeleteDataSourceCommandInput, DeleteDataSourceCommandOutput } from "./commands/DeleteDataSourceCommand"; import { DeleteFolderCommandInput, DeleteFolderCommandOutput } from "./commands/DeleteFolderCommand"; import { @@ -112,6 +120,10 @@ import { DeleteIAMPolicyAssignmentCommandOutput, } from "./commands/DeleteIAMPolicyAssignmentCommand"; import { DeleteNamespaceCommandInput, DeleteNamespaceCommandOutput } from "./commands/DeleteNamespaceCommand"; +import { + DeleteRefreshScheduleCommandInput, + DeleteRefreshScheduleCommandOutput, +} from "./commands/DeleteRefreshScheduleCommand"; import { DeleteTemplateAliasCommandInput, DeleteTemplateAliasCommandOutput, @@ -159,6 +171,10 @@ import { DescribeDataSetPermissionsCommandInput, DescribeDataSetPermissionsCommandOutput, } from "./commands/DescribeDataSetPermissionsCommand"; +import { + DescribeDataSetRefreshPropertiesCommandInput, + DescribeDataSetRefreshPropertiesCommandOutput, +} from "./commands/DescribeDataSetRefreshPropertiesCommand"; import { DescribeDataSourceCommandInput, DescribeDataSourceCommandOutput } from "./commands/DescribeDataSourceCommand"; import { DescribeDataSourcePermissionsCommandInput, @@ -188,6 +204,10 @@ import { DescribeIpRestrictionCommandOutput, } from "./commands/DescribeIpRestrictionCommand"; import { DescribeNamespaceCommandInput, DescribeNamespaceCommandOutput } from "./commands/DescribeNamespaceCommand"; +import { + DescribeRefreshScheduleCommandInput, + DescribeRefreshScheduleCommandOutput, +} from "./commands/DescribeRefreshScheduleCommand"; import { DescribeTemplateAliasCommandInput, DescribeTemplateAliasCommandOutput, @@ -246,6 +266,10 @@ import { } from "./commands/ListIAMPolicyAssignmentsForUserCommand"; import { ListIngestionsCommandInput, ListIngestionsCommandOutput } from "./commands/ListIngestionsCommand"; import { ListNamespacesCommandInput, ListNamespacesCommandOutput } from "./commands/ListNamespacesCommand"; +import { + ListRefreshSchedulesCommandInput, + ListRefreshSchedulesCommandOutput, +} from "./commands/ListRefreshSchedulesCommand"; import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, @@ -264,6 +288,10 @@ import { ListThemesCommandInput, ListThemesCommandOutput } from "./commands/List import { ListThemeVersionsCommandInput, ListThemeVersionsCommandOutput } from "./commands/ListThemeVersionsCommand"; import { ListUserGroupsCommandInput, ListUserGroupsCommandOutput } from "./commands/ListUserGroupsCommand"; import { ListUsersCommandInput, ListUsersCommandOutput } from "./commands/ListUsersCommand"; +import { + PutDataSetRefreshPropertiesCommandInput, + PutDataSetRefreshPropertiesCommandOutput, +} from "./commands/PutDataSetRefreshPropertiesCommand"; import { RegisterUserCommandInput, RegisterUserCommandOutput } from "./commands/RegisterUserCommand"; import { RestoreAnalysisCommandInput, RestoreAnalysisCommandOutput } from "./commands/RestoreAnalysisCommand"; import { SearchAnalysesCommandInput, SearchAnalysesCommandOutput } from "./commands/SearchAnalysesCommand"; @@ -324,6 +352,10 @@ import { UpdatePublicSharingSettingsCommandInput, UpdatePublicSharingSettingsCommandOutput, } from "./commands/UpdatePublicSharingSettingsCommand"; +import { + UpdateRefreshScheduleCommandInput, + UpdateRefreshScheduleCommandOutput, +} from "./commands/UpdateRefreshScheduleCommand"; import { UpdateTemplateAliasCommandInput, UpdateTemplateAliasCommandOutput, @@ -366,6 +398,7 @@ export type ServiceInputTypes = | CreateIAMPolicyAssignmentCommandInput | CreateIngestionCommandInput | CreateNamespaceCommandInput + | CreateRefreshScheduleCommandInput | CreateTemplateAliasCommandInput | CreateTemplateCommandInput | CreateThemeAliasCommandInput @@ -375,6 +408,7 @@ export type ServiceInputTypes = | DeleteAnalysisCommandInput | DeleteDashboardCommandInput | DeleteDataSetCommandInput + | DeleteDataSetRefreshPropertiesCommandInput | DeleteDataSourceCommandInput | DeleteFolderCommandInput | DeleteFolderMembershipCommandInput @@ -382,6 +416,7 @@ export type ServiceInputTypes = | DeleteGroupMembershipCommandInput | DeleteIAMPolicyAssignmentCommandInput | DeleteNamespaceCommandInput + | DeleteRefreshScheduleCommandInput | DeleteTemplateAliasCommandInput | DeleteTemplateCommandInput | DeleteThemeAliasCommandInput @@ -399,6 +434,7 @@ export type ServiceInputTypes = | DescribeDashboardPermissionsCommandInput | DescribeDataSetCommandInput | DescribeDataSetPermissionsCommandInput + | DescribeDataSetRefreshPropertiesCommandInput | DescribeDataSourceCommandInput | DescribeDataSourcePermissionsCommandInput | DescribeFolderCommandInput @@ -410,6 +446,7 @@ export type ServiceInputTypes = | DescribeIngestionCommandInput | DescribeIpRestrictionCommandInput | DescribeNamespaceCommandInput + | DescribeRefreshScheduleCommandInput | DescribeTemplateAliasCommandInput | DescribeTemplateCommandInput | DescribeTemplateDefinitionCommandInput @@ -435,6 +472,7 @@ export type ServiceInputTypes = | ListIAMPolicyAssignmentsForUserCommandInput | ListIngestionsCommandInput | ListNamespacesCommandInput + | ListRefreshSchedulesCommandInput | ListTagsForResourceCommandInput | ListTemplateAliasesCommandInput | ListTemplateVersionsCommandInput @@ -444,6 +482,7 @@ export type ServiceInputTypes = | ListThemesCommandInput | ListUserGroupsCommandInput | ListUsersCommandInput + | PutDataSetRefreshPropertiesCommandInput | RegisterUserCommandInput | RestoreAnalysisCommandInput | SearchAnalysesCommandInput @@ -471,6 +510,7 @@ export type ServiceInputTypes = | UpdateIAMPolicyAssignmentCommandInput | UpdateIpRestrictionCommandInput | UpdatePublicSharingSettingsCommandInput + | UpdateRefreshScheduleCommandInput | UpdateTemplateAliasCommandInput | UpdateTemplateCommandInput | UpdateTemplatePermissionsCommandInput @@ -497,6 +537,7 @@ export type ServiceOutputTypes = | CreateIAMPolicyAssignmentCommandOutput | CreateIngestionCommandOutput | CreateNamespaceCommandOutput + | CreateRefreshScheduleCommandOutput | CreateTemplateAliasCommandOutput | CreateTemplateCommandOutput | CreateThemeAliasCommandOutput @@ -506,6 +547,7 @@ export type ServiceOutputTypes = | DeleteAnalysisCommandOutput | DeleteDashboardCommandOutput | DeleteDataSetCommandOutput + | DeleteDataSetRefreshPropertiesCommandOutput | DeleteDataSourceCommandOutput | DeleteFolderCommandOutput | DeleteFolderMembershipCommandOutput @@ -513,6 +555,7 @@ export type ServiceOutputTypes = | DeleteGroupMembershipCommandOutput | DeleteIAMPolicyAssignmentCommandOutput | DeleteNamespaceCommandOutput + | DeleteRefreshScheduleCommandOutput | DeleteTemplateAliasCommandOutput | DeleteTemplateCommandOutput | DeleteThemeAliasCommandOutput @@ -530,6 +573,7 @@ export type ServiceOutputTypes = | DescribeDashboardPermissionsCommandOutput | DescribeDataSetCommandOutput | DescribeDataSetPermissionsCommandOutput + | DescribeDataSetRefreshPropertiesCommandOutput | DescribeDataSourceCommandOutput | DescribeDataSourcePermissionsCommandOutput | DescribeFolderCommandOutput @@ -541,6 +585,7 @@ export type ServiceOutputTypes = | DescribeIngestionCommandOutput | DescribeIpRestrictionCommandOutput | DescribeNamespaceCommandOutput + | DescribeRefreshScheduleCommandOutput | DescribeTemplateAliasCommandOutput | DescribeTemplateCommandOutput | DescribeTemplateDefinitionCommandOutput @@ -566,6 +611,7 @@ export type ServiceOutputTypes = | ListIAMPolicyAssignmentsForUserCommandOutput | ListIngestionsCommandOutput | ListNamespacesCommandOutput + | ListRefreshSchedulesCommandOutput | ListTagsForResourceCommandOutput | ListTemplateAliasesCommandOutput | ListTemplateVersionsCommandOutput @@ -575,6 +621,7 @@ export type ServiceOutputTypes = | ListThemesCommandOutput | ListUserGroupsCommandOutput | ListUsersCommandOutput + | PutDataSetRefreshPropertiesCommandOutput | RegisterUserCommandOutput | RestoreAnalysisCommandOutput | SearchAnalysesCommandOutput @@ -602,6 +649,7 @@ export type ServiceOutputTypes = | UpdateIAMPolicyAssignmentCommandOutput | UpdateIpRestrictionCommandOutput | UpdatePublicSharingSettingsCommandOutput + | UpdateRefreshScheduleCommandOutput | UpdateTemplateAliasCommandOutput | UpdateTemplateCommandOutput | UpdateTemplatePermissionsCommandOutput diff --git a/clients/client-quicksight/src/commands/CreateDataSetCommand.ts b/clients/client-quicksight/src/commands/CreateDataSetCommand.ts index 9b22c0981fdd..a55e9f4d4244 100644 --- a/clients/client-quicksight/src/commands/CreateDataSetCommand.ts +++ b/clients/client-quicksight/src/commands/CreateDataSetCommand.ts @@ -203,6 +203,11 @@ export interface CreateDataSetCommandOutput extends CreateDataSetResponse, __Met * MatchAllValue: "STRING_VALUE", * }, * ], + * TagRuleConfigurations: [ // RowLevelPermissionTagRuleConfigurationList + * [ // RowLevelPermissionTagRuleConfiguration + * "STRING_VALUE", + * ], + * ], * }, * ColumnLevelPermissionRules: [ // ColumnLevelPermissionRuleList * { // ColumnLevelPermissionRule diff --git a/clients/client-quicksight/src/commands/CreateRefreshScheduleCommand.ts b/clients/client-quicksight/src/commands/CreateRefreshScheduleCommand.ts new file mode 100644 index 000000000000..05d95fd0e2db --- /dev/null +++ b/clients/client-quicksight/src/commands/CreateRefreshScheduleCommand.ts @@ -0,0 +1,175 @@ +// smithy-typescript generated code +import { EndpointParameterInstructions, getEndpointPlugin } from "@aws-sdk/middleware-endpoint"; +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +import { CreateRefreshScheduleRequest, CreateRefreshScheduleResponse } from "../models/models_2"; +import { de_CreateRefreshScheduleCommand, se_CreateRefreshScheduleCommand } from "../protocols/Aws_restJson1"; +import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient"; + +/** + * @public + * + * The input for {@link CreateRefreshScheduleCommand}. + */ +export interface CreateRefreshScheduleCommandInput extends CreateRefreshScheduleRequest {} +/** + * @public + * + * The output of {@link CreateRefreshScheduleCommand}. + */ +export interface CreateRefreshScheduleCommandOutput extends CreateRefreshScheduleResponse, __MetadataBearer {} + +/** + * @public + *Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, CreateRefreshScheduleCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, CreateRefreshScheduleCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const input = { // CreateRefreshScheduleRequest + * DataSetId: "STRING_VALUE", // required + * AwsAccountId: "STRING_VALUE", // required + * Schedule: { // RefreshSchedule + * ScheduleId: "STRING_VALUE", // required + * ScheduleFrequency: { // RefreshFrequency + * Interval: "MINUTE15" || "MINUTE30" || "HOURLY" || "DAILY" || "WEEKLY" || "MONTHLY", // required + * RefreshOnDay: { // ScheduleRefreshOnEntity + * DayOfWeek: "SUNDAY" || "MONDAY" || "TUESDAY" || "WEDNESDAY" || "THURSDAY" || "FRIDAY" || "SATURDAY", + * DayOfMonth: "STRING_VALUE", + * }, + * Timezone: "STRING_VALUE", + * TimeOfTheDay: "STRING_VALUE", + * }, + * StartAfterDateTime: new Date("TIMESTAMP"), + * RefreshType: "INCREMENTAL_REFRESH" || "FULL_REFRESH", // required + * Arn: "STRING_VALUE", + * }, + * }; + * const command = new CreateRefreshScheduleCommand(input); + * const response = await client.send(command); + * ``` + * + * @param CreateRefreshScheduleCommandInput - {@link CreateRefreshScheduleCommandInput} + * @returns {@link CreateRefreshScheduleCommandOutput} + * @see {@link CreateRefreshScheduleCommandInput} for command's `input` shape. + * @see {@link CreateRefreshScheduleCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to this item. The provided credentials couldn't be + * validated. You might not be authorized to carry out the request. Make sure that your + * account is authorized to use the Amazon QuickSight service, that your policies have the + * correct permissions, and that you are using the correct credentials.
+ * + * @throws {@link InternalFailureException} (server fault) + *An internal failure occurred.
+ * + * @throws {@link InvalidParameterValueException} (client fault) + *One or more parameters has a value that isn't valid.
+ * + * @throws {@link LimitExceededException} (client fault) + *A limit is exceeded.
+ * + * @throws {@link PreconditionNotMetException} (client fault) + *One or more preconditions aren't met.
+ * + * @throws {@link ResourceExistsException} (client fault) + *The resource specified already exists.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *One or more resources can't be found.
+ * + * @throws {@link ThrottlingException} (client fault) + *Access is throttled.
+ * + * + */ +export class CreateRefreshScheduleCommand extends $Command< + CreateRefreshScheduleCommandInput, + CreateRefreshScheduleCommandOutput, + QuickSightClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: CreateRefreshScheduleCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes the dataset refresh properties of the dataset.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DeleteDataSetRefreshPropertiesCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DeleteDataSetRefreshPropertiesCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const input = { // DeleteDataSetRefreshPropertiesRequest + * AwsAccountId: "STRING_VALUE", // required + * DataSetId: "STRING_VALUE", // required + * }; + * const command = new DeleteDataSetRefreshPropertiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @param DeleteDataSetRefreshPropertiesCommandInput - {@link DeleteDataSetRefreshPropertiesCommandInput} + * @returns {@link DeleteDataSetRefreshPropertiesCommandOutput} + * @see {@link DeleteDataSetRefreshPropertiesCommandInput} for command's `input` shape. + * @see {@link DeleteDataSetRefreshPropertiesCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to this item. The provided credentials couldn't be + * validated. You might not be authorized to carry out the request. Make sure that your + * account is authorized to use the Amazon QuickSight service, that your policies have the + * correct permissions, and that you are using the correct credentials.
+ * + * @throws {@link ConflictException} (client fault) + *Updating or deleting a resource can cause an inconsistent state.
+ * + * @throws {@link InternalFailureException} (server fault) + *An internal failure occurred.
+ * + * @throws {@link InvalidParameterValueException} (client fault) + *One or more parameters has a value that isn't valid.
+ * + * @throws {@link LimitExceededException} (client fault) + *A limit is exceeded.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *One or more resources can't be found.
+ * + * @throws {@link ThrottlingException} (client fault) + *Access is throttled.
+ * + * + */ +export class DeleteDataSetRefreshPropertiesCommand extends $Command< + DeleteDataSetRefreshPropertiesCommandInput, + DeleteDataSetRefreshPropertiesCommandOutput, + QuickSightClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DeleteDataSetRefreshPropertiesCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes a refresh schedule from a dataset.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DeleteRefreshScheduleCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DeleteRefreshScheduleCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const input = { // DeleteRefreshScheduleRequest + * DataSetId: "STRING_VALUE", // required + * AwsAccountId: "STRING_VALUE", // required + * ScheduleId: "STRING_VALUE", // required + * }; + * const command = new DeleteRefreshScheduleCommand(input); + * const response = await client.send(command); + * ``` + * + * @param DeleteRefreshScheduleCommandInput - {@link DeleteRefreshScheduleCommandInput} + * @returns {@link DeleteRefreshScheduleCommandOutput} + * @see {@link DeleteRefreshScheduleCommandInput} for command's `input` shape. + * @see {@link DeleteRefreshScheduleCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to this item. The provided credentials couldn't be + * validated. You might not be authorized to carry out the request. Make sure that your + * account is authorized to use the Amazon QuickSight service, that your policies have the + * correct permissions, and that you are using the correct credentials.
+ * + * @throws {@link InternalFailureException} (server fault) + *An internal failure occurred.
+ * + * @throws {@link InvalidParameterValueException} (client fault) + *One or more parameters has a value that isn't valid.
+ * + * @throws {@link LimitExceededException} (client fault) + *A limit is exceeded.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *One or more resources can't be found.
+ * + * @throws {@link ThrottlingException} (client fault) + *Access is throttled.
+ * + * + */ +export class DeleteRefreshScheduleCommand extends $Command< + DeleteRefreshScheduleCommandInput, + DeleteRefreshScheduleCommandOutput, + QuickSightClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DeleteRefreshScheduleCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDescribes the refresh properties of a dataset.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DescribeDataSetRefreshPropertiesCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DescribeDataSetRefreshPropertiesCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const input = { // DescribeDataSetRefreshPropertiesRequest + * AwsAccountId: "STRING_VALUE", // required + * DataSetId: "STRING_VALUE", // required + * }; + * const command = new DescribeDataSetRefreshPropertiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @param DescribeDataSetRefreshPropertiesCommandInput - {@link DescribeDataSetRefreshPropertiesCommandInput} + * @returns {@link DescribeDataSetRefreshPropertiesCommandOutput} + * @see {@link DescribeDataSetRefreshPropertiesCommandInput} for command's `input` shape. + * @see {@link DescribeDataSetRefreshPropertiesCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to this item. The provided credentials couldn't be + * validated. You might not be authorized to carry out the request. Make sure that your + * account is authorized to use the Amazon QuickSight service, that your policies have the + * correct permissions, and that you are using the correct credentials.
+ * + * @throws {@link InternalFailureException} (server fault) + *An internal failure occurred.
+ * + * @throws {@link InvalidParameterValueException} (client fault) + *One or more parameters has a value that isn't valid.
+ * + * @throws {@link LimitExceededException} (client fault) + *A limit is exceeded.
+ * + * @throws {@link PreconditionNotMetException} (client fault) + *One or more preconditions aren't met.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *One or more resources can't be found.
+ * + * @throws {@link ThrottlingException} (client fault) + *Access is throttled.
+ * + * + */ +export class DescribeDataSetRefreshPropertiesCommand extends $Command< + DescribeDataSetRefreshPropertiesCommandInput, + DescribeDataSetRefreshPropertiesCommandOutput, + QuickSightClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DescribeDataSetRefreshPropertiesCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackProvides a summary of a refresh schedule.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DescribeRefreshScheduleCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DescribeRefreshScheduleCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const input = { // DescribeRefreshScheduleRequest + * AwsAccountId: "STRING_VALUE", // required + * DataSetId: "STRING_VALUE", // required + * ScheduleId: "STRING_VALUE", // required + * }; + * const command = new DescribeRefreshScheduleCommand(input); + * const response = await client.send(command); + * ``` + * + * @param DescribeRefreshScheduleCommandInput - {@link DescribeRefreshScheduleCommandInput} + * @returns {@link DescribeRefreshScheduleCommandOutput} + * @see {@link DescribeRefreshScheduleCommandInput} for command's `input` shape. + * @see {@link DescribeRefreshScheduleCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to this item. The provided credentials couldn't be + * validated. You might not be authorized to carry out the request. Make sure that your + * account is authorized to use the Amazon QuickSight service, that your policies have the + * correct permissions, and that you are using the correct credentials.
+ * + * @throws {@link InternalFailureException} (server fault) + *An internal failure occurred.
+ * + * @throws {@link InvalidParameterValueException} (client fault) + *One or more parameters has a value that isn't valid.
+ * + * @throws {@link LimitExceededException} (client fault) + *A limit is exceeded.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *One or more resources can't be found.
+ * + * @throws {@link ThrottlingException} (client fault) + *Access is throttled.
+ * + * + */ +export class DescribeRefreshScheduleCommand extends $Command< + DescribeRefreshScheduleCommandInput, + DescribeRefreshScheduleCommandOutput, + QuickSightClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DescribeRefreshScheduleCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackLists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, ListRefreshSchedulesCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, ListRefreshSchedulesCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const input = { // ListRefreshSchedulesRequest + * AwsAccountId: "STRING_VALUE", // required + * DataSetId: "STRING_VALUE", // required + * }; + * const command = new ListRefreshSchedulesCommand(input); + * const response = await client.send(command); + * ``` + * + * @param ListRefreshSchedulesCommandInput - {@link ListRefreshSchedulesCommandInput} + * @returns {@link ListRefreshSchedulesCommandOutput} + * @see {@link ListRefreshSchedulesCommandInput} for command's `input` shape. + * @see {@link ListRefreshSchedulesCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to this item. The provided credentials couldn't be + * validated. You might not be authorized to carry out the request. Make sure that your + * account is authorized to use the Amazon QuickSight service, that your policies have the + * correct permissions, and that you are using the correct credentials.
+ * + * @throws {@link InternalFailureException} (server fault) + *An internal failure occurred.
+ * + * @throws {@link InvalidParameterValueException} (client fault) + *One or more parameters has a value that isn't valid.
+ * + * @throws {@link LimitExceededException} (client fault) + *A limit is exceeded.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *One or more resources can't be found.
+ * + * @throws {@link ThrottlingException} (client fault) + *Access is throttled.
+ * + * + */ +export class ListRefreshSchedulesCommand extends $Command< + ListRefreshSchedulesCommandInput, + ListRefreshSchedulesCommandOutput, + QuickSightClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListRefreshSchedulesCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackCreates or updates the dataset refresh properties for the dataset.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, PutDataSetRefreshPropertiesCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, PutDataSetRefreshPropertiesCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const input = { // PutDataSetRefreshPropertiesRequest + * AwsAccountId: "STRING_VALUE", // required + * DataSetId: "STRING_VALUE", // required + * DataSetRefreshProperties: { // DataSetRefreshProperties + * RefreshConfiguration: { // RefreshConfiguration + * IncrementalRefresh: { // IncrementalRefresh + * LookbackWindow: { // LookbackWindow + * ColumnName: "STRING_VALUE", // required + * Size: Number("long"), // required + * SizeUnit: "HOUR" || "DAY" || "WEEK", // required + * }, + * }, + * }, + * }, + * }; + * const command = new PutDataSetRefreshPropertiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @param PutDataSetRefreshPropertiesCommandInput - {@link PutDataSetRefreshPropertiesCommandInput} + * @returns {@link PutDataSetRefreshPropertiesCommandOutput} + * @see {@link PutDataSetRefreshPropertiesCommandInput} for command's `input` shape. + * @see {@link PutDataSetRefreshPropertiesCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to this item. The provided credentials couldn't be + * validated. You might not be authorized to carry out the request. Make sure that your + * account is authorized to use the Amazon QuickSight service, that your policies have the + * correct permissions, and that you are using the correct credentials.
+ * + * @throws {@link ConflictException} (client fault) + *Updating or deleting a resource can cause an inconsistent state.
+ * + * @throws {@link InternalFailureException} (server fault) + *An internal failure occurred.
+ * + * @throws {@link InvalidParameterValueException} (client fault) + *One or more parameters has a value that isn't valid.
+ * + * @throws {@link LimitExceededException} (client fault) + *A limit is exceeded.
+ * + * @throws {@link PreconditionNotMetException} (client fault) + *One or more preconditions aren't met.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *One or more resources can't be found.
+ * + * @throws {@link ThrottlingException} (client fault) + *Access is throttled.
+ * + * + */ +export class PutDataSetRefreshPropertiesCommand extends $Command< + PutDataSetRefreshPropertiesCommandInput, + PutDataSetRefreshPropertiesCommandOutput, + QuickSightClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: PutDataSetRefreshPropertiesCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackUpdates a refresh schedule for a dataset.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, UpdateRefreshScheduleCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, UpdateRefreshScheduleCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const input = { // UpdateRefreshScheduleRequest + * DataSetId: "STRING_VALUE", // required + * AwsAccountId: "STRING_VALUE", // required + * Schedule: { // RefreshSchedule + * ScheduleId: "STRING_VALUE", // required + * ScheduleFrequency: { // RefreshFrequency + * Interval: "MINUTE15" || "MINUTE30" || "HOURLY" || "DAILY" || "WEEKLY" || "MONTHLY", // required + * RefreshOnDay: { // ScheduleRefreshOnEntity + * DayOfWeek: "SUNDAY" || "MONDAY" || "TUESDAY" || "WEDNESDAY" || "THURSDAY" || "FRIDAY" || "SATURDAY", + * DayOfMonth: "STRING_VALUE", + * }, + * Timezone: "STRING_VALUE", + * TimeOfTheDay: "STRING_VALUE", + * }, + * StartAfterDateTime: new Date("TIMESTAMP"), + * RefreshType: "INCREMENTAL_REFRESH" || "FULL_REFRESH", // required + * Arn: "STRING_VALUE", + * }, + * }; + * const command = new UpdateRefreshScheduleCommand(input); + * const response = await client.send(command); + * ``` + * + * @param UpdateRefreshScheduleCommandInput - {@link UpdateRefreshScheduleCommandInput} + * @returns {@link UpdateRefreshScheduleCommandOutput} + * @see {@link UpdateRefreshScheduleCommandInput} for command's `input` shape. + * @see {@link UpdateRefreshScheduleCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have access to this item. The provided credentials couldn't be + * validated. You might not be authorized to carry out the request. Make sure that your + * account is authorized to use the Amazon QuickSight service, that your policies have the + * correct permissions, and that you are using the correct credentials.
+ * + * @throws {@link InternalFailureException} (server fault) + *An internal failure occurred.
+ * + * @throws {@link InvalidParameterValueException} (client fault) + *One or more parameters has a value that isn't valid.
+ * + * @throws {@link LimitExceededException} (client fault) + *A limit is exceeded.
+ * + * @throws {@link PreconditionNotMetException} (client fault) + *One or more preconditions aren't met.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *One or more resources can't be found.
+ * + * @throws {@link ThrottlingException} (client fault) + *Access is throttled.
+ * + * + */ +export class UpdateRefreshScheduleCommand extends $Command< + UpdateRefreshScheduleCommandInput, + UpdateRefreshScheduleCommandOutput, + QuickSightClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: UpdateRefreshScheduleCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackA set of rules associated with row-level security, such as the tag names and columns that they are assigned to.
*/ TagRules: RowLevelPermissionTagRule[] | undefined; + + /** + *A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.
+ */ + TagRuleConfigurations?: string[][]; } /** @@ -3605,6 +3608,198 @@ export interface CreateNamespaceResponse { Status?: number; } +/** + * @public + * @enum + */ +export const RefreshInterval = { + DAILY: "DAILY", + HOURLY: "HOURLY", + MINUTE15: "MINUTE15", + MINUTE30: "MINUTE30", + MONTHLY: "MONTHLY", + WEEKLY: "WEEKLY", +} as const; + +/** + * @public + */ +export type RefreshInterval = (typeof RefreshInterval)[keyof typeof RefreshInterval]; + +/** + * @public + * @enum + */ +export const DayOfWeek = { + FRIDAY: "FRIDAY", + MONDAY: "MONDAY", + SATURDAY: "SATURDAY", + SUNDAY: "SUNDAY", + THURSDAY: "THURSDAY", + TUESDAY: "TUESDAY", + WEDNESDAY: "WEDNESDAY", +} as const; + +/** + * @public + */ +export type DayOfWeek = (typeof DayOfWeek)[keyof typeof DayOfWeek]; + +/** + * @public + *The refresh on entity for weekly or monthly schedules.
+ */ +export interface ScheduleRefreshOnEntity { + /** + *The day of the week that you want to schedule a refresh on.
+ */ + DayOfWeek?: DayOfWeek | string; + + /** + *The day of the month that you want to schedule refresh on.
+ */ + DayOfMonth?: string; +} + +/** + * @public + *Specifies the interval between each scheduled refresh of a dataset.
+ */ +export interface RefreshFrequency { + /** + *The interval between scheduled refreshes. Valid values are as follows:
+ *
+ * MINUTE15: The dataset refreshes every 15 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.
+ * MINUTE30:The dataset refreshes every 30 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.
+ * HOURLY: The dataset refreshes every hour. This interval can only be used for one schedule per dataset.
+ * DAILY: The dataset refreshes every day.
+ * WEEKLY: The dataset refreshes every week.
+ * MONTHLY: The dataset refreshes every month.
The day of the week that you want to schedule the refresh on. This value is required for weekly and monthly refresh intervals.
+ */ + RefreshOnDay?: ScheduleRefreshOnEntity; + + /** + *The timezone that you want the refresh schedule to use. The timezone ID must match a corresponding ID found on java.util.time.getAvailableIDs().
The time of day that you want the datset to refresh. This value is expressed in HH:MM format. This field is not required for schedules that refresh hourly.
+ */ + TimeOfTheDay?: string; +} + +/** + * @public + *The refresh schedule of a dataset.
+ */ +export interface RefreshSchedule { + /** + *An identifier for the refresh schedule.
+ */ + ScheduleId: string | undefined; + + /** + *The frequency for the refresh schedule.
+ */ + ScheduleFrequency: RefreshFrequency | undefined; + + /** + *Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.
The type of refresh that a datset undergoes. Valid values are as follows:
+ *
+ * FULL_REFRESH: A complete refresh of a dataset.
+ * INCREMENTAL_REFRESH: A partial refresh of some rows of a dataset, based on the time window specified.
For more information on full and incremental refreshes, see Refreshing SPICE data in the Amazon QuickSight User Guide.
+ */ + RefreshType: IngestionType | string | undefined; + + /** + *The Amazon Resource Name (ARN) for the refresh schedule.
+ */ + Arn?: string; +} + +/** + * @public + */ +export interface CreateRefreshScheduleRequest { + /** + *The ID of the dataset.
+ */ + DataSetId: string | undefined; + + /** + *The Amazon Web Services account ID.
+ */ + AwsAccountId: string | undefined; + + /** + *The refresh schedule.
+ */ + Schedule: RefreshSchedule | undefined; +} + +/** + * @public + */ +export interface CreateRefreshScheduleResponse { + /** + *The HTTP status of the request.
+ */ + Status?: number; + + /** + *The Amazon Web Services request ID for this operation.
+ */ + RequestId?: string; + + /** + *The ID of the refresh schedule.
+ */ + ScheduleId?: string; + + /** + *The Amazon Resource Name (ARN) for the refresh schedule.
+ */ + Arn?: string; +} + /** * @public *Dataset schema.
@@ -4715,6 +4910,75 @@ export const DataSetFilterAttribute = { */ export type DataSetFilterAttribute = (typeof DataSetFilterAttribute)[keyof typeof DataSetFilterAttribute]; +/** + * @public + * @enum + */ +export const LookbackWindowSizeUnit = { + DAY: "DAY", + HOUR: "HOUR", + WEEK: "WEEK", +} as const; + +/** + * @public + */ +export type LookbackWindowSizeUnit = (typeof LookbackWindowSizeUnit)[keyof typeof LookbackWindowSizeUnit]; + +/** + * @public + *The lookback window setup of an incremental refresh configuration.
+ */ +export interface LookbackWindow { + /** + *The name of the lookback window column.
+ */ + ColumnName: string | undefined; + + /** + *The lookback window column size.
+ */ + Size: number | undefined; + + /** + *The size unit that is used for the lookback window column. Valid values for this structure are HOUR, DAY, and WEEK.
The incremental refresh configuration for a dataset.
+ */ +export interface IncrementalRefresh { + /** + *The lookback window setup for an incremental refresh configuration.
+ */ + LookbackWindow: LookbackWindow | undefined; +} + +/** + * @public + *The refresh configuration of a dataset.
+ */ +export interface RefreshConfiguration { + /** + *The incremental refresh for the dataset.
+ */ + IncrementalRefresh: IncrementalRefresh | undefined; +} + +/** + * @public + *The refresh properties of a dataset.
+ */ +export interface DataSetRefreshProperties { + /** + *The refresh configuration for a dataset.
+ */ + RefreshConfiguration: RefreshConfiguration | undefined; +} + /** * @public *A filter that you apply when searching for datasets.
@@ -5239,6 +5503,36 @@ export interface DeleteDataSetResponse { Status?: number; } +/** + * @public + */ +export interface DeleteDataSetRefreshPropertiesRequest { + /** + *The Amazon Web Services account ID.
+ */ + AwsAccountId: string | undefined; + + /** + *The ID of the dataset.
+ */ + DataSetId: string | undefined; +} + +/** + * @public + */ +export interface DeleteDataSetRefreshPropertiesResponse { + /** + *The Amazon Web Services request ID for this operation.
+ */ + RequestId?: string; + + /** + *The HTTP status of the request.
+ */ + Status?: number; +} + /** * @public */ @@ -5507,6 +5801,51 @@ export interface DeleteNamespaceResponse { Status?: number; } +/** + * @public + */ +export interface DeleteRefreshScheduleRequest { + /** + *The ID of the dataset.
+ */ + DataSetId: string | undefined; + + /** + *The Amazon Web Services account ID.
+ */ + AwsAccountId: string | undefined; + + /** + *The ID of the refresh schedule.
+ */ + ScheduleId: string | undefined; +} + +/** + * @public + */ +export interface DeleteRefreshScheduleResponse { + /** + *The HTTP status of the request.
+ */ + Status?: number; + + /** + *The Amazon Web Services request ID for this operation.
+ */ + RequestId?: string; + + /** + *The ID of the refresh schedule.
+ */ + ScheduleId?: string; + + /** + *The Amazon Resource Name (ARN) for the refresh schedule.
+ */ + Arn?: string; +} + /** * @public */ @@ -6444,26 +6783,61 @@ export interface DescribeDataSetPermissionsResponse { /** * @public */ -export interface DescribeDataSourceRequest { +export interface DescribeDataSetRefreshPropertiesRequest { /** *The Amazon Web Services account ID.
*/ AwsAccountId: string | undefined; /** - *The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
+ *The ID of the dataset.
*/ - DataSourceId: string | undefined; + DataSetId: string | undefined; } /** * @public */ -export interface DescribeDataSourceResponse { +export interface DescribeDataSetRefreshPropertiesResponse { /** - *The information on the data source.
+ *The Amazon Web Services request ID for this operation.
*/ - DataSource?: DataSource; + RequestId?: string; + + /** + *The HTTP status of the request.
+ */ + Status?: number; + + /** + *The dataset refresh properties.
+ */ + DataSetRefreshProperties?: DataSetRefreshProperties; +} + +/** + * @public + */ +export interface DescribeDataSourceRequest { + /** + *The Amazon Web Services account ID.
+ */ + AwsAccountId: string | undefined; + + /** + *The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
+ */ + DataSourceId: string | undefined; +} + +/** + * @public + */ +export interface DescribeDataSourceResponse { + /** + *The information on the data source.
+ */ + DataSource?: DataSource; /** *The Amazon Web Services request ID for this operation.
@@ -6914,6 +7288,7 @@ export const IngestionErrorType = { DATA_SOURCE_CONNECTION_FAILED: "DATA_SOURCE_CONNECTION_FAILED", DATA_SOURCE_NOT_FOUND: "DATA_SOURCE_NOT_FOUND", DATA_TOLERANCE_EXCEPTION: "DATA_TOLERANCE_EXCEPTION", + DUPLICATE_COLUMN_NAMES_FOUND: "DUPLICATE_COLUMN_NAMES_FOUND", ELASTICSEARCH_CURSOR_NOT_ENABLED: "ELASTICSEARCH_CURSOR_NOT_ENABLED", FAILURE_TO_ASSUME_ROLE: "FAILURE_TO_ASSUME_ROLE", FAILURE_TO_PROCESS_JSON_FILE: "FAILURE_TO_PROCESS_JSON_FILE", @@ -7263,6 +7638,51 @@ export interface DescribeNamespaceResponse { Status?: number; } +/** + * @public + */ +export interface DescribeRefreshScheduleRequest { + /** + *The Amazon Web Services account ID.
+ */ + AwsAccountId: string | undefined; + + /** + *The ID of the dataset.
+ */ + DataSetId: string | undefined; + + /** + *The ID of the refresh schedule.
+ */ + ScheduleId: string | undefined; +} + +/** + * @public + */ +export interface DescribeRefreshScheduleResponse { + /** + *The refresh schedule.
+ */ + RefreshSchedule?: RefreshSchedule; + + /** + *The HTTP status of the request.
+ */ + Status?: number; + + /** + *The Amazon Web Services request ID for this operation.
+ */ + RequestId?: string; + + /** + *The Amazon Resource Name (ARN) for the refresh schedule.
+ */ + Arn?: string; +} + /** * @public */ @@ -8188,622 +8608,6 @@ export const FolderFilterAttribute = { */ export type FolderFilterAttribute = (typeof FolderFilterAttribute)[keyof typeof FolderFilterAttribute]; -/** - * @public - *An object that consists of a member Amazon Resource Name (ARN) and a member ID.
- */ -export interface MemberIdArnPair { - /** - *The ID of the member.
- */ - MemberId?: string; - - /** - *The Amazon Resource Name (ARN) of the member.
- */ - MemberArn?: string; -} - -/** - * @public - *A filter to use to search an Amazon QuickSight folder.
- */ -export interface FolderSearchFilter { - /** - *The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".
If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose folders you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".
If you set the value to "StringLike", you need to provide the name of the folders you are searching for. For example, "Name":"FOLDER_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value FOLDER_NAME.
The name of a value that you want to use in the filter. For example, "Name": "QUICKSIGHT_OWNER".
Valid values are defined as follows:
- *
- * QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as one of the folder's owners or viewers are returned. Implicit permissions from folders or groups are considered.
- * QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners of the folders are returned. Implicit permissions from folders or groups are considered.
- * DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as the only owner of the folder are returned. Implicit permissions from folders or groups are not considered.
- * DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners of the folders are returned. Implicit permissions from folders or groups are not considered.
- * DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners or viewers of the folders are returned. Implicit permissions from folders or groups are not considered.
- * FOLDER_NAME: Any folders whose names have a substring match to this value will be returned.
- * PARENT_FOLDER_ARN: Provide an ARN of a folder, and any folders that are directly under that parent folder are returned. If you choose to use this option and leave the value blank, all root-level folders in the account are returned.
The value of the named item (in this example, PARENT_FOLDER_ARN), that you want to use as a filter. For example, "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId".
A summary of information about an existing Amazon QuickSight folder.
- */ -export interface FolderSummary { - /** - *The Amazon Resource Name (ARN) of the folder.
- */ - Arn?: string; - - /** - *The ID of the folder.
- */ - FolderId?: string; - - /** - *The display name of the folder.
- */ - Name?: string; - - /** - *The type of folder.
- */ - FolderType?: FolderType | string; - - /** - *The time that the folder was created.
- */ - CreatedTime?: Date; - - /** - *The time that the folder was last updated.
- */ - LastUpdatedTime?: Date; -} - -/** - * @public - *The key-value pair used for the row-level security tags feature.
- */ -export interface SessionTag { - /** - *The key for the tag.
- */ - Key: string | undefined; - - /** - *The value that you want to assign the tag.
- */ - Value: string | undefined; -} - -/** - * @public - */ -export interface GenerateEmbedUrlForAnonymousUserRequest { - /** - *The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
- */ - AwsAccountId: string | undefined; - - /** - *How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.
- */ - SessionLifetimeInMinutes?: number; - - /** - *The Amazon QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon QuickSight custom namespace, set this to default.
The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.
These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.
- */ - SessionTags?: SessionTag[]; - - /** - *The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user
- * is authorized to access during the lifetime of the session. If you choose
- * Dashboard embedding experience, pass the list of dashboard ARNs in the
- * account that you want the user to be able to view. Currently, you can pass up to 25
- * dashboard ARNs in each API call.
The configuration of the experience that you are embedding.
- */ - ExperienceConfiguration: AnonymousUserEmbeddingExperienceConfiguration | undefined; - - /** - *The domains that you want to add to the allow list for access to the generated URL that - * is then embedded. This optional parameter overrides the static domains that are - * configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it - * allows only the domains that you include in this parameter. You can list up to three - * domains or subdomains in each API call.
- *To include all subdomains under a specific domain to the allow list, use *.
- * For example, https://*.sapp.amazon.com includes all subdomains under
- * https://sapp.amazon.com.
The embed URL for the dashboard.
- */ - EmbedUrl: string | undefined; - - /** - *The HTTP status of the request.
- */ - Status: number | undefined; - - /** - *The Amazon Web Services request ID for this operation.
- */ - RequestId: string | undefined; - - /** - *The Amazon Resource Name (ARN) to use for the anonymous Amazon QuickSight user.
- */ - AnonymousUserArn: string | undefined; -} - -/** - * @public - *The number of minutes specified for the lifetime of a session isn't valid. The session - * lifetime must be 15-600 minutes.
- */ -export class SessionLifetimeInMinutesInvalidException extends __BaseException { - readonly name: "SessionLifetimeInMinutesInvalidException" = "SessionLifetimeInMinutesInvalidException"; - readonly $fault: "client" = "client"; - Message?: string; - /** - *The Amazon Web Services request ID for this request.
- */ - RequestId?: string; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeThis error indicates that you are calling an embedding operation in Amazon QuickSight - * without the required pricing plan on your Amazon Web Services account. Before you can use embedding - * for anonymous users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You - * can do this on the Manage Amazon QuickSight page.
- *After capacity pricing is added, you can use the
- *
- * GetDashboardEmbedUrl
- * API operation with the
- * --identity-type ANONYMOUS option.
The Amazon Web Services request ID for this request.
- */ - RequestId?: string; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeThe state perssitence configuration of an embedded dashboard.
- */ -export interface StatePersistenceConfigurations { - /** - *Determines if a Amazon QuickSight dashboard's state persistence settings are turned on or off.
- */ - Enabled: boolean | undefined; -} - -/** - * @public - *The feature configuration for an embedded dashboard.
- */ -export interface RegisteredUserDashboardFeatureConfigurations { - /** - *The state persistence settings of an embedded dashboard.
- */ - StatePersistence?: StatePersistenceConfigurations; -} - -/** - * @public - *Information about the dashboard you want to embed.
- */ -export interface RegisteredUserDashboardEmbeddingConfiguration { - /** - *The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has permissions to view it.
- *If the user does not have permission to view this dashboard, they see a permissions error message.
- */ - InitialDashboardId: string | undefined; - - /** - *The feature configurations of an embbedded Amazon QuickSight dashboard.
- */ - FeatureConfigurations?: RegisteredUserDashboardFeatureConfigurations; -} - -/** - * @public - *The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.
- */ -export interface RegisteredUserDashboardVisualEmbeddingConfiguration { - /** - *The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.
- *The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.
Information about the Q search bar embedding experience.
- */ -export interface RegisteredUserQSearchBarEmbeddingConfiguration { - /** - *The ID of the Q topic that you want to make the starting topic in the Q search bar. - * You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening - * a topic. The ID is in the URL for the topic that you open.
- *If you don't specify an initial topic, a list of all shared topics is shown in the Q bar - * for your readers. When you select an initial topic, you can specify whether or not readers - * are allowed to select other topics from the available ones in the list.
- */ - InitialTopicId?: string; -} - -/** - * @public - *The feature configurations of an embedded Amazon QuickSight console.
- */ -export interface RegisteredUserConsoleFeatureConfigurations { - /** - *The state persistence configurations of an embedded Amazon QuickSight console.
- */ - StatePersistence?: StatePersistenceConfigurations; -} - -/** - * @public - *Information about the Amazon QuickSight console that you want to embed.
- */ -export interface RegisteredUserQuickSightConsoleEmbeddingConfiguration { - /** - *The initial URL path for the Amazon QuickSight console. InitialPath is required.
The entry point URL is constrained to the following paths:
- *
- * /start
- *
- * /start/analyses
- *
- * /start/dashboards
- *
- * /start/favorites
- *
- * /dashboards/DashboardId. DashboardId is the actual ID key from the Amazon QuickSight console URL of the dashboard.
- * /analyses/AnalysisId. AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis.
The embedding configuration of an embedded Amazon QuickSight console.
- */ - FeatureConfigurations?: RegisteredUserConsoleFeatureConfigurations; -} - -/** - * @public - *The type of experience you want to embed. For registered users, you can embed Amazon QuickSight dashboards or the Amazon QuickSight console.
- *Exactly one of the experience configurations is required. You can choose
- * Dashboard or QuickSightConsole. You cannot choose more
- * than one experience configuration.
The configuration details for providing a dashboard embedding experience.
- */ - Dashboard?: RegisteredUserDashboardEmbeddingConfiguration; - - /** - *The configuration details for providing each Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the Amazon QuickSight Console in the Amazon QuickSight User - * Guide.
- *Use
- * GenerateEmbedUrlForRegisteredUser
- *
- * where
- * you want to provide an authoring portal that allows users to create data sources,
- * datasets, analyses, and dashboards. The users who accesses an embedded Amazon QuickSight console
- * needs to belong to the author or admin security cohort. If you want to restrict permissions
- * to some of these features, add a custom permissions profile to the user with the
- *
- * UpdateUser
- * API operation. Use the
- * RegisterUser
- * API operation to add a new user with a custom permission profile attached. For more
- * information, see the following sections in the Amazon QuickSight User
- * Guide:
- * Embedding the Full Functionality of the Amazon QuickSight Console for Authenticated Users - *
- *For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
- */ - QuickSightConsole?: RegisteredUserQuickSightConsoleEmbeddingConfiguration; - - /** - *The configuration details for embedding the Q search bar.
- *For more information about embedding the Q search bar, see Embedding Overview in - * the Amazon QuickSight User Guide.
- */ - QSearchBar?: RegisteredUserQSearchBarEmbeddingConfiguration; - - /** - *The type of embedding experience. In this case, Amazon QuickSight visuals.
- */ - DashboardVisual?: RegisteredUserDashboardVisualEmbeddingConfiguration; -} - -/** - * @public - */ -export interface GenerateEmbedUrlForRegisteredUserRequest { - /** - *The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
- */ - AwsAccountId: string | undefined; - - /** - *How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.
- */ - SessionLifetimeInMinutes?: number; - - /** - *The Amazon Resource Name for the registered user.
- */ - UserArn: string | undefined; - - /** - *The experience you are embedding. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, or the entire Amazon QuickSight console.
- */ - ExperienceConfiguration: RegisteredUserEmbeddingExperienceConfiguration | undefined; - - /** - *The domains that you want to add to the allow list for access to the generated URL that - * is then embedded. This optional parameter overrides the static domains that are - * configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it - * allows only the domains that you include in this parameter. You can list up to three - * domains or subdomains in each API call.
- *To include all subdomains under a specific domain to the allow list, use *.
- * For example, https://*.sapp.amazon.com includes all subdomains under
- * https://sapp.amazon.com.
The embed URL for the Amazon QuickSight dashboard, visual, Q search bar, or console.
- */ - EmbedUrl: string | undefined; - - /** - *The HTTP status of the request.
- */ - Status: number | undefined; - - /** - *The Amazon Web Services request ID for this operation.
- */ - RequestId: string | undefined; -} - -/** - * @public - *The user with the provided name isn't found. This error can happen in any operation
- * that requires finding a user based on a provided user name, such as
- * DeleteUser, DescribeUser, and so on.
The Amazon Web Services request ID for this request.
- */ - RequestId?: string; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeThe ID for the Amazon Web Services account that contains the dashboard that you're embedding.
- */ - AwsAccountId: string | undefined; - - /** - *The ID for the dashboard, also added to the Identity and Access Management (IAM) - * policy.
- */ - DashboardId: string | undefined; - - /** - *The authentication method that the user uses to sign in.
- */ - IdentityType: EmbeddingIdentityType | string | undefined; - - /** - *How many minutes the session is valid. The session lifetime must be 15-600 minutes.
- */ - SessionLifetimeInMinutes?: number; - - /** - *Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables - * the undo/redo button.
- */ - UndoRedoDisabled?: boolean; - - /** - *Remove the reset button on the embedded dashboard. The default is FALSE, which enables the - * reset button.
- */ - ResetDisabled?: boolean; - - /** - *Adds persistence of state for the user session in an embedded dashboard. Persistence
- * applies to the sheet and the parameter settings. These are control settings that the
- * dashboard subscriber (Amazon QuickSight reader) chooses while viewing the dashboard. If this is
- * set to TRUE, the settings are the same when the subscriber reopens the same
- * dashboard URL. The state is stored in Amazon QuickSight, not in a browser cookie. If this is
- * set to FALSE, the state of the user session is not persisted. The default is
- * FALSE.
The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type.
- * You can use this for any Amazon QuickSight users in your account (readers, authors, or
- * admins) authenticated as one of the following:
Active Directory (AD) users or group members
- *Invited nonfederated users
- *IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using - * SAML, OpenID Connect, or IAM federation.
- *Omit this parameter for users in the third group – IAM users and IAM - * role-based sessions.
- */ - UserArn?: string; - - /** - *The Amazon QuickSight namespace that contains the dashboard IDs in this request.
- * If you're not using a custom namespace, set Namespace = default.
A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the IdentityType parameter must be set to ANONYMOUS because other identity types authenticate as Amazon QuickSight or IAM users. For example, if you set "--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS", the session can access all three dashboards.
An object that consists of a member Amazon Resource Name (ARN) and a member ID.
+ */ +export interface MemberIdArnPair { + /** + *The ID of the member.
+ */ + MemberId?: string; + + /** + *The Amazon Resource Name (ARN) of the member.
+ */ + MemberArn?: string; +} + +/** + * @public + *A filter to use to search an Amazon QuickSight folder.
+ */ +export interface FolderSearchFilter { + /** + *The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".
If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose folders you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".
If you set the value to "StringLike", you need to provide the name of the folders you are searching for. For example, "Name":"FOLDER_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value FOLDER_NAME.
The name of a value that you want to use in the filter. For example, "Name": "QUICKSIGHT_OWNER".
Valid values are defined as follows:
+ *
+ * QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as one of the folder's owners or viewers are returned. Implicit permissions from folders or groups are considered.
+ * QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners of the folders are returned. Implicit permissions from folders or groups are considered.
+ * DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as the only owner of the folder are returned. Implicit permissions from folders or groups are not considered.
+ * DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners of the folders are returned. Implicit permissions from folders or groups are not considered.
+ * DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners or viewers of the folders are returned. Implicit permissions from folders or groups are not considered.
+ * FOLDER_NAME: Any folders whose names have a substring match to this value will be returned.
+ * PARENT_FOLDER_ARN: Provide an ARN of a folder, and any folders that are directly under that parent folder are returned. If you choose to use this option and leave the value blank, all root-level folders in the account are returned.
The value of the named item (in this example, PARENT_FOLDER_ARN), that you want to use as a filter. For example, "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId".
A summary of information about an existing Amazon QuickSight folder.
+ */ +export interface FolderSummary { + /** + *The Amazon Resource Name (ARN) of the folder.
+ */ + Arn?: string; + + /** + *The ID of the folder.
+ */ + FolderId?: string; + + /** + *The display name of the folder.
+ */ + Name?: string; + + /** + *The type of folder.
+ */ + FolderType?: FolderType | string; + + /** + *The time that the folder was created.
+ */ + CreatedTime?: Date; + + /** + *The time that the folder was last updated.
+ */ + LastUpdatedTime?: Date; +} + +/** + * @public + *The key-value pair used for the row-level security tags feature.
+ */ +export interface SessionTag { + /** + *The key for the tag.
+ */ + Key: string | undefined; + + /** + *The value that you want to assign the tag.
+ */ + Value: string | undefined; +} + +/** + * @public + */ +export interface GenerateEmbedUrlForAnonymousUserRequest { + /** + *The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
+ */ + AwsAccountId: string | undefined; + + /** + *How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.
+ */ + SessionLifetimeInMinutes?: number; + + /** + *The Amazon QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon QuickSight custom namespace, set this to default.
The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.
These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.
+ */ + SessionTags?: SessionTag[]; + + /** + *The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user
+ * is authorized to access during the lifetime of the session. If you choose
+ * Dashboard embedding experience, pass the list of dashboard ARNs in the
+ * account that you want the user to be able to view. Currently, you can pass up to 25
+ * dashboard ARNs in each API call.
The configuration of the experience that you are embedding.
+ */ + ExperienceConfiguration: AnonymousUserEmbeddingExperienceConfiguration | undefined; + + /** + *The domains that you want to add to the allow list for access to the generated URL that + * is then embedded. This optional parameter overrides the static domains that are + * configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it + * allows only the domains that you include in this parameter. You can list up to three + * domains or subdomains in each API call.
+ *To include all subdomains under a specific domain to the allow list, use *.
+ * For example, https://*.sapp.amazon.com includes all subdomains under
+ * https://sapp.amazon.com.
The embed URL for the dashboard.
+ */ + EmbedUrl: string | undefined; + + /** + *The HTTP status of the request.
+ */ + Status: number | undefined; + + /** + *The Amazon Web Services request ID for this operation.
+ */ + RequestId: string | undefined; + + /** + *The Amazon Resource Name (ARN) to use for the anonymous Amazon QuickSight user.
+ */ + AnonymousUserArn: string | undefined; +} + +/** + * @public + *The number of minutes specified for the lifetime of a session isn't valid. The session + * lifetime must be 15-600 minutes.
+ */ +export class SessionLifetimeInMinutesInvalidException extends __BaseException { + readonly name: "SessionLifetimeInMinutesInvalidException" = "SessionLifetimeInMinutesInvalidException"; + readonly $fault: "client" = "client"; + Message?: string; + /** + *The Amazon Web Services request ID for this request.
+ */ + RequestId?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThis error indicates that you are calling an embedding operation in Amazon QuickSight + * without the required pricing plan on your Amazon Web Services account. Before you can use embedding + * for anonymous users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You + * can do this on the Manage Amazon QuickSight page.
+ *After capacity pricing is added, you can use the
+ *
+ * GetDashboardEmbedUrl
+ * API operation with the
+ * --identity-type ANONYMOUS option.
The Amazon Web Services request ID for this request.
+ */ + RequestId?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe state perssitence configuration of an embedded dashboard.
+ */ +export interface StatePersistenceConfigurations { + /** + *Determines if a Amazon QuickSight dashboard's state persistence settings are turned on or off.
+ */ + Enabled: boolean | undefined; +} + +/** + * @public + *The feature configuration for an embedded dashboard.
+ */ +export interface RegisteredUserDashboardFeatureConfigurations { + /** + *The state persistence settings of an embedded dashboard.
+ */ + StatePersistence?: StatePersistenceConfigurations; +} + +/** + * @public + *Information about the dashboard you want to embed.
+ */ +export interface RegisteredUserDashboardEmbeddingConfiguration { + /** + *The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has permissions to view it.
+ *If the user does not have permission to view this dashboard, they see a permissions error message.
+ */ + InitialDashboardId: string | undefined; + + /** + *The feature configurations of an embbedded Amazon QuickSight dashboard.
+ */ + FeatureConfigurations?: RegisteredUserDashboardFeatureConfigurations; +} + +/** + * @public + *The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.
+ */ +export interface RegisteredUserDashboardVisualEmbeddingConfiguration { + /** + *The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.
+ *The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.
Information about the Q search bar embedding experience.
+ */ +export interface RegisteredUserQSearchBarEmbeddingConfiguration { + /** + *The ID of the Q topic that you want to make the starting topic in the Q search bar. + * You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening + * a topic. The ID is in the URL for the topic that you open.
+ *If you don't specify an initial topic, a list of all shared topics is shown in the Q bar + * for your readers. When you select an initial topic, you can specify whether or not readers + * are allowed to select other topics from the available ones in the list.
+ */ + InitialTopicId?: string; +} + +/** + * @public + *The feature configurations of an embedded Amazon QuickSight console.
+ */ +export interface RegisteredUserConsoleFeatureConfigurations { + /** + *The state persistence configurations of an embedded Amazon QuickSight console.
+ */ + StatePersistence?: StatePersistenceConfigurations; +} + +/** + * @public + *Information about the Amazon QuickSight console that you want to embed.
+ */ +export interface RegisteredUserQuickSightConsoleEmbeddingConfiguration { + /** + *The initial URL path for the Amazon QuickSight console. InitialPath is required.
The entry point URL is constrained to the following paths:
+ *
+ * /start
+ *
+ * /start/analyses
+ *
+ * /start/dashboards
+ *
+ * /start/favorites
+ *
+ * /dashboards/DashboardId. DashboardId is the actual ID key from the Amazon QuickSight console URL of the dashboard.
+ * /analyses/AnalysisId. AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis.
The embedding configuration of an embedded Amazon QuickSight console.
+ */ + FeatureConfigurations?: RegisteredUserConsoleFeatureConfigurations; +} + +/** + * @public + *The type of experience you want to embed. For registered users, you can embed Amazon QuickSight dashboards or the Amazon QuickSight console.
+ *Exactly one of the experience configurations is required. You can choose
+ * Dashboard or QuickSightConsole. You cannot choose more
+ * than one experience configuration.
The configuration details for providing a dashboard embedding experience.
+ */ + Dashboard?: RegisteredUserDashboardEmbeddingConfiguration; + + /** + *The configuration details for providing each Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the Amazon QuickSight Console in the Amazon QuickSight User + * Guide.
+ *Use
+ * GenerateEmbedUrlForRegisteredUser
+ *
+ * where
+ * you want to provide an authoring portal that allows users to create data sources,
+ * datasets, analyses, and dashboards. The users who accesses an embedded Amazon QuickSight console
+ * needs to belong to the author or admin security cohort. If you want to restrict permissions
+ * to some of these features, add a custom permissions profile to the user with the
+ *
+ * UpdateUser
+ * API operation. Use the
+ * RegisterUser
+ * API operation to add a new user with a custom permission profile attached. For more
+ * information, see the following sections in the Amazon QuickSight User
+ * Guide:
+ * Embedding the Full Functionality of the Amazon QuickSight Console for Authenticated Users + *
+ *For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
+ */ + QuickSightConsole?: RegisteredUserQuickSightConsoleEmbeddingConfiguration; + + /** + *The configuration details for embedding the Q search bar.
+ *For more information about embedding the Q search bar, see Embedding Overview in + * the Amazon QuickSight User Guide.
+ */ + QSearchBar?: RegisteredUserQSearchBarEmbeddingConfiguration; + + /** + *The type of embedding experience. In this case, Amazon QuickSight visuals.
+ */ + DashboardVisual?: RegisteredUserDashboardVisualEmbeddingConfiguration; +} + +/** + * @public + */ +export interface GenerateEmbedUrlForRegisteredUserRequest { + /** + *The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
+ */ + AwsAccountId: string | undefined; + + /** + *How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.
+ */ + SessionLifetimeInMinutes?: number; + + /** + *The Amazon Resource Name for the registered user.
+ */ + UserArn: string | undefined; + + /** + *The experience you are embedding. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, or the entire Amazon QuickSight console.
+ */ + ExperienceConfiguration: RegisteredUserEmbeddingExperienceConfiguration | undefined; + + /** + *The domains that you want to add to the allow list for access to the generated URL that + * is then embedded. This optional parameter overrides the static domains that are + * configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it + * allows only the domains that you include in this parameter. You can list up to three + * domains or subdomains in each API call.
+ *To include all subdomains under a specific domain to the allow list, use *.
+ * For example, https://*.sapp.amazon.com includes all subdomains under
+ * https://sapp.amazon.com.
The embed URL for the Amazon QuickSight dashboard, visual, Q search bar, or console.
+ */ + EmbedUrl: string | undefined; + + /** + *The HTTP status of the request.
+ */ + Status: number | undefined; + + /** + *The Amazon Web Services request ID for this operation.
+ */ + RequestId: string | undefined; +} + +/** + * @public + *The user with the provided name isn't found. This error can happen in any operation
+ * that requires finding a user based on a provided user name, such as
+ * DeleteUser, DescribeUser, and so on.
The Amazon Web Services request ID for this request.
+ */ + RequestId?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe ID for the Amazon Web Services account that contains the dashboard that you're embedding.
+ */ + AwsAccountId: string | undefined; + + /** + *The ID for the dashboard, also added to the Identity and Access Management (IAM) + * policy.
+ */ + DashboardId: string | undefined; + + /** + *The authentication method that the user uses to sign in.
+ */ + IdentityType: EmbeddingIdentityType | string | undefined; + + /** + *How many minutes the session is valid. The session lifetime must be 15-600 minutes.
+ */ + SessionLifetimeInMinutes?: number; + + /** + *Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables + * the undo/redo button.
+ */ + UndoRedoDisabled?: boolean; + + /** + *Remove the reset button on the embedded dashboard. The default is FALSE, which enables the + * reset button.
+ */ + ResetDisabled?: boolean; + + /** + *Adds persistence of state for the user session in an embedded dashboard. Persistence
+ * applies to the sheet and the parameter settings. These are control settings that the
+ * dashboard subscriber (Amazon QuickSight reader) chooses while viewing the dashboard. If this is
+ * set to TRUE, the settings are the same when the subscriber reopens the same
+ * dashboard URL. The state is stored in Amazon QuickSight, not in a browser cookie. If this is
+ * set to FALSE, the state of the user session is not persisted. The default is
+ * FALSE.
The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type.
+ * You can use this for any Amazon QuickSight users in your account (readers, authors, or
+ * admins) authenticated as one of the following:
Active Directory (AD) users or group members
+ *Invited nonfederated users
+ *IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using + * SAML, OpenID Connect, or IAM federation.
+ *Omit this parameter for users in the third group – IAM users and IAM + * role-based sessions.
+ */ + UserArn?: string; + + /** + *The Amazon QuickSight namespace that contains the dashboard IDs in this request.
+ * If you're not using a custom namespace, set Namespace = default.
A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the IdentityType parameter must be set to ANONYMOUS because other identity types authenticate as Amazon QuickSight or IAM users. For example, if you set "--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS", the session can access all three dashboards.
Output returned from the GetDashboardEmbedUrl operation.
The Amazon Web Services account ID.
+ */ + AwsAccountId: string | undefined; + + /** + *The ID of the dataset.
+ */ + DataSetId: string | undefined; +} + +/** + * @public + */ +export interface ListRefreshSchedulesResponse { + /** + *The list of refresh schedules for the dataset.
+ */ + RefreshSchedules?: RefreshSchedule[]; + + /** + *The HTTP status of the request.
+ */ + Status?: number; + + /** + *The Amazon Web Services request ID for this operation.
+ */ + RequestId?: string; +} + /** * @public */ @@ -1527,6 +2183,41 @@ export interface ListUsersResponse { Status?: number; } +/** + * @public + */ +export interface PutDataSetRefreshPropertiesRequest { + /** + *The Amazon Web Services account ID.
+ */ + AwsAccountId: string | undefined; + + /** + *The ID of the dataset.
+ */ + DataSetId: string | undefined; + + /** + *The dataset refresh properties.
+ */ + DataSetRefreshProperties: DataSetRefreshProperties | undefined; +} + +/** + * @public + */ +export interface PutDataSetRefreshPropertiesResponse { + /** + *The Amazon Web Services request ID for this operation.
+ */ + RequestId?: string; + + /** + *The HTTP status of the request.
+ */ + Status?: number; +} + /** * @public */ @@ -3209,6 +3900,51 @@ export interface UpdatePublicSharingSettingsResponse { Status?: number; } +/** + * @public + */ +export interface UpdateRefreshScheduleRequest { + /** + *The ID of the dataset.
+ */ + DataSetId: string | undefined; + + /** + *The Amazon Web Services account ID.
+ */ + AwsAccountId: string | undefined; + + /** + *The refresh schedule.
+ */ + Schedule: RefreshSchedule | undefined; +} + +/** + * @public + */ +export interface UpdateRefreshScheduleResponse { + /** + *The HTTP status of the request.
+ */ + Status?: number; + + /** + *The Amazon Web Services request ID for this operation.
+ */ + RequestId?: string; + + /** + *The ID of the refresh schedule.
+ */ + ScheduleId?: string; + + /** + *The Amazon Resource Name (ARN) for the refresh schedule.
+ */ + Arn?: string; +} + /** * @public */ @@ -3710,6 +4446,44 @@ export interface UpdateUserResponse { Status?: number; } +/** + * @internal + */ +export const SessionTagFilterSensitiveLog = (obj: SessionTag): any => ({ + ...obj, + ...(obj.Value && { Value: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const GenerateEmbedUrlForAnonymousUserRequestFilterSensitiveLog = ( + obj: GenerateEmbedUrlForAnonymousUserRequest +): any => ({ + ...obj, + ...(obj.SessionTags && { SessionTags: obj.SessionTags.map((item) => SessionTagFilterSensitiveLog(item)) }), +}); + +/** + * @internal + */ +export const GenerateEmbedUrlForAnonymousUserResponseFilterSensitiveLog = ( + obj: GenerateEmbedUrlForAnonymousUserResponse +): any => ({ + ...obj, + ...(obj.EmbedUrl && { EmbedUrl: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const GenerateEmbedUrlForRegisteredUserResponseFilterSensitiveLog = ( + obj: GenerateEmbedUrlForRegisteredUserResponse +): any => ({ + ...obj, + ...(obj.EmbedUrl && { EmbedUrl: SENSITIVE_STRING }), +}); + /** * @internal */ diff --git a/clients/client-quicksight/src/protocols/Aws_restJson1.ts b/clients/client-quicksight/src/protocols/Aws_restJson1.ts index 79dfbebc513a..1285e351455a 100644 --- a/clients/client-quicksight/src/protocols/Aws_restJson1.ts +++ b/clients/client-quicksight/src/protocols/Aws_restJson1.ts @@ -53,6 +53,10 @@ import { } from "../commands/CreateIAMPolicyAssignmentCommand"; import { CreateIngestionCommandInput, CreateIngestionCommandOutput } from "../commands/CreateIngestionCommand"; import { CreateNamespaceCommandInput, CreateNamespaceCommandOutput } from "../commands/CreateNamespaceCommand"; +import { + CreateRefreshScheduleCommandInput, + CreateRefreshScheduleCommandOutput, +} from "../commands/CreateRefreshScheduleCommand"; import { CreateTemplateAliasCommandInput, CreateTemplateAliasCommandOutput, @@ -71,6 +75,10 @@ import { import { DeleteAnalysisCommandInput, DeleteAnalysisCommandOutput } from "../commands/DeleteAnalysisCommand"; import { DeleteDashboardCommandInput, DeleteDashboardCommandOutput } from "../commands/DeleteDashboardCommand"; import { DeleteDataSetCommandInput, DeleteDataSetCommandOutput } from "../commands/DeleteDataSetCommand"; +import { + DeleteDataSetRefreshPropertiesCommandInput, + DeleteDataSetRefreshPropertiesCommandOutput, +} from "../commands/DeleteDataSetRefreshPropertiesCommand"; import { DeleteDataSourceCommandInput, DeleteDataSourceCommandOutput } from "../commands/DeleteDataSourceCommand"; import { DeleteFolderCommandInput, DeleteFolderCommandOutput } from "../commands/DeleteFolderCommand"; import { @@ -87,6 +95,10 @@ import { DeleteIAMPolicyAssignmentCommandOutput, } from "../commands/DeleteIAMPolicyAssignmentCommand"; import { DeleteNamespaceCommandInput, DeleteNamespaceCommandOutput } from "../commands/DeleteNamespaceCommand"; +import { + DeleteRefreshScheduleCommandInput, + DeleteRefreshScheduleCommandOutput, +} from "../commands/DeleteRefreshScheduleCommand"; import { DeleteTemplateAliasCommandInput, DeleteTemplateAliasCommandOutput, @@ -134,6 +146,10 @@ import { DescribeDataSetPermissionsCommandInput, DescribeDataSetPermissionsCommandOutput, } from "../commands/DescribeDataSetPermissionsCommand"; +import { + DescribeDataSetRefreshPropertiesCommandInput, + DescribeDataSetRefreshPropertiesCommandOutput, +} from "../commands/DescribeDataSetRefreshPropertiesCommand"; import { DescribeDataSourceCommandInput, DescribeDataSourceCommandOutput } from "../commands/DescribeDataSourceCommand"; import { DescribeDataSourcePermissionsCommandInput, @@ -163,6 +179,10 @@ import { DescribeIpRestrictionCommandOutput, } from "../commands/DescribeIpRestrictionCommand"; import { DescribeNamespaceCommandInput, DescribeNamespaceCommandOutput } from "../commands/DescribeNamespaceCommand"; +import { + DescribeRefreshScheduleCommandInput, + DescribeRefreshScheduleCommandOutput, +} from "../commands/DescribeRefreshScheduleCommand"; import { DescribeTemplateAliasCommandInput, DescribeTemplateAliasCommandOutput, @@ -221,6 +241,10 @@ import { } from "../commands/ListIAMPolicyAssignmentsForUserCommand"; import { ListIngestionsCommandInput, ListIngestionsCommandOutput } from "../commands/ListIngestionsCommand"; import { ListNamespacesCommandInput, ListNamespacesCommandOutput } from "../commands/ListNamespacesCommand"; +import { + ListRefreshSchedulesCommandInput, + ListRefreshSchedulesCommandOutput, +} from "../commands/ListRefreshSchedulesCommand"; import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, @@ -239,6 +263,10 @@ import { ListThemesCommandInput, ListThemesCommandOutput } from "../commands/Lis import { ListThemeVersionsCommandInput, ListThemeVersionsCommandOutput } from "../commands/ListThemeVersionsCommand"; import { ListUserGroupsCommandInput, ListUserGroupsCommandOutput } from "../commands/ListUserGroupsCommand"; import { ListUsersCommandInput, ListUsersCommandOutput } from "../commands/ListUsersCommand"; +import { + PutDataSetRefreshPropertiesCommandInput, + PutDataSetRefreshPropertiesCommandOutput, +} from "../commands/PutDataSetRefreshPropertiesCommand"; import { RegisterUserCommandInput, RegisterUserCommandOutput } from "../commands/RegisterUserCommand"; import { RestoreAnalysisCommandInput, RestoreAnalysisCommandOutput } from "../commands/RestoreAnalysisCommand"; import { SearchAnalysesCommandInput, SearchAnalysesCommandOutput } from "../commands/SearchAnalysesCommand"; @@ -299,6 +327,10 @@ import { UpdatePublicSharingSettingsCommandInput, UpdatePublicSharingSettingsCommandOutput, } from "../commands/UpdatePublicSharingSettingsCommand"; +import { + UpdateRefreshScheduleCommandInput, + UpdateRefreshScheduleCommandOutput, +} from "../commands/UpdateRefreshScheduleCommand"; import { UpdateTemplateAliasCommandInput, UpdateTemplateAliasCommandOutput, @@ -826,6 +858,7 @@ import { DataPointTooltipOption, DataSet, DataSetConfiguration, + DataSetRefreshProperties, DataSetSchema, DataSetSearchFilter, DataSetSummary, @@ -848,13 +881,12 @@ import { FilterOperation, Folder, FolderMember, - FolderSearchFilter, - FolderSummary, Font, Group, GroupMember, GutterStyle, IAMPolicyAssignment, + IncrementalRefresh, Ingestion, InputColumn, IntegerParameter, @@ -866,10 +898,10 @@ import { LinkSharingConfiguration, LogicalTable, LogicalTableSource, + LookbackWindow, ManifestFileLocation, MarginStyle, MariaDbParameters, - MemberIdArnPair, MySqlParameters, NamespaceError, NamespaceInfoV2, @@ -881,16 +913,11 @@ import { PrestoParameters, ProjectOperation, QueueInfo, - QuickSightUserNotFoundException, RdsParameters, RedshiftParameters, - RegisteredUserConsoleFeatureConfigurations, - RegisteredUserDashboardEmbeddingConfiguration, - RegisteredUserDashboardFeatureConfigurations, - RegisteredUserDashboardVisualEmbeddingConfiguration, - RegisteredUserEmbeddingExperienceConfiguration, - RegisteredUserQSearchBarEmbeddingConfiguration, - RegisteredUserQuickSightConsoleEmbeddingConfiguration, + RefreshConfiguration, + RefreshFrequency, + RefreshSchedule, RelationalTable, RenameColumnOperation, ResourcePermission, @@ -900,9 +927,8 @@ import { RowLevelPermissionTagRule, S3Parameters, S3Source, + ScheduleRefreshOnEntity, ServiceNowParameters, - SessionLifetimeInMinutesInvalidException, - SessionTag, SheetControlsOption, SheetLayoutElementMaximizationOption, SheetStyle, @@ -910,7 +936,6 @@ import { SparkParameters, SqlServerParameters, SslProperties, - StatePersistenceConfigurations, StringParameter, TagColumnOperation, Template, @@ -933,7 +958,6 @@ import { TwitterParameters, Typography, UIColorPalette, - UnsupportedPricingPlanException, UnsupportedUserEditionException, UntagColumnOperation, UploadSettings, @@ -943,14 +967,29 @@ import { VpcConnectionProperties, } from "../models/models_2"; import { + FolderSearchFilter, + FolderSummary, GroupSearchFilter, IAMPolicyAssignmentSummary, IdentityTypeNotSupportedException, InvalidRequestException, + MemberIdArnPair, + QuickSightUserNotFoundException, + RegisteredUserConsoleFeatureConfigurations, + RegisteredUserDashboardEmbeddingConfiguration, + RegisteredUserDashboardFeatureConfigurations, + RegisteredUserDashboardVisualEmbeddingConfiguration, + RegisteredUserEmbeddingExperienceConfiguration, + RegisteredUserQSearchBarEmbeddingConfiguration, + RegisteredUserQuickSightConsoleEmbeddingConfiguration, + SessionLifetimeInMinutesInvalidException, + SessionTag, + StatePersistenceConfigurations, TemplateSummary, TemplateVersionSummary, ThemeSummary, ThemeVersionSummary, + UnsupportedPricingPlanException, } from "../models/models_3"; import { QuickSightServiceException as __BaseException } from "../models/QuickSightServiceException"; @@ -1546,6 +1585,44 @@ export const se_CreateNamespaceCommand = async ( }); }; +/** + * serializeAws_restJson1CreateRefreshScheduleCommand + */ +export const se_CreateRefreshScheduleCommand = async ( + input: CreateRefreshScheduleCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const { hostname, protocol = "https", port, path: basePath } = await context.endpoint(); + const headers: any = { + "content-type": "application/json", + }; + let resolvedPath = + `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + + "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules"; + resolvedPath = __resolvedPath(resolvedPath, input, "DataSetId", () => input.DataSetId!, "{DataSetId}", false); + resolvedPath = __resolvedPath( + resolvedPath, + input, + "AwsAccountId", + () => input.AwsAccountId!, + "{AwsAccountId}", + false + ); + let body: any; + body = JSON.stringify({ + ...(input.Schedule != null && { Schedule: se_RefreshSchedule(input.Schedule, context) }), + }); + return new __HttpRequest({ + protocol, + hostname, + port, + method: "POST", + headers, + path: resolvedPath, + body, + }); +}; + /** * serializeAws_restJson1CreateTemplateCommand */ @@ -1888,6 +1965,39 @@ export const se_DeleteDataSetCommand = async ( }); }; +/** + * serializeAws_restJson1DeleteDataSetRefreshPropertiesCommand + */ +export const se_DeleteDataSetRefreshPropertiesCommand = async ( + input: DeleteDataSetRefreshPropertiesCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const { hostname, protocol = "https", port, path: basePath } = await context.endpoint(); + const headers: any = {}; + let resolvedPath = + `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + + "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties"; + resolvedPath = __resolvedPath( + resolvedPath, + input, + "AwsAccountId", + () => input.AwsAccountId!, + "{AwsAccountId}", + false + ); + resolvedPath = __resolvedPath(resolvedPath, input, "DataSetId", () => input.DataSetId!, "{DataSetId}", false); + let body: any; + return new __HttpRequest({ + protocol, + hostname, + port, + method: "DELETE", + headers, + path: resolvedPath, + body, + }); +}; + /** * serializeAws_restJson1DeleteDataSourceCommand */ @@ -2139,6 +2249,40 @@ export const se_DeleteNamespaceCommand = async ( }); }; +/** + * serializeAws_restJson1DeleteRefreshScheduleCommand + */ +export const se_DeleteRefreshScheduleCommand = async ( + input: DeleteRefreshScheduleCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const { hostname, protocol = "https", port, path: basePath } = await context.endpoint(); + const headers: any = {}; + let resolvedPath = + `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + + "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules/{ScheduleId}"; + resolvedPath = __resolvedPath(resolvedPath, input, "DataSetId", () => input.DataSetId!, "{DataSetId}", false); + resolvedPath = __resolvedPath( + resolvedPath, + input, + "AwsAccountId", + () => input.AwsAccountId!, + "{AwsAccountId}", + false + ); + resolvedPath = __resolvedPath(resolvedPath, input, "ScheduleId", () => input.ScheduleId!, "{ScheduleId}", false); + let body: any; + return new __HttpRequest({ + protocol, + hostname, + port, + method: "DELETE", + headers, + path: resolvedPath, + body, + }); +}; + /** * serializeAws_restJson1DeleteTemplateCommand */ @@ -2719,6 +2863,39 @@ export const se_DescribeDataSetPermissionsCommand = async ( }); }; +/** + * serializeAws_restJson1DescribeDataSetRefreshPropertiesCommand + */ +export const se_DescribeDataSetRefreshPropertiesCommand = async ( + input: DescribeDataSetRefreshPropertiesCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const { hostname, protocol = "https", port, path: basePath } = await context.endpoint(); + const headers: any = {}; + let resolvedPath = + `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + + "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties"; + resolvedPath = __resolvedPath( + resolvedPath, + input, + "AwsAccountId", + () => input.AwsAccountId!, + "{AwsAccountId}", + false + ); + resolvedPath = __resolvedPath(resolvedPath, input, "DataSetId", () => input.DataSetId!, "{DataSetId}", false); + let body: any; + return new __HttpRequest({ + protocol, + hostname, + port, + method: "GET", + headers, + path: resolvedPath, + body, + }); +}; + /** * serializeAws_restJson1DescribeDataSourceCommand */ @@ -3106,6 +3283,40 @@ export const se_DescribeNamespaceCommand = async ( }); }; +/** + * serializeAws_restJson1DescribeRefreshScheduleCommand + */ +export const se_DescribeRefreshScheduleCommand = async ( + input: DescribeRefreshScheduleCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const { hostname, protocol = "https", port, path: basePath } = await context.endpoint(); + const headers: any = {}; + let resolvedPath = + `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + + "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules/{ScheduleId}"; + resolvedPath = __resolvedPath( + resolvedPath, + input, + "AwsAccountId", + () => input.AwsAccountId!, + "{AwsAccountId}", + false + ); + resolvedPath = __resolvedPath(resolvedPath, input, "DataSetId", () => input.DataSetId!, "{DataSetId}", false); + resolvedPath = __resolvedPath(resolvedPath, input, "ScheduleId", () => input.ScheduleId!, "{ScheduleId}", false); + let body: any; + return new __HttpRequest({ + protocol, + hostname, + port, + method: "GET", + headers, + path: resolvedPath, + body, + }); +}; + /** * serializeAws_restJson1DescribeTemplateCommand */ @@ -4061,6 +4272,39 @@ export const se_ListNamespacesCommand = async ( }); }; +/** + * serializeAws_restJson1ListRefreshSchedulesCommand + */ +export const se_ListRefreshSchedulesCommand = async ( + input: ListRefreshSchedulesCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const { hostname, protocol = "https", port, path: basePath } = await context.endpoint(); + const headers: any = {}; + let resolvedPath = + `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + + "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules"; + resolvedPath = __resolvedPath( + resolvedPath, + input, + "AwsAccountId", + () => input.AwsAccountId!, + "{AwsAccountId}", + false + ); + resolvedPath = __resolvedPath(resolvedPath, input, "DataSetId", () => input.DataSetId!, "{DataSetId}", false); + let body: any; + return new __HttpRequest({ + protocol, + hostname, + port, + method: "GET", + headers, + path: resolvedPath, + body, + }); +}; + /** * serializeAws_restJson1ListTagsForResourceCommand */ @@ -4387,6 +4631,46 @@ export const se_ListUsersCommand = async ( }); }; +/** + * serializeAws_restJson1PutDataSetRefreshPropertiesCommand + */ +export const se_PutDataSetRefreshPropertiesCommand = async ( + input: PutDataSetRefreshPropertiesCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const { hostname, protocol = "https", port, path: basePath } = await context.endpoint(); + const headers: any = { + "content-type": "application/json", + }; + let resolvedPath = + `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + + "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties"; + resolvedPath = __resolvedPath( + resolvedPath, + input, + "AwsAccountId", + () => input.AwsAccountId!, + "{AwsAccountId}", + false + ); + resolvedPath = __resolvedPath(resolvedPath, input, "DataSetId", () => input.DataSetId!, "{DataSetId}", false); + let body: any; + body = JSON.stringify({ + ...(input.DataSetRefreshProperties != null && { + DataSetRefreshProperties: se_DataSetRefreshProperties(input.DataSetRefreshProperties, context), + }), + }); + return new __HttpRequest({ + protocol, + hostname, + port, + method: "PUT", + headers, + path: resolvedPath, + body, + }); +}; + /** * serializeAws_restJson1RegisterUserCommand */ @@ -5518,10 +5802,10 @@ export const se_UpdatePublicSharingSettingsCommand = async ( }; /** - * serializeAws_restJson1UpdateTemplateCommand + * serializeAws_restJson1UpdateRefreshScheduleCommand */ -export const se_UpdateTemplateCommand = async ( - input: UpdateTemplateCommandInput, +export const se_UpdateRefreshScheduleCommand = async ( + input: UpdateRefreshScheduleCommandInput, context: __SerdeContext ): Promise<__HttpRequest> => { const { hostname, protocol = "https", port, path: basePath } = await context.endpoint(); @@ -5530,7 +5814,8 @@ export const se_UpdateTemplateCommand = async ( }; let resolvedPath = `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + - "/accounts/{AwsAccountId}/templates/{TemplateId}"; + "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules"; + resolvedPath = __resolvedPath(resolvedPath, input, "DataSetId", () => input.DataSetId!, "{DataSetId}", false); resolvedPath = __resolvedPath( resolvedPath, input, @@ -5539,7 +5824,44 @@ export const se_UpdateTemplateCommand = async ( "{AwsAccountId}", false ); - resolvedPath = __resolvedPath(resolvedPath, input, "TemplateId", () => input.TemplateId!, "{TemplateId}", false); + let body: any; + body = JSON.stringify({ + ...(input.Schedule != null && { Schedule: se_RefreshSchedule(input.Schedule, context) }), + }); + return new __HttpRequest({ + protocol, + hostname, + port, + method: "PUT", + headers, + path: resolvedPath, + body, + }); +}; + +/** + * serializeAws_restJson1UpdateTemplateCommand + */ +export const se_UpdateTemplateCommand = async ( + input: UpdateTemplateCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const { hostname, protocol = "https", port, path: basePath } = await context.endpoint(); + const headers: any = { + "content-type": "application/json", + }; + let resolvedPath = + `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + + "/accounts/{AwsAccountId}/templates/{TemplateId}"; + resolvedPath = __resolvedPath( + resolvedPath, + input, + "AwsAccountId", + () => input.AwsAccountId!, + "{AwsAccountId}", + false + ); + resolvedPath = __resolvedPath(resolvedPath, input, "TemplateId", () => input.TemplateId!, "{TemplateId}", false); let body: any; body = JSON.stringify({ ...(input.Definition != null && { Definition: se_TemplateVersionDefinition(input.Definition, context) }), @@ -6925,6 +7247,83 @@ const de_CreateNamespaceCommandError = async ( } }; +/** + * deserializeAws_restJson1CreateRefreshScheduleCommand + */ +export const de_CreateRefreshScheduleCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): PromiseCreates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.
", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateRefreshScheduleRequest": { + "type": "structure", + "members": { + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "The ID of the dataset.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Schedule": { + "target": "com.amazonaws.quicksight#RefreshSchedule", + "traits": { + "smithy.api#documentation": "The refresh schedule.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateRefreshScheduleResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + }, + "ScheduleId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The ID of the refresh schedule.
" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the refresh schedule.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#CreateTemplate": { "type": "operation", "input": { @@ -8258,6 +8366,21 @@ } } }, + "com.amazonaws.quicksight#DataSetRefreshProperties": { + "type": "structure", + "members": { + "RefreshConfiguration": { + "target": "com.amazonaws.quicksight#RefreshConfiguration", + "traits": { + "smithy.api#documentation": "The refresh configuration for a dataset.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The refresh properties of a dataset.
" + } + }, "com.amazonaws.quicksight#DataSetSchema": { "type": "structure", "members": { @@ -9393,6 +9516,63 @@ "smithy.api#documentation": "The configuration that defines the default value of a DateTime parameter when a value has not been set.
Deletes the dataset refresh properties of the dataset.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteDataSetRefreshPropertiesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "The ID of the dataset.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteDataSetRefreshPropertiesResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#DeleteDataSetRequest": { "type": "structure", "members": { @@ -10789,6 +11055,109 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#DeleteRefreshSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteRefreshScheduleRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteRefreshScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a refresh schedule from a dataset.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules/{ScheduleId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteRefreshScheduleRequest": { + "type": "structure", + "members": { + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "The ID of the dataset.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ScheduleId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The ID of the refresh schedule.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteRefreshScheduleResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + }, + "ScheduleId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The ID of the refresh schedule.
" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the refresh schedule.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#DeleteTemplate": { "type": "operation", "input": { @@ -12484,6 +12853,98 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#DescribeDataSetRefreshProperties": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Describes the refresh properties of a dataset.
", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "The ID of the dataset.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + }, + "DataSetRefreshProperties": { + "target": "com.amazonaws.quicksight#DataSetRefreshProperties", + "traits": { + "smithy.api#documentation": "The dataset refresh properties.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#DescribeDataSetRequest": { "type": "structure", "members": { @@ -13589,6 +14050,109 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#DescribeRefreshSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeRefreshScheduleRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeRefreshScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Provides a summary of a refresh schedule.
", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules/{ScheduleId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeRefreshScheduleRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "The ID of the dataset.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ScheduleId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The ID of the refresh schedule.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeRefreshScheduleResponse": { + "type": "structure", + "members": { + "RefreshSchedule": { + "target": "com.amazonaws.quicksight#RefreshSchedule", + "traits": { + "smithy.api#documentation": "The refresh schedule.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the refresh schedule.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#DescribeTemplate": { "type": "operation", "input": { @@ -19544,6 +20108,21 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.quicksight#IncrementalRefresh": { + "type": "structure", + "members": { + "LookbackWindow": { + "target": "com.amazonaws.quicksight#LookbackWindow", + "traits": { + "smithy.api#documentation": "The lookback window setup for an incremental refresh configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The incremental refresh configuration for a dataset.
" + } + }, "com.amazonaws.quicksight#Ingestion": { "type": "structure", "members": { @@ -19883,6 +20462,12 @@ "traits": { "smithy.api#enumValue": "CURSOR_NOT_ENABLED" } + }, + "DUPLICATE_COLUMN_NAMES_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DUPLICATE_COLUMN_NAMES_FOUND" + } } } }, @@ -23000,6 +23585,95 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#ListRefreshSchedules": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListRefreshSchedulesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListRefreshSchedulesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.
", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#ListRefreshSchedulesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "The ID of the dataset.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListRefreshSchedulesResponse": { + "type": "structure", + "members": { + "RefreshSchedules": { + "target": "com.amazonaws.quicksight#RefreshSchedules", + "traits": { + "smithy.api#documentation": "The list of refresh schedules for the dataset.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#ListTagsForResource": { "type": "operation", "input": { @@ -24172,6 +24846,59 @@ } } }, + "com.amazonaws.quicksight#LookbackWindow": { + "type": "structure", + "members": { + "ColumnName": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The name of the lookback window column.
", + "smithy.api#required": {} + } + }, + "Size": { + "target": "com.amazonaws.quicksight#PositiveLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The lookback window column size.
", + "smithy.api#required": {} + } + }, + "SizeUnit": { + "target": "com.amazonaws.quicksight#LookbackWindowSizeUnit", + "traits": { + "smithy.api#documentation": "The size unit that is used for the lookback window column. Valid values for this structure are HOUR, DAY, and WEEK.
The lookback window setup of an incremental refresh configuration.
" + } + }, + "com.amazonaws.quicksight#LookbackWindowSizeUnit": { + "type": "enum", + "members": { + "HOUR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOUR" + } + }, + "DAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DAY" + } + }, + "WEEK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEEK" + } + } + } + }, "com.amazonaws.quicksight#ManifestFileLocation": { "type": "structure", "members": { @@ -27179,6 +27906,15 @@ } } }, + "com.amazonaws.quicksight#PositiveLong": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1 + } + } + }, "com.amazonaws.quicksight#PostgreSqlParameters": { "type": "structure", "members": { @@ -27402,6 +28138,102 @@ } } }, + "com.amazonaws.quicksight#PutDataSetRefreshProperties": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#PutDataSetRefreshPropertiesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#PutDataSetRefreshPropertiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Creates or updates the dataset refresh properties for the dataset.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#PutDataSetRefreshPropertiesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "The ID of the dataset.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetRefreshProperties": { + "target": "com.amazonaws.quicksight#DataSetRefreshProperties", + "traits": { + "smithy.api#documentation": "The dataset refresh properties.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#PutDataSetRefreshPropertiesResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#Query": { "type": "string", "traits": { @@ -27498,6 +28330,9 @@ { "target": "com.amazonaws.quicksight#CreateNamespace" }, + { + "target": "com.amazonaws.quicksight#CreateRefreshSchedule" + }, { "target": "com.amazonaws.quicksight#CreateTemplate" }, @@ -27525,6 +28360,9 @@ { "target": "com.amazonaws.quicksight#DeleteDataSet" }, + { + "target": "com.amazonaws.quicksight#DeleteDataSetRefreshProperties" + }, { "target": "com.amazonaws.quicksight#DeleteDataSource" }, @@ -27546,6 +28384,9 @@ { "target": "com.amazonaws.quicksight#DeleteNamespace" }, + { + "target": "com.amazonaws.quicksight#DeleteRefreshSchedule" + }, { "target": "com.amazonaws.quicksight#DeleteTemplate" }, @@ -27597,6 +28438,9 @@ { "target": "com.amazonaws.quicksight#DescribeDataSetPermissions" }, + { + "target": "com.amazonaws.quicksight#DescribeDataSetRefreshProperties" + }, { "target": "com.amazonaws.quicksight#DescribeDataSource" }, @@ -27630,6 +28474,9 @@ { "target": "com.amazonaws.quicksight#DescribeNamespace" }, + { + "target": "com.amazonaws.quicksight#DescribeRefreshSchedule" + }, { "target": "com.amazonaws.quicksight#DescribeTemplate" }, @@ -27705,6 +28552,9 @@ { "target": "com.amazonaws.quicksight#ListNamespaces" }, + { + "target": "com.amazonaws.quicksight#ListRefreshSchedules" + }, { "target": "com.amazonaws.quicksight#ListTagsForResource" }, @@ -27732,6 +28582,9 @@ { "target": "com.amazonaws.quicksight#ListUsers" }, + { + "target": "com.amazonaws.quicksight#PutDataSetRefreshProperties" + }, { "target": "com.amazonaws.quicksight#RegisterUser" }, @@ -27813,6 +28666,9 @@ { "target": "com.amazonaws.quicksight#UpdatePublicSharingSettings" }, + { + "target": "com.amazonaws.quicksight#UpdateRefreshSchedule" + }, { "target": "com.amazonaws.quicksight#UpdateTemplate" }, @@ -28210,8 +29066,8 @@ }, "params": { "Region": "ap-northeast-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28223,8 +29079,8 @@ }, "params": { "Region": "ap-northeast-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28236,8 +29092,8 @@ }, "params": { "Region": "ap-south-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28249,8 +29105,8 @@ }, "params": { "Region": "ap-southeast-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28262,8 +29118,8 @@ }, "params": { "Region": "ap-southeast-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28275,8 +29131,8 @@ }, "params": { "Region": "api", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28288,8 +29144,8 @@ }, "params": { "Region": "ca-central-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28301,8 +29157,8 @@ }, "params": { "Region": "eu-central-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28314,8 +29170,8 @@ }, "params": { "Region": "eu-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28327,8 +29183,8 @@ }, "params": { "Region": "eu-west-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28340,8 +29196,8 @@ }, "params": { "Region": "sa-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28353,8 +29209,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28366,8 +29222,8 @@ }, "params": { "Region": "us-east-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28379,8 +29235,8 @@ }, "params": { "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28392,8 +29248,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -28405,8 +29261,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -28418,8 +29274,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -28431,8 +29287,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -28444,8 +29300,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -28457,8 +29313,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -28470,8 +29326,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28483,8 +29339,8 @@ }, "params": { "Region": "api", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28496,8 +29352,8 @@ }, "params": { "Region": "us-gov-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28509,8 +29365,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -28522,8 +29378,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -28535,8 +29391,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -28548,8 +29404,19 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { @@ -28561,8 +29428,19 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { @@ -28574,8 +29452,19 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { @@ -28587,8 +29476,19 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { @@ -28600,8 +29500,8 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -28613,8 +29513,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -28626,8 +29526,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -28638,8 +29538,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -28650,10 +29550,16 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Endpoint": "https://example.com" } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } ], "version": "1.0" @@ -29333,6 +30239,145 @@ } } }, + "com.amazonaws.quicksight#RefreshConfiguration": { + "type": "structure", + "members": { + "IncrementalRefresh": { + "target": "com.amazonaws.quicksight#IncrementalRefresh", + "traits": { + "smithy.api#documentation": "The incremental refresh for the dataset.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The refresh configuration of a dataset.
" + } + }, + "com.amazonaws.quicksight#RefreshFrequency": { + "type": "structure", + "members": { + "Interval": { + "target": "com.amazonaws.quicksight#RefreshInterval", + "traits": { + "smithy.api#documentation": "The interval between scheduled refreshes. Valid values are as follows:
\n\n MINUTE15: The dataset refreshes every 15 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.
\n MINUTE30:The dataset refreshes every 30 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.
\n HOURLY: The dataset refreshes every hour. This interval can only be used for one schedule per dataset.
\n DAILY: The dataset refreshes every day.
\n WEEKLY: The dataset refreshes every week.
\n MONTHLY: The dataset refreshes every month.
The day of the week that you want to schedule the refresh on. This value is required for weekly and monthly refresh intervals.
" + } + }, + "Timezone": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The timezone that you want the refresh schedule to use. The timezone ID must match a corresponding ID found on java.util.time.getAvailableIDs().
The time of day that you want the datset to refresh. This value is expressed in HH:MM format. This field is not required for schedules that refresh hourly.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the interval between each scheduled refresh of a dataset.
" + } + }, + "com.amazonaws.quicksight#RefreshInterval": { + "type": "enum", + "members": { + "MINUTE15": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MINUTE15" + } + }, + "MINUTE30": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MINUTE30" + } + }, + "HOURLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOURLY" + } + }, + "DAILY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DAILY" + } + }, + "WEEKLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEEKLY" + } + }, + "MONTHLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONTHLY" + } + } + } + }, + "com.amazonaws.quicksight#RefreshSchedule": { + "type": "structure", + "members": { + "ScheduleId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "An identifier for the refresh schedule.
", + "smithy.api#required": {} + } + }, + "ScheduleFrequency": { + "target": "com.amazonaws.quicksight#RefreshFrequency", + "traits": { + "smithy.api#documentation": "The frequency for the refresh schedule.
", + "smithy.api#required": {} + } + }, + "StartAfterDateTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.
The type of refresh that a datset undergoes. Valid values are as follows:
\n\n FULL_REFRESH: A complete refresh of a dataset.
\n INCREMENTAL_REFRESH: A partial refresh of some rows of a dataset, based on the time window specified.
For more information on full and incremental refreshes, see Refreshing SPICE data in the Amazon QuickSight User Guide.
", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the refresh schedule.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The refresh schedule of a dataset.
" + } + }, + "com.amazonaws.quicksight#RefreshSchedules": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#RefreshSchedule", + "traits": { + "smithy.api#documentation": "A list of RefreshSchedule objects.
A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.
", "smithy.api#required": {} } + }, + "TagRuleConfigurations": { + "target": "com.amazonaws.quicksight#RowLevelPermissionTagRuleConfigurationList", + "traits": { + "smithy.api#documentation": "A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.
" + } } }, "traits": { @@ -30424,6 +31475,30 @@ "smithy.api#documentation": "A set of rules associated with a tag.
" } }, + "com.amazonaws.quicksight#RowLevelPermissionTagRuleConfiguration": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SessionTagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#RowLevelPermissionTagRuleConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#RowLevelPermissionTagRuleConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, "com.amazonaws.quicksight#RowLevelPermissionTagRuleList": { "type": "list", "member": { @@ -30650,9 +31725,188 @@ } }, "ChartConfiguration": { - "target": "com.amazonaws.quicksight#SankeyDiagramChartConfiguration", + "target": "com.amazonaws.quicksight#SankeyDiagramChartConfiguration", + "traits": { + "smithy.api#documentation": "The configuration of a sankey diagram.
" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "The list of custom actions that are configured for a visual.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A sankey diagram.
\nFor more information, see Using Sankey diagrams in the Amazon QuickSight User Guide.
" + } + }, + "com.amazonaws.quicksight#ScatterPlotCategoricallyAggregatedFieldWells": { + "type": "structure", + "members": { + "XAxis": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "The x-axis field well of a scatter plot.
\nThe x-axis is aggregated by category.
" + } + }, + "YAxis": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "The y-axis field well of a scatter plot.
\nThe y-axis is aggregated by category.
" + } + }, + "Category": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "The category field well of a scatter plot.
" + } + }, + "Size": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "The size field well of a scatter plot.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The aggregated field well of a scatter plot.
" + } + }, + "com.amazonaws.quicksight#ScatterPlotConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#ScatterPlotFieldWells", + "traits": { + "smithy.api#documentation": "The field wells of the visual.
" + } + }, + "XAxisLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis.
" + } + }, + "XAxisDisplayOptions": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "The label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis.
" + } + }, + "YAxisLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "The label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis.
" + } + }, + "YAxisDisplayOptions": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "The label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis.
" + } + }, + "Legend": { + "target": "com.amazonaws.quicksight#LegendOptions", + "traits": { + "smithy.api#documentation": "The legend display setup of the visual.
" + } + }, + "DataLabels": { + "target": "com.amazonaws.quicksight#DataLabelOptions", + "traits": { + "smithy.api#documentation": "The options that determine if visual data labels are displayed.
" + } + }, + "Tooltip": { + "target": "com.amazonaws.quicksight#TooltipOptions", + "traits": { + "smithy.api#documentation": "The legend display setup of the visual.
" + } + }, + "VisualPalette": { + "target": "com.amazonaws.quicksight#VisualPalette", + "traits": { + "smithy.api#documentation": "The palette (chart color) display setup of the visual.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of a scatter plot.
" + } + }, + "com.amazonaws.quicksight#ScatterPlotFieldWells": { + "type": "structure", + "members": { + "ScatterPlotCategoricallyAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#ScatterPlotCategoricallyAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "The aggregated field wells of a scatter plot. Scatter plots that have a field in the category (group/color) field will have aggregated field wells. The x and y-axes of these scatter plots are aggregated by category.
" + } + }, + "ScatterPlotUnaggregatedFieldWells": { + "target": "com.amazonaws.quicksight#ScatterPlotUnaggregatedFieldWells", + "traits": { + "smithy.api#documentation": "The unaggregated field wells of a scatter plot. Scatter plots without a category field\n well have unaggregated field wells. The x and y-axes of these scatter plots are\n unaggregated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The field well configuration of a scatter plot.
\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.
" + } + }, + "com.amazonaws.quicksight#ScatterPlotUnaggregatedFieldWells": { + "type": "structure", + "members": { + "XAxis": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "The x-axis field well of a scatter plot.
\nThe x-axis is a dimension field and cannot be aggregated.
" + } + }, + "YAxis": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "The y-axis field well of a scatter plot.
\nThe y-axis is a dimension field and cannot be aggregated.
" + } + }, + "Size": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "The size field well of a scatter plot.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The unaggregated field wells of a scatter plot.
" + } + }, + "com.amazonaws.quicksight#ScatterPlotVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "The title that is displayed on the visual.
" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "The subtitle that is displayed on the visual.
" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#ScatterPlotConfiguration", "traits": { - "smithy.api#documentation": "The configuration of a sankey diagram.
" + "smithy.api#documentation": "The configuration settings of the visual.
" } }, "Actions": { @@ -30660,195 +31914,36 @@ "traits": { "smithy.api#documentation": "The list of custom actions that are configured for a visual.
" } - } - }, - "traits": { - "smithy.api#documentation": "A sankey diagram.
\nFor more information, see Using Sankey diagrams in the Amazon QuickSight User Guide.
" - } - }, - "com.amazonaws.quicksight#ScatterPlotCategoricallyAggregatedFieldWells": { - "type": "structure", - "members": { - "XAxis": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "The x-axis field well of a scatter plot.
\nThe x-axis is aggregated by category.
" - } - }, - "YAxis": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "The y-axis field well of a scatter plot.
\nThe y-axis is aggregated by category.
" - } - }, - "Category": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "The category field well of a scatter plot.
" - } - }, - "Size": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "The size field well of a scatter plot.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The aggregated field well of a scatter plot.
" - } - }, - "com.amazonaws.quicksight#ScatterPlotConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#ScatterPlotFieldWells", - "traits": { - "smithy.api#documentation": "The field wells of the visual.
" - } - }, - "XAxisLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis.
" - } - }, - "XAxisDisplayOptions": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "The label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis.
" - } - }, - "YAxisLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "The label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis.
" - } - }, - "YAxisDisplayOptions": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "The label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis.
" - } - }, - "Legend": { - "target": "com.amazonaws.quicksight#LegendOptions", - "traits": { - "smithy.api#documentation": "The legend display setup of the visual.
" - } - }, - "DataLabels": { - "target": "com.amazonaws.quicksight#DataLabelOptions", - "traits": { - "smithy.api#documentation": "The options that determine if visual data labels are displayed.
" - } - }, - "Tooltip": { - "target": "com.amazonaws.quicksight#TooltipOptions", - "traits": { - "smithy.api#documentation": "The legend display setup of the visual.
" - } - }, - "VisualPalette": { - "target": "com.amazonaws.quicksight#VisualPalette", - "traits": { - "smithy.api#documentation": "The palette (chart color) display setup of the visual.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration of a scatter plot.
" - } - }, - "com.amazonaws.quicksight#ScatterPlotFieldWells": { - "type": "structure", - "members": { - "ScatterPlotCategoricallyAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#ScatterPlotCategoricallyAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "The aggregated field wells of a scatter plot. Scatter plots that have a field in the category (group/color) field will have aggregated field wells. The x and y-axes of these scatter plots are aggregated by category.
" - } - }, - "ScatterPlotUnaggregatedFieldWells": { - "target": "com.amazonaws.quicksight#ScatterPlotUnaggregatedFieldWells", - "traits": { - "smithy.api#documentation": "The unaggregated field wells of a scatter plot. Scatter plots without a category field\n well have unaggregated field wells. The x and y-axes of these scatter plots are\n unaggregated.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The field well configuration of a scatter plot.
\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.
" - } - }, - "com.amazonaws.quicksight#ScatterPlotUnaggregatedFieldWells": { - "type": "structure", - "members": { - "XAxis": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "The x-axis field well of a scatter plot.
\nThe x-axis is a dimension field and cannot be aggregated.
" - } - }, - "YAxis": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "The y-axis field well of a scatter plot.
\nThe y-axis is a dimension field and cannot be aggregated.
" - } }, - "Size": { - "target": "com.amazonaws.quicksight#MeasureFieldList", + "ColumnHierarchies": { + "target": "com.amazonaws.quicksight#ColumnHierarchyList", "traits": { - "smithy.api#documentation": "The size field well of a scatter plot.
" + "smithy.api#documentation": "The column hierarchy that is used during drill-downs and drill-ups.
" } } }, "traits": { - "smithy.api#documentation": "The unaggregated field wells of a scatter plot.
" + "smithy.api#documentation": "A scatter plot.
\nFor more information, see Using scatter plots in the Amazon QuickSight User Guide.
" } }, - "com.amazonaws.quicksight#ScatterPlotVisual": { + "com.amazonaws.quicksight#ScheduleRefreshOnEntity": { "type": "structure", "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "The title that is displayed on the visual.
" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "The subtitle that is displayed on the visual.
" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#ScatterPlotConfiguration", - "traits": { - "smithy.api#documentation": "The configuration settings of the visual.
" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", + "DayOfWeek": { + "target": "com.amazonaws.quicksight#DayOfWeek", "traits": { - "smithy.api#documentation": "The list of custom actions that are configured for a visual.
" + "smithy.api#documentation": "The day of the week that you want to schedule a refresh on.
" } }, - "ColumnHierarchies": { - "target": "com.amazonaws.quicksight#ColumnHierarchyList", + "DayOfMonth": { + "target": "com.amazonaws.quicksight#DayOfMonth", "traits": { - "smithy.api#documentation": "The column hierarchy that is used during drill-downs and drill-ups.
" + "smithy.api#documentation": "The day of the month that you want to schedule refresh on.
" } } }, "traits": { - "smithy.api#documentation": "A scatter plot.
\nFor more information, see Using scatter plots in the Amazon QuickSight User Guide.
" + "smithy.api#documentation": "The refresh on entity for weekly or monthly schedules.
" } }, "com.amazonaws.quicksight#ScrollBarOptions": { @@ -38434,6 +39529,111 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#UpdateRefreshSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateRefreshScheduleRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateRefreshScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a refresh schedule for a dataset.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateRefreshScheduleRequest": { + "type": "structure", + "members": { + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "The ID of the dataset.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Schedule": { + "target": "com.amazonaws.quicksight#RefreshSchedule", + "traits": { + "smithy.api#documentation": "The refresh schedule.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateRefreshScheduleResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + }, + "ScheduleId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The ID of the refresh schedule.
" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the refresh schedule.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#UpdateResourcePermissionList": { "type": "list", "member": {