import type { DocumentType as __DocumentType } from "@smithy/types"; import type { AgentStatus, AssignmentStatus, DashboardsQAStatus, DataSetImportMode, DataSourceType, PersonalizationMode, PurchaseMode, QSearchStatus, ResourceStatus, Role, SelfUpgradeAdminAction, SelfUpgradeStatus, ServiceType, SpaceQuickSightResourceType, UserRole, VisualRole, VPCConnectionAvailabilityStatus, VPCConnectionResourceStatus } from "./enums"; import type { AccountCustomization } from "./models_0"; import type { _Parameters, AnalysisDefinition, AnalysisSourceEntity, AuthConfig, BrandDefinition, BrandDetail, Capabilities, ColumnGroup, ColumnLevelPermissionRule, CustomPromptInput, DashboardPublishOptions, DashboardSourceEntity, DashboardVersionDefinition, DataSourceParameters, LinkSharingConfiguration, ResourcePermission, SslProperties, Tag, TopicIR, TopicTemplate, ValidationStrategy, VpcConnectionProperties } from "./models_2"; import type { CustomInstructions, DataPrepConfiguration, DatasetParameter, DataSetUsageConfiguration, DataSourceCredentials, FieldFolder, Group, LogicalTable, PerformanceConfiguration, Permission, PhysicalTable, RefreshSchedule, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, SemanticModelConfiguration, SnapshotConfiguration, TemplateAlias, TemplateSourceEntity, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, TopicDetails, TopicRefreshSchedule } from "./models_3"; import type { FailedKeyRegistrationEntry, FailedSpaceResourceOperation, FailedToUpdateAssociation, RegisteredCustomerManagedKey, SelfUpgradeRequestDetail, SnapshotAnonymousUser, SpaceQuickSightResourceDetails, User } from "./models_4"; /** *

A structure that contains information about the users that the dashboard snapshot is generated for.

* *

When using identity-enhanced session credentials, set the UserConfiguration request attribute to null. Otherwise, the request will be invalid.

* * @public */ export interface SnapshotUserConfiguration { /** *

An array of records that describe the anonymous users that the dashboard snapshot is generated for.

* @public */ AnonymousUsers?: SnapshotAnonymousUser[] | undefined; } /** * @public */ export interface StartDashboardSnapshotJobRequest { /** *

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

* @public */ AwsAccountId: string | undefined; /** *

The ID of the dashboard that you want to start a snapshot job for. *

* @public */ DashboardId: string | undefined; /** *

An ID for the dashboard snapshot job. This ID is unique to the dashboard while the job is running. This ID can be used to poll the status of a job with a DescribeDashboardSnapshotJob while the job runs. You can reuse this ID for another job 24 hours after the current job is completed.

* @public */ SnapshotJobId: string | undefined; /** *

A structure that contains information about the users that the dashboard snapshot is generated for. The users can be either anonymous users or registered users. Anonymous users cannot be used together with registered users.

* *

When using identity-enhanced session credentials, set the UserConfiguration request attribute to null. Otherwise, the request will be invalid.

* * @public */ UserConfiguration?: SnapshotUserConfiguration | undefined; /** *

A structure that describes the configuration of the dashboard snapshot.

* @public */ SnapshotConfiguration: SnapshotConfiguration | undefined; } /** * @public */ export interface StartDashboardSnapshotJobResponse { /** *

The Amazon Resource Name (ARN) for the dashboard snapshot job.

* @public */ Arn?: string | undefined; /** *

The ID of the job. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

* @public */ SnapshotJobId?: string | undefined; /** *

* The Amazon Web Services request ID for this operation. *

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request

* @public */ Status?: number | undefined; } /** * @public */ export interface StartDashboardSnapshotJobScheduleRequest { /** *

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

* @public */ AwsAccountId: string | undefined; /** *

The ID of the dashboard that you want to start a snapshot job schedule for. *

* @public */ DashboardId: string | undefined; /** *

The ID of the schedule that you want to start a snapshot job schedule for. The schedule ID can be found in the Amazon Quick Sight console in the Schedules pane of the dashboard that the schedule is configured for.

* @public */ ScheduleId: string | undefined; } /** * @public */ export interface StartDashboardSnapshotJobScheduleResponse { /** *

* The Amazon Web Services request ID for this operation. *

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request

* @public */ Status?: number | undefined; } /** * @public */ export interface TagResourceRequest { /** *

The Amazon Resource Name (ARN) of the resource that you want to tag.

* @public */ ResourceArn: string | undefined; /** *

Contains a map of the key-value pairs for the resource tag or tags assigned to the * resource.

* @public */ Tags: Tag[] | undefined; } /** * @public */ export interface TagResourceResponse { /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; } /** * @public */ export interface UntagResourceRequest { /** *

The Amazon Resource Name (ARN) of the resource that you want to untag.

* @public */ ResourceArn: string | undefined; /** *

The keys of the key-value pairs for the resource tag or tags assigned to the * resource.

* @public */ TagKeys: string[] | undefined; } /** * @public */ export interface UntagResourceResponse { /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; } /** * @public */ export interface UpdateAccountCustomizationRequest { /** *

The ID for the Amazon Web Services account that you want to update Quick Sight customizations * for.

* @public */ AwsAccountId: string | undefined; /** *

The namespace that you want to update Quick Sight customizations for.

* @public */ Namespace?: string | undefined; /** *

The Quick Sight customizations you're updating.

* @public */ AccountCustomization: AccountCustomization | undefined; } /** * @public */ export interface UpdateAccountCustomizationResponse { /** *

The Amazon Resource Name (ARN) for the updated customization for this Amazon Web Services account.

* @public */ Arn?: string | undefined; /** *

The ID for the Amazon Web Services account that you want to update Quick Sight customizations * for.

* @public */ AwsAccountId?: string | undefined; /** *

The namespace associated with the customization that you're updating.

* @public */ Namespace?: string | undefined; /** *

The Quick Sight customizations you're updating.

* @public */ AccountCustomization?: AccountCustomization | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; } /** * @public */ export interface UpdateAccountCustomPermissionRequest { /** *

The name of the custom permissions profile that you want to apply to an account.

* @public */ CustomPermissionsName: string | undefined; /** *

The ID of the Amazon Web Services account for which you want to apply a custom permissions profile.

* @public */ AwsAccountId: string | undefined; } /** * @public */ export interface UpdateAccountCustomPermissionResponse { /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; } /** * @public */ export interface UpdateAccountSettingsRequest { /** *

The ID for the Amazon Web Services account that contains the Quick Sight settings that you want to * list.

* @public */ AwsAccountId: string | undefined; /** *

The default namespace for this Amazon Web Services account. Currently, the default is * default. IAM users that * register for the first time with Amazon Quick Sight provide an email address that becomes * associated with the default namespace. *

* @public */ DefaultNamespace: string | undefined; /** *

The email address that you want Quick Sight to send notifications to regarding your * Amazon Web Services account or Quick Sight subscription.

* @public */ NotificationEmail?: string | undefined; /** *

A boolean value that determines whether or not an Quick Sight account can be deleted. A True value doesn't allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubscription request. A False value will allow the account to be deleted.

* @public */ TerminationProtectionEnabled?: boolean | undefined; } /** * @public */ export interface UpdateAccountSettingsResponse { /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; } /** * @public */ export interface UpdateActionConnectorRequest { /** *

The Amazon Web Services account ID that contains the action connector to update.

* @public */ AwsAccountId: string | undefined; /** *

The unique identifier of the action connector to update.

* @public */ ActionConnectorId: string | undefined; /** *

The new name for the action connector.

* @public */ Name: string | undefined; /** *

The updated authentication configuration for connecting to the external service.

* @public */ AuthenticationConfig: AuthConfig | undefined; /** *

The updated description of the action connector.

* @public */ Description?: string | undefined; /** *

The updated ARN of the VPC connection to use for secure connectivity.

* @public */ VpcConnectionArn?: string | undefined; } /** * @public */ export interface UpdateActionConnectorResponse { /** *

The Amazon Resource Name (ARN) of the updated action connector.

* @public */ Arn?: string | undefined; /** *

The unique identifier of the updated action connector.

* @public */ ActionConnectorId?: string | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The status of the update operation.

* @public */ UpdateStatus?: ResourceStatus | undefined; /** *

The HTTP status code of the request.

* @public */ Status?: number | undefined; } /** * @public */ export interface UpdateActionConnectorPermissionsRequest { /** *

The Amazon Web Services account ID that contains the action connector.

* @public */ AwsAccountId: string | undefined; /** *

The unique identifier of the action connector whose permissions you want to update.

* @public */ ActionConnectorId: string | undefined; /** *

The permissions to grant to users and groups for this action connector.

* @public */ GrantPermissions?: ResourcePermission[] | undefined; /** *

The permissions to revoke from users and groups for this action connector.

* @public */ RevokePermissions?: ResourcePermission[] | undefined; } /** * @public */ export interface UpdateActionConnectorPermissionsResponse { /** *

The Amazon Resource Name (ARN) of the action connector.

* @public */ Arn?: string | undefined; /** *

The unique identifier of the action connector.

* @public */ ActionConnectorId?: string | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status code of the request.

* @public */ Status?: number | undefined; /** *

The updated permissions configuration for the action connector.

* @public */ Permissions?: ResourcePermission[] | undefined; } /** * @public */ export interface UpdateAgentRequest { /** *

The unique identifier for the agent to update.

* @public */ AgentId: string | undefined; /** *

The ID of the Amazon Web Services account that contains the agent.

* @public */ AwsAccountId: string | undefined; /** *

The name of the agent.

* @public */ Name: string | undefined; /** *

A description of the agent.

* @public */ Description?: string | undefined; /** *

The icon identifier for the agent.

* @public */ IconId?: string | undefined; /** *

A list of starter prompts that are displayed to users when they begin interacting with the agent.

* @public */ StarterPrompts?: string[] | undefined; /** *

The welcome message that is displayed when a user starts a conversation with the agent.

* @public */ WelcomeMessage?: string | undefined; /** *

The custom prompt configuration for the agent.

* @public */ CustomPromptInput?: CustomPromptInput | undefined; /** *

The Amazon Resource Names (ARNs) of the spaces to attach to the agent.

* @public */ SpacesToAdd?: string[] | undefined; /** *

The Amazon Resource Names (ARNs) of the spaces to detach from the agent.

* @public */ SpacesToRemove?: string[] | undefined; /** *

The Amazon Resource Names (ARNs) of the action connectors to attach to the agent.

* @public */ ActionConnectorsToAdd?: string[] | undefined; /** *

The Amazon Resource Names (ARNs) of the action connectors to detach from the agent.

* @public */ ActionConnectorsToRemove?: string[] | undefined; } /** * @public */ export interface UpdateAgentResponse { /** *

The Amazon Resource Name (ARN) of the agent.

* @public */ Arn: string | undefined; /** *

The unique identifier for the agent.

* @public */ AgentId: string | undefined; /** *

The status of the agent.

* @public */ AgentStatus: AgentStatus | undefined; /** *

A list of per-ARN failures from the spaces that were requested to be added.

* @public */ FailedToAddSpaces?: FailedToUpdateAssociation[] | undefined; /** *

A list of per-ARN failures from the spaces that were requested to be removed.

* @public */ FailedToRemoveSpaces?: FailedToUpdateAssociation[] | undefined; /** *

A list of per-ARN failures from the action connectors that were requested to be added.

* @public */ FailedToAddActionConnectors?: FailedToUpdateAssociation[] | undefined; /** *

A list of per-ARN failures from the action connectors that were requested to be removed.

* @public */ FailedToRemoveActionConnectors?: FailedToUpdateAssociation[] | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; } /** * @public */ export interface UpdateAgentPermissionsRequest { /** *

The unique identifier for the agent.

* @public */ AgentId: string | undefined; /** *

The ID of the Amazon Web Services account that contains the agent.

* @public */ AwsAccountId: string | undefined; /** *

The resource permissions that you want to grant on the agent.

* @public */ GrantPermissions?: ResourcePermission[] | undefined; /** *

The resource permissions that you want to revoke from the agent.

* @public */ RevokePermissions?: ResourcePermission[] | undefined; } /** * @public */ export interface UpdateAgentPermissionsResponse { /** *

The Amazon Resource Name (ARN) of the agent.

* @public */ Arn: string | undefined; /** *

The unique identifier for the agent.

* @public */ AgentId: string | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The resource permissions for the agent.

* @public */ Permissions?: ResourcePermission[] | undefined; } /** * @public */ export interface UpdateAnalysisRequest { /** *

The ID of the Amazon Web Services account that contains the analysis that you're updating.

* @public */ AwsAccountId: string | undefined; /** *

The ID for the analysis that you're updating. This ID displays in the URL of the * analysis.

* @public */ AnalysisId: string | undefined; /** *

A descriptive name for the analysis that you're updating. This name displays for the * analysis in the Amazon Quick Sight console.

* @public */ Name: string | undefined; /** *

The parameter names and override values that you want to use. An analysis can have * any parameter type, and some parameters might accept multiple values.

* @public */ Parameters?: _Parameters | undefined; /** *

A source entity to use for the analysis that you're updating. This metadata structure * contains details that describe a source template and one or more datasets.

* @public */ SourceEntity?: AnalysisSourceEntity | undefined; /** *

The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're * creating. To see the theme in the Amazon Quick Sight console, make sure that you have access to * it.

* @public */ ThemeArn?: string | undefined; /** *

The definition of an analysis.

*

A definition is the data model of all features in a Dashboard, Template, or Analysis.

* @public */ Definition?: AnalysisDefinition | undefined; /** *

The option to relax the validation needed to update an analysis with definition objects. This skips the validation step for specific errors.

* @public */ ValidationStrategy?: ValidationStrategy | undefined; } /** * @public */ export interface UpdateAnalysisResponse { /** *

The ARN of the analysis that you're updating.

* @public */ Arn?: string | undefined; /** *

The ID of the analysis.

* @public */ AnalysisId?: string | undefined; /** *

The update status of the last update that was made to the analysis.

* @public */ UpdateStatus?: ResourceStatus | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; } /** * @public */ export interface UpdateAnalysisPermissionsRequest { /** *

The ID of the Amazon Web Services account that contains the analysis whose permissions you're * updating. You must be using the Amazon Web Services account that the analysis is in.

* @public */ AwsAccountId: string | undefined; /** *

The ID of the analysis whose permissions you're updating. The ID is part of the * analysis URL.

* @public */ AnalysisId: string | undefined; /** *

A structure that describes the permissions to add and the principal to add them * to.

* @public */ GrantPermissions?: ResourcePermission[] | undefined; /** *

A structure that describes the permissions to remove and the principal to remove them * from.

* @public */ RevokePermissions?: ResourcePermission[] | undefined; } /** * @public */ export interface UpdateAnalysisPermissionsResponse { /** *

The Amazon Resource Name (ARN) of the analysis that you updated.

* @public */ AnalysisArn?: string | undefined; /** *

The ID of the analysis that you updated permissions for.

* @public */ AnalysisId?: string | undefined; /** *

A structure that describes the principals and the resource-level permissions on an * analysis.

* @public */ Permissions?: ResourcePermission[] | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; } /** * @public */ export interface UpdateApplicationWithTokenExchangeGrantRequest { /** *

The ID of the Amazon Web Services account to be updated with a token exchange grant.

* @public */ AwsAccountId: string | undefined; /** *

The namespace of the Quick application.

* @public */ Namespace: string | undefined; } /** * @public */ export interface UpdateApplicationWithTokenExchangeGrantResponse { /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; } /** * @public */ export interface UpdateBrandRequest { /** *

The ID of the Amazon Web Services account that owns the brand.

* @public */ AwsAccountId: string | undefined; /** *

The ID of the Quick brand.

* @public */ BrandId: string | undefined; /** *

The definition of the brand.

* @public */ BrandDefinition?: BrandDefinition | undefined; } /** * @public */ export interface UpdateBrandResponse { /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The details of the brand.

* @public */ BrandDetail?: BrandDetail | undefined; /** *

The definition of the brand.

* @public */ BrandDefinition?: BrandDefinition | undefined; } /** * @public */ export interface UpdateBrandAssignmentRequest { /** *

The ID of the Amazon Web Services account that owns the brand assignment.

* @public */ AwsAccountId: string | undefined; /** *

The Amazon Resource Name (ARN) of the brand.

* @public */ BrandArn: string | undefined; } /** * @public */ export interface UpdateBrandAssignmentResponse { /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The Amazon Resource Name (ARN) of the brand.

* @public */ BrandArn?: string | undefined; } /** * @public */ export interface UpdateBrandPublishedVersionRequest { /** *

The ID of the Amazon Web Services account that owns the brand.

* @public */ AwsAccountId: string | undefined; /** *

The ID of the Quick brand.

* @public */ BrandId: string | undefined; /** *

The ID of the published version.

* @public */ VersionId: string | undefined; } /** * @public */ export interface UpdateBrandPublishedVersionResponse { /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The ID of the published version.

* @public */ VersionId?: string | undefined; } /** * @public */ export interface UpdateCustomPermissionsRequest { /** *

The ID of the Amazon Web Services account that contains the custom permissions profile that you want to update.

* @public */ AwsAccountId: string | undefined; /** *

The name of the custom permissions profile that you want to update.

* @public */ CustomPermissionsName: string | undefined; /** *

A set of actions to include in the custom permissions profile.

* @public */ Capabilities?: Capabilities | undefined; } /** * @public */ export interface UpdateCustomPermissionsResponse { /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; /** *

The Amazon Resource Name (ARN) of the custom permissions profile.

* @public */ Arn?: string | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; } /** * @public */ export interface UpdateDashboardRequest { /** *

The ID of the Amazon Web Services account that contains the dashboard that you're * updating.

* @public */ AwsAccountId: string | undefined; /** *

The ID for the dashboard.

* @public */ DashboardId: string | undefined; /** *

The display name of the dashboard.

* @public */ Name: string | undefined; /** *

The entity that you are using as a source when you update the dashboard. In * SourceEntity, you specify the type of object you're using as source. * You can only update a dashboard from a template, so you use a * SourceTemplate entity. If you need to update a dashboard from an * analysis, first convert the analysis to a template by using the * CreateTemplate * API operation. For SourceTemplate, * specify the Amazon Resource Name (ARN) of the source template. The * SourceTemplate ARN can contain any Amazon Web Services account and any * Amazon Quick Sight-supported Amazon Web Services Region.

*

Use the DataSetReferences entity within SourceTemplate to * list the replacement datasets for the placeholders listed in the original. The schema in * each dataset must match its placeholder.

* @public */ SourceEntity?: DashboardSourceEntity | undefined; /** *

A structure that contains the parameters of the dashboard. These are parameter * overrides for a dashboard. A dashboard can have any type of parameters, and some * parameters might accept multiple values.

* @public */ Parameters?: _Parameters | undefined; /** *

A description for the first version of the dashboard being created.

* @public */ VersionDescription?: string | undefined; /** *

Options for publishing the dashboard when you create it:

* * @public */ DashboardPublishOptions?: DashboardPublishOptions | undefined; /** *

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If * you add a value for this field, it overrides the value that was originally associated * with the entity. The theme ARN must exist in the same Amazon Web Services account where * you create the dashboard.

* @public */ ThemeArn?: string | undefined; /** *

The definition of a dashboard.

*

A definition is the data model of all features in a Dashboard, Template, or Analysis.

* @public */ Definition?: DashboardVersionDefinition | undefined; /** *

The option to relax the validation needed to update a dashboard with definition * objects. This skips the validation step for specific errors.

* @public */ ValidationStrategy?: ValidationStrategy | undefined; } /** * @public */ export interface UpdateDashboardResponse { /** *

The Amazon Resource Name (ARN) of the resource.

* @public */ Arn?: string | undefined; /** *

The ARN of the dashboard, including the version number.

* @public */ VersionArn?: string | undefined; /** *

The ID for the dashboard.

* @public */ DashboardId?: string | undefined; /** *

The creation status of the request.

* @public */ CreationStatus?: ResourceStatus | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; } /** * @public */ export interface UpdateDashboardLinksRequest { /** *

The ID of the Amazon Web Services account that contains the dashboard whose links you * want to update.

* @public */ AwsAccountId: string | undefined; /** *

The ID for the dashboard.

* @public */ DashboardId: string | undefined; /** *

list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

* @public */ LinkEntities: string[] | undefined; } /** * @public */ export interface UpdateDashboardLinksResponse { /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; /** *

The Amazon Resource Name (ARN) of the dashboard.

* @public */ DashboardArn?: string | undefined; /** *

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

* @public */ LinkEntities?: string[] | undefined; } /** * @public */ export interface UpdateDashboardPermissionsRequest { /** *

The ID of the Amazon Web Services account that contains the dashboard whose permissions * you're updating.

* @public */ AwsAccountId: string | undefined; /** *

The ID for the dashboard.

* @public */ DashboardId: string | undefined; /** *

The permissions that you want to grant on this resource.

* @public */ GrantPermissions?: ResourcePermission[] | undefined; /** *

The permissions that you want to revoke from this resource.

* @public */ RevokePermissions?: ResourcePermission[] | undefined; /** *

Grants link permissions to all users in a defined namespace.

* @public */ GrantLinkPermissions?: ResourcePermission[] | undefined; /** *

Revokes link permissions from all users in a defined namespace.

* @public */ RevokeLinkPermissions?: ResourcePermission[] | undefined; } /** * @public */ export interface UpdateDashboardPermissionsResponse { /** *

The Amazon Resource Name (ARN) of the dashboard.

* @public */ DashboardArn?: string | undefined; /** *

The ID for the dashboard.

* @public */ DashboardId?: string | undefined; /** *

Information about the permissions on the dashboard.

* @public */ Permissions?: ResourcePermission[] | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; /** *

Updates the permissions of a shared link to an Quick Sight dashboard.

* @public */ LinkSharingConfiguration?: LinkSharingConfiguration | undefined; } /** * @public */ export interface UpdateDashboardPublishedVersionRequest { /** *

The ID of the Amazon Web Services account that contains the dashboard that you're * updating.

* @public */ AwsAccountId: string | undefined; /** *

The ID for the dashboard.

* @public */ DashboardId: string | undefined; /** *

The version number of the dashboard.

* @public */ VersionNumber: number | undefined; } /** * @public */ export interface UpdateDashboardPublishedVersionResponse { /** *

The ID for the dashboard.

* @public */ DashboardId?: string | undefined; /** *

The Amazon Resource Name (ARN) of the dashboard.

* @public */ DashboardArn?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; } /** * @public */ export interface UpdateDashboardsQAConfigurationRequest { /** *

The ID of the Amazon Web Services account that contains the dashboard QA configuration that you want to update.

* @public */ AwsAccountId: string | undefined; /** *

The status of dashboards QA configuration that you want to update.

* @public */ DashboardsQAStatus: DashboardsQAStatus | undefined; } /** * @public */ export interface UpdateDashboardsQAConfigurationResponse { /** *

A value that indicates whether the dashboard QA configuration is enabled or not.

* @public */ DashboardsQAStatus?: DashboardsQAStatus | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; } /** * @public */ export interface UpdateDataSetRequest { /** *

The Amazon Web Services account ID.

* @public */ AwsAccountId: string | undefined; /** *

The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ DataSetId: string | undefined; /** *

The display name for the dataset.

* @public */ Name: string | undefined; /** *

Declares the physical tables that are available in the underlying data sources.

* @public */ PhysicalTableMap: Record | undefined; /** *

Configures the combination and transformation of the data from the physical * tables. This parameter is used with the legacy data preparation experience.

* * @deprecated (since 2025-10-23) Only used in the legacy data preparation experience. * @public */ LogicalTableMap?: Record | undefined; /** *

Indicates whether you want to import the data into SPICE.

* @public */ ImportMode: DataSetImportMode | undefined; /** *

Groupings of columns that work together in certain Amazon Quick Sight features. * Currently, only geospatial hierarchy is supported.

* @public */ ColumnGroups?: ColumnGroup[] | undefined; /** *

The folder that contains fields and nested subfolders for your dataset.

* @public */ FieldFolders?: Record | undefined; /** *

The row-level security configuration for the data you want to create. This parameter is used * with the legacy data preparation experience.

* * @deprecated (since 2025-10-23) Only used in the legacy data preparation experience. * @public */ RowLevelPermissionDataSet?: RowLevelPermissionDataSet | undefined; /** *

The configuration of tags on a dataset to set row-level security. Row-level security * tags are currently supported for anonymous embedding only. This parameter is used with * the legacy data preparation experience.

* * @deprecated (since 2025-10-23) Only used in the legacy data preparation experience. * @public */ RowLevelPermissionTagConfiguration?: RowLevelPermissionTagConfiguration | undefined; /** *

A set of one or more definitions of a * ColumnLevelPermissionRule * .

* @public */ ColumnLevelPermissionRules?: ColumnLevelPermissionRule[] | undefined; /** *

The usage configuration to apply to child datasets that reference this dataset as a source.

* @public */ DataSetUsageConfiguration?: DataSetUsageConfiguration | undefined; /** *

The parameter declarations of the dataset.

* @public */ DatasetParameters?: DatasetParameter[] | undefined; /** *

The configuration for the performance optimization of the dataset that contains a * UniqueKey configuration.

* @public */ PerformanceConfiguration?: PerformanceConfiguration | undefined; /** *

The data preparation configuration for the dataset. This configuration defines the source tables, * transformation steps, and destination tables used to prepare the data. * Required when using the new data preparation experience.

* @public */ DataPrepConfiguration?: DataPrepConfiguration | undefined; /** *

The semantic model configuration for the dataset. This configuration defines how the prepared * data is structured for an analysis, including table mappings and row-level security configurations. * Required when using the new data preparation experience.

* @public */ SemanticModelConfiguration?: SemanticModelConfiguration | undefined; } /** * @public */ export interface UpdateDataSetResponse { /** *

The Amazon Resource Name (ARN) of the dataset.

* @public */ Arn?: string | undefined; /** *

The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ DataSetId?: string | undefined; /** *

The ARN for the ingestion, which is triggered as a result of dataset creation if the * import mode is SPICE.

* @public */ IngestionArn?: string | undefined; /** *

The ID of the ingestion, which is triggered as a result of dataset creation if the * import mode is SPICE.

* @public */ IngestionId?: string | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; } /** * @public */ export interface UpdateDataSetPermissionsRequest { /** *

The Amazon Web Services account ID.

* @public */ AwsAccountId: string | undefined; /** *

The ID for the dataset whose permissions you want to update. This ID is unique per * Amazon Web Services Region for each Amazon Web Services account.

* @public */ DataSetId: string | undefined; /** *

The resource permissions that you want to grant to the dataset.

* @public */ GrantPermissions?: ResourcePermission[] | undefined; /** *

The resource permissions that you want to revoke from the dataset.

* @public */ RevokePermissions?: ResourcePermission[] | undefined; } /** * @public */ export interface UpdateDataSetPermissionsResponse { /** *

The Amazon Resource Name (ARN) of the dataset.

* @public */ DataSetArn?: string | undefined; /** *

The ID for the dataset whose permissions you want to update. This ID is unique per * Amazon Web Services Region for each Amazon Web Services account.

* @public */ DataSetId?: string | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; } /** * @public */ export interface UpdateDataSourceRequest { /** *

The Amazon Web Services account ID.

* @public */ AwsAccountId: string | undefined; /** *

The ID of the data source. This ID is unique per Amazon Web Services Region for each * Amazon Web Services account.

* @public */ DataSourceId: string | undefined; /** *

A display name for the data source.

* @public */ Name: string | undefined; /** *

The parameters that Amazon Quick Sight uses to connect to your underlying * source.

* @public */ DataSourceParameters?: DataSourceParameters | undefined; /** *

The credentials that Amazon Quick Sight that uses to connect to your underlying source. * Currently, only credentials based on user name and password are supported.

* @public */ Credentials?: DataSourceCredentials | undefined; /** *

Use this parameter only when you want Amazon Quick Sight to use a VPC connection when * connecting to your underlying source.

* @public */ VpcConnectionProperties?: VpcConnectionProperties | undefined; /** *

Secure Socket Layer (SSL) properties that apply when Amazon Quick Sight connects to * your underlying source.

* @public */ SslProperties?: SslProperties | undefined; } /** * @public */ export interface UpdateDataSourceResponse { /** *

The Amazon Resource Name (ARN) of the data source.

* @public */ Arn?: string | undefined; /** *

The ID of the data source. This ID is unique per Amazon Web Services Region for each * Amazon Web Services account.

* @public */ DataSourceId?: string | undefined; /** *

The update status of the data source's last update.

* @public */ UpdateStatus?: ResourceStatus | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; } /** * @public */ export interface UpdateDataSourcePermissionsRequest { /** *

The Amazon Web Services account ID.

* @public */ AwsAccountId: string | undefined; /** *

The ID of the data source. This ID is unique per Amazon Web Services Region for each * Amazon Web Services account.

* @public */ DataSourceId: string | undefined; /** *

A list of resource permissions that you want to grant on the data source.

* @public */ GrantPermissions?: ResourcePermission[] | undefined; /** *

A list of resource permissions that you want to revoke on the data source.

* @public */ RevokePermissions?: ResourcePermission[] | undefined; } /** * @public */ export interface UpdateDataSourcePermissionsResponse { /** *

The Amazon Resource Name (ARN) of the data source.

* @public */ DataSourceArn?: string | undefined; /** *

The ID of the data source. This ID is unique per Amazon Web Services Region for each * Amazon Web Services account.

* @public */ DataSourceId?: string | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; } /** * @public */ export interface UpdateDefaultQBusinessApplicationRequest { /** *

The ID of the Quick Sight account that is connected to the Amazon Q Business application that you want to update.

* @public */ AwsAccountId: string | undefined; /** *

The Quick Sight namespace that contains the linked Amazon Q Business application. If this field is left blank, the default namespace is used. Currently, the default namespace is the only valid value for this parameter.

* @public */ Namespace?: string | undefined; /** *

The ID of the Amazon Q Business application that you want to update.

* @public */ ApplicationId: string | undefined; } /** * @public */ export interface UpdateDefaultQBusinessApplicationResponse { /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; } /** * @public */ export interface UpdateFlowRequest { /** *

The ID of the Amazon Web Services account that contains the flow that you are updating.

* @public */ AwsAccountId: string | undefined; /** *

The unique identifier of the flow to update.

* @public */ FlowId: string | undefined; /** *

Updated display name for the flow. Omit to preserve the existing name.

* @public */ Name?: string | undefined; /** *

Updated description for the flow. Omit to preserve the existing description.

* @public */ Description?: string | undefined; /** *

The definition of the flow, specifying the steps and configurations. This is the flow definition in Quick Flow's internal format. The format is subject to change. When provided, all existing steps are replaced. Omit to preserve the existing definition.

* *

Always derive or depend on the flow definition from the DescribeFlow operation to ensure you are working with the latest format.

* * @public */ FlowDefinition?: __DocumentType | undefined; /** *

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

* @public */ ClientToken?: string | undefined; } /** * @public */ export interface UpdateFlowResponse { /** *

The Amazon Resource Name (ARN) of the flow.

* @public */ Arn: string | undefined; /** *

The unique identifier of the flow.

* @public */ FlowId: string | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; } /** * @public */ export interface UpdateFlowPermissionsInput { /** *

The ID of the Amazon Web Services account that contains the flow you are updating permissions against.

* @public */ AwsAccountId: string | undefined; /** *

The unique identifier of the flow to update permissions for.

* @public */ FlowId: string | undefined; /** *

The permissions that you want to grant on this flow.

* @public */ GrantPermissions?: Permission[] | undefined; /** *

The permissions that you want to revoke from this flow.

* @public */ RevokePermissions?: Permission[] | undefined; } /** * @public */ export interface UpdateFlowPermissionsOutput { /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; /** *

The Amazon Resource Name (ARN) of the flow you are updating permissions against.

* @public */ Arn: string | undefined; /** *

The permissions on the flow after they are updated.

* @public */ Permissions: Permission[] | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId: string | undefined; /** *

The unique identifier of the flow with updated permissions.

* @public */ FlowId: string | undefined; } /** * @public */ export interface UpdateFolderRequest { /** *

The ID for the Amazon Web Services account that contains the folder to update.

* @public */ AwsAccountId: string | undefined; /** *

The ID of the folder.

* @public */ FolderId: string | undefined; /** *

The name of the folder.

* @public */ Name: string | undefined; } /** * @public */ export interface UpdateFolderResponse { /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; /** *

The Amazon Resource Name (ARN) of the folder.

* @public */ Arn?: string | undefined; /** *

The ID of the folder.

* @public */ FolderId?: string | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; } /** * @public */ export interface UpdateFolderPermissionsRequest { /** *

The ID for the Amazon Web Services account that contains the folder to update.

* @public */ AwsAccountId: string | undefined; /** *

The ID of the folder.

* @public */ FolderId: string | undefined; /** *

The permissions that you want to grant on a resource. Namespace ARNs are not supported Principal values for folder permissions.

* @public */ GrantPermissions?: ResourcePermission[] | undefined; /** *

The permissions that you want to revoke from a resource. Namespace ARNs are not supported Principal values for folder permissions.

* @public */ RevokePermissions?: ResourcePermission[] | undefined; } /** * @public */ export interface UpdateFolderPermissionsResponse { /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; /** *

The Amazon Resource Name (ARN) of the folder.

* @public */ Arn?: string | undefined; /** *

The ID of the folder.

* @public */ FolderId?: string | undefined; /** *

Information about the permissions for the folder.

* @public */ Permissions?: ResourcePermission[] | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; } /** * @public */ export interface UpdateGroupRequest { /** *

The name of the group that you want to update.

* @public */ GroupName: string | undefined; /** *

The description for the group that you want to update.

* @public */ Description?: string | undefined; /** *

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the * Amazon Web Services account that contains your Amazon Quick Sight account.

* @public */ AwsAccountId: string | undefined; /** *

The namespace of the group that you want to update.

* @public */ Namespace: string | undefined; } /** * @public */ export interface UpdateGroupResponse { /** *

The name of the group.

* @public */ Group?: Group | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; } /** * @public */ export interface UpdateIAMPolicyAssignmentRequest { /** *

The ID of the Amazon Web Services account that contains the IAM policy * assignment.

* @public */ AwsAccountId: string | undefined; /** *

The name of the assignment, also called a rule. * The * name must be unique within the * Amazon Web Services account.

* @public */ AssignmentName: string | undefined; /** *

The namespace of the assignment.

* @public */ Namespace: string | undefined; /** *

The status of the assignment. Possible values are as follows:

*
    *
  • *

    * ENABLED - Anything specified in this assignment is used when * creating the data source.

    *
    • *
  • *

    * DISABLED - This assignment isn't used when creating the data * source.

    *
    • *
  • *

    * DRAFT - This assignment is an unfinished draft and isn't used * when creating the data source.

    *
    • *
* @public */ AssignmentStatus?: AssignmentStatus | undefined; /** *

The ARN for the IAM policy to apply to the Amazon Quick Sight users and * groups specified in this assignment.

* @public */ PolicyArn?: string | undefined; /** *

The Amazon Quick Sight users, groups, or both that you want to assign the policy * to.

* @public */ Identities?: Record | undefined; } /** * @public */ export interface UpdateIAMPolicyAssignmentResponse { /** *

The name of the assignment or rule.

* @public */ AssignmentName?: string | undefined; /** *

The ID of the assignment.

* @public */ AssignmentId?: string | undefined; /** *

The ARN for the IAM policy applied to the Amazon Quick Sight users and * groups specified in this assignment.

* @public */ PolicyArn?: string | undefined; /** *

The Amazon Quick Sight users, groups, or both that the IAM policy is * assigned to.

* @public */ Identities?: Record | undefined; /** *

The status of the assignment. Possible values are as follows:

*
    *
  • *

    * ENABLED - Anything specified in this assignment is used when * creating the data source.

    *
    • *
  • *

    * DISABLED - This assignment isn't used when creating the data * source.

    *
    • *
  • *

    * DRAFT - This assignment is an unfinished draft and isn't used * when creating the data source.

    *
    • *
* @public */ AssignmentStatus?: AssignmentStatus | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; } /** * @public */ export interface UpdateIdentityPropagationConfigRequest { /** *

The ID of the Amazon Web Services account that contains the identity propagation configuration that you want to update.

* @public */ AwsAccountId: string | undefined; /** *

The name of the Amazon Web Services service that contains the authorized targets that you want to add or update.

* @public */ Service: ServiceType | undefined; /** *

Specifies a list of application ARNs that represent the authorized targets for a service.

* @public */ AuthorizedTargets?: string[] | undefined; } /** * @public */ export interface UpdateIdentityPropagationConfigResponse { /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; } /** * @public */ export interface UpdateIpRestrictionRequest { /** *

The ID of the Amazon Web Services account that contains the IP rules.

* @public */ AwsAccountId: string | undefined; /** *

A map that describes the updated IP rules with CIDR ranges and descriptions.

* @public */ IpRestrictionRuleMap?: Record | undefined; /** *

A map of VPC IDs and their corresponding rules. When you configure this parameter, traffic from all VPC endpoints that are present in the specified VPC is allowed.

* @public */ VpcIdRestrictionRuleMap?: Record | undefined; /** *

A map of allowed VPC endpoint IDs and their corresponding rule descriptions.

* @public */ VpcEndpointIdRestrictionRuleMap?: Record | undefined; /** *

A value that specifies whether IP rules are turned on.

* @public */ Enabled?: boolean | undefined; } /** * @public */ export interface UpdateIpRestrictionResponse { /** *

The ID of the Amazon Web Services account that contains the IP rules.

* @public */ AwsAccountId?: string | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; } /** * @public */ export interface UpdateKeyRegistrationRequest { /** *

The ID of the Amazon Web Services account that contains the customer managed key registration that you want to update.

* @public */ AwsAccountId: string | undefined; /** *

A list of RegisteredCustomerManagedKey objects to be updated to the Quick Sight account.

* @public */ KeyRegistration: RegisteredCustomerManagedKey[] | undefined; } /** *

A success entry that occurs when a KeyRegistration job is successfully applied to the Quick Sight account.

* @public */ export interface SuccessfulKeyRegistrationEntry { /** *

The ARN of the KMS key that is associated with the SuccessfulKeyRegistrationEntry entry.

* @public */ KeyArn: string | undefined; /** *

The HTTP status of a SuccessfulKeyRegistrationEntry entry.

* @public */ StatusCode: number | undefined; } /** * @public */ export interface UpdateKeyRegistrationResponse { /** *

A list of all customer managed key registrations that failed to update.

* @public */ FailedKeyRegistration?: FailedKeyRegistrationEntry[] | undefined; /** *

A list of all customer managed key registrations that were successfully updated.

* @public */ SuccessfulKeyRegistration?: SuccessfulKeyRegistrationEntry[] | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; } /** * @public */ export interface UpdateKnowledgeBasePermissionsRequest { /** *

The ID of the Amazon Web Services account that contains the knowledge base.

* @public */ AwsAccountId: string | undefined; /** *

The unique identifier for the knowledge base.

* @public */ KnowledgeBaseId: string | undefined; /** *

The resource permissions that you want to grant on the knowledge base.

* @public */ GrantPermissions?: ResourcePermission[] | undefined; /** *

The resource permissions that you want to revoke from the knowledge base.

* @public */ RevokePermissions?: ResourcePermission[] | undefined; } /** * @public */ export interface UpdateKnowledgeBasePermissionsResponse { /** *

The Amazon Resource Name (ARN) of the knowledge base.

* @public */ KnowledgeBaseArn: string | undefined; /** *

The unique identifier for the knowledge base.

* @public */ KnowledgeBaseId: string | undefined; /** *

The resource permissions for the knowledge base.

* @public */ Permissions?: ResourcePermission[] | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; } /** * @public */ export interface UpdateOAuthClientApplicationRequest { /** *

The Amazon Web Services account ID.

* @public */ AwsAccountId: string | undefined; /** *

The ID of the OAuthClientApplication that you want to update.

* @public */ OAuthClientApplicationId: string | undefined; /** *

The display name for the OAuthClientApplication.

* @public */ Name: string | undefined; /** *

The client ID of the OAuth application that is registered with the identity provider.

* @public */ ClientId?: string | undefined; /** *

The client secret of the OAuth application that is registered with the identity provider.

* @public */ ClientSecret?: string | undefined; /** *

The token endpoint URL of the identity provider that is used to obtain access tokens.

* @public */ OAuthTokenEndpointUrl?: string | undefined; /** *

The authorization endpoint URL of the identity provider that is used to obtain authorization codes.

* @public */ OAuthAuthorizationEndpointUrl?: string | undefined; /** *

The OAuth scopes that are requested when the OAuthClientApplication obtains an access token from the identity provider.

* @public */ OAuthScopes?: string | undefined; /** *

The type of data source that the OAuthClientApplication is used with. Valid values are SNOWFLAKE.

* @public */ DataSourceType?: DataSourceType | undefined; /** *

VPC connection properties.

* @public */ IdentityProviderVpcConnectionProperties?: VpcConnectionProperties | undefined; } /** * @public */ export interface UpdateOAuthClientApplicationResponse { /** *

The Amazon Resource Name (ARN) of the OAuthClientApplication.

* @public */ Arn?: string | undefined; /** *

The ID of the OAuthClientApplication. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ OAuthClientApplicationId?: string | undefined; /** *

The status of updating the OAuthClientApplication.

* @public */ UpdateStatus?: ResourceStatus | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; } /** * @public */ export interface UpdatePublicSharingSettingsRequest { /** *

The Amazon Web Services account ID associated with your Amazon Quick Sight * subscription.

* @public */ AwsAccountId: string | undefined; /** *

A Boolean value that indicates whether public sharing is turned on for an Quick account.

* @public */ PublicSharingEnabled?: boolean | undefined; } /** * @public */ export interface UpdatePublicSharingSettingsResponse { /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; } /** * @public */ export interface UpdateQPersonalizationConfigurationRequest { /** *

The ID of the Amazon Web Services account account that contains the personalization configuration that the user wants to update.

* @public */ AwsAccountId: string | undefined; /** *

An option to allow Amazon Quick Sight to customize data stories with user specific metadata, specifically location and job information, in your IAM Identity Center instance.

* @public */ PersonalizationMode: PersonalizationMode | undefined; } /** * @public */ export interface UpdateQPersonalizationConfigurationResponse { /** *

The personalization mode that is used for the personalization configuration.

* @public */ PersonalizationMode?: PersonalizationMode | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; } /** * @public */ export interface UpdateQuickSightQSearchConfigurationRequest { /** *

The ID of the Amazon Web Services account that contains the Quick Sight Q Search configuration that you want to update.

* @public */ AwsAccountId: string | undefined; /** *

The status of the Quick Sight Q Search configuration that the user wants to update.

* @public */ QSearchStatus: QSearchStatus | undefined; } /** * @public */ export interface UpdateQuickSightQSearchConfigurationResponse { /** *

The status of the Quick Sight Q Search configuration.

* @public */ QSearchStatus?: QSearchStatus | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; } /** * @public */ export interface UpdateRefreshScheduleRequest { /** *

The ID of the dataset.

* @public */ DataSetId: string | undefined; /** *

The Amazon Web Services account ID.

* @public */ AwsAccountId: string | undefined; /** *

The refresh schedule.

* @public */ Schedule: RefreshSchedule | undefined; } /** * @public */ export interface UpdateRefreshScheduleResponse { /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The ID of the refresh schedule.

* @public */ ScheduleId?: string | undefined; /** *

The Amazon Resource Name (ARN) for the refresh schedule.

* @public */ Arn?: string | undefined; } /** * @public */ export interface UpdateRoleCustomPermissionRequest { /** *

The name of the custom permission that you want to update the role with.

* @public */ CustomPermissionsName: string | undefined; /** *

The name of role tht you want to update.

* @public */ Role: Role | undefined; /** *

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon Quick Sight account.

* @public */ AwsAccountId: string | undefined; /** *

The namespace that contains the role that you want to update.

* @public */ Namespace: string | undefined; } /** * @public */ export interface UpdateRoleCustomPermissionResponse { /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; } /** * @public */ export interface UpdateSelfUpgradeRequest { /** *

The ID of the Amazon Web Services account that contains the self-upgrade request.

* @public */ AwsAccountId: string | undefined; /** *

The Quick namespace for the self-upgrade request.

* @public */ Namespace: string | undefined; /** *

The ID of the self-upgrade request to update.

* @public */ UpgradeRequestId: string | undefined; /** *

The action to perform on the self-upgrade request. Valid values are APPROVE, DENY, or VERIFY.

* @public */ Action: SelfUpgradeAdminAction | undefined; } /** * @public */ export interface UpdateSelfUpgradeResponse { /** *

Details of the updated self-upgrade request.

* @public */ SelfUpgradeRequestDetail?: SelfUpgradeRequestDetail | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; } /** * @public */ export interface UpdateSelfUpgradeConfigurationRequest { /** *

The ID of the Amazon Web Services account that contains the Quick self-upgrade configuration that you want to update.

* @public */ AwsAccountId: string | undefined; /** *

The Quick namespace that you want to update the Quick self-upgrade configuration for.

* @public */ Namespace: string | undefined; /** *

The self-upgrade status that you want to set for the Quick account.

* @public */ SelfUpgradeStatus: SelfUpgradeStatus | undefined; } /** * @public */ export interface UpdateSelfUpgradeConfigurationResponse { /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; } /** * @public */ export interface UpdateSpaceRequest { /** *

The ID of the Amazon Web Services account that contains the space.

* @public */ AwsAccountId: string | undefined; /** *

The ID of the space that you want to update.

* @public */ SpaceId: string | undefined; /** *

A new display name for the space.

* @public */ Name?: string | undefined; /** *

A new description for the space.

* @public */ Description?: string | undefined; } /** * @public */ export interface UpdateSpaceResponse { /** *

The ID of the space.

* @public */ spaceId: string | undefined; /** *

The ARN of the space.

* @public */ spaceArn?: string | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; } /** * @public */ export interface UpdateSpacePermissionsRequest { /** *

The ID of the Amazon Web Services account that contains the space.

* @public */ AwsAccountId: string | undefined; /** *

The ID of the space that you want to update permissions for.

* @public */ SpaceId: string | undefined; /** *

The permissions that you want to grant on the space.

* @public */ GrantPermissions?: ResourcePermission[] | undefined; /** *

The permissions that you want to revoke from the space.

* @public */ RevokePermissions?: ResourcePermission[] | undefined; } /** * @public */ export interface UpdateSpacePermissionsResponse { /** *

The ID of the space.

* @public */ spaceId: string | undefined; /** *

The ARN of the space.

* @public */ spaceArn?: string | undefined; /** *

The updated permissions for the space.

* @public */ permissions?: ResourcePermission[] | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ requestId?: string | undefined; } /** *

An operation to perform on a resource in a space.

* @public */ export interface SpaceResourceOperation { /** *

The type of the resource.

* @public */ ResourceType: SpaceQuickSightResourceType | undefined; /** *

The details of the resource.

* @public */ ResourceDetails: SpaceQuickSightResourceDetails | undefined; } /** * @public */ export interface UpdateSpaceResourcesRequest { /** *

The ID of the Amazon Web Services account that contains the space.

* @public */ AwsAccountId: string | undefined; /** *

The ID of the space that you want to update resources for.

* @public */ SpaceId: string | undefined; /** *

A list of resources to add to the space.

* @public */ AddResources?: SpaceResourceOperation[] | undefined; /** *

A list of resources to remove from the space.

* @public */ RemoveResources?: SpaceResourceOperation[] | undefined; } /** * @public */ export interface UpdateSpaceResourcesResponse { /** *

The ID of the space.

* @public */ spaceId: string | undefined; /** *

The ARN of the space.

* @public */ spaceArn?: string | undefined; /** *

A list of resource operations that failed.

* @public */ FailedResourceOperations?: FailedSpaceResourceOperation[] | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; } /** * @public */ export interface UpdateSPICECapacityConfigurationRequest { /** *

The ID of the Amazon Web Services account that contains the SPICE configuration that you want to update.

* @public */ AwsAccountId: string | undefined; /** *

Determines how SPICE capacity can be purchased. The following options are available.

*
    *
  • *

    * MANUAL: SPICE capacity can only be purchased manually.

    *
    • *
  • *

    * AUTO_PURCHASE: Extra SPICE capacity is automatically purchased on your behalf as needed. SPICE capacity can also be purchased manually with this option.

    *
    • *
* @public */ PurchaseMode: PurchaseMode | undefined; } /** * @public */ export interface UpdateSPICECapacityConfigurationResponse { /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; } /** * @public */ export interface UpdateTemplateRequest { /** *

The ID of the Amazon Web Services account that contains the template that you're updating.

* @public */ AwsAccountId: string | undefined; /** *

The ID for the template.

* @public */ TemplateId: string | undefined; /** *

The entity that you are using as a source when you update the template. In * SourceEntity, you specify the type of object you're using as source: * SourceTemplate for a template or SourceAnalysis for an * analysis. Both of these require an Amazon Resource Name (ARN). For * SourceTemplate, specify the ARN of the source template. For * SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate * ARN can contain any Amazon Web Services account and any Quick Sight-supported Amazon Web Services Region;.

*

Use the DataSetReferences entity within SourceTemplate or * SourceAnalysis to list the replacement datasets for the placeholders listed * in the original. The schema in each dataset must match its placeholder.

* @public */ SourceEntity?: TemplateSourceEntity | undefined; /** *

A description of the current template version that is being updated. Every time you call * UpdateTemplate, you create a new version of the template. Each version * of the template maintains a description of the version in the * VersionDescription field.

* @public */ VersionDescription?: string | undefined; /** *

The name for the template.

* @public */ Name?: string | undefined; /** *

The definition of a template.

*

A definition is the data model of all features in a Dashboard, Template, or Analysis.

* @public */ Definition?: TemplateVersionDefinition | undefined; /** *

The option to relax the validation needed to update a template with definition objects. This skips the validation step for specific errors.

* @public */ ValidationStrategy?: ValidationStrategy | undefined; } /** * @public */ export interface UpdateTemplateResponse { /** *

The ID for the template.

* @public */ TemplateId?: string | undefined; /** *

The Amazon Resource Name (ARN) for the template.

* @public */ Arn?: string | undefined; /** *

The ARN for the template, including the version information of the first version.

* @public */ VersionArn?: string | undefined; /** *

The creation status of the template.

* @public */ CreationStatus?: ResourceStatus | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; } /** * @public */ export interface UpdateTemplateAliasRequest { /** *

The ID of the Amazon Web Services account that contains the template alias that you're updating.

* @public */ AwsAccountId: string | undefined; /** *

The ID for the template.

* @public */ TemplateId: string | undefined; /** *

The alias of the template that you want to update. If you name a specific alias, you update * the version that the alias points to. You can specify the latest version of the template * by providing the keyword $LATEST in the AliasName parameter. * The keyword $PUBLISHED doesn't apply to templates.

* @public */ AliasName: string | undefined; /** *

The version number of the template.

* @public */ TemplateVersionNumber: number | undefined; } /** * @public */ export interface UpdateTemplateAliasResponse { /** *

The template alias.

* @public */ TemplateAlias?: TemplateAlias | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; } /** * @public */ export interface UpdateTemplatePermissionsRequest { /** *

The ID of the Amazon Web Services account that contains the template.

* @public */ AwsAccountId: string | undefined; /** *

The ID for the template.

* @public */ TemplateId: string | undefined; /** *

A list of resource permissions to be granted on the template.

* @public */ GrantPermissions?: ResourcePermission[] | undefined; /** *

A list of resource permissions to be revoked from the template.

* @public */ RevokePermissions?: ResourcePermission[] | undefined; } /** * @public */ export interface UpdateTemplatePermissionsResponse { /** *

The ID for the template.

* @public */ TemplateId?: string | undefined; /** *

The Amazon Resource Name (ARN) of the template.

* @public */ TemplateArn?: string | undefined; /** *

A list of resource permissions to be set on the template.

* @public */ Permissions?: ResourcePermission[] | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; } /** * @public */ export interface UpdateThemeRequest { /** *

The ID of the Amazon Web Services account that contains the theme that you're updating.

* @public */ AwsAccountId: string | undefined; /** *

The ID for the theme.

* @public */ ThemeId: string | undefined; /** *

The name for the theme.

* @public */ Name?: string | undefined; /** *

The theme ID, defined by Amazon Quick Sight, that a custom theme inherits from. * All themes initially inherit from a default Quick Sight theme.

* @public */ BaseThemeId: string | undefined; /** *

A description of the theme version that you're updating Every time that you call * UpdateTheme, you create a new version of the theme. Each version of the * theme maintains a description of the version in VersionDescription.

* @public */ VersionDescription?: string | undefined; /** *

The theme configuration, which contains the theme display properties.

* @public */ Configuration?: ThemeConfiguration | undefined; } /** * @public */ export interface UpdateThemeResponse { /** *

The ID for the theme.

* @public */ ThemeId?: string | undefined; /** *

The Amazon Resource Name (ARN) for the theme.

* @public */ Arn?: string | undefined; /** *

The Amazon Resource Name (ARN) for the new version of the theme.

* @public */ VersionArn?: string | undefined; /** *

The creation status of the theme.

* @public */ CreationStatus?: ResourceStatus | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; } /** * @public */ export interface UpdateThemeAliasRequest { /** *

The ID of the Amazon Web Services account that contains the theme alias that you're updating.

* @public */ AwsAccountId: string | undefined; /** *

The ID for the theme.

* @public */ ThemeId: string | undefined; /** *

The name of the theme alias that you want to update.

* @public */ AliasName: string | undefined; /** *

The version number of the theme that the alias should reference.

* @public */ ThemeVersionNumber: number | undefined; } /** * @public */ export interface UpdateThemeAliasResponse { /** *

Information about the theme alias.

* @public */ ThemeAlias?: ThemeAlias | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; } /** * @public */ export interface UpdateThemePermissionsRequest { /** *

The ID of the Amazon Web Services account that contains the theme.

* @public */ AwsAccountId: string | undefined; /** *

The ID for the theme.

* @public */ ThemeId: string | undefined; /** *

A list of resource permissions to be granted for the theme.

* @public */ GrantPermissions?: ResourcePermission[] | undefined; /** *

A list of resource permissions to be revoked from the theme.

* @public */ RevokePermissions?: ResourcePermission[] | undefined; } /** * @public */ export interface UpdateThemePermissionsResponse { /** *

The ID for the theme.

* @public */ ThemeId?: string | undefined; /** *

The Amazon Resource Name (ARN) of the theme.

* @public */ ThemeArn?: string | undefined; /** *

The resulting list of resource permissions for the theme.

* @public */ Permissions?: ResourcePermission[] | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; } /** * @public */ export interface UpdateTopicRequest { /** *

The ID of the Amazon Web Services account that contains the topic that you want to * update.

* @public */ AwsAccountId: string | undefined; /** *

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ TopicId: string | undefined; /** *

The definition of the topic that you want to update.

* @public */ Topic: TopicDetails | undefined; /** *

Custom instructions for the topic.

* @public */ CustomInstructions?: CustomInstructions | undefined; } /** * @public */ export interface UpdateTopicResponse { /** *

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ TopicId?: string | undefined; /** *

The Amazon Resource Name (ARN) of the topic.

* @public */ Arn?: string | undefined; /** *

The Amazon Resource Name (ARN) of the topic refresh.

* @public */ RefreshArn?: string | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; } /** * @public */ export interface UpdateTopicPermissionsRequest { /** *

The ID of the Amazon Web Services account that contains the topic that you want to update * the permissions for.

* @public */ AwsAccountId: string | undefined; /** *

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ TopicId: string | undefined; /** *

The resource permissions that you want to grant to the topic.

* @public */ GrantPermissions?: ResourcePermission[] | undefined; /** *

The resource permissions that you want to revoke from the topic.

* @public */ RevokePermissions?: ResourcePermission[] | undefined; } /** * @public */ export interface UpdateTopicPermissionsResponse { /** *

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ TopicId?: string | undefined; /** *

The Amazon Resource Name (ARN) of the topic.

* @public */ TopicArn?: string | undefined; /** *

A list of resource permissions on the topic.

* @public */ Permissions?: ResourcePermission[] | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; } /** * @public */ export interface UpdateTopicRefreshScheduleRequest { /** *

The ID of the Amazon Web Services account that contains the topic whose refresh schedule * you want to update.

* @public */ AwsAccountId: string | undefined; /** *

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ TopicId: string | undefined; /** *

The ID of the dataset.

* @public */ DatasetId: string | undefined; /** *

The definition of a refresh schedule.

* @public */ RefreshSchedule: TopicRefreshSchedule | undefined; } /** * @public */ export interface UpdateTopicRefreshScheduleResponse { /** *

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ TopicId?: string | undefined; /** *

The Amazon Resource Name (ARN) of the topic.

* @public */ TopicArn?: string | undefined; /** *

The Amazon Resource Name (ARN) of the dataset.

* @public */ DatasetArn?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; } /** * @public */ export interface UpdateUserRequest { /** *

The Amazon Quick Sight user name that you want to update.

* @public */ UserName: string | undefined; /** *

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the * Amazon Web Services account that contains your Amazon Quick Sight account.

* @public */ AwsAccountId: string | undefined; /** *

The namespace. Currently, you should set this to default.

* @public */ Namespace: string | undefined; /** *

The email address of the user that you want to update.

* @public */ Email: string | undefined; /** *

The Amazon Quick Sight role of the user. The role can be one of the * following default security cohorts:

*
    *
  • *

    * READER: A user who has read-only access to dashboards.

    *
    • *
  • *

    * AUTHOR: A user who can create data sources, datasets, analyses, and * dashboards.

    *
    • *
  • *

    * ADMIN: A user who is an author, who can also manage Amazon Quick Sight * settings.

    *
    • *
  • *

    * READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Quick Sight, can build stories with Amazon Q, and can generate executive summaries from dashboards.

    *
    • *
  • *

    * AUTHOR_PRO: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.

    *
    • *
  • *

    * ADMIN_PRO: Admin Pros are Author Pros who can also manage Amazon Quick Sight administrative settings. Admin Pro users are billed at Author Pro pricing.

    *
    • *
*

The name of the Quick Sight role is invisible to the user except for the console * screens dealing with permissions.

* @public */ Role: UserRole | undefined; /** *

(Enterprise edition only) The name of the custom permissions profile that you want to * assign to this user. Customized permissions allows you to control a user's access by * restricting access the following operations:

*
    *
  • *

    Create and update data sources

    *
    • *
  • *

    Create and update datasets

    *
    • *
  • *

    Create and update email reports

    *
    • *
  • *

    Subscribe to email reports

    *
    • *
*

A set of custom permissions includes any combination of these restrictions. Currently, * you need to create the profile names for custom permission sets by using the Quick Sight * console. Then, you use the RegisterUser API operation to assign the named set of * permissions to a Quick Sight user.

*

Quick Sight custom permissions are applied through IAM policies. Therefore, they * override the permissions typically granted by assigning Quick Sight users to one of the * default security cohorts in Quick Sight (admin, author, reader).

*

This feature is available only to Quick Sight Enterprise edition subscriptions.

* @public */ CustomPermissionsName?: string | undefined; /** *

A flag that you use to indicate that you want to remove all custom permissions * from this user. Using this parameter resets the user to the state * it was in before a custom permissions profile was applied. This parameter defaults to * NULL and it doesn't accept any other value.

* @public */ UnapplyCustomPermissions?: boolean | undefined; /** *

The type of supported external login provider that provides identity to let a user federate into Quick Sight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.

*
    *
  • *

    * COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.

    *
    • *
  • *

    * CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.

    *
    • *
  • *

    * NONE: This clears all the previously saved external login information for a user. Use the * * DescribeUser * * API operation to check the external login information.

    *
    • *
* @public */ ExternalLoginFederationProviderType?: string | undefined; /** *

The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate * into Quick Sight with an associated Identity and Access Management(IAM) role. This parameter should * only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

* @public */ CustomFederationProviderUrl?: string | undefined; /** *

The identity ID for a user in the external login provider.

* @public */ ExternalLoginId?: string | undefined; } /** * @public */ export interface UpdateUserResponse { /** *

The Amazon Quick Sight user.

* @public */ User?: User | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; } /** * @public */ export interface UpdateUserCustomPermissionRequest { /** *

The username of the user that you want to update custom permissions for.

* @public */ UserName: string | undefined; /** *

The ID of the Amazon Web Services account that contains the custom permission configuration that you want to update.

* @public */ AwsAccountId: string | undefined; /** *

The namespace that the user belongs to.

* @public */ Namespace: string | undefined; /** *

The name of the custom permissions that you want to update.

* @public */ CustomPermissionsName: string | undefined; } /** * @public */ export interface UpdateUserCustomPermissionResponse { /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; } /** * @public */ export interface UpdateVPCConnectionRequest { /** *

The Amazon Web Services account ID of the account that contains the VPC connection that * you want to update.

* @public */ AwsAccountId: string | undefined; /** *

The ID of the VPC connection that * you're updating. This ID is a unique identifier for each Amazon Web Services Region in an * Amazon Web Services account.

* @public */ VPCConnectionId: string | undefined; /** *

The display name for the VPC connection.

* @public */ Name: string | undefined; /** *

A list of subnet IDs for the VPC connection.

* @public */ SubnetIds: string[] | undefined; /** *

A list of security group IDs for the VPC connection.

* @public */ SecurityGroupIds: string[] | undefined; /** *

A list of IP addresses of DNS resolver endpoints for the VPC connection.

* @public */ DnsResolvers?: string[] | undefined; /** *

An IAM role associated with the VPC connection.

* @public */ RoleArn: string | undefined; } /** * @public */ export interface UpdateVPCConnectionResponse { /** *

The Amazon Resource Name (ARN) of the VPC connection.

* @public */ Arn?: string | undefined; /** *

The ID of the VPC connection that you are updating. This ID is a unique identifier for each Amazon Web Services Region in anAmazon Web Services account.

* @public */ VPCConnectionId?: string | undefined; /** *

The update status of the VPC connection's last update.

* @public */ UpdateStatus?: VPCConnectionResourceStatus | undefined; /** *

The availability status of the VPC connection.

* @public */ AvailabilityStatus?: VPCConnectionAvailabilityStatus | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; } /** *

The definition for a TopicVisual.

* @public */ export interface TopicVisual { /** *

The visual ID for the TopicVisual.

* @public */ VisualId?: string | undefined; /** *

The role for the TopicVisual.

* @public */ Role?: VisualRole | undefined; /** *

The ir for the TopicVisual.

* @public */ Ir?: TopicIR | undefined; /** *

The supporting visuals for the TopicVisual.

* @public */ SupportingVisuals?: TopicVisual[] | undefined; } /** *

The definition for a CreateTopicReviewedAnswer.

* @public */ export interface CreateTopicReviewedAnswer { /** *

The answer ID for the CreateTopicReviewedAnswer.

* @public */ AnswerId: string | undefined; /** *

The Dataset arn for the CreateTopicReviewedAnswer.

* @public */ DatasetArn: string | undefined; /** *

The Question to be created.

* @public */ Question: string | undefined; /** *

The Mir for the CreateTopicReviewedAnswer.

* @public */ Mir?: TopicIR | undefined; /** *

The PrimaryVisual for the CreateTopicReviewedAnswer.

* @public */ PrimaryVisual?: TopicVisual | undefined; /** *

The template for the CreateTopicReviewedAnswer.

* @public */ Template?: TopicTemplate | undefined; } /** *

The deinition for a TopicReviewedAnswer.

* @public */ export interface TopicReviewedAnswer { /** *

The Amazon Resource Name (ARN) of the reviewed answer.

* @public */ Arn?: string | undefined; /** *

The answer ID of the reviewed answer.

* @public */ AnswerId: string | undefined; /** *

The Dataset ARN for the TopicReviewedAnswer.

* @public */ DatasetArn: string | undefined; /** *

The question for the TopicReviewedAnswer.

* @public */ Question: string | undefined; /** *

The mir for the TopicReviewedAnswer.

* @public */ Mir?: TopicIR | undefined; /** *

The primary visual for the TopicReviewedAnswer.

* @public */ PrimaryVisual?: TopicVisual | undefined; /** *

The template for the TopicReviewedAnswer.

* @public */ Template?: TopicTemplate | undefined; } /** * @public */ export interface BatchCreateTopicReviewedAnswerRequest { /** *

The ID of the Amazon Web Services account that you want to create a reviewed answer in.

* @public */ AwsAccountId: string | undefined; /** *

The ID for the topic reviewed answer that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ TopicId: string | undefined; /** *

The definition of the Answers to be created.

* @public */ Answers: CreateTopicReviewedAnswer[] | undefined; } /** * @public */ export interface ListTopicReviewedAnswersResponse { /** *

The ID for the topic that contains the reviewed answer that you want to list. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

* @public */ TopicId?: string | undefined; /** *

The Amazon Resource Name (ARN) of the topic.

* @public */ TopicArn?: string | undefined; /** *

The definition of all Answers in the topic.

* @public */ Answers?: TopicReviewedAnswer[] | undefined; /** *

The HTTP status of the request.

* @public */ Status?: number | undefined; /** *

The Amazon Web Services request ID for this operation.

* @public */ RequestId?: string | undefined; }