@aws-sdk/client-quicksight 3.904.0 → 3.907.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +106 -2
- package/dist-cjs/index.js +22805 -22423
- package/dist-es/QuickSight.js +26 -0
- package/dist-es/commands/CreateActionConnectorCommand.js +23 -0
- package/dist-es/commands/DeleteActionConnectorCommand.js +22 -0
- package/dist-es/commands/DescribeActionConnectorCommand.js +23 -0
- package/dist-es/commands/DescribeActionConnectorPermissionsCommand.js +22 -0
- package/dist-es/commands/GetFlowMetadataCommand.js +22 -0
- package/dist-es/commands/GetFlowPermissionsCommand.js +22 -0
- package/dist-es/commands/ListActionConnectorsCommand.js +23 -0
- package/dist-es/commands/ListFlowsCommand.js +22 -0
- package/dist-es/commands/PredictQAResultsCommand.js +1 -1
- package/dist-es/commands/SearchActionConnectorsCommand.js +23 -0
- package/dist-es/commands/SearchFlowsCommand.js +22 -0
- package/dist-es/commands/UpdateActionConnectorCommand.js +23 -0
- package/dist-es/commands/UpdateActionConnectorPermissionsCommand.js +22 -0
- package/dist-es/commands/UpdateFlowPermissionsCommand.js +22 -0
- package/dist-es/commands/index.js +13 -0
- package/dist-es/models/models_0.js +143 -93
- package/dist-es/models/models_1.js +86 -50
- package/dist-es/models/models_2.js +169 -161
- package/dist-es/models/models_3.js +172 -0
- package/dist-es/models/models_4.js +20 -21
- package/dist-es/models/models_5.js +44 -3
- package/dist-es/pagination/ListActionConnectorsPaginator.js +4 -0
- package/dist-es/pagination/ListFlowsPaginator.js +4 -0
- package/dist-es/pagination/SearchActionConnectorsPaginator.js +4 -0
- package/dist-es/pagination/SearchFlowsPaginator.js +4 -0
- package/dist-es/pagination/index.js +4 -0
- package/dist-es/protocols/Aws_restJson1.js +502 -2
- package/dist-types/QuickSight.d.ts +93 -2
- package/dist-types/QuickSightClient.d.ts +17 -4
- package/dist-types/commands/BatchCreateTopicReviewedAnswerCommand.d.ts +2 -2
- package/dist-types/commands/BatchDeleteTopicReviewedAnswerCommand.d.ts +2 -2
- package/dist-types/commands/CancelIngestionCommand.d.ts +1 -1
- package/dist-types/commands/CreateAccountCustomizationCommand.d.ts +6 -6
- package/dist-types/commands/CreateAccountSubscriptionCommand.d.ts +11 -11
- package/dist-types/commands/CreateActionConnectorCommand.d.ts +165 -0
- package/dist-types/commands/CreateAnalysisCommand.d.ts +3 -3
- package/dist-types/commands/CreateBrandCommand.d.ts +14 -2
- package/dist-types/commands/CreateCustomPermissionsCommand.d.ts +13 -1
- package/dist-types/commands/CreateDashboardCommand.d.ts +13 -10
- package/dist-types/commands/CreateDataSetCommand.d.ts +5 -4
- package/dist-types/commands/CreateDataSourceCommand.d.ts +49 -3
- package/dist-types/commands/CreateFolderCommand.d.ts +3 -3
- package/dist-types/commands/CreateFolderMembershipCommand.d.ts +3 -3
- package/dist-types/commands/CreateGroupCommand.d.ts +2 -2
- package/dist-types/commands/CreateGroupMembershipCommand.d.ts +2 -2
- package/dist-types/commands/CreateIAMPolicyAssignmentCommand.d.ts +2 -2
- package/dist-types/commands/CreateIngestionCommand.d.ts +1 -1
- package/dist-types/commands/CreateNamespaceCommand.d.ts +4 -4
- package/dist-types/commands/CreateRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/commands/CreateRoleMembershipCommand.d.ts +2 -2
- package/dist-types/commands/CreateTemplateAliasCommand.d.ts +2 -2
- package/dist-types/commands/CreateTemplateCommand.d.ts +5 -5
- package/dist-types/commands/CreateThemeAliasCommand.d.ts +2 -2
- package/dist-types/commands/CreateThemeCommand.d.ts +4 -4
- package/dist-types/commands/CreateTopicCommand.d.ts +1 -1
- package/dist-types/commands/CreateTopicRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/commands/CreateVPCConnectionCommand.d.ts +3 -3
- package/dist-types/commands/DeleteAccountCustomPermissionCommand.d.ts +2 -2
- package/dist-types/commands/DeleteAccountCustomizationCommand.d.ts +5 -5
- package/dist-types/commands/DeleteAccountSubscriptionCommand.d.ts +7 -7
- package/dist-types/commands/DeleteActionConnectorCommand.d.ts +96 -0
- package/dist-types/commands/DeleteAnalysisCommand.d.ts +7 -7
- package/dist-types/commands/DeleteBrandAssignmentCommand.d.ts +2 -2
- package/dist-types/commands/DeleteBrandCommand.d.ts +4 -4
- package/dist-types/commands/DeleteCustomPermissionsCommand.d.ts +2 -2
- package/dist-types/commands/DeleteDashboardCommand.d.ts +3 -3
- package/dist-types/commands/DeleteDataSetCommand.d.ts +2 -2
- package/dist-types/commands/DeleteDataSetRefreshPropertiesCommand.d.ts +2 -2
- package/dist-types/commands/DeleteDataSourceCommand.d.ts +4 -4
- package/dist-types/commands/DeleteDefaultQBusinessApplicationCommand.d.ts +3 -3
- package/dist-types/commands/DeleteFolderCommand.d.ts +4 -4
- package/dist-types/commands/DeleteFolderMembershipCommand.d.ts +4 -4
- package/dist-types/commands/DeleteGroupCommand.d.ts +3 -3
- package/dist-types/commands/DeleteGroupMembershipCommand.d.ts +2 -2
- package/dist-types/commands/DeleteIAMPolicyAssignmentCommand.d.ts +2 -2
- package/dist-types/commands/DeleteIdentityPropagationConfigCommand.d.ts +4 -4
- package/dist-types/commands/DeleteNamespaceCommand.d.ts +2 -2
- package/dist-types/commands/DeleteRefreshScheduleCommand.d.ts +2 -2
- package/dist-types/commands/DeleteRoleCustomPermissionCommand.d.ts +2 -2
- package/dist-types/commands/DeleteRoleMembershipCommand.d.ts +2 -3
- package/dist-types/commands/DeleteTemplateAliasCommand.d.ts +2 -2
- package/dist-types/commands/DeleteTemplateCommand.d.ts +2 -2
- package/dist-types/commands/DeleteThemeAliasCommand.d.ts +2 -2
- package/dist-types/commands/DeleteThemeCommand.d.ts +3 -3
- package/dist-types/commands/DeleteTopicCommand.d.ts +1 -1
- package/dist-types/commands/DeleteTopicRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/commands/DeleteUserByPrincipalIdCommand.d.ts +1 -1
- package/dist-types/commands/DeleteUserCommand.d.ts +2 -2
- package/dist-types/commands/DeleteUserCustomPermissionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteVPCConnectionCommand.d.ts +3 -3
- package/dist-types/commands/DescribeAccountCustomPermissionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAccountCustomizationCommand.d.ts +8 -8
- package/dist-types/commands/DescribeAccountSettingsCommand.d.ts +2 -2
- package/dist-types/commands/DescribeAccountSubscriptionCommand.d.ts +2 -2
- package/dist-types/commands/DescribeActionConnectorCommand.d.ts +154 -0
- package/dist-types/commands/DescribeActionConnectorPermissionsCommand.d.ts +104 -0
- package/dist-types/commands/DescribeAnalysisCommand.d.ts +3 -3
- package/dist-types/commands/DescribeAnalysisDefinitionCommand.d.ts +3 -3
- package/dist-types/commands/DescribeAnalysisPermissionsCommand.d.ts +2 -2
- package/dist-types/commands/DescribeAssetBundleExportJobCommand.d.ts +6 -3
- package/dist-types/commands/DescribeAssetBundleImportJobCommand.d.ts +25 -3
- package/dist-types/commands/DescribeBrandAssignmentCommand.d.ts +1 -1
- package/dist-types/commands/DescribeBrandCommand.d.ts +7 -1
- package/dist-types/commands/DescribeBrandPublishedVersionCommand.d.ts +7 -1
- package/dist-types/commands/DescribeCustomPermissionsCommand.d.ts +13 -1
- package/dist-types/commands/DescribeDashboardCommand.d.ts +3 -3
- package/dist-types/commands/DescribeDashboardDefinitionCommand.d.ts +10 -8
- package/dist-types/commands/DescribeDashboardPermissionsCommand.d.ts +2 -2
- package/dist-types/commands/DescribeDashboardSnapshotJobCommand.d.ts +3 -3
- package/dist-types/commands/DescribeDashboardSnapshotJobResultCommand.d.ts +3 -3
- package/dist-types/commands/DescribeDashboardsQAConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDataSetCommand.d.ts +3 -2
- package/dist-types/commands/DescribeDataSetPermissionsCommand.d.ts +3 -2
- package/dist-types/commands/DescribeDataSetRefreshPropertiesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDataSourceCommand.d.ts +44 -2
- package/dist-types/commands/DescribeDataSourcePermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDefaultQBusinessApplicationCommand.d.ts +2 -2
- package/dist-types/commands/DescribeFolderCommand.d.ts +3 -3
- package/dist-types/commands/DescribeFolderPermissionsCommand.d.ts +3 -3
- package/dist-types/commands/DescribeFolderResolvedPermissionsCommand.d.ts +3 -3
- package/dist-types/commands/DescribeGroupCommand.d.ts +2 -2
- package/dist-types/commands/DescribeGroupMembershipCommand.d.ts +1 -1
- package/dist-types/commands/DescribeIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist-types/commands/DescribeIngestionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeIpRestrictionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeKeyRegistrationCommand.d.ts +2 -2
- package/dist-types/commands/DescribeNamespaceCommand.d.ts +1 -1
- package/dist-types/commands/DescribeQPersonalizationConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DescribeQuickSightQSearchConfigurationCommand.d.ts +2 -2
- package/dist-types/commands/DescribeRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/commands/DescribeRoleCustomPermissionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTemplateAliasCommand.d.ts +2 -2
- package/dist-types/commands/DescribeTemplateCommand.d.ts +3 -3
- package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +3 -3
- package/dist-types/commands/DescribeTemplatePermissionsCommand.d.ts +2 -2
- package/dist-types/commands/DescribeThemeAliasCommand.d.ts +2 -2
- package/dist-types/commands/DescribeThemeCommand.d.ts +3 -3
- package/dist-types/commands/DescribeThemePermissionsCommand.d.ts +3 -3
- package/dist-types/commands/DescribeTopicCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTopicPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTopicRefreshCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTopicRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/commands/DescribeUserCommand.d.ts +1 -1
- package/dist-types/commands/DescribeVPCConnectionCommand.d.ts +3 -3
- package/dist-types/commands/GenerateEmbedUrlForAnonymousUserCommand.d.ts +21 -13
- package/dist-types/commands/GenerateEmbedUrlForRegisteredUserCommand.d.ts +20 -15
- package/dist-types/commands/GenerateEmbedUrlForRegisteredUserWithIdentityCommand.d.ts +17 -8
- package/dist-types/commands/GetDashboardEmbedUrlCommand.d.ts +22 -13
- package/dist-types/commands/GetFlowMetadataCommand.d.ts +100 -0
- package/dist-types/commands/GetFlowPermissionsCommand.d.ts +101 -0
- package/dist-types/commands/GetSessionEmbedUrlCommand.d.ts +14 -14
- package/dist-types/commands/ListActionConnectorsCommand.d.ts +111 -0
- package/dist-types/commands/ListAnalysesCommand.d.ts +3 -3
- package/dist-types/commands/ListAssetBundleExportJobsCommand.d.ts +7 -4
- package/dist-types/commands/ListAssetBundleImportJobsCommand.d.ts +7 -4
- package/dist-types/commands/ListBrandsCommand.d.ts +2 -2
- package/dist-types/commands/ListCustomPermissionsCommand.d.ts +13 -1
- package/dist-types/commands/ListDashboardVersionsCommand.d.ts +3 -3
- package/dist-types/commands/ListDashboardsCommand.d.ts +2 -2
- package/dist-types/commands/ListDataSetsCommand.d.ts +5 -3
- package/dist-types/commands/ListDataSourcesCommand.d.ts +44 -2
- package/dist-types/commands/ListFlowsCommand.d.ts +110 -0
- package/dist-types/commands/ListFolderMembersCommand.d.ts +3 -3
- package/dist-types/commands/ListFoldersCommand.d.ts +3 -3
- package/dist-types/commands/ListFoldersForResourceCommand.d.ts +3 -3
- package/dist-types/commands/ListGroupMembershipsCommand.d.ts +1 -1
- package/dist-types/commands/ListGroupsCommand.d.ts +4 -3
- package/dist-types/commands/ListIAMPolicyAssignmentsCommand.d.ts +3 -3
- package/dist-types/commands/ListIAMPolicyAssignmentsForUserCommand.d.ts +2 -2
- package/dist-types/commands/ListIdentityPropagationConfigsCommand.d.ts +4 -4
- package/dist-types/commands/ListIngestionsCommand.d.ts +2 -2
- package/dist-types/commands/ListNamespacesCommand.d.ts +2 -2
- package/dist-types/commands/ListRefreshSchedulesCommand.d.ts +2 -2
- package/dist-types/commands/ListRoleMembershipsCommand.d.ts +2 -2
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -2
- package/dist-types/commands/ListTemplateAliasesCommand.d.ts +3 -3
- package/dist-types/commands/ListTemplateVersionsCommand.d.ts +4 -4
- package/dist-types/commands/ListTemplatesCommand.d.ts +4 -4
- package/dist-types/commands/ListThemeAliasesCommand.d.ts +3 -3
- package/dist-types/commands/ListThemeVersionsCommand.d.ts +4 -4
- package/dist-types/commands/ListThemesCommand.d.ts +4 -4
- package/dist-types/commands/ListTopicRefreshSchedulesCommand.d.ts +2 -2
- package/dist-types/commands/ListTopicReviewedAnswersCommand.d.ts +2 -3
- package/dist-types/commands/ListTopicsCommand.d.ts +2 -2
- package/dist-types/commands/ListUserGroupsCommand.d.ts +3 -3
- package/dist-types/commands/ListUsersCommand.d.ts +3 -3
- package/dist-types/commands/ListVPCConnectionsCommand.d.ts +4 -4
- package/dist-types/commands/PredictQAResultsCommand.d.ts +2 -2
- package/dist-types/commands/PutDataSetRefreshPropertiesCommand.d.ts +2 -2
- package/dist-types/commands/RegisterUserCommand.d.ts +3 -3
- package/dist-types/commands/RestoreAnalysisCommand.d.ts +3 -3
- package/dist-types/commands/SearchActionConnectorsCommand.d.ts +115 -0
- package/dist-types/commands/SearchAnalysesCommand.d.ts +3 -3
- package/dist-types/commands/SearchDashboardsCommand.d.ts +5 -4
- package/dist-types/commands/SearchDataSetsCommand.d.ts +3 -2
- package/dist-types/commands/SearchDataSourcesCommand.d.ts +4 -3
- package/dist-types/commands/SearchFlowsCommand.d.ts +117 -0
- package/dist-types/commands/SearchFoldersCommand.d.ts +3 -3
- package/dist-types/commands/SearchGroupsCommand.d.ts +2 -2
- package/dist-types/commands/SearchTopicsCommand.d.ts +2 -2
- package/dist-types/commands/StartAssetBundleExportJobCommand.d.ts +12 -5
- package/dist-types/commands/StartAssetBundleImportJobCommand.d.ts +33 -5
- package/dist-types/commands/StartDashboardSnapshotJobCommand.d.ts +9 -9
- package/dist-types/commands/StartDashboardSnapshotJobScheduleCommand.d.ts +4 -4
- package/dist-types/commands/TagResourceCommand.d.ts +10 -8
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAccountCustomPermissionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAccountCustomizationCommand.d.ts +3 -3
- package/dist-types/commands/UpdateAccountSettingsCommand.d.ts +2 -2
- package/dist-types/commands/UpdateActionConnectorCommand.d.ts +150 -0
- package/dist-types/commands/UpdateActionConnectorPermissionsCommand.d.ts +132 -0
- package/dist-types/commands/UpdateAnalysisCommand.d.ts +3 -3
- package/dist-types/commands/UpdateAnalysisPermissionsCommand.d.ts +2 -2
- package/dist-types/commands/UpdateApplicationWithTokenExchangeGrantCommand.d.ts +1 -1
- package/dist-types/commands/UpdateBrandAssignmentCommand.d.ts +1 -1
- package/dist-types/commands/UpdateBrandCommand.d.ts +13 -1
- package/dist-types/commands/UpdateBrandPublishedVersionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateCustomPermissionsCommand.d.ts +13 -1
- package/dist-types/commands/UpdateDashboardCommand.d.ts +7 -4
- package/dist-types/commands/UpdateDashboardLinksCommand.d.ts +3 -3
- package/dist-types/commands/UpdateDashboardPermissionsCommand.d.ts +2 -2
- package/dist-types/commands/UpdateDashboardPublishedVersionCommand.d.ts +2 -2
- package/dist-types/commands/UpdateDashboardsQAConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDataSetCommand.d.ts +5 -4
- package/dist-types/commands/UpdateDataSetPermissionsCommand.d.ts +3 -2
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +48 -2
- package/dist-types/commands/UpdateDataSourcePermissionsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDefaultQBusinessApplicationCommand.d.ts +2 -2
- package/dist-types/commands/UpdateFlowPermissionsCommand.d.ts +117 -0
- package/dist-types/commands/UpdateFolderCommand.d.ts +3 -3
- package/dist-types/commands/UpdateFolderPermissionsCommand.d.ts +3 -3
- package/dist-types/commands/UpdateGroupCommand.d.ts +1 -1
- package/dist-types/commands/UpdateIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist-types/commands/UpdateIdentityPropagationConfigCommand.d.ts +3 -3
- package/dist-types/commands/UpdateIpRestrictionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateKeyRegistrationCommand.d.ts +2 -2
- package/dist-types/commands/UpdatePublicSharingSettingsCommand.d.ts +16 -13
- package/dist-types/commands/UpdateQPersonalizationConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateQuickSightQSearchConfigurationCommand.d.ts +2 -2
- package/dist-types/commands/UpdateRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/commands/UpdateRoleCustomPermissionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateSPICECapacityConfigurationCommand.d.ts +2 -2
- package/dist-types/commands/UpdateTemplateAliasCommand.d.ts +2 -2
- package/dist-types/commands/UpdateTemplateCommand.d.ts +3 -3
- package/dist-types/commands/UpdateTemplatePermissionsCommand.d.ts +2 -2
- package/dist-types/commands/UpdateThemeAliasCommand.d.ts +2 -2
- package/dist-types/commands/UpdateThemeCommand.d.ts +3 -3
- package/dist-types/commands/UpdateThemePermissionsCommand.d.ts +3 -3
- package/dist-types/commands/UpdateTopicCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTopicPermissionsCommand.d.ts +3 -3
- package/dist-types/commands/UpdateTopicRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/commands/UpdateUserCommand.d.ts +2 -2
- package/dist-types/commands/UpdateUserCustomPermissionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateVPCConnectionCommand.d.ts +3 -3
- package/dist-types/commands/index.d.ts +13 -0
- package/dist-types/index.d.ts +2 -2
- package/dist-types/models/models_0.d.ts +3714 -3674
- package/dist-types/models/models_1.d.ts +3770 -3698
- package/dist-types/models/models_2.d.ts +2474 -1883
- package/dist-types/models/models_3.d.ts +4585 -4312
- package/dist-types/models/models_4.d.ts +3844 -4136
- package/dist-types/models/models_5.d.ts +2234 -127
- package/dist-types/pagination/ListActionConnectorsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListFlowsPaginator.d.ts +7 -0
- package/dist-types/pagination/SearchActionConnectorsPaginator.d.ts +7 -0
- package/dist-types/pagination/SearchFlowsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +4 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +117 -0
- package/dist-types/ts3.4/QuickSight.d.ts +227 -0
- package/dist-types/ts3.4/QuickSightClient.d.ts +78 -0
- package/dist-types/ts3.4/commands/BatchCreateTopicReviewedAnswerCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/BatchDeleteTopicReviewedAnswerCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateActionConnectorCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteAccountCustomPermissionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteAccountCustomizationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteAccountSubscriptionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteActionConnectorCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteAnalysisCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteBrandAssignmentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteBrandCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteCustomPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteDashboardCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteDataSetCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteDataSetRefreshPropertiesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteDataSourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteDefaultQBusinessApplicationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteFolderCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteFolderMembershipCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteGroupCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteGroupMembershipCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteIAMPolicyAssignmentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteIdentityPropagationConfigCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteNamespaceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteRoleCustomPermissionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteRoleMembershipCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/DescribeActionConnectorCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeActionConnectorPermissionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetFlowMetadataCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetFlowPermissionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListActionConnectorsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListFlowsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListGroupsCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/ListIAMPolicyAssignmentsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListIAMPolicyAssignmentsForUserCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListIdentityPropagationConfigsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListIngestionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListNamespacesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListRefreshSchedulesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListRoleMembershipsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListTemplateAliasesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListTemplateVersionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListTemplatesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListThemeAliasesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListThemeVersionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListThemesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListTopicRefreshSchedulesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListTopicReviewedAnswersCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/ListTopicsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListUserGroupsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListUsersCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListVPCConnectionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PredictQAResultsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutDataSetRefreshPropertiesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/RegisterUserCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/RestoreAnalysisCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SearchActionConnectorsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/SearchAnalysesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SearchDashboardsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SearchFlowsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UpdateActionConnectorCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateActionConnectorPermissionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateFlowPermissionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +13 -0
- package/dist-types/ts3.4/models/models_0.d.ts +311 -174
- package/dist-types/ts3.4/models/models_1.d.ts +170 -158
- package/dist-types/ts3.4/models/models_2.d.ts +661 -307
- package/dist-types/ts3.4/models/models_3.d.ts +352 -217
- package/dist-types/ts3.4/models/models_4.d.ts +330 -396
- package/dist-types/ts3.4/models/models_5.d.ts +502 -8
- package/dist-types/ts3.4/pagination/ListActionConnectorsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListFlowsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/SearchActionConnectorsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/SearchFlowsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +4 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +156 -0
- package/package.json +6 -6
|
@@ -1,7 +1,1762 @@
|
|
|
1
|
-
import { AccountCustomization, ResourceStatus } from "./models_0";
|
|
2
|
-
import { AnalysisDefinition, AnalysisSourceEntity, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportFormat, AssetBundleExportJobValidationStrategy, AssetBundleImportFailureAction, AssetBundleImportJobOverrideParameters, AssetBundleImportJobOverridePermissions, AssetBundleImportJobOverrideTags, AssetBundleImportJobOverrideValidationStrategy, AssetBundleImportSource, AssignmentStatus,
|
|
3
|
-
import { _Parameters, BrandDetail, Capabilities, ColumnGroup, ColumnLevelPermissionRule, CustomInstructions, DashboardPublishOptions, DashboardSourceEntity, DashboardsQAStatus, DashboardVersionDefinition, DataSetImportMode, DatasetParameter, DataSetSearchFilter, DataSetSummary, DataSetUsageConfiguration, DataSourceCredentials, DataSourceSearchFilter,
|
|
4
|
-
import { FailedKeyRegistrationEntry, FolderSearchFilter, FolderSummary, GroupSearchFilter, IncludeFolderMembers,
|
|
1
|
+
import { AccountCustomization, ActionConnectorSearchFilter, ActionConnectorSummary, ActiveIAMPolicyAssignment, ResourceStatus } from "./models_0";
|
|
2
|
+
import { AnalysisDefinition, AnalysisSearchFilter, AnalysisSourceEntity, AnalysisSummary, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportFormat, AssetBundleExportJobValidationStrategy, AssetBundleImportFailureAction, AssetBundleImportJobOverrideParameters, AssetBundleImportJobOverridePermissions, AssetBundleImportJobOverrideTags, AssetBundleImportJobOverrideValidationStrategy, AssetBundleImportSource, AssignmentStatus, AuthConfig, AuthorizedTargetsByService, DataSetRefreshProperties, DataSourceParameters, ServiceType, SslProperties, Tag, VpcConnectionProperties } from "./models_2";
|
|
3
|
+
import { _Parameters, BrandDefinition, BrandDetail, Capabilities, ColumnGroup, ColumnLevelPermissionRule, CustomInstructions, DashboardPublishOptions, DashboardSearchFilter, DashboardSourceEntity, DashboardsQAStatus, DashboardSummary, DashboardVersionDefinition, DashboardVisualResult, DataSetImportMode, DatasetParameter, DataSetSearchFilter, DataSetSummary, DataSetUsageConfiguration, DataSourceCredentials, DataSourceSearchFilter, FieldFolder, Group, LinkSharingConfiguration, LogicalTable, PerformanceConfiguration, PhysicalTable, RefreshSchedule, ResourcePermission, Role, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, TemplateAlias, TemplateSourceEntity, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, TopicDetails, TopicIR, TopicRefreshSchedule, TopicTemplate, TopicUserExperienceVersion, ValidationStrategy, VisualRole, VPCConnectionAvailabilityStatus, VPCConnectionResourceStatus } from "./models_3";
|
|
4
|
+
import { DataSourceSummary, FailedKeyRegistrationEntry, FieldName, FlowSummary, FolderSearchFilter, FolderSummary, GeneratedAnswerResult, GroupSearchFilter, IAMPolicyAssignmentSummary, IdentityType, IncludeFolderMembers, IncludeGeneratedAnswer, IncludeQuickSightQIndex, Ingestion, NamespaceInfoV2, NetworkInterface, Permission, PersonalizationMode, QSearchStatus, RegisteredCustomerManagedKey, SessionTag, SnapshotConfiguration, ThemeType, User, UserRole } from "./models_4";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export interface ListGroupsResponse {
|
|
9
|
+
/**
|
|
10
|
+
* <p>The list of the groups.</p>
|
|
11
|
+
* @public
|
|
12
|
+
*/
|
|
13
|
+
GroupList?: Group[] | undefined;
|
|
14
|
+
/**
|
|
15
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
16
|
+
* @public
|
|
17
|
+
*/
|
|
18
|
+
NextToken?: string | undefined;
|
|
19
|
+
/**
|
|
20
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
21
|
+
* @public
|
|
22
|
+
*/
|
|
23
|
+
RequestId?: string | undefined;
|
|
24
|
+
/**
|
|
25
|
+
* <p>The HTTP status of the request.</p>
|
|
26
|
+
* @public
|
|
27
|
+
*/
|
|
28
|
+
Status?: number | undefined;
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* @public
|
|
32
|
+
*/
|
|
33
|
+
export interface ListIAMPolicyAssignmentsRequest {
|
|
34
|
+
/**
|
|
35
|
+
* <p>The ID of the Amazon Web Services account that contains these IAM policy
|
|
36
|
+
* assignments.</p>
|
|
37
|
+
* @public
|
|
38
|
+
*/
|
|
39
|
+
AwsAccountId: string | undefined;
|
|
40
|
+
/**
|
|
41
|
+
* <p>The status of the assignments.</p>
|
|
42
|
+
* @public
|
|
43
|
+
*/
|
|
44
|
+
AssignmentStatus?: AssignmentStatus | undefined;
|
|
45
|
+
/**
|
|
46
|
+
* <p>The namespace for the assignments.</p>
|
|
47
|
+
* @public
|
|
48
|
+
*/
|
|
49
|
+
Namespace: string | undefined;
|
|
50
|
+
/**
|
|
51
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
52
|
+
* @public
|
|
53
|
+
*/
|
|
54
|
+
NextToken?: string | undefined;
|
|
55
|
+
/**
|
|
56
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
57
|
+
* @public
|
|
58
|
+
*/
|
|
59
|
+
MaxResults?: number | undefined;
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* @public
|
|
63
|
+
*/
|
|
64
|
+
export interface ListIAMPolicyAssignmentsResponse {
|
|
65
|
+
/**
|
|
66
|
+
* <p>Information describing the IAM policy assignments.</p>
|
|
67
|
+
* @public
|
|
68
|
+
*/
|
|
69
|
+
IAMPolicyAssignments?: IAMPolicyAssignmentSummary[] | undefined;
|
|
70
|
+
/**
|
|
71
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
72
|
+
* @public
|
|
73
|
+
*/
|
|
74
|
+
NextToken?: string | undefined;
|
|
75
|
+
/**
|
|
76
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
77
|
+
* @public
|
|
78
|
+
*/
|
|
79
|
+
RequestId?: string | undefined;
|
|
80
|
+
/**
|
|
81
|
+
* <p>The HTTP status of the request.</p>
|
|
82
|
+
* @public
|
|
83
|
+
*/
|
|
84
|
+
Status?: number | undefined;
|
|
85
|
+
}
|
|
86
|
+
/**
|
|
87
|
+
* @public
|
|
88
|
+
*/
|
|
89
|
+
export interface ListIAMPolicyAssignmentsForUserRequest {
|
|
90
|
+
/**
|
|
91
|
+
* <p>The ID of the Amazon Web Services account that contains the assignments.</p>
|
|
92
|
+
* @public
|
|
93
|
+
*/
|
|
94
|
+
AwsAccountId: string | undefined;
|
|
95
|
+
/**
|
|
96
|
+
* <p>The name of the user.</p>
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
UserName: string | undefined;
|
|
100
|
+
/**
|
|
101
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
102
|
+
* @public
|
|
103
|
+
*/
|
|
104
|
+
NextToken?: string | undefined;
|
|
105
|
+
/**
|
|
106
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
107
|
+
* @public
|
|
108
|
+
*/
|
|
109
|
+
MaxResults?: number | undefined;
|
|
110
|
+
/**
|
|
111
|
+
* <p>The namespace of the assignment.</p>
|
|
112
|
+
* @public
|
|
113
|
+
*/
|
|
114
|
+
Namespace: string | undefined;
|
|
115
|
+
}
|
|
116
|
+
/**
|
|
117
|
+
* @public
|
|
118
|
+
*/
|
|
119
|
+
export interface ListIAMPolicyAssignmentsForUserResponse {
|
|
120
|
+
/**
|
|
121
|
+
* <p>The active assignments for this user.</p>
|
|
122
|
+
* @public
|
|
123
|
+
*/
|
|
124
|
+
ActiveAssignments?: ActiveIAMPolicyAssignment[] | undefined;
|
|
125
|
+
/**
|
|
126
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
127
|
+
* @public
|
|
128
|
+
*/
|
|
129
|
+
RequestId?: string | undefined;
|
|
130
|
+
/**
|
|
131
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
132
|
+
* @public
|
|
133
|
+
*/
|
|
134
|
+
NextToken?: string | undefined;
|
|
135
|
+
/**
|
|
136
|
+
* <p>The HTTP status of the request.</p>
|
|
137
|
+
* @public
|
|
138
|
+
*/
|
|
139
|
+
Status?: number | undefined;
|
|
140
|
+
}
|
|
141
|
+
/**
|
|
142
|
+
* @public
|
|
143
|
+
*/
|
|
144
|
+
export interface ListIdentityPropagationConfigsRequest {
|
|
145
|
+
/**
|
|
146
|
+
* <p>The ID of the Amazon Web Services account that contain the identity propagation configurations of.</p>
|
|
147
|
+
* @public
|
|
148
|
+
*/
|
|
149
|
+
AwsAccountId: string | undefined;
|
|
150
|
+
/**
|
|
151
|
+
* <p>The maximum number of results to be returned.</p>
|
|
152
|
+
* @public
|
|
153
|
+
*/
|
|
154
|
+
MaxResults?: number | undefined;
|
|
155
|
+
/**
|
|
156
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
157
|
+
* @public
|
|
158
|
+
*/
|
|
159
|
+
NextToken?: string | undefined;
|
|
160
|
+
}
|
|
161
|
+
/**
|
|
162
|
+
* @public
|
|
163
|
+
*/
|
|
164
|
+
export interface ListIdentityPropagationConfigsResponse {
|
|
165
|
+
/**
|
|
166
|
+
* <p>A list of services and their authorized targets that the Quick Sight IAM Identity Center application can access.</p>
|
|
167
|
+
* @public
|
|
168
|
+
*/
|
|
169
|
+
Services?: AuthorizedTargetsByService[] | undefined;
|
|
170
|
+
/**
|
|
171
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
172
|
+
* @public
|
|
173
|
+
*/
|
|
174
|
+
NextToken?: string | undefined;
|
|
175
|
+
/**
|
|
176
|
+
* <p>The HTTP status of the request.</p>
|
|
177
|
+
* @public
|
|
178
|
+
*/
|
|
179
|
+
Status?: number | undefined;
|
|
180
|
+
/**
|
|
181
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
182
|
+
* @public
|
|
183
|
+
*/
|
|
184
|
+
RequestId?: string | undefined;
|
|
185
|
+
}
|
|
186
|
+
/**
|
|
187
|
+
* @public
|
|
188
|
+
*/
|
|
189
|
+
export interface ListIngestionsRequest {
|
|
190
|
+
/**
|
|
191
|
+
* <p>The ID of the dataset used in the ingestion.</p>
|
|
192
|
+
* @public
|
|
193
|
+
*/
|
|
194
|
+
DataSetId: string | undefined;
|
|
195
|
+
/**
|
|
196
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
197
|
+
* @public
|
|
198
|
+
*/
|
|
199
|
+
NextToken?: string | undefined;
|
|
200
|
+
/**
|
|
201
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
202
|
+
* @public
|
|
203
|
+
*/
|
|
204
|
+
AwsAccountId: string | undefined;
|
|
205
|
+
/**
|
|
206
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
207
|
+
* @public
|
|
208
|
+
*/
|
|
209
|
+
MaxResults?: number | undefined;
|
|
210
|
+
}
|
|
211
|
+
/**
|
|
212
|
+
* @public
|
|
213
|
+
*/
|
|
214
|
+
export interface ListIngestionsResponse {
|
|
215
|
+
/**
|
|
216
|
+
* <p>A list of the ingestions.</p>
|
|
217
|
+
* @public
|
|
218
|
+
*/
|
|
219
|
+
Ingestions?: Ingestion[] | undefined;
|
|
220
|
+
/**
|
|
221
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
222
|
+
* @public
|
|
223
|
+
*/
|
|
224
|
+
NextToken?: string | undefined;
|
|
225
|
+
/**
|
|
226
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
227
|
+
* @public
|
|
228
|
+
*/
|
|
229
|
+
RequestId?: string | undefined;
|
|
230
|
+
/**
|
|
231
|
+
* <p>The HTTP status of the request.</p>
|
|
232
|
+
* @public
|
|
233
|
+
*/
|
|
234
|
+
Status?: number | undefined;
|
|
235
|
+
}
|
|
236
|
+
/**
|
|
237
|
+
* @public
|
|
238
|
+
*/
|
|
239
|
+
export interface ListNamespacesRequest {
|
|
240
|
+
/**
|
|
241
|
+
* <p>The ID for the Amazon Web Services account that contains the Quick Sight namespaces that you want to list.</p>
|
|
242
|
+
* @public
|
|
243
|
+
*/
|
|
244
|
+
AwsAccountId: string | undefined;
|
|
245
|
+
/**
|
|
246
|
+
* <p>A unique pagination token that can be used in a subsequent request. You will receive a pagination token in the response body of a previous <code>ListNameSpaces</code> API call if there is more data that can be returned. To receive the data, make another <code>ListNamespaces</code> API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a <code>ListNamespaces</code> API call with an expired token, you will receive a <code>HTTP 400 InvalidNextTokenException</code> error.</p>
|
|
247
|
+
* @public
|
|
248
|
+
*/
|
|
249
|
+
NextToken?: string | undefined;
|
|
250
|
+
/**
|
|
251
|
+
* <p>The maximum number of results to return.</p>
|
|
252
|
+
* @public
|
|
253
|
+
*/
|
|
254
|
+
MaxResults?: number | undefined;
|
|
255
|
+
}
|
|
256
|
+
/**
|
|
257
|
+
* @public
|
|
258
|
+
*/
|
|
259
|
+
export interface ListNamespacesResponse {
|
|
260
|
+
/**
|
|
261
|
+
* <p>The information about the namespaces in this Amazon Web Services account. The response includes
|
|
262
|
+
* the namespace ARN, name, Amazon Web Services Region, notification email address, creation status, and
|
|
263
|
+
* identity store.</p>
|
|
264
|
+
* @public
|
|
265
|
+
*/
|
|
266
|
+
Namespaces?: NamespaceInfoV2[] | undefined;
|
|
267
|
+
/**
|
|
268
|
+
* <p>A unique pagination token that can be used in a subsequent request. Receiving <code>NextToken</code> in your response inticates that there is more data that can be returned. To receive the data, make another <code>ListNamespaces</code> API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a <code>ListNamespaces</code> API call with an expired token, you will receive a <code>HTTP 400 InvalidNextTokenException</code> error.</p>
|
|
269
|
+
* @public
|
|
270
|
+
*/
|
|
271
|
+
NextToken?: string | undefined;
|
|
272
|
+
/**
|
|
273
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
274
|
+
* @public
|
|
275
|
+
*/
|
|
276
|
+
RequestId?: string | undefined;
|
|
277
|
+
/**
|
|
278
|
+
* <p>The HTTP status of the request.</p>
|
|
279
|
+
* @public
|
|
280
|
+
*/
|
|
281
|
+
Status?: number | undefined;
|
|
282
|
+
}
|
|
283
|
+
/**
|
|
284
|
+
* @public
|
|
285
|
+
*/
|
|
286
|
+
export interface ListRefreshSchedulesRequest {
|
|
287
|
+
/**
|
|
288
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
289
|
+
* @public
|
|
290
|
+
*/
|
|
291
|
+
AwsAccountId: string | undefined;
|
|
292
|
+
/**
|
|
293
|
+
* <p>The ID of the dataset.</p>
|
|
294
|
+
* @public
|
|
295
|
+
*/
|
|
296
|
+
DataSetId: string | undefined;
|
|
297
|
+
}
|
|
298
|
+
/**
|
|
299
|
+
* @public
|
|
300
|
+
*/
|
|
301
|
+
export interface ListRefreshSchedulesResponse {
|
|
302
|
+
/**
|
|
303
|
+
* <p>The list of refresh schedules for the dataset.</p>
|
|
304
|
+
* @public
|
|
305
|
+
*/
|
|
306
|
+
RefreshSchedules?: RefreshSchedule[] | undefined;
|
|
307
|
+
/**
|
|
308
|
+
* <p>The HTTP status of the request.</p>
|
|
309
|
+
* @public
|
|
310
|
+
*/
|
|
311
|
+
Status?: number | undefined;
|
|
312
|
+
/**
|
|
313
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
314
|
+
* @public
|
|
315
|
+
*/
|
|
316
|
+
RequestId?: string | undefined;
|
|
317
|
+
}
|
|
318
|
+
/**
|
|
319
|
+
* @public
|
|
320
|
+
*/
|
|
321
|
+
export interface ListRoleMembershipsRequest {
|
|
322
|
+
/**
|
|
323
|
+
* <p>The name of the role.</p>
|
|
324
|
+
* @public
|
|
325
|
+
*/
|
|
326
|
+
Role: Role | undefined;
|
|
327
|
+
/**
|
|
328
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
329
|
+
* @public
|
|
330
|
+
*/
|
|
331
|
+
NextToken?: string | undefined;
|
|
332
|
+
/**
|
|
333
|
+
* <p>The maximum number of results to return.</p>
|
|
334
|
+
* @public
|
|
335
|
+
*/
|
|
336
|
+
MaxResults?: number | undefined;
|
|
337
|
+
/**
|
|
338
|
+
* <p>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.</p>
|
|
339
|
+
* @public
|
|
340
|
+
*/
|
|
341
|
+
AwsAccountId: string | undefined;
|
|
342
|
+
/**
|
|
343
|
+
* <p>The namespace that includes the role.</p>
|
|
344
|
+
* @public
|
|
345
|
+
*/
|
|
346
|
+
Namespace: string | undefined;
|
|
347
|
+
}
|
|
348
|
+
/**
|
|
349
|
+
* @public
|
|
350
|
+
*/
|
|
351
|
+
export interface ListRoleMembershipsResponse {
|
|
352
|
+
/**
|
|
353
|
+
* <p>The list of groups associated with a role</p>
|
|
354
|
+
* @public
|
|
355
|
+
*/
|
|
356
|
+
MembersList?: string[] | undefined;
|
|
357
|
+
/**
|
|
358
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
359
|
+
* @public
|
|
360
|
+
*/
|
|
361
|
+
NextToken?: string | undefined;
|
|
362
|
+
/**
|
|
363
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
364
|
+
* @public
|
|
365
|
+
*/
|
|
366
|
+
RequestId?: string | undefined;
|
|
367
|
+
/**
|
|
368
|
+
* <p>The HTTP status of the request.</p>
|
|
369
|
+
* @public
|
|
370
|
+
*/
|
|
371
|
+
Status?: number | undefined;
|
|
372
|
+
}
|
|
373
|
+
/**
|
|
374
|
+
* @public
|
|
375
|
+
*/
|
|
376
|
+
export interface ListTagsForResourceRequest {
|
|
377
|
+
/**
|
|
378
|
+
* <p>The Amazon Resource Name (ARN) of the resource that you want a list of tags
|
|
379
|
+
* for.</p>
|
|
380
|
+
* @public
|
|
381
|
+
*/
|
|
382
|
+
ResourceArn: string | undefined;
|
|
383
|
+
}
|
|
384
|
+
/**
|
|
385
|
+
* @public
|
|
386
|
+
*/
|
|
387
|
+
export interface ListTagsForResourceResponse {
|
|
388
|
+
/**
|
|
389
|
+
* <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the
|
|
390
|
+
* resource.</p>
|
|
391
|
+
* @public
|
|
392
|
+
*/
|
|
393
|
+
Tags?: Tag[] | undefined;
|
|
394
|
+
/**
|
|
395
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
396
|
+
* @public
|
|
397
|
+
*/
|
|
398
|
+
RequestId?: string | undefined;
|
|
399
|
+
/**
|
|
400
|
+
* <p>The HTTP status of the request.</p>
|
|
401
|
+
* @public
|
|
402
|
+
*/
|
|
403
|
+
Status?: number | undefined;
|
|
404
|
+
}
|
|
405
|
+
/**
|
|
406
|
+
* @public
|
|
407
|
+
*/
|
|
408
|
+
export interface ListTemplateAliasesRequest {
|
|
409
|
+
/**
|
|
410
|
+
* <p>The ID of the Amazon Web Services account that contains the template aliases that you're listing.</p>
|
|
411
|
+
* @public
|
|
412
|
+
*/
|
|
413
|
+
AwsAccountId: string | undefined;
|
|
414
|
+
/**
|
|
415
|
+
* <p>The ID for the template.</p>
|
|
416
|
+
* @public
|
|
417
|
+
*/
|
|
418
|
+
TemplateId: string | undefined;
|
|
419
|
+
/**
|
|
420
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
421
|
+
* @public
|
|
422
|
+
*/
|
|
423
|
+
NextToken?: string | undefined;
|
|
424
|
+
/**
|
|
425
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
426
|
+
* @public
|
|
427
|
+
*/
|
|
428
|
+
MaxResults?: number | undefined;
|
|
429
|
+
}
|
|
430
|
+
/**
|
|
431
|
+
* @public
|
|
432
|
+
*/
|
|
433
|
+
export interface ListTemplateAliasesResponse {
|
|
434
|
+
/**
|
|
435
|
+
* <p>A structure containing the list of the template's aliases.</p>
|
|
436
|
+
* @public
|
|
437
|
+
*/
|
|
438
|
+
TemplateAliasList?: TemplateAlias[] | undefined;
|
|
439
|
+
/**
|
|
440
|
+
* <p>The HTTP status of the request.</p>
|
|
441
|
+
* @public
|
|
442
|
+
*/
|
|
443
|
+
Status?: number | undefined;
|
|
444
|
+
/**
|
|
445
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
446
|
+
* @public
|
|
447
|
+
*/
|
|
448
|
+
RequestId?: string | undefined;
|
|
449
|
+
/**
|
|
450
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
451
|
+
* @public
|
|
452
|
+
*/
|
|
453
|
+
NextToken?: string | undefined;
|
|
454
|
+
}
|
|
455
|
+
/**
|
|
456
|
+
* @public
|
|
457
|
+
*/
|
|
458
|
+
export interface ListTemplatesRequest {
|
|
459
|
+
/**
|
|
460
|
+
* <p>The ID of the Amazon Web Services account that contains the templates that you're listing.</p>
|
|
461
|
+
* @public
|
|
462
|
+
*/
|
|
463
|
+
AwsAccountId: string | undefined;
|
|
464
|
+
/**
|
|
465
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
466
|
+
* @public
|
|
467
|
+
*/
|
|
468
|
+
NextToken?: string | undefined;
|
|
469
|
+
/**
|
|
470
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
471
|
+
* @public
|
|
472
|
+
*/
|
|
473
|
+
MaxResults?: number | undefined;
|
|
474
|
+
}
|
|
475
|
+
/**
|
|
476
|
+
* <p>The template summary.</p>
|
|
477
|
+
* @public
|
|
478
|
+
*/
|
|
479
|
+
export interface TemplateSummary {
|
|
480
|
+
/**
|
|
481
|
+
* <p>A summary of a template.</p>
|
|
482
|
+
* @public
|
|
483
|
+
*/
|
|
484
|
+
Arn?: string | undefined;
|
|
485
|
+
/**
|
|
486
|
+
* <p>The ID of the template. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
487
|
+
* @public
|
|
488
|
+
*/
|
|
489
|
+
TemplateId?: string | undefined;
|
|
490
|
+
/**
|
|
491
|
+
* <p>A display name for the template.</p>
|
|
492
|
+
* @public
|
|
493
|
+
*/
|
|
494
|
+
Name?: string | undefined;
|
|
495
|
+
/**
|
|
496
|
+
* <p>A structure containing a list of version numbers for the template summary.</p>
|
|
497
|
+
* @public
|
|
498
|
+
*/
|
|
499
|
+
LatestVersionNumber?: number | undefined;
|
|
500
|
+
/**
|
|
501
|
+
* <p>The last time that this template was created.</p>
|
|
502
|
+
* @public
|
|
503
|
+
*/
|
|
504
|
+
CreatedTime?: Date | undefined;
|
|
505
|
+
/**
|
|
506
|
+
* <p>The last time that this template was updated.</p>
|
|
507
|
+
* @public
|
|
508
|
+
*/
|
|
509
|
+
LastUpdatedTime?: Date | undefined;
|
|
510
|
+
}
|
|
511
|
+
/**
|
|
512
|
+
* @public
|
|
513
|
+
*/
|
|
514
|
+
export interface ListTemplatesResponse {
|
|
515
|
+
/**
|
|
516
|
+
* <p>A structure containing information about the templates in the list.</p>
|
|
517
|
+
* @public
|
|
518
|
+
*/
|
|
519
|
+
TemplateSummaryList?: TemplateSummary[] | undefined;
|
|
520
|
+
/**
|
|
521
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
522
|
+
* @public
|
|
523
|
+
*/
|
|
524
|
+
NextToken?: string | undefined;
|
|
525
|
+
/**
|
|
526
|
+
* <p>The HTTP status of the request.</p>
|
|
527
|
+
* @public
|
|
528
|
+
*/
|
|
529
|
+
Status?: number | undefined;
|
|
530
|
+
/**
|
|
531
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
532
|
+
* @public
|
|
533
|
+
*/
|
|
534
|
+
RequestId?: string | undefined;
|
|
535
|
+
}
|
|
536
|
+
/**
|
|
537
|
+
* @public
|
|
538
|
+
*/
|
|
539
|
+
export interface ListTemplateVersionsRequest {
|
|
540
|
+
/**
|
|
541
|
+
* <p>The ID of the Amazon Web Services account that contains the templates that you're listing.</p>
|
|
542
|
+
* @public
|
|
543
|
+
*/
|
|
544
|
+
AwsAccountId: string | undefined;
|
|
545
|
+
/**
|
|
546
|
+
* <p>The ID for the template.</p>
|
|
547
|
+
* @public
|
|
548
|
+
*/
|
|
549
|
+
TemplateId: string | undefined;
|
|
550
|
+
/**
|
|
551
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
552
|
+
* @public
|
|
553
|
+
*/
|
|
554
|
+
NextToken?: string | undefined;
|
|
555
|
+
/**
|
|
556
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
557
|
+
* @public
|
|
558
|
+
*/
|
|
559
|
+
MaxResults?: number | undefined;
|
|
560
|
+
}
|
|
561
|
+
/**
|
|
562
|
+
* <p>The template version.</p>
|
|
563
|
+
* @public
|
|
564
|
+
*/
|
|
565
|
+
export interface TemplateVersionSummary {
|
|
566
|
+
/**
|
|
567
|
+
* <p>The Amazon Resource Name (ARN) of the template version.</p>
|
|
568
|
+
* @public
|
|
569
|
+
*/
|
|
570
|
+
Arn?: string | undefined;
|
|
571
|
+
/**
|
|
572
|
+
* <p>The version number of the template version.</p>
|
|
573
|
+
* @public
|
|
574
|
+
*/
|
|
575
|
+
VersionNumber?: number | undefined;
|
|
576
|
+
/**
|
|
577
|
+
* <p>The time that this template version was created.</p>
|
|
578
|
+
* @public
|
|
579
|
+
*/
|
|
580
|
+
CreatedTime?: Date | undefined;
|
|
581
|
+
/**
|
|
582
|
+
* <p>The status of the template version.</p>
|
|
583
|
+
* @public
|
|
584
|
+
*/
|
|
585
|
+
Status?: ResourceStatus | undefined;
|
|
586
|
+
/**
|
|
587
|
+
* <p>The description of the template version.</p>
|
|
588
|
+
* @public
|
|
589
|
+
*/
|
|
590
|
+
Description?: string | undefined;
|
|
591
|
+
}
|
|
592
|
+
/**
|
|
593
|
+
* @public
|
|
594
|
+
*/
|
|
595
|
+
export interface ListTemplateVersionsResponse {
|
|
596
|
+
/**
|
|
597
|
+
* <p>A structure containing a list of all the versions of the specified template.</p>
|
|
598
|
+
* @public
|
|
599
|
+
*/
|
|
600
|
+
TemplateVersionSummaryList?: TemplateVersionSummary[] | undefined;
|
|
601
|
+
/**
|
|
602
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
603
|
+
* @public
|
|
604
|
+
*/
|
|
605
|
+
NextToken?: string | undefined;
|
|
606
|
+
/**
|
|
607
|
+
* <p>The HTTP status of the request.</p>
|
|
608
|
+
* @public
|
|
609
|
+
*/
|
|
610
|
+
Status?: number | undefined;
|
|
611
|
+
/**
|
|
612
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
613
|
+
* @public
|
|
614
|
+
*/
|
|
615
|
+
RequestId?: string | undefined;
|
|
616
|
+
}
|
|
617
|
+
/**
|
|
618
|
+
* @public
|
|
619
|
+
*/
|
|
620
|
+
export interface ListThemeAliasesRequest {
|
|
621
|
+
/**
|
|
622
|
+
* <p>The ID of the Amazon Web Services account that contains the theme aliases that you're listing.</p>
|
|
623
|
+
* @public
|
|
624
|
+
*/
|
|
625
|
+
AwsAccountId: string | undefined;
|
|
626
|
+
/**
|
|
627
|
+
* <p>The ID for the theme.</p>
|
|
628
|
+
* @public
|
|
629
|
+
*/
|
|
630
|
+
ThemeId: string | undefined;
|
|
631
|
+
/**
|
|
632
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
633
|
+
* @public
|
|
634
|
+
*/
|
|
635
|
+
NextToken?: string | undefined;
|
|
636
|
+
/**
|
|
637
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
638
|
+
* @public
|
|
639
|
+
*/
|
|
640
|
+
MaxResults?: number | undefined;
|
|
641
|
+
}
|
|
642
|
+
/**
|
|
643
|
+
* @public
|
|
644
|
+
*/
|
|
645
|
+
export interface ListThemeAliasesResponse {
|
|
646
|
+
/**
|
|
647
|
+
* <p>A structure containing the list of the theme's aliases.</p>
|
|
648
|
+
* @public
|
|
649
|
+
*/
|
|
650
|
+
ThemeAliasList?: ThemeAlias[] | undefined;
|
|
651
|
+
/**
|
|
652
|
+
* <p>The HTTP status of the request.</p>
|
|
653
|
+
* @public
|
|
654
|
+
*/
|
|
655
|
+
Status?: number | undefined;
|
|
656
|
+
/**
|
|
657
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
658
|
+
* @public
|
|
659
|
+
*/
|
|
660
|
+
RequestId?: string | undefined;
|
|
661
|
+
/**
|
|
662
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
663
|
+
* @public
|
|
664
|
+
*/
|
|
665
|
+
NextToken?: string | undefined;
|
|
666
|
+
}
|
|
667
|
+
/**
|
|
668
|
+
* @public
|
|
669
|
+
*/
|
|
670
|
+
export interface ListThemesRequest {
|
|
671
|
+
/**
|
|
672
|
+
* <p>The ID of the Amazon Web Services account that contains the themes that you're listing.</p>
|
|
673
|
+
* @public
|
|
674
|
+
*/
|
|
675
|
+
AwsAccountId: string | undefined;
|
|
676
|
+
/**
|
|
677
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
678
|
+
* @public
|
|
679
|
+
*/
|
|
680
|
+
NextToken?: string | undefined;
|
|
681
|
+
/**
|
|
682
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
683
|
+
* @public
|
|
684
|
+
*/
|
|
685
|
+
MaxResults?: number | undefined;
|
|
686
|
+
/**
|
|
687
|
+
* <p>The type of themes that you want to list. Valid options include the following:</p>
|
|
688
|
+
* <ul>
|
|
689
|
+
* <li>
|
|
690
|
+
* <p>
|
|
691
|
+
* <code>ALL (default)</code>- Display all existing themes.</p>
|
|
692
|
+
* </li>
|
|
693
|
+
* <li>
|
|
694
|
+
* <p>
|
|
695
|
+
* <code>CUSTOM</code> - Display only the themes created by people using Amazon Quick Sight.</p>
|
|
696
|
+
* </li>
|
|
697
|
+
* <li>
|
|
698
|
+
* <p>
|
|
699
|
+
* <code>QUICKSIGHT</code> - Display only the starting themes defined by Quick Sight.</p>
|
|
700
|
+
* </li>
|
|
701
|
+
* </ul>
|
|
702
|
+
* @public
|
|
703
|
+
*/
|
|
704
|
+
Type?: ThemeType | undefined;
|
|
705
|
+
}
|
|
706
|
+
/**
|
|
707
|
+
* <p>The theme summary.</p>
|
|
708
|
+
* @public
|
|
709
|
+
*/
|
|
710
|
+
export interface ThemeSummary {
|
|
711
|
+
/**
|
|
712
|
+
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
713
|
+
* @public
|
|
714
|
+
*/
|
|
715
|
+
Arn?: string | undefined;
|
|
716
|
+
/**
|
|
717
|
+
* <p>the display name for the theme.</p>
|
|
718
|
+
* @public
|
|
719
|
+
*/
|
|
720
|
+
Name?: string | undefined;
|
|
721
|
+
/**
|
|
722
|
+
* <p>The ID of the theme. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
723
|
+
* @public
|
|
724
|
+
*/
|
|
725
|
+
ThemeId?: string | undefined;
|
|
726
|
+
/**
|
|
727
|
+
* <p>The latest version number for the theme. </p>
|
|
728
|
+
* @public
|
|
729
|
+
*/
|
|
730
|
+
LatestVersionNumber?: number | undefined;
|
|
731
|
+
/**
|
|
732
|
+
* <p>The date and time that this theme was created.</p>
|
|
733
|
+
* @public
|
|
734
|
+
*/
|
|
735
|
+
CreatedTime?: Date | undefined;
|
|
736
|
+
/**
|
|
737
|
+
* <p>The last date and time that this theme was updated.</p>
|
|
738
|
+
* @public
|
|
739
|
+
*/
|
|
740
|
+
LastUpdatedTime?: Date | undefined;
|
|
741
|
+
}
|
|
742
|
+
/**
|
|
743
|
+
* @public
|
|
744
|
+
*/
|
|
745
|
+
export interface ListThemesResponse {
|
|
746
|
+
/**
|
|
747
|
+
* <p>Information about the themes in the list.</p>
|
|
748
|
+
* @public
|
|
749
|
+
*/
|
|
750
|
+
ThemeSummaryList?: ThemeSummary[] | undefined;
|
|
751
|
+
/**
|
|
752
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
753
|
+
* @public
|
|
754
|
+
*/
|
|
755
|
+
NextToken?: string | undefined;
|
|
756
|
+
/**
|
|
757
|
+
* <p>The HTTP status of the request.</p>
|
|
758
|
+
* @public
|
|
759
|
+
*/
|
|
760
|
+
Status?: number | undefined;
|
|
761
|
+
/**
|
|
762
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
763
|
+
* @public
|
|
764
|
+
*/
|
|
765
|
+
RequestId?: string | undefined;
|
|
766
|
+
}
|
|
767
|
+
/**
|
|
768
|
+
* @public
|
|
769
|
+
*/
|
|
770
|
+
export interface ListThemeVersionsRequest {
|
|
771
|
+
/**
|
|
772
|
+
* <p>The ID of the Amazon Web Services account that contains the themes that you're listing.</p>
|
|
773
|
+
* @public
|
|
774
|
+
*/
|
|
775
|
+
AwsAccountId: string | undefined;
|
|
776
|
+
/**
|
|
777
|
+
* <p>The ID for the theme.</p>
|
|
778
|
+
* @public
|
|
779
|
+
*/
|
|
780
|
+
ThemeId: string | undefined;
|
|
781
|
+
/**
|
|
782
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
783
|
+
* @public
|
|
784
|
+
*/
|
|
785
|
+
NextToken?: string | undefined;
|
|
786
|
+
/**
|
|
787
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
788
|
+
* @public
|
|
789
|
+
*/
|
|
790
|
+
MaxResults?: number | undefined;
|
|
791
|
+
}
|
|
792
|
+
/**
|
|
793
|
+
* <p>The theme version.</p>
|
|
794
|
+
* @public
|
|
795
|
+
*/
|
|
796
|
+
export interface ThemeVersionSummary {
|
|
797
|
+
/**
|
|
798
|
+
* <p>The version number of the theme version.</p>
|
|
799
|
+
* @public
|
|
800
|
+
*/
|
|
801
|
+
VersionNumber?: number | undefined;
|
|
802
|
+
/**
|
|
803
|
+
* <p>The Amazon Resource Name (ARN) of the theme version.</p>
|
|
804
|
+
* @public
|
|
805
|
+
*/
|
|
806
|
+
Arn?: string | undefined;
|
|
807
|
+
/**
|
|
808
|
+
* <p>The description of the theme version.</p>
|
|
809
|
+
* @public
|
|
810
|
+
*/
|
|
811
|
+
Description?: string | undefined;
|
|
812
|
+
/**
|
|
813
|
+
* <p>The date and time that this theme version was created.</p>
|
|
814
|
+
* @public
|
|
815
|
+
*/
|
|
816
|
+
CreatedTime?: Date | undefined;
|
|
817
|
+
/**
|
|
818
|
+
* <p>The status of the theme version.</p>
|
|
819
|
+
* @public
|
|
820
|
+
*/
|
|
821
|
+
Status?: ResourceStatus | undefined;
|
|
822
|
+
}
|
|
823
|
+
/**
|
|
824
|
+
* @public
|
|
825
|
+
*/
|
|
826
|
+
export interface ListThemeVersionsResponse {
|
|
827
|
+
/**
|
|
828
|
+
* <p>A structure containing a list of all the versions of the specified theme.</p>
|
|
829
|
+
* @public
|
|
830
|
+
*/
|
|
831
|
+
ThemeVersionSummaryList?: ThemeVersionSummary[] | undefined;
|
|
832
|
+
/**
|
|
833
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
834
|
+
* @public
|
|
835
|
+
*/
|
|
836
|
+
NextToken?: string | undefined;
|
|
837
|
+
/**
|
|
838
|
+
* <p>The HTTP status of the request.</p>
|
|
839
|
+
* @public
|
|
840
|
+
*/
|
|
841
|
+
Status?: number | undefined;
|
|
842
|
+
/**
|
|
843
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
844
|
+
* @public
|
|
845
|
+
*/
|
|
846
|
+
RequestId?: string | undefined;
|
|
847
|
+
}
|
|
848
|
+
/**
|
|
849
|
+
* @public
|
|
850
|
+
*/
|
|
851
|
+
export interface ListTopicRefreshSchedulesRequest {
|
|
852
|
+
/**
|
|
853
|
+
* <p>The ID of the Amazon Web Services account that contains the topic whose refresh schedule
|
|
854
|
+
* you want described.</p>
|
|
855
|
+
* @public
|
|
856
|
+
*/
|
|
857
|
+
AwsAccountId: string | undefined;
|
|
858
|
+
/**
|
|
859
|
+
* <p>The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
860
|
+
* @public
|
|
861
|
+
*/
|
|
862
|
+
TopicId: string | undefined;
|
|
863
|
+
}
|
|
864
|
+
/**
|
|
865
|
+
* <p>A summary of the refresh schedule details for a dataset.</p>
|
|
866
|
+
* @public
|
|
867
|
+
*/
|
|
868
|
+
export interface TopicRefreshScheduleSummary {
|
|
869
|
+
/**
|
|
870
|
+
* <p>The ID of the dataset.</p>
|
|
871
|
+
* @public
|
|
872
|
+
*/
|
|
873
|
+
DatasetId?: string | undefined;
|
|
874
|
+
/**
|
|
875
|
+
* <p>The Amazon Resource Name (ARN) of the dataset.</p>
|
|
876
|
+
* @public
|
|
877
|
+
*/
|
|
878
|
+
DatasetArn?: string | undefined;
|
|
879
|
+
/**
|
|
880
|
+
* <p>The name of the dataset.</p>
|
|
881
|
+
* @public
|
|
882
|
+
*/
|
|
883
|
+
DatasetName?: string | undefined;
|
|
884
|
+
/**
|
|
885
|
+
* <p>The definition of a refresh schedule.</p>
|
|
886
|
+
* @public
|
|
887
|
+
*/
|
|
888
|
+
RefreshSchedule?: TopicRefreshSchedule | undefined;
|
|
889
|
+
}
|
|
890
|
+
/**
|
|
891
|
+
* @public
|
|
892
|
+
*/
|
|
893
|
+
export interface ListTopicRefreshSchedulesResponse {
|
|
894
|
+
/**
|
|
895
|
+
* <p>The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
896
|
+
* @public
|
|
897
|
+
*/
|
|
898
|
+
TopicId?: string | undefined;
|
|
899
|
+
/**
|
|
900
|
+
* <p>The Amazon Resource Name (ARN) of the topic.</p>
|
|
901
|
+
* @public
|
|
902
|
+
*/
|
|
903
|
+
TopicArn?: string | undefined;
|
|
904
|
+
/**
|
|
905
|
+
* <p>The list of topic refresh schedules.</p>
|
|
906
|
+
* @public
|
|
907
|
+
*/
|
|
908
|
+
RefreshSchedules?: TopicRefreshScheduleSummary[] | undefined;
|
|
909
|
+
/**
|
|
910
|
+
* <p>The HTTP status of the request.</p>
|
|
911
|
+
* @public
|
|
912
|
+
*/
|
|
913
|
+
Status?: number | undefined;
|
|
914
|
+
/**
|
|
915
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
916
|
+
* @public
|
|
917
|
+
*/
|
|
918
|
+
RequestId?: string | undefined;
|
|
919
|
+
}
|
|
920
|
+
/**
|
|
921
|
+
* @public
|
|
922
|
+
*/
|
|
923
|
+
export interface ListTopicReviewedAnswersRequest {
|
|
924
|
+
/**
|
|
925
|
+
* <p>The ID of the Amazon Web Services account that containd the reviewed answers that you want listed.</p>
|
|
926
|
+
* @public
|
|
927
|
+
*/
|
|
928
|
+
AwsAccountId: string | undefined;
|
|
929
|
+
/**
|
|
930
|
+
* <p>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.</p>
|
|
931
|
+
* @public
|
|
932
|
+
*/
|
|
933
|
+
TopicId: string | undefined;
|
|
934
|
+
}
|
|
935
|
+
/**
|
|
936
|
+
* @public
|
|
937
|
+
*/
|
|
938
|
+
export interface ListTopicsRequest {
|
|
939
|
+
/**
|
|
940
|
+
* <p>The ID of the Amazon Web Services account that contains the topics that you want to
|
|
941
|
+
* list.</p>
|
|
942
|
+
* @public
|
|
943
|
+
*/
|
|
944
|
+
AwsAccountId: string | undefined;
|
|
945
|
+
/**
|
|
946
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
947
|
+
* @public
|
|
948
|
+
*/
|
|
949
|
+
NextToken?: string | undefined;
|
|
950
|
+
/**
|
|
951
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
952
|
+
* @public
|
|
953
|
+
*/
|
|
954
|
+
MaxResults?: number | undefined;
|
|
955
|
+
}
|
|
956
|
+
/**
|
|
957
|
+
* <p>A topic summary.</p>
|
|
958
|
+
* @public
|
|
959
|
+
*/
|
|
960
|
+
export interface TopicSummary {
|
|
961
|
+
/**
|
|
962
|
+
* <p>The Amazon Resource Name (ARN) of the topic.</p>
|
|
963
|
+
* @public
|
|
964
|
+
*/
|
|
965
|
+
Arn?: string | undefined;
|
|
966
|
+
/**
|
|
967
|
+
* <p>The ID for the topic. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
968
|
+
* @public
|
|
969
|
+
*/
|
|
970
|
+
TopicId?: string | undefined;
|
|
971
|
+
/**
|
|
972
|
+
* <p>The name of the topic.</p>
|
|
973
|
+
* @public
|
|
974
|
+
*/
|
|
975
|
+
Name?: string | undefined;
|
|
976
|
+
/**
|
|
977
|
+
* <p>The user experience version of the topic.</p>
|
|
978
|
+
* @public
|
|
979
|
+
*/
|
|
980
|
+
UserExperienceVersion?: TopicUserExperienceVersion | undefined;
|
|
981
|
+
}
|
|
982
|
+
/**
|
|
983
|
+
* @public
|
|
984
|
+
*/
|
|
985
|
+
export interface ListTopicsResponse {
|
|
986
|
+
/**
|
|
987
|
+
* <p>A list of topic summaries.</p>
|
|
988
|
+
* @public
|
|
989
|
+
*/
|
|
990
|
+
TopicsSummaries?: TopicSummary[] | undefined;
|
|
991
|
+
/**
|
|
992
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
993
|
+
* @public
|
|
994
|
+
*/
|
|
995
|
+
NextToken?: string | undefined;
|
|
996
|
+
/**
|
|
997
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
998
|
+
* @public
|
|
999
|
+
*/
|
|
1000
|
+
RequestId?: string | undefined;
|
|
1001
|
+
/**
|
|
1002
|
+
* <p>The HTTP status of the request.</p>
|
|
1003
|
+
* @public
|
|
1004
|
+
*/
|
|
1005
|
+
Status?: number | undefined;
|
|
1006
|
+
}
|
|
1007
|
+
/**
|
|
1008
|
+
* @public
|
|
1009
|
+
*/
|
|
1010
|
+
export interface ListUserGroupsRequest {
|
|
1011
|
+
/**
|
|
1012
|
+
* <p>The Amazon Quick Sight user name that you want to list group memberships for.</p>
|
|
1013
|
+
* @public
|
|
1014
|
+
*/
|
|
1015
|
+
UserName: string | undefined;
|
|
1016
|
+
/**
|
|
1017
|
+
* <p>The Amazon Web Services account ID that the user is in. Currently, you use the ID for the Amazon Web Services account
|
|
1018
|
+
* that contains your Amazon Quick Sight account.</p>
|
|
1019
|
+
* @public
|
|
1020
|
+
*/
|
|
1021
|
+
AwsAccountId: string | undefined;
|
|
1022
|
+
/**
|
|
1023
|
+
* <p>The namespace. Currently, you should set this to <code>default</code>.</p>
|
|
1024
|
+
* @public
|
|
1025
|
+
*/
|
|
1026
|
+
Namespace: string | undefined;
|
|
1027
|
+
/**
|
|
1028
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
1029
|
+
* @public
|
|
1030
|
+
*/
|
|
1031
|
+
NextToken?: string | undefined;
|
|
1032
|
+
/**
|
|
1033
|
+
* <p>The maximum number of results to return from this request.</p>
|
|
1034
|
+
* @public
|
|
1035
|
+
*/
|
|
1036
|
+
MaxResults?: number | undefined;
|
|
1037
|
+
}
|
|
1038
|
+
/**
|
|
1039
|
+
* @public
|
|
1040
|
+
*/
|
|
1041
|
+
export interface ListUserGroupsResponse {
|
|
1042
|
+
/**
|
|
1043
|
+
* <p>The list of groups the user is a member of.</p>
|
|
1044
|
+
* @public
|
|
1045
|
+
*/
|
|
1046
|
+
GroupList?: Group[] | undefined;
|
|
1047
|
+
/**
|
|
1048
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
1049
|
+
* @public
|
|
1050
|
+
*/
|
|
1051
|
+
NextToken?: string | undefined;
|
|
1052
|
+
/**
|
|
1053
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1054
|
+
* @public
|
|
1055
|
+
*/
|
|
1056
|
+
RequestId?: string | undefined;
|
|
1057
|
+
/**
|
|
1058
|
+
* <p>The HTTP status of the request.</p>
|
|
1059
|
+
* @public
|
|
1060
|
+
*/
|
|
1061
|
+
Status?: number | undefined;
|
|
1062
|
+
}
|
|
1063
|
+
/**
|
|
1064
|
+
* @public
|
|
1065
|
+
*/
|
|
1066
|
+
export interface ListUsersRequest {
|
|
1067
|
+
/**
|
|
1068
|
+
* <p>The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the
|
|
1069
|
+
* Amazon Web Services account that contains your Amazon Quick Sight account.</p>
|
|
1070
|
+
* @public
|
|
1071
|
+
*/
|
|
1072
|
+
AwsAccountId: string | undefined;
|
|
1073
|
+
/**
|
|
1074
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
1075
|
+
* @public
|
|
1076
|
+
*/
|
|
1077
|
+
NextToken?: string | undefined;
|
|
1078
|
+
/**
|
|
1079
|
+
* <p>The maximum number of results to return from this request.</p>
|
|
1080
|
+
* @public
|
|
1081
|
+
*/
|
|
1082
|
+
MaxResults?: number | undefined;
|
|
1083
|
+
/**
|
|
1084
|
+
* <p>The namespace. Currently, you should set this to <code>default</code>.</p>
|
|
1085
|
+
* @public
|
|
1086
|
+
*/
|
|
1087
|
+
Namespace: string | undefined;
|
|
1088
|
+
}
|
|
1089
|
+
/**
|
|
1090
|
+
* @public
|
|
1091
|
+
*/
|
|
1092
|
+
export interface ListUsersResponse {
|
|
1093
|
+
/**
|
|
1094
|
+
* <p>The list of users.</p>
|
|
1095
|
+
* @public
|
|
1096
|
+
*/
|
|
1097
|
+
UserList?: User[] | undefined;
|
|
1098
|
+
/**
|
|
1099
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
1100
|
+
* @public
|
|
1101
|
+
*/
|
|
1102
|
+
NextToken?: string | undefined;
|
|
1103
|
+
/**
|
|
1104
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1105
|
+
* @public
|
|
1106
|
+
*/
|
|
1107
|
+
RequestId?: string | undefined;
|
|
1108
|
+
/**
|
|
1109
|
+
* <p>The HTTP status of the request.</p>
|
|
1110
|
+
* @public
|
|
1111
|
+
*/
|
|
1112
|
+
Status?: number | undefined;
|
|
1113
|
+
}
|
|
1114
|
+
/**
|
|
1115
|
+
* @public
|
|
1116
|
+
*/
|
|
1117
|
+
export interface ListVPCConnectionsRequest {
|
|
1118
|
+
/**
|
|
1119
|
+
* <p>The Amazon Web Services account ID of the account that contains the VPC connections
|
|
1120
|
+
* that you want to list.</p>
|
|
1121
|
+
* @public
|
|
1122
|
+
*/
|
|
1123
|
+
AwsAccountId: string | undefined;
|
|
1124
|
+
/**
|
|
1125
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1126
|
+
* @public
|
|
1127
|
+
*/
|
|
1128
|
+
NextToken?: string | undefined;
|
|
1129
|
+
/**
|
|
1130
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
1131
|
+
* @public
|
|
1132
|
+
*/
|
|
1133
|
+
MaxResults?: number | undefined;
|
|
1134
|
+
}
|
|
1135
|
+
/**
|
|
1136
|
+
* <p>The summary metadata that describes a VPC connection.</p>
|
|
1137
|
+
* @public
|
|
1138
|
+
*/
|
|
1139
|
+
export interface VPCConnectionSummary {
|
|
1140
|
+
/**
|
|
1141
|
+
* <p>The ID of the VPC connection that
|
|
1142
|
+
* you're
|
|
1143
|
+
* creating. This ID is a unique identifier for each Amazon Web Services Region in an
|
|
1144
|
+
* Amazon Web Services account.</p>
|
|
1145
|
+
* @public
|
|
1146
|
+
*/
|
|
1147
|
+
VPCConnectionId?: string | undefined;
|
|
1148
|
+
/**
|
|
1149
|
+
* <p>The Amazon Resource Name (ARN) of the VPC connection.</p>
|
|
1150
|
+
* @public
|
|
1151
|
+
*/
|
|
1152
|
+
Arn?: string | undefined;
|
|
1153
|
+
/**
|
|
1154
|
+
* <p>The display name for the VPC connection.</p>
|
|
1155
|
+
* @public
|
|
1156
|
+
*/
|
|
1157
|
+
Name?: string | undefined;
|
|
1158
|
+
/**
|
|
1159
|
+
* <p>The Amazon EC2 VPC ID associated with the VPC connection.</p>
|
|
1160
|
+
* @public
|
|
1161
|
+
*/
|
|
1162
|
+
VPCId?: string | undefined;
|
|
1163
|
+
/**
|
|
1164
|
+
* <p>The Amazon EC2 security group IDs associated with the VPC connection.</p>
|
|
1165
|
+
* @public
|
|
1166
|
+
*/
|
|
1167
|
+
SecurityGroupIds?: string[] | undefined;
|
|
1168
|
+
/**
|
|
1169
|
+
* <p>A list of IP addresses of DNS resolver endpoints for the VPC connection.</p>
|
|
1170
|
+
* @public
|
|
1171
|
+
*/
|
|
1172
|
+
DnsResolvers?: string[] | undefined;
|
|
1173
|
+
/**
|
|
1174
|
+
* <p>The status of the VPC connection.</p>
|
|
1175
|
+
* @public
|
|
1176
|
+
*/
|
|
1177
|
+
Status?: VPCConnectionResourceStatus | undefined;
|
|
1178
|
+
/**
|
|
1179
|
+
* <p>The availability status of the VPC connection.</p>
|
|
1180
|
+
* @public
|
|
1181
|
+
*/
|
|
1182
|
+
AvailabilityStatus?: VPCConnectionAvailabilityStatus | undefined;
|
|
1183
|
+
/**
|
|
1184
|
+
* <p>A list of network interfaces.</p>
|
|
1185
|
+
* @public
|
|
1186
|
+
*/
|
|
1187
|
+
NetworkInterfaces?: NetworkInterface[] | undefined;
|
|
1188
|
+
/**
|
|
1189
|
+
* <p>The ARN of the IAM role associated
|
|
1190
|
+
* with the VPC connection.</p>
|
|
1191
|
+
* @public
|
|
1192
|
+
*/
|
|
1193
|
+
RoleArn?: string | undefined;
|
|
1194
|
+
/**
|
|
1195
|
+
* <p>The time that the VPC connection was created.</p>
|
|
1196
|
+
* @public
|
|
1197
|
+
*/
|
|
1198
|
+
CreatedTime?: Date | undefined;
|
|
1199
|
+
/**
|
|
1200
|
+
* <p>The time that the VPC connection was last updated.</p>
|
|
1201
|
+
* @public
|
|
1202
|
+
*/
|
|
1203
|
+
LastUpdatedTime?: Date | undefined;
|
|
1204
|
+
}
|
|
1205
|
+
/**
|
|
1206
|
+
* @public
|
|
1207
|
+
*/
|
|
1208
|
+
export interface ListVPCConnectionsResponse {
|
|
1209
|
+
/**
|
|
1210
|
+
* <p>A <code>VPCConnectionSummaries</code> object that returns a summary of VPC connection
|
|
1211
|
+
* objects.</p>
|
|
1212
|
+
* @public
|
|
1213
|
+
*/
|
|
1214
|
+
VPCConnectionSummaries?: VPCConnectionSummary[] | undefined;
|
|
1215
|
+
/**
|
|
1216
|
+
* <p>The token for the next set of results, or null if there are no more
|
|
1217
|
+
* results.</p>
|
|
1218
|
+
* @public
|
|
1219
|
+
*/
|
|
1220
|
+
NextToken?: string | undefined;
|
|
1221
|
+
/**
|
|
1222
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1223
|
+
* @public
|
|
1224
|
+
*/
|
|
1225
|
+
RequestId?: string | undefined;
|
|
1226
|
+
/**
|
|
1227
|
+
* <p>The HTTP status of the request.</p>
|
|
1228
|
+
* @public
|
|
1229
|
+
*/
|
|
1230
|
+
Status?: number | undefined;
|
|
1231
|
+
}
|
|
1232
|
+
/**
|
|
1233
|
+
* @public
|
|
1234
|
+
*/
|
|
1235
|
+
export interface PredictQAResultsRequest {
|
|
1236
|
+
/**
|
|
1237
|
+
* <p>The ID of the Amazon Web Services account that the user wants to execute Predict QA results in.</p>
|
|
1238
|
+
* @public
|
|
1239
|
+
*/
|
|
1240
|
+
AwsAccountId: string | undefined;
|
|
1241
|
+
/**
|
|
1242
|
+
* <p>The query text to be used to predict QA results.</p>
|
|
1243
|
+
* @public
|
|
1244
|
+
*/
|
|
1245
|
+
QueryText: string | undefined;
|
|
1246
|
+
/**
|
|
1247
|
+
* <p>Indicates whether Q indicies are included or excluded.</p>
|
|
1248
|
+
* @public
|
|
1249
|
+
*/
|
|
1250
|
+
IncludeQuickSightQIndex?: IncludeQuickSightQIndex | undefined;
|
|
1251
|
+
/**
|
|
1252
|
+
* <p>Indicates whether generated answers are included or excluded.</p>
|
|
1253
|
+
* @public
|
|
1254
|
+
*/
|
|
1255
|
+
IncludeGeneratedAnswer?: IncludeGeneratedAnswer | undefined;
|
|
1256
|
+
/**
|
|
1257
|
+
* <p>The number of maximum topics to be considered to predict QA results.</p>
|
|
1258
|
+
* @public
|
|
1259
|
+
*/
|
|
1260
|
+
MaxTopicsToConsider?: number | undefined;
|
|
1261
|
+
}
|
|
1262
|
+
/**
|
|
1263
|
+
* @public
|
|
1264
|
+
* @enum
|
|
1265
|
+
*/
|
|
1266
|
+
export declare const QAResultType: {
|
|
1267
|
+
readonly DASHBOARD_VISUAL: "DASHBOARD_VISUAL";
|
|
1268
|
+
readonly GENERATED_ANSWER: "GENERATED_ANSWER";
|
|
1269
|
+
readonly NO_ANSWER: "NO_ANSWER";
|
|
1270
|
+
};
|
|
1271
|
+
/**
|
|
1272
|
+
* @public
|
|
1273
|
+
*/
|
|
1274
|
+
export type QAResultType = (typeof QAResultType)[keyof typeof QAResultType];
|
|
1275
|
+
/**
|
|
1276
|
+
* <p>The QA result that is made from the <code>DashboardVisual</code> or <code>GeneratedAnswer</code>.</p>
|
|
1277
|
+
* @public
|
|
1278
|
+
*/
|
|
1279
|
+
export interface QAResult {
|
|
1280
|
+
/**
|
|
1281
|
+
* <p>The type of QA result.</p>
|
|
1282
|
+
* @public
|
|
1283
|
+
*/
|
|
1284
|
+
ResultType?: QAResultType | undefined;
|
|
1285
|
+
/**
|
|
1286
|
+
* <p>The representation of a dashboard visual result.</p>
|
|
1287
|
+
* @public
|
|
1288
|
+
*/
|
|
1289
|
+
DashboardVisual?: DashboardVisualResult | undefined;
|
|
1290
|
+
/**
|
|
1291
|
+
* <p>The representation of a generated answer result.</p>
|
|
1292
|
+
* @public
|
|
1293
|
+
*/
|
|
1294
|
+
GeneratedAnswer?: GeneratedAnswerResult | undefined;
|
|
1295
|
+
}
|
|
1296
|
+
/**
|
|
1297
|
+
* @public
|
|
1298
|
+
*/
|
|
1299
|
+
export interface PredictQAResultsResponse {
|
|
1300
|
+
/**
|
|
1301
|
+
* <p>The primary visual response.</p>
|
|
1302
|
+
* @public
|
|
1303
|
+
*/
|
|
1304
|
+
PrimaryResult?: QAResult | undefined;
|
|
1305
|
+
/**
|
|
1306
|
+
* <p>Additional visual responses.</p>
|
|
1307
|
+
* @public
|
|
1308
|
+
*/
|
|
1309
|
+
AdditionalResults?: QAResult[] | undefined;
|
|
1310
|
+
/**
|
|
1311
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1312
|
+
* @public
|
|
1313
|
+
*/
|
|
1314
|
+
RequestId?: string | undefined;
|
|
1315
|
+
/**
|
|
1316
|
+
* <p>The HTTP status of the request.</p>
|
|
1317
|
+
* @public
|
|
1318
|
+
*/
|
|
1319
|
+
Status?: number | undefined;
|
|
1320
|
+
}
|
|
1321
|
+
/**
|
|
1322
|
+
* @public
|
|
1323
|
+
* @enum
|
|
1324
|
+
*/
|
|
1325
|
+
export declare const PurchaseMode: {
|
|
1326
|
+
readonly AUTO_PURCHASE: "AUTO_PURCHASE";
|
|
1327
|
+
readonly MANUAL: "MANUAL";
|
|
1328
|
+
};
|
|
1329
|
+
/**
|
|
1330
|
+
* @public
|
|
1331
|
+
*/
|
|
1332
|
+
export type PurchaseMode = (typeof PurchaseMode)[keyof typeof PurchaseMode];
|
|
1333
|
+
/**
|
|
1334
|
+
* @public
|
|
1335
|
+
*/
|
|
1336
|
+
export interface PutDataSetRefreshPropertiesRequest {
|
|
1337
|
+
/**
|
|
1338
|
+
* <p>The Amazon Web Services account ID.</p>
|
|
1339
|
+
* @public
|
|
1340
|
+
*/
|
|
1341
|
+
AwsAccountId: string | undefined;
|
|
1342
|
+
/**
|
|
1343
|
+
* <p>The ID of the dataset.</p>
|
|
1344
|
+
* @public
|
|
1345
|
+
*/
|
|
1346
|
+
DataSetId: string | undefined;
|
|
1347
|
+
/**
|
|
1348
|
+
* <p>The dataset refresh properties.</p>
|
|
1349
|
+
* @public
|
|
1350
|
+
*/
|
|
1351
|
+
DataSetRefreshProperties: DataSetRefreshProperties | undefined;
|
|
1352
|
+
}
|
|
1353
|
+
/**
|
|
1354
|
+
* @public
|
|
1355
|
+
*/
|
|
1356
|
+
export interface PutDataSetRefreshPropertiesResponse {
|
|
1357
|
+
/**
|
|
1358
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1359
|
+
* @public
|
|
1360
|
+
*/
|
|
1361
|
+
RequestId?: string | undefined;
|
|
1362
|
+
/**
|
|
1363
|
+
* <p>The HTTP status of the request.</p>
|
|
1364
|
+
* @public
|
|
1365
|
+
*/
|
|
1366
|
+
Status?: number | undefined;
|
|
1367
|
+
}
|
|
1368
|
+
/**
|
|
1369
|
+
* @public
|
|
1370
|
+
*/
|
|
1371
|
+
export interface RegisterUserRequest {
|
|
1372
|
+
/**
|
|
1373
|
+
* <p>The identity type that your Quick Sight account uses to manage the identity of users.</p>
|
|
1374
|
+
* @public
|
|
1375
|
+
*/
|
|
1376
|
+
IdentityType: IdentityType | undefined;
|
|
1377
|
+
/**
|
|
1378
|
+
* <p>The email address of the user that you want to register.</p>
|
|
1379
|
+
* @public
|
|
1380
|
+
*/
|
|
1381
|
+
Email: string | undefined;
|
|
1382
|
+
/**
|
|
1383
|
+
* <p>The Amazon Quick Sight role for the user. The user role can be one of the
|
|
1384
|
+
* following:</p>
|
|
1385
|
+
* <ul>
|
|
1386
|
+
* <li>
|
|
1387
|
+
* <p>
|
|
1388
|
+
* <code>READER</code>: A user who has read-only access to dashboards.</p>
|
|
1389
|
+
* </li>
|
|
1390
|
+
* <li>
|
|
1391
|
+
* <p>
|
|
1392
|
+
* <code>AUTHOR</code>: A user who can create data sources, datasets, analyses, and
|
|
1393
|
+
* dashboards.</p>
|
|
1394
|
+
* </li>
|
|
1395
|
+
* <li>
|
|
1396
|
+
* <p>
|
|
1397
|
+
* <code>ADMIN</code>: A user who is an author, who can also manage Amazon Quick Sight
|
|
1398
|
+
* settings.</p>
|
|
1399
|
+
* </li>
|
|
1400
|
+
* <li>
|
|
1401
|
+
* <p>
|
|
1402
|
+
* <code>READER_PRO</code>: 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.</p>
|
|
1403
|
+
* </li>
|
|
1404
|
+
* <li>
|
|
1405
|
+
* <p>
|
|
1406
|
+
* <code>AUTHOR_PRO</code>: 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.</p>
|
|
1407
|
+
* </li>
|
|
1408
|
+
* <li>
|
|
1409
|
+
* <p>
|
|
1410
|
+
* <code>ADMIN_PRO</code>: Admin Pros are Author Pros who can also manage Amazon Quick Sight administrative settings. Admin Pro users are billed at Author Pro pricing.</p>
|
|
1411
|
+
* </li>
|
|
1412
|
+
* <li>
|
|
1413
|
+
* <p>
|
|
1414
|
+
* <code>RESTRICTED_READER</code>: This role isn't currently available for
|
|
1415
|
+
* use.</p>
|
|
1416
|
+
* </li>
|
|
1417
|
+
* <li>
|
|
1418
|
+
* <p>
|
|
1419
|
+
* <code>RESTRICTED_AUTHOR</code>: This role isn't currently available for
|
|
1420
|
+
* use.</p>
|
|
1421
|
+
* </li>
|
|
1422
|
+
* </ul>
|
|
1423
|
+
* @public
|
|
1424
|
+
*/
|
|
1425
|
+
UserRole: UserRole | undefined;
|
|
1426
|
+
/**
|
|
1427
|
+
* <p>The ARN of the IAM user or role that you are registering with Amazon Quick Sight. </p>
|
|
1428
|
+
* @public
|
|
1429
|
+
*/
|
|
1430
|
+
IamArn?: string | undefined;
|
|
1431
|
+
/**
|
|
1432
|
+
* <p>You need to use this parameter only when you register one or more users using an assumed
|
|
1433
|
+
* IAM role. You don't need to provide the session name for other scenarios, for example when
|
|
1434
|
+
* you are registering an IAM user or an Amazon Quick Sight user. You can register multiple
|
|
1435
|
+
* users using the same IAM role if each user has a different session name. For more
|
|
1436
|
+
* information on assuming IAM roles, see <a href="https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html">
|
|
1437
|
+
* <code>assume-role</code>
|
|
1438
|
+
* </a> in the <i>CLI Reference.</i>
|
|
1439
|
+
* </p>
|
|
1440
|
+
* @public
|
|
1441
|
+
*/
|
|
1442
|
+
SessionName?: string | undefined;
|
|
1443
|
+
/**
|
|
1444
|
+
* <p>The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the
|
|
1445
|
+
* Amazon Web Services account that contains your Amazon Quick Sight account.</p>
|
|
1446
|
+
* @public
|
|
1447
|
+
*/
|
|
1448
|
+
AwsAccountId: string | undefined;
|
|
1449
|
+
/**
|
|
1450
|
+
* <p>The namespace. Currently, you should set this to <code>default</code>.</p>
|
|
1451
|
+
* @public
|
|
1452
|
+
*/
|
|
1453
|
+
Namespace: string | undefined;
|
|
1454
|
+
/**
|
|
1455
|
+
* <p>The Amazon Quick Sight user name that you want to create for the user you are
|
|
1456
|
+
* registering.</p>
|
|
1457
|
+
* @public
|
|
1458
|
+
*/
|
|
1459
|
+
UserName?: string | undefined;
|
|
1460
|
+
/**
|
|
1461
|
+
* <p>(Enterprise edition only) The name of the custom permissions profile that you want to
|
|
1462
|
+
* assign to this user. Customized permissions allows you to control a user's access by
|
|
1463
|
+
* restricting access the following operations:</p>
|
|
1464
|
+
* <ul>
|
|
1465
|
+
* <li>
|
|
1466
|
+
* <p>Create and update data sources</p>
|
|
1467
|
+
* </li>
|
|
1468
|
+
* <li>
|
|
1469
|
+
* <p>Create and update datasets</p>
|
|
1470
|
+
* </li>
|
|
1471
|
+
* <li>
|
|
1472
|
+
* <p>Create and update email reports</p>
|
|
1473
|
+
* </li>
|
|
1474
|
+
* <li>
|
|
1475
|
+
* <p>Subscribe to email reports</p>
|
|
1476
|
+
* </li>
|
|
1477
|
+
* </ul>
|
|
1478
|
+
* <p>To add custom permissions to an existing user, use <code>
|
|
1479
|
+
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html">UpdateUser</a>
|
|
1480
|
+
* </code> instead.</p>
|
|
1481
|
+
* <p>A set of custom permissions includes any combination of these restrictions. Currently,
|
|
1482
|
+
* you need to create the profile names for custom permission sets by using the Quick Sight
|
|
1483
|
+
* console. Then, you use the <code>RegisterUser</code> API operation to assign the named set of
|
|
1484
|
+
* permissions to a Quick Sight user. </p>
|
|
1485
|
+
* <p>Quick Sight custom permissions are applied through IAM policies. Therefore, they
|
|
1486
|
+
* override the permissions typically granted by assigning Quick Sight users to one of the
|
|
1487
|
+
* default security cohorts in Quick Sight (admin, author, reader, admin pro, author pro, reader pro).</p>
|
|
1488
|
+
* <p>This feature is available only to Quick Sight Enterprise edition subscriptions.</p>
|
|
1489
|
+
* @public
|
|
1490
|
+
*/
|
|
1491
|
+
CustomPermissionsName?: string | undefined;
|
|
1492
|
+
/**
|
|
1493
|
+
* <p>The type of supported external login provider that provides identity to let a user federate into Amazon Quick Sight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.</p>
|
|
1494
|
+
* <ul>
|
|
1495
|
+
* <li>
|
|
1496
|
+
* <p>
|
|
1497
|
+
* <code>COGNITO</code>: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the <code>COGNITO</code> provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.</p>
|
|
1498
|
+
* </li>
|
|
1499
|
+
* <li>
|
|
1500
|
+
* <p>
|
|
1501
|
+
* <code>CUSTOM_OIDC</code>: Custom OpenID Connect (OIDC) provider. When choosing <code>CUSTOM_OIDC</code> type, use the <code>CustomFederationProviderUrl</code> parameter to provide the custom OIDC provider URL.</p>
|
|
1502
|
+
* </li>
|
|
1503
|
+
* </ul>
|
|
1504
|
+
* @public
|
|
1505
|
+
*/
|
|
1506
|
+
ExternalLoginFederationProviderType?: string | undefined;
|
|
1507
|
+
/**
|
|
1508
|
+
* <p>The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate
|
|
1509
|
+
* into Quick Sight with an associated Identity and Access Management(IAM) role. This parameter should
|
|
1510
|
+
* only be used when <code>ExternalLoginFederationProviderType</code> parameter is set to <code>CUSTOM_OIDC</code>.</p>
|
|
1511
|
+
* @public
|
|
1512
|
+
*/
|
|
1513
|
+
CustomFederationProviderUrl?: string | undefined;
|
|
1514
|
+
/**
|
|
1515
|
+
* <p>The identity ID for a user in the external login provider.</p>
|
|
1516
|
+
* @public
|
|
1517
|
+
*/
|
|
1518
|
+
ExternalLoginId?: string | undefined;
|
|
1519
|
+
/**
|
|
1520
|
+
* <p>The tags to associate with the user.</p>
|
|
1521
|
+
* @public
|
|
1522
|
+
*/
|
|
1523
|
+
Tags?: Tag[] | undefined;
|
|
1524
|
+
}
|
|
1525
|
+
/**
|
|
1526
|
+
* @public
|
|
1527
|
+
*/
|
|
1528
|
+
export interface RegisterUserResponse {
|
|
1529
|
+
/**
|
|
1530
|
+
* <p>The user's user name.</p>
|
|
1531
|
+
* @public
|
|
1532
|
+
*/
|
|
1533
|
+
User?: User | undefined;
|
|
1534
|
+
/**
|
|
1535
|
+
* <p>The URL the user visits to complete registration and provide a password. This is
|
|
1536
|
+
* returned only for users with an identity type of <code>QUICKSIGHT</code>.</p>
|
|
1537
|
+
* @public
|
|
1538
|
+
*/
|
|
1539
|
+
UserInvitationUrl?: string | undefined;
|
|
1540
|
+
/**
|
|
1541
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1542
|
+
* @public
|
|
1543
|
+
*/
|
|
1544
|
+
RequestId?: string | undefined;
|
|
1545
|
+
/**
|
|
1546
|
+
* <p>The HTTP status of the request.</p>
|
|
1547
|
+
* @public
|
|
1548
|
+
*/
|
|
1549
|
+
Status?: number | undefined;
|
|
1550
|
+
}
|
|
1551
|
+
/**
|
|
1552
|
+
* @public
|
|
1553
|
+
*/
|
|
1554
|
+
export interface RestoreAnalysisRequest {
|
|
1555
|
+
/**
|
|
1556
|
+
* <p>The ID of the Amazon Web Services account that contains the analysis.</p>
|
|
1557
|
+
* @public
|
|
1558
|
+
*/
|
|
1559
|
+
AwsAccountId: string | undefined;
|
|
1560
|
+
/**
|
|
1561
|
+
* <p>The ID of the analysis that you're restoring.</p>
|
|
1562
|
+
* @public
|
|
1563
|
+
*/
|
|
1564
|
+
AnalysisId: string | undefined;
|
|
1565
|
+
/**
|
|
1566
|
+
* <p>A boolean value that determines if the analysis will be restored to folders that it previously resided in. A <code>True</code> value restores analysis back to all folders that it previously resided in. A <code>False</code> value restores the analysis but does not restore the analysis back to all previously resided folders. Restoring a restricted analysis requires this parameter to be set to <code>True</code>.</p>
|
|
1567
|
+
* @public
|
|
1568
|
+
*/
|
|
1569
|
+
RestoreToFolders?: boolean | undefined;
|
|
1570
|
+
}
|
|
1571
|
+
/**
|
|
1572
|
+
* @public
|
|
1573
|
+
*/
|
|
1574
|
+
export interface RestoreAnalysisResponse {
|
|
1575
|
+
/**
|
|
1576
|
+
* <p>The HTTP status of the request.</p>
|
|
1577
|
+
* @public
|
|
1578
|
+
*/
|
|
1579
|
+
Status?: number | undefined;
|
|
1580
|
+
/**
|
|
1581
|
+
* <p>The Amazon Resource Name (ARN) of the analysis that you're restoring.</p>
|
|
1582
|
+
* @public
|
|
1583
|
+
*/
|
|
1584
|
+
Arn?: string | undefined;
|
|
1585
|
+
/**
|
|
1586
|
+
* <p>The ID of the analysis that you're restoring.
|
|
1587
|
+
* </p>
|
|
1588
|
+
* @public
|
|
1589
|
+
*/
|
|
1590
|
+
AnalysisId?: string | undefined;
|
|
1591
|
+
/**
|
|
1592
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1593
|
+
* @public
|
|
1594
|
+
*/
|
|
1595
|
+
RequestId?: string | undefined;
|
|
1596
|
+
/**
|
|
1597
|
+
* <p>A list of folder arns thatthe analysis failed to be restored to.</p>
|
|
1598
|
+
* @public
|
|
1599
|
+
*/
|
|
1600
|
+
RestorationFailedFolderArns?: string[] | undefined;
|
|
1601
|
+
}
|
|
1602
|
+
/**
|
|
1603
|
+
* @public
|
|
1604
|
+
*/
|
|
1605
|
+
export interface SearchActionConnectorsRequest {
|
|
1606
|
+
/**
|
|
1607
|
+
* <p>The Amazon Web Services account ID in which to search for action connectors.</p>
|
|
1608
|
+
* @public
|
|
1609
|
+
*/
|
|
1610
|
+
AwsAccountId: string | undefined;
|
|
1611
|
+
/**
|
|
1612
|
+
* <p>The maximum number of action connectors to return in a single response. Valid range is 1 to 100.</p>
|
|
1613
|
+
* @public
|
|
1614
|
+
*/
|
|
1615
|
+
MaxResults?: number | undefined;
|
|
1616
|
+
/**
|
|
1617
|
+
* <p>A pagination token to retrieve the next set of results. Use the token returned from a previous call to continue searching.</p>
|
|
1618
|
+
* @public
|
|
1619
|
+
*/
|
|
1620
|
+
NextToken?: string | undefined;
|
|
1621
|
+
/**
|
|
1622
|
+
* <p>The search filters to apply. You can filter by connector name, type, or user permissions. Maximum of one filter is supported.</p>
|
|
1623
|
+
* @public
|
|
1624
|
+
*/
|
|
1625
|
+
Filters: ActionConnectorSearchFilter[] | undefined;
|
|
1626
|
+
}
|
|
1627
|
+
/**
|
|
1628
|
+
* @public
|
|
1629
|
+
*/
|
|
1630
|
+
export interface SearchActionConnectorsResponse {
|
|
1631
|
+
/**
|
|
1632
|
+
* <p>A pagination token to retrieve the next set of results. If null, there are no more results to retrieve.</p>
|
|
1633
|
+
* @public
|
|
1634
|
+
*/
|
|
1635
|
+
NextToken?: string | undefined;
|
|
1636
|
+
/**
|
|
1637
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1638
|
+
* @public
|
|
1639
|
+
*/
|
|
1640
|
+
RequestId?: string | undefined;
|
|
1641
|
+
/**
|
|
1642
|
+
* <p>The HTTP status code of the request.</p>
|
|
1643
|
+
* @public
|
|
1644
|
+
*/
|
|
1645
|
+
Status?: number | undefined;
|
|
1646
|
+
/**
|
|
1647
|
+
* <p>A list of action connector summaries that match the search criteria.</p>
|
|
1648
|
+
* @public
|
|
1649
|
+
*/
|
|
1650
|
+
ActionConnectorSummaries?: ActionConnectorSummary[] | undefined;
|
|
1651
|
+
}
|
|
1652
|
+
/**
|
|
1653
|
+
* @public
|
|
1654
|
+
*/
|
|
1655
|
+
export interface SearchAnalysesRequest {
|
|
1656
|
+
/**
|
|
1657
|
+
* <p>The ID of the Amazon Web Services account that contains the analyses that you're searching
|
|
1658
|
+
* for.</p>
|
|
1659
|
+
* @public
|
|
1660
|
+
*/
|
|
1661
|
+
AwsAccountId: string | undefined;
|
|
1662
|
+
/**
|
|
1663
|
+
* <p>The structure for the search filters that you want to apply to your search. </p>
|
|
1664
|
+
* @public
|
|
1665
|
+
*/
|
|
1666
|
+
Filters: AnalysisSearchFilter[] | undefined;
|
|
1667
|
+
/**
|
|
1668
|
+
* <p>A pagination token that can be used in a subsequent request.</p>
|
|
1669
|
+
* @public
|
|
1670
|
+
*/
|
|
1671
|
+
NextToken?: string | undefined;
|
|
1672
|
+
/**
|
|
1673
|
+
* <p>The maximum number of results to return.</p>
|
|
1674
|
+
* @public
|
|
1675
|
+
*/
|
|
1676
|
+
MaxResults?: number | undefined;
|
|
1677
|
+
}
|
|
1678
|
+
/**
|
|
1679
|
+
* @public
|
|
1680
|
+
*/
|
|
1681
|
+
export interface SearchAnalysesResponse {
|
|
1682
|
+
/**
|
|
1683
|
+
* <p>Metadata describing the analyses that you searched for.</p>
|
|
1684
|
+
* @public
|
|
1685
|
+
*/
|
|
1686
|
+
AnalysisSummaryList?: AnalysisSummary[] | undefined;
|
|
1687
|
+
/**
|
|
1688
|
+
* <p>A pagination token that can be used in a subsequent request.
|
|
1689
|
+
* </p>
|
|
1690
|
+
* @public
|
|
1691
|
+
*/
|
|
1692
|
+
NextToken?: string | undefined;
|
|
1693
|
+
/**
|
|
1694
|
+
* <p>The HTTP status of the request.</p>
|
|
1695
|
+
* @public
|
|
1696
|
+
*/
|
|
1697
|
+
Status?: number | undefined;
|
|
1698
|
+
/**
|
|
1699
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1700
|
+
* @public
|
|
1701
|
+
*/
|
|
1702
|
+
RequestId?: string | undefined;
|
|
1703
|
+
}
|
|
1704
|
+
/**
|
|
1705
|
+
* @public
|
|
1706
|
+
*/
|
|
1707
|
+
export interface SearchDashboardsRequest {
|
|
1708
|
+
/**
|
|
1709
|
+
* <p>The ID of the Amazon Web Services account that contains the user whose dashboards
|
|
1710
|
+
* you're searching for. </p>
|
|
1711
|
+
* @public
|
|
1712
|
+
*/
|
|
1713
|
+
AwsAccountId: string | undefined;
|
|
1714
|
+
/**
|
|
1715
|
+
* <p>The filters to apply to the search. Currently, you can search only by user name, for
|
|
1716
|
+
* example, <code>"Filters": [ \{ "Name": "QUICKSIGHT_USER", "Operator": "StringEquals",
|
|
1717
|
+
* "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" \}
|
|
1718
|
+
* ]</code>
|
|
1719
|
+
* </p>
|
|
1720
|
+
* @public
|
|
1721
|
+
*/
|
|
1722
|
+
Filters: DashboardSearchFilter[] | undefined;
|
|
1723
|
+
/**
|
|
1724
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1725
|
+
* @public
|
|
1726
|
+
*/
|
|
1727
|
+
NextToken?: string | undefined;
|
|
1728
|
+
/**
|
|
1729
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
1730
|
+
* @public
|
|
1731
|
+
*/
|
|
1732
|
+
MaxResults?: number | undefined;
|
|
1733
|
+
}
|
|
1734
|
+
/**
|
|
1735
|
+
* @public
|
|
1736
|
+
*/
|
|
1737
|
+
export interface SearchDashboardsResponse {
|
|
1738
|
+
/**
|
|
1739
|
+
* <p>The list of dashboards owned by the user specified in <code>Filters</code> in your
|
|
1740
|
+
* request.</p>
|
|
1741
|
+
* @public
|
|
1742
|
+
*/
|
|
1743
|
+
DashboardSummaryList?: DashboardSummary[] | undefined;
|
|
1744
|
+
/**
|
|
1745
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1746
|
+
* @public
|
|
1747
|
+
*/
|
|
1748
|
+
NextToken?: string | undefined;
|
|
1749
|
+
/**
|
|
1750
|
+
* <p>The HTTP status of the request.</p>
|
|
1751
|
+
* @public
|
|
1752
|
+
*/
|
|
1753
|
+
Status?: number | undefined;
|
|
1754
|
+
/**
|
|
1755
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1756
|
+
* @public
|
|
1757
|
+
*/
|
|
1758
|
+
RequestId?: string | undefined;
|
|
1759
|
+
}
|
|
5
1760
|
/**
|
|
6
1761
|
* @public
|
|
7
1762
|
*/
|
|
@@ -82,7 +1837,8 @@ export interface SearchDataSourcesRequest {
|
|
|
82
1837
|
*/
|
|
83
1838
|
export interface SearchDataSourcesResponse {
|
|
84
1839
|
/**
|
|
85
|
-
* <p>A <code>DataSourceSummaries</code> object that returns a summary of a data
|
|
1840
|
+
* <p>A <code>DataSourceSummaries</code> object that returns a summary of a data
|
|
1841
|
+
* source.</p>
|
|
86
1842
|
* @public
|
|
87
1843
|
*/
|
|
88
1844
|
DataSourceSummaries?: DataSourceSummary[] | undefined;
|
|
@@ -102,6 +1858,115 @@ export interface SearchDataSourcesResponse {
|
|
|
102
1858
|
*/
|
|
103
1859
|
RequestId?: string | undefined;
|
|
104
1860
|
}
|
|
1861
|
+
/**
|
|
1862
|
+
* @public
|
|
1863
|
+
* @enum
|
|
1864
|
+
*/
|
|
1865
|
+
export declare const SearchFilterOperator: {
|
|
1866
|
+
readonly STRING_EQUALS: "StringEquals";
|
|
1867
|
+
readonly STRING_LIKE: "StringLike";
|
|
1868
|
+
};
|
|
1869
|
+
/**
|
|
1870
|
+
* @public
|
|
1871
|
+
*/
|
|
1872
|
+
export type SearchFilterOperator = (typeof SearchFilterOperator)[keyof typeof SearchFilterOperator];
|
|
1873
|
+
/**
|
|
1874
|
+
* <p>A structure that contains the filter information when searching flows.</p>
|
|
1875
|
+
* @public
|
|
1876
|
+
*/
|
|
1877
|
+
export interface SearchFlowsFilter {
|
|
1878
|
+
/**
|
|
1879
|
+
* <p>The name of the value that you want to use as a filter, for example <code>"Name":
|
|
1880
|
+
* "DIRECT_QUICKSIGHT_SOLE_OWNER"</code>.</p>
|
|
1881
|
+
* <p>Valid values are defined as follows:</p>
|
|
1882
|
+
* <ul>
|
|
1883
|
+
* <li>
|
|
1884
|
+
* <p>
|
|
1885
|
+
* <code>assetName</code>: Any flows whose names have a substring match to this value will be returned.</p>
|
|
1886
|
+
* </li>
|
|
1887
|
+
* <li>
|
|
1888
|
+
* <p>
|
|
1889
|
+
* <code>assetDescription</code>: Any flows whose descriptions have a substring match to this value will be returned.</p>
|
|
1890
|
+
* </li>
|
|
1891
|
+
* <li>
|
|
1892
|
+
* <p>
|
|
1893
|
+
* <code>DIRECT_QUICKSIGHT_SOLE_OWNER</code>: Provide an ARN of a user or group, and any analyses with that ARN listed as the only owner of the analysis are returned. Implicit permissions from folders or groups are not considered.</p>
|
|
1894
|
+
* </li>
|
|
1895
|
+
* <li>
|
|
1896
|
+
* <p>
|
|
1897
|
+
* <code>DIRECT_QUICKSIGHT_OWNER</code>: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners of the analyses are returned. Implicit permissions from folders or groups are not considered.</p>
|
|
1898
|
+
* </li>
|
|
1899
|
+
* <li>
|
|
1900
|
+
* <p>
|
|
1901
|
+
* <code>DIRECT_QUICKSIGHT_VIEWER_OR_OWNER</code>: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners or viewers of the analyses are returned. Implicit permissions from folders or groups are not considered. </p>
|
|
1902
|
+
* </li>
|
|
1903
|
+
* </ul>
|
|
1904
|
+
* @public
|
|
1905
|
+
*/
|
|
1906
|
+
Name: FieldName | undefined;
|
|
1907
|
+
/**
|
|
1908
|
+
* <p>The comparison operator that you want to use as a filter, for example <code>"Operator": "StringEquals"</code>. Valid values are <code>"StringEquals"</code> and <code>"StringLike"</code>.</p>
|
|
1909
|
+
* @public
|
|
1910
|
+
*/
|
|
1911
|
+
Operator: SearchFilterOperator | undefined;
|
|
1912
|
+
/**
|
|
1913
|
+
* <p>The value of the named item, in this case <code>DIRECT_QUICKSIGHT_SOLE_OWNER</code>, that you want
|
|
1914
|
+
* to use as a filter, for example <code>"Value"</code>. An example is
|
|
1915
|
+
* <code>"arn:aws:quicksight:us-east-1:1:user/default/UserName1"</code>.</p>
|
|
1916
|
+
* @public
|
|
1917
|
+
*/
|
|
1918
|
+
Value: string | undefined;
|
|
1919
|
+
}
|
|
1920
|
+
/**
|
|
1921
|
+
* @public
|
|
1922
|
+
*/
|
|
1923
|
+
export interface SearchFlowsInput {
|
|
1924
|
+
/**
|
|
1925
|
+
* <p>The ID of the Amazon Web Services account where you are searching for flows from.</p>
|
|
1926
|
+
* @public
|
|
1927
|
+
*/
|
|
1928
|
+
AwsAccountId: string | undefined;
|
|
1929
|
+
/**
|
|
1930
|
+
* <p>The filters applied to the search when searching for flows in the Amazon Web Services account.</p>
|
|
1931
|
+
* @public
|
|
1932
|
+
*/
|
|
1933
|
+
Filters: SearchFlowsFilter[] | undefined;
|
|
1934
|
+
/**
|
|
1935
|
+
* <p>The token to request the next set of results, or null if you want to retrieve the first set.</p>
|
|
1936
|
+
* @public
|
|
1937
|
+
*/
|
|
1938
|
+
NextToken?: string | undefined;
|
|
1939
|
+
/**
|
|
1940
|
+
* <p>The maximum number of results to be returned per request.</p>
|
|
1941
|
+
* @public
|
|
1942
|
+
*/
|
|
1943
|
+
MaxResults?: number | undefined;
|
|
1944
|
+
}
|
|
1945
|
+
/**
|
|
1946
|
+
* @public
|
|
1947
|
+
*/
|
|
1948
|
+
export interface SearchFlowsOutput {
|
|
1949
|
+
/**
|
|
1950
|
+
* <p>The list of flows found against the search.</p>
|
|
1951
|
+
* @public
|
|
1952
|
+
*/
|
|
1953
|
+
FlowSummaryList: FlowSummary[] | undefined;
|
|
1954
|
+
/**
|
|
1955
|
+
* <p>The token for the next set of results, or null if there are no more results.</p>
|
|
1956
|
+
* @public
|
|
1957
|
+
*/
|
|
1958
|
+
NextToken?: string | undefined;
|
|
1959
|
+
/**
|
|
1960
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
1961
|
+
* @public
|
|
1962
|
+
*/
|
|
1963
|
+
RequestId?: string | undefined;
|
|
1964
|
+
/**
|
|
1965
|
+
* <p>The HTTP status of the request.</p>
|
|
1966
|
+
* @public
|
|
1967
|
+
*/
|
|
1968
|
+
Status?: number | undefined;
|
|
1969
|
+
}
|
|
105
1970
|
/**
|
|
106
1971
|
* @public
|
|
107
1972
|
*/
|
|
@@ -158,7 +2023,7 @@ export interface SearchFoldersResponse {
|
|
|
158
2023
|
export interface SearchGroupsRequest {
|
|
159
2024
|
/**
|
|
160
2025
|
* <p>The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the
|
|
161
|
-
* Amazon Web Services account that contains your Amazon
|
|
2026
|
+
* Amazon Web Services account that contains your Amazon Quick Sight account.</p>
|
|
162
2027
|
* @public
|
|
163
2028
|
*/
|
|
164
2029
|
AwsAccountId: string | undefined;
|
|
@@ -318,7 +2183,8 @@ export interface StartAssetBundleExportJobRequest {
|
|
|
318
2183
|
*/
|
|
319
2184
|
AwsAccountId: string | undefined;
|
|
320
2185
|
/**
|
|
321
|
-
* <p>The ID of the job. This ID is unique while the job is running. After the job is
|
|
2186
|
+
* <p>The ID of the job. This ID is unique while the job is running. After the job is
|
|
2187
|
+
* completed, you can reuse this ID for another job.</p>
|
|
322
2188
|
* @public
|
|
323
2189
|
*/
|
|
324
2190
|
AssetBundleExportJobId: string | undefined;
|
|
@@ -361,7 +2227,8 @@ export interface StartAssetBundleExportJobRequest {
|
|
|
361
2227
|
* </p>
|
|
362
2228
|
* </li>
|
|
363
2229
|
* </ul>
|
|
364
|
-
* <p>The API caller must have the necessary permissions in their IAM role to
|
|
2230
|
+
* <p>The API caller must have the necessary permissions in their IAM role to
|
|
2231
|
+
* access each resource before the resources can be exported.</p>
|
|
365
2232
|
* @public
|
|
366
2233
|
*/
|
|
367
2234
|
ResourceArns: string[] | undefined;
|
|
@@ -369,8 +2236,8 @@ export interface StartAssetBundleExportJobRequest {
|
|
|
369
2236
|
* <p>A Boolean that determines whether all dependencies of each resource ARN are recursively
|
|
370
2237
|
* exported with the job. For example, say you provided a Dashboard ARN to the
|
|
371
2238
|
* <code>ResourceArns</code> parameter. If you set <code>IncludeAllDependencies</code> to
|
|
372
|
-
* <code>TRUE</code>, any theme, dataset, and data source resource that is a dependency of
|
|
373
|
-
* exported.</p>
|
|
2239
|
+
* <code>TRUE</code>, any theme, dataset, and data source resource that is a dependency of
|
|
2240
|
+
* the dashboard is also exported.</p>
|
|
374
2241
|
* @public
|
|
375
2242
|
*/
|
|
376
2243
|
IncludeAllDependencies?: boolean | undefined;
|
|
@@ -380,34 +2247,47 @@ export interface StartAssetBundleExportJobRequest {
|
|
|
380
2247
|
*/
|
|
381
2248
|
ExportFormat: AssetBundleExportFormat | undefined;
|
|
382
2249
|
/**
|
|
383
|
-
* <p>An optional collection of structures that generate CloudFormation parameters to
|
|
384
|
-
*
|
|
2250
|
+
* <p>An optional collection of structures that generate CloudFormation parameters to
|
|
2251
|
+
* override the existing resource property values when the resource is exported to a new
|
|
2252
|
+
* CloudFormation template.</p>
|
|
2253
|
+
* <p>Use this field if the <code>ExportFormat</code> field of a
|
|
2254
|
+
* <code>StartAssetBundleExportJobRequest</code> API call is set to
|
|
2255
|
+
* <code>CLOUDFORMATION_JSON</code>.</p>
|
|
385
2256
|
* @public
|
|
386
2257
|
*/
|
|
387
2258
|
CloudFormationOverridePropertyConfiguration?: AssetBundleCloudFormationOverridePropertyConfiguration | undefined;
|
|
388
2259
|
/**
|
|
389
|
-
* <p>A Boolean that determines whether all permissions for each resource ARN are exported
|
|
390
|
-
*
|
|
2260
|
+
* <p>A Boolean that determines whether all permissions for each resource ARN are exported
|
|
2261
|
+
* with the job. If you set <code>IncludePermissions</code> to <code>TRUE</code>, any
|
|
2262
|
+
* permissions associated with each resource are exported. </p>
|
|
391
2263
|
* @public
|
|
392
2264
|
*/
|
|
393
2265
|
IncludePermissions?: boolean | undefined;
|
|
394
2266
|
/**
|
|
395
|
-
* <p> A Boolean that determines whether all tags for each resource ARN are exported with the
|
|
2267
|
+
* <p> A Boolean that determines whether all tags for each resource ARN are exported with the
|
|
2268
|
+
* job. If you set <code>IncludeTags</code> to <code>TRUE</code>, any tags associated with
|
|
2269
|
+
* each resource are exported.</p>
|
|
396
2270
|
* @public
|
|
397
2271
|
*/
|
|
398
2272
|
IncludeTags?: boolean | undefined;
|
|
399
2273
|
/**
|
|
400
|
-
* <p>An optional parameter that determines which validation strategy to use for the export
|
|
2274
|
+
* <p>An optional parameter that determines which validation strategy to use for the export
|
|
2275
|
+
* job. If <code>StrictModeForAllResources</code> is set to <code>TRUE</code>, strict
|
|
2276
|
+
* validation for every error is enforced. If it is set to <code>FALSE</code>, validation is
|
|
2277
|
+
* skipped for specific UI errors that are shown as warnings. The default value for
|
|
2278
|
+
* <code>StrictModeForAllResources</code> is <code>FALSE</code>.</p>
|
|
401
2279
|
* @public
|
|
402
2280
|
*/
|
|
403
2281
|
ValidationStrategy?: AssetBundleExportJobValidationStrategy | undefined;
|
|
404
2282
|
/**
|
|
405
|
-
* <p>A Boolean that determines if the exported asset carries over information about the
|
|
2283
|
+
* <p>A Boolean that determines if the exported asset carries over information about the
|
|
2284
|
+
* folders that the asset is a member of. </p>
|
|
406
2285
|
* @public
|
|
407
2286
|
*/
|
|
408
2287
|
IncludeFolderMemberships?: boolean | undefined;
|
|
409
2288
|
/**
|
|
410
|
-
* <p>A setting that indicates whether you want to include folder assets. You can also use
|
|
2289
|
+
* <p>A setting that indicates whether you want to include folder assets. You can also use
|
|
2290
|
+
* this setting to recusrsively include all subfolders of an exported folder.</p>
|
|
411
2291
|
* @public
|
|
412
2292
|
*/
|
|
413
2293
|
IncludeFolderMembers?: IncludeFolderMembers | undefined;
|
|
@@ -422,7 +2302,8 @@ export interface StartAssetBundleExportJobResponse {
|
|
|
422
2302
|
*/
|
|
423
2303
|
Arn?: string | undefined;
|
|
424
2304
|
/**
|
|
425
|
-
* <p>The ID of the job. This ID is unique while the job is running. After the job is
|
|
2305
|
+
* <p>The ID of the job. This ID is unique while the job is running. After the job is
|
|
2306
|
+
* completed, you can reuse this ID for another job.</p>
|
|
426
2307
|
* @public
|
|
427
2308
|
*/
|
|
428
2309
|
AssetBundleExportJobId?: string | undefined;
|
|
@@ -447,13 +2328,14 @@ export interface StartAssetBundleImportJobRequest {
|
|
|
447
2328
|
*/
|
|
448
2329
|
AwsAccountId: string | undefined;
|
|
449
2330
|
/**
|
|
450
|
-
* <p>The ID of the job. This ID is unique while the job is running. After the job is
|
|
2331
|
+
* <p>The ID of the job. This ID is unique while the job is running. After the job is
|
|
2332
|
+
* completed, you can reuse this ID for another job.</p>
|
|
451
2333
|
* @public
|
|
452
2334
|
*/
|
|
453
2335
|
AssetBundleImportJobId: string | undefined;
|
|
454
2336
|
/**
|
|
455
|
-
* <p>The source of the asset bundle zip file that contains the data that you want to import.
|
|
456
|
-
*
|
|
2337
|
+
* <p>The source of the asset bundle zip file that contains the data that you want to import.
|
|
2338
|
+
* The file must be in <code>QUICKSIGHT_JSON</code> format. </p>
|
|
457
2339
|
* @public
|
|
458
2340
|
*/
|
|
459
2341
|
AssetBundleImportSource: AssetBundleImportSource | undefined;
|
|
@@ -464,24 +2346,29 @@ export interface StartAssetBundleImportJobRequest {
|
|
|
464
2346
|
OverrideParameters?: AssetBundleImportJobOverrideParameters | undefined;
|
|
465
2347
|
/**
|
|
466
2348
|
* <p>The failure action for the import job.</p>
|
|
467
|
-
* <p>If you choose <code>ROLLBACK</code>, failed
|
|
2349
|
+
* <p>If you choose <code>ROLLBACK</code>, failed import jobs will attempt to undo any asset
|
|
2350
|
+
* changes caused by the failed job.</p>
|
|
468
2351
|
* <p>If you choose <code>DO_NOTHING</code>, failed import jobs will not attempt to roll back
|
|
469
|
-
* any asset changes caused by the failed job, possibly keeping the
|
|
2352
|
+
* any asset changes caused by the failed job, possibly keeping the Amazon Quick Sight account
|
|
2353
|
+
* in an inconsistent state.</p>
|
|
470
2354
|
* @public
|
|
471
2355
|
*/
|
|
472
2356
|
FailureAction?: AssetBundleImportFailureAction | undefined;
|
|
473
2357
|
/**
|
|
474
|
-
* <p>Optional permission overrides that are applied to the resource configuration before
|
|
2358
|
+
* <p>Optional permission overrides that are applied to the resource configuration before
|
|
2359
|
+
* import.</p>
|
|
475
2360
|
* @public
|
|
476
2361
|
*/
|
|
477
2362
|
OverridePermissions?: AssetBundleImportJobOverridePermissions | undefined;
|
|
478
2363
|
/**
|
|
479
|
-
* <p>Optional tag overrides that are applied to the resource configuration before
|
|
2364
|
+
* <p>Optional tag overrides that are applied to the resource configuration before
|
|
2365
|
+
* import.</p>
|
|
480
2366
|
* @public
|
|
481
2367
|
*/
|
|
482
2368
|
OverrideTags?: AssetBundleImportJobOverrideTags | undefined;
|
|
483
2369
|
/**
|
|
484
|
-
* <p>An optional validation strategy override for all analyses and dashboards that is applied
|
|
2370
|
+
* <p>An optional validation strategy override for all analyses and dashboards that is applied
|
|
2371
|
+
* to the resource configuration before import. </p>
|
|
485
2372
|
* @public
|
|
486
2373
|
*/
|
|
487
2374
|
OverrideValidationStrategy?: AssetBundleImportJobOverrideValidationStrategy | undefined;
|
|
@@ -496,7 +2383,8 @@ export interface StartAssetBundleImportJobResponse {
|
|
|
496
2383
|
*/
|
|
497
2384
|
Arn?: string | undefined;
|
|
498
2385
|
/**
|
|
499
|
-
* <p>The ID of the job. This ID is unique while the job is running. After the job is
|
|
2386
|
+
* <p>The ID of the job. This ID is unique while the job is running. After the job is
|
|
2387
|
+
* completed, you can reuse this ID for another job.</p>
|
|
500
2388
|
* @public
|
|
501
2389
|
*/
|
|
502
2390
|
AssetBundleImportJobId?: string | undefined;
|
|
@@ -518,7 +2406,7 @@ export interface StartAssetBundleImportJobResponse {
|
|
|
518
2406
|
export interface SnapshotAnonymousUser {
|
|
519
2407
|
/**
|
|
520
2408
|
* <p>The tags to be used for row-level security (RLS). Make sure that the relevant datasets have RLS tags configured before you start a snapshot export job. You can configure the RLS tags of a dataset with a <code>DataSet$RowLevelPermissionTagConfiguration</code> API call.</p>
|
|
521
|
-
* <p>These are not the tags that are used for Amazon Web Services resource tagging. For more information on row level security in
|
|
2409
|
+
* <p>These are not the tags that are used for Amazon Web Services resource tagging. For more information on row level security in Amazon Quick Sight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-rls-tags.html">Using Row-Level Security (RLS) with Tags</a>in the <i>Amazon QuickSight User Guide</i>.</p>
|
|
522
2410
|
* @public
|
|
523
2411
|
*/
|
|
524
2412
|
RowLevelPermissionTags?: SessionTag[] | undefined;
|
|
@@ -556,7 +2444,7 @@ export interface StartDashboardSnapshotJobRequest {
|
|
|
556
2444
|
SnapshotJobId: string | undefined;
|
|
557
2445
|
/**
|
|
558
2446
|
* <p>
|
|
559
|
-
* A structure that contains information about the anonymous users that the generated snapshot is for. This API will not return information about registered
|
|
2447
|
+
* A structure that contains information about the anonymous users that the generated snapshot is for. This API will not return information about registered Amazon Quick Sight.</p>
|
|
560
2448
|
* @public
|
|
561
2449
|
*/
|
|
562
2450
|
UserConfiguration: SnapshotUserConfiguration | undefined;
|
|
@@ -609,7 +2497,7 @@ export interface StartDashboardSnapshotJobScheduleRequest {
|
|
|
609
2497
|
*/
|
|
610
2498
|
DashboardId: string | undefined;
|
|
611
2499
|
/**
|
|
612
|
-
* <p>The ID of the schedule that you want to start a snapshot job schedule for. The schedule ID can be found in the
|
|
2500
|
+
* <p>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 <b>Schedules</b> pane of the dashboard that the schedule is configured for.</p>
|
|
613
2501
|
* @public
|
|
614
2502
|
*/
|
|
615
2503
|
ScheduleId: string | undefined;
|
|
@@ -641,7 +2529,8 @@ export interface TagResourceRequest {
|
|
|
641
2529
|
*/
|
|
642
2530
|
ResourceArn: string | undefined;
|
|
643
2531
|
/**
|
|
644
|
-
* <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the
|
|
2532
|
+
* <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the
|
|
2533
|
+
* resource.</p>
|
|
645
2534
|
* @public
|
|
646
2535
|
*/
|
|
647
2536
|
Tags: Tag[] | undefined;
|
|
@@ -671,7 +2560,8 @@ export interface UntagResourceRequest {
|
|
|
671
2560
|
*/
|
|
672
2561
|
ResourceArn: string | undefined;
|
|
673
2562
|
/**
|
|
674
|
-
* <p>The keys of the key-value pairs for the resource tag or tags assigned to the
|
|
2563
|
+
* <p>The keys of the key-value pairs for the resource tag or tags assigned to the
|
|
2564
|
+
* resource.</p>
|
|
675
2565
|
* @public
|
|
676
2566
|
*/
|
|
677
2567
|
TagKeys: string[] | undefined;
|
|
@@ -696,18 +2586,18 @@ export interface UntagResourceResponse {
|
|
|
696
2586
|
*/
|
|
697
2587
|
export interface UpdateAccountCustomizationRequest {
|
|
698
2588
|
/**
|
|
699
|
-
* <p>The ID for the Amazon Web Services account that you want to update
|
|
2589
|
+
* <p>The ID for the Amazon Web Services account that you want to update Quick Sight customizations
|
|
700
2590
|
* for.</p>
|
|
701
2591
|
* @public
|
|
702
2592
|
*/
|
|
703
2593
|
AwsAccountId: string | undefined;
|
|
704
2594
|
/**
|
|
705
|
-
* <p>The namespace that you want to update
|
|
2595
|
+
* <p>The namespace that you want to update Quick Sight customizations for.</p>
|
|
706
2596
|
* @public
|
|
707
2597
|
*/
|
|
708
2598
|
Namespace?: string | undefined;
|
|
709
2599
|
/**
|
|
710
|
-
* <p>The
|
|
2600
|
+
* <p>The Quick Sight customizations you're updating. </p>
|
|
711
2601
|
* @public
|
|
712
2602
|
*/
|
|
713
2603
|
AccountCustomization: AccountCustomization | undefined;
|
|
@@ -722,7 +2612,7 @@ export interface UpdateAccountCustomizationResponse {
|
|
|
722
2612
|
*/
|
|
723
2613
|
Arn?: string | undefined;
|
|
724
2614
|
/**
|
|
725
|
-
* <p>The ID for the Amazon Web Services account that you want to update
|
|
2615
|
+
* <p>The ID for the Amazon Web Services account that you want to update Quick Sight customizations
|
|
726
2616
|
* for.</p>
|
|
727
2617
|
* @public
|
|
728
2618
|
*/
|
|
@@ -733,7 +2623,7 @@ export interface UpdateAccountCustomizationResponse {
|
|
|
733
2623
|
*/
|
|
734
2624
|
Namespace?: string | undefined;
|
|
735
2625
|
/**
|
|
736
|
-
* <p>The
|
|
2626
|
+
* <p>The Quick Sight customizations you're updating. </p>
|
|
737
2627
|
* @public
|
|
738
2628
|
*/
|
|
739
2629
|
AccountCustomization?: AccountCustomization | undefined;
|
|
@@ -783,7 +2673,7 @@ export interface UpdateAccountCustomPermissionResponse {
|
|
|
783
2673
|
*/
|
|
784
2674
|
export interface UpdateAccountSettingsRequest {
|
|
785
2675
|
/**
|
|
786
|
-
* <p>The ID for the Amazon Web Services account that contains the
|
|
2676
|
+
* <p>The ID for the Amazon Web Services account that contains the Quick Sight settings that you want to
|
|
787
2677
|
* list.</p>
|
|
788
2678
|
* @public
|
|
789
2679
|
*/
|
|
@@ -791,20 +2681,20 @@ export interface UpdateAccountSettingsRequest {
|
|
|
791
2681
|
/**
|
|
792
2682
|
* <p>The default namespace for this Amazon Web Services account. Currently, the default is
|
|
793
2683
|
* <code>default</code>. IAM users that
|
|
794
|
-
* register for the first time with
|
|
2684
|
+
* register for the first time with Amazon Quick Sight provide an email address that becomes
|
|
795
2685
|
* associated with the default namespace.
|
|
796
2686
|
* </p>
|
|
797
2687
|
* @public
|
|
798
2688
|
*/
|
|
799
2689
|
DefaultNamespace: string | undefined;
|
|
800
2690
|
/**
|
|
801
|
-
* <p>The email address that you want
|
|
802
|
-
* Amazon Web Services account or
|
|
2691
|
+
* <p>The email address that you want Quick Sight to send notifications to regarding your
|
|
2692
|
+
* Amazon Web Services account or Quick Sight subscription.</p>
|
|
803
2693
|
* @public
|
|
804
2694
|
*/
|
|
805
2695
|
NotificationEmail?: string | undefined;
|
|
806
2696
|
/**
|
|
807
|
-
* <p>A boolean value that determines whether or not an
|
|
2697
|
+
* <p>A boolean value that determines whether or not an Quick Sight account can be deleted. A <code>True</code> value doesn't allow the account to be deleted and results in an error message if a user tries to make a <code>DeleteAccountSubscription</code> request. A <code>False</code> value will allow the account to be deleted.</p>
|
|
808
2698
|
* @public
|
|
809
2699
|
*/
|
|
810
2700
|
TerminationProtectionEnabled?: boolean | undefined;
|
|
@@ -824,6 +2714,126 @@ export interface UpdateAccountSettingsResponse {
|
|
|
824
2714
|
*/
|
|
825
2715
|
Status?: number | undefined;
|
|
826
2716
|
}
|
|
2717
|
+
/**
|
|
2718
|
+
* @public
|
|
2719
|
+
*/
|
|
2720
|
+
export interface UpdateActionConnectorRequest {
|
|
2721
|
+
/**
|
|
2722
|
+
* <p>The Amazon Web Services account ID that contains the action connector to update.</p>
|
|
2723
|
+
* @public
|
|
2724
|
+
*/
|
|
2725
|
+
AwsAccountId: string | undefined;
|
|
2726
|
+
/**
|
|
2727
|
+
* <p>The unique identifier of the action connector to update.</p>
|
|
2728
|
+
* @public
|
|
2729
|
+
*/
|
|
2730
|
+
ActionConnectorId: string | undefined;
|
|
2731
|
+
/**
|
|
2732
|
+
* <p>The new name for the action connector.</p>
|
|
2733
|
+
* @public
|
|
2734
|
+
*/
|
|
2735
|
+
Name: string | undefined;
|
|
2736
|
+
/**
|
|
2737
|
+
* <p>The updated authentication configuration for connecting to the external service.</p>
|
|
2738
|
+
* @public
|
|
2739
|
+
*/
|
|
2740
|
+
AuthenticationConfig: AuthConfig | undefined;
|
|
2741
|
+
/**
|
|
2742
|
+
* <p>The updated description of the action connector.</p>
|
|
2743
|
+
* @public
|
|
2744
|
+
*/
|
|
2745
|
+
Description?: string | undefined;
|
|
2746
|
+
/**
|
|
2747
|
+
* <p>The updated ARN of the VPC connection to use for secure connectivity.</p>
|
|
2748
|
+
* @public
|
|
2749
|
+
*/
|
|
2750
|
+
VpcConnectionArn?: string | undefined;
|
|
2751
|
+
}
|
|
2752
|
+
/**
|
|
2753
|
+
* @public
|
|
2754
|
+
*/
|
|
2755
|
+
export interface UpdateActionConnectorResponse {
|
|
2756
|
+
/**
|
|
2757
|
+
* <p>The Amazon Resource Name (ARN) of the updated action connector.</p>
|
|
2758
|
+
* @public
|
|
2759
|
+
*/
|
|
2760
|
+
Arn?: string | undefined;
|
|
2761
|
+
/**
|
|
2762
|
+
* <p>The unique identifier of the updated action connector.</p>
|
|
2763
|
+
* @public
|
|
2764
|
+
*/
|
|
2765
|
+
ActionConnectorId?: string | undefined;
|
|
2766
|
+
/**
|
|
2767
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
2768
|
+
* @public
|
|
2769
|
+
*/
|
|
2770
|
+
RequestId?: string | undefined;
|
|
2771
|
+
/**
|
|
2772
|
+
* <p>The status of the update operation.</p>
|
|
2773
|
+
* @public
|
|
2774
|
+
*/
|
|
2775
|
+
UpdateStatus?: ResourceStatus | undefined;
|
|
2776
|
+
/**
|
|
2777
|
+
* <p>The HTTP status code of the request.</p>
|
|
2778
|
+
* @public
|
|
2779
|
+
*/
|
|
2780
|
+
Status?: number | undefined;
|
|
2781
|
+
}
|
|
2782
|
+
/**
|
|
2783
|
+
* @public
|
|
2784
|
+
*/
|
|
2785
|
+
export interface UpdateActionConnectorPermissionsRequest {
|
|
2786
|
+
/**
|
|
2787
|
+
* <p>The Amazon Web Services account ID that contains the action connector.</p>
|
|
2788
|
+
* @public
|
|
2789
|
+
*/
|
|
2790
|
+
AwsAccountId: string | undefined;
|
|
2791
|
+
/**
|
|
2792
|
+
* <p>The unique identifier of the action connector whose permissions you want to update.</p>
|
|
2793
|
+
* @public
|
|
2794
|
+
*/
|
|
2795
|
+
ActionConnectorId: string | undefined;
|
|
2796
|
+
/**
|
|
2797
|
+
* <p>The permissions to grant to users and groups for this action connector.</p>
|
|
2798
|
+
* @public
|
|
2799
|
+
*/
|
|
2800
|
+
GrantPermissions?: ResourcePermission[] | undefined;
|
|
2801
|
+
/**
|
|
2802
|
+
* <p>The permissions to revoke from users and groups for this action connector.</p>
|
|
2803
|
+
* @public
|
|
2804
|
+
*/
|
|
2805
|
+
RevokePermissions?: ResourcePermission[] | undefined;
|
|
2806
|
+
}
|
|
2807
|
+
/**
|
|
2808
|
+
* @public
|
|
2809
|
+
*/
|
|
2810
|
+
export interface UpdateActionConnectorPermissionsResponse {
|
|
2811
|
+
/**
|
|
2812
|
+
* <p>The Amazon Resource Name (ARN) of the action connector.</p>
|
|
2813
|
+
* @public
|
|
2814
|
+
*/
|
|
2815
|
+
Arn?: string | undefined;
|
|
2816
|
+
/**
|
|
2817
|
+
* <p>The unique identifier of the action connector.</p>
|
|
2818
|
+
* @public
|
|
2819
|
+
*/
|
|
2820
|
+
ActionConnectorId?: string | undefined;
|
|
2821
|
+
/**
|
|
2822
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
2823
|
+
* @public
|
|
2824
|
+
*/
|
|
2825
|
+
RequestId?: string | undefined;
|
|
2826
|
+
/**
|
|
2827
|
+
* <p>The HTTP status code of the request.</p>
|
|
2828
|
+
* @public
|
|
2829
|
+
*/
|
|
2830
|
+
Status?: number | undefined;
|
|
2831
|
+
/**
|
|
2832
|
+
* <p>The updated permissions configuration for the action connector.</p>
|
|
2833
|
+
* @public
|
|
2834
|
+
*/
|
|
2835
|
+
Permissions?: ResourcePermission[] | undefined;
|
|
2836
|
+
}
|
|
827
2837
|
/**
|
|
828
2838
|
* @public
|
|
829
2839
|
*/
|
|
@@ -841,7 +2851,7 @@ export interface UpdateAnalysisRequest {
|
|
|
841
2851
|
AnalysisId: string | undefined;
|
|
842
2852
|
/**
|
|
843
2853
|
* <p>A descriptive name for the analysis that you're updating. This name displays for the
|
|
844
|
-
* analysis in the
|
|
2854
|
+
* analysis in the Amazon Quick Sight console.</p>
|
|
845
2855
|
* @public
|
|
846
2856
|
*/
|
|
847
2857
|
Name: string | undefined;
|
|
@@ -859,7 +2869,7 @@ export interface UpdateAnalysisRequest {
|
|
|
859
2869
|
SourceEntity?: AnalysisSourceEntity | undefined;
|
|
860
2870
|
/**
|
|
861
2871
|
* <p>The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're
|
|
862
|
-
* creating. To see the theme in the
|
|
2872
|
+
* creating. To see the theme in the Amazon Quick Sight console, make sure that you have access to
|
|
863
2873
|
* it.</p>
|
|
864
2874
|
* @public
|
|
865
2875
|
*/
|
|
@@ -1163,15 +3173,15 @@ export interface UpdateDashboardRequest {
|
|
|
1163
3173
|
Name: string | undefined;
|
|
1164
3174
|
/**
|
|
1165
3175
|
* <p>The entity that you are using as a source when you update the dashboard. In
|
|
1166
|
-
*
|
|
1167
|
-
* can only update a dashboard from a template, so you use a
|
|
1168
|
-
*
|
|
1169
|
-
* to a template by using the <code>
|
|
3176
|
+
* <code>SourceEntity</code>, you specify the type of object you're using as source.
|
|
3177
|
+
* You can only update a dashboard from a template, so you use a
|
|
3178
|
+
* <code>SourceTemplate</code> entity. If you need to update a dashboard from an
|
|
3179
|
+
* analysis, first convert the analysis to a template by using the <code>
|
|
1170
3180
|
* <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a>
|
|
1171
|
-
* </code> API operation. For
|
|
1172
|
-
*
|
|
1173
|
-
*
|
|
1174
|
-
*
|
|
3181
|
+
* </code> API operation. For <code>SourceTemplate</code>,
|
|
3182
|
+
* specify the Amazon Resource Name (ARN) of the source template. The
|
|
3183
|
+
* <code>SourceTemplate</code> ARN can contain any Amazon Web Services account and any
|
|
3184
|
+
* Amazon Quick Sight-supported Amazon Web Services Region. </p>
|
|
1175
3185
|
* <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> to
|
|
1176
3186
|
* list the replacement datasets for the placeholders listed in the original. The schema in
|
|
1177
3187
|
* each dataset must match its placeholder. </p>
|
|
@@ -1197,8 +3207,8 @@ export interface UpdateDashboardRequest {
|
|
|
1197
3207
|
* <p>
|
|
1198
3208
|
* <code>AvailabilityStatus</code> for <code>AdHocFilteringOption</code> - This
|
|
1199
3209
|
* status can be either <code>ENABLED</code> or <code>DISABLED</code>. When this is
|
|
1200
|
-
* set to <code>DISABLED</code>,
|
|
1201
|
-
* published dashboard, which can be used for ad hoc (one-time) filtering. This
|
|
3210
|
+
* set to <code>DISABLED</code>, Amazon Quick Sight disables the left filter pane on
|
|
3211
|
+
* the published dashboard, which can be used for ad hoc (one-time) filtering. This
|
|
1202
3212
|
* option is <code>ENABLED</code> by default. </p>
|
|
1203
3213
|
* </li>
|
|
1204
3214
|
* <li>
|
|
@@ -1206,7 +3216,8 @@ export interface UpdateDashboardRequest {
|
|
|
1206
3216
|
* <code>AvailabilityStatus</code> for <code>ExportToCSVOption</code> - This
|
|
1207
3217
|
* status can be either <code>ENABLED</code> or <code>DISABLED</code>. The visual
|
|
1208
3218
|
* option to export data to .CSV format isn't enabled when this is set to
|
|
1209
|
-
*
|
|
3219
|
+
* <code>DISABLED</code>. This option is <code>ENABLED</code> by default.
|
|
3220
|
+
* </p>
|
|
1210
3221
|
* </li>
|
|
1211
3222
|
* <li>
|
|
1212
3223
|
* <p>
|
|
@@ -1216,17 +3227,27 @@ export interface UpdateDashboardRequest {
|
|
|
1216
3227
|
* </li>
|
|
1217
3228
|
* <li>
|
|
1218
3229
|
* <p>
|
|
1219
|
-
* <code>AvailabilityStatus</code> for <code>
|
|
1220
|
-
* can be either <code>ENABLED</code> or <code>DISABLED</code>.
|
|
1221
|
-
*
|
|
3230
|
+
* <code>AvailabilityStatus</code> for <code>QuickSuiteActionsOption</code> -
|
|
3231
|
+
* This status can be either <code>ENABLED</code> or <code>DISABLED</code>.
|
|
3232
|
+
* Features related to Actions in Amazon Quick Suite on dashboards are disabled
|
|
3233
|
+
* when this is set to <code>DISABLED</code>. This option is <code>DISABLED</code>
|
|
1222
3234
|
* by default.</p>
|
|
1223
3235
|
* </li>
|
|
1224
3236
|
* <li>
|
|
1225
3237
|
* <p>
|
|
1226
|
-
* <code>AvailabilityStatus</code> for <code>
|
|
1227
|
-
* can be either <code>ENABLED</code> or <code>DISABLED</code>. The option
|
|
1228
|
-
* disabled when this is set to
|
|
1229
|
-
*
|
|
3238
|
+
* <code>AvailabilityStatus</code> for <code>ExecutiveSummaryOption</code> - This
|
|
3239
|
+
* status can be either <code>ENABLED</code> or <code>DISABLED</code>. The option
|
|
3240
|
+
* to build an executive summary is disabled when this is set to
|
|
3241
|
+
* <code>DISABLED</code>. This option is <code>ENABLED</code> by
|
|
3242
|
+
* default.</p>
|
|
3243
|
+
* </li>
|
|
3244
|
+
* <li>
|
|
3245
|
+
* <p>
|
|
3246
|
+
* <code>AvailabilityStatus</code> for <code>DataStoriesSharingOption</code> -
|
|
3247
|
+
* This status can be either <code>ENABLED</code> or <code>DISABLED</code>. The
|
|
3248
|
+
* option to share a data story is disabled when this is set to
|
|
3249
|
+
* <code>DISABLED</code>. This option is <code>ENABLED</code> by
|
|
3250
|
+
* default.</p>
|
|
1230
3251
|
* </li>
|
|
1231
3252
|
* </ul>
|
|
1232
3253
|
* @public
|
|
@@ -1235,8 +3256,8 @@ export interface UpdateDashboardRequest {
|
|
|
1235
3256
|
/**
|
|
1236
3257
|
* <p>The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If
|
|
1237
3258
|
* you add a value for this field, it overrides the value that was originally associated
|
|
1238
|
-
* with the entity. The theme ARN must exist in the same Amazon Web Services account where
|
|
1239
|
-
* dashboard.</p>
|
|
3259
|
+
* with the entity. The theme ARN must exist in the same Amazon Web Services account where
|
|
3260
|
+
* you create the dashboard.</p>
|
|
1240
3261
|
* @public
|
|
1241
3262
|
*/
|
|
1242
3263
|
ThemeArn?: string | undefined;
|
|
@@ -1247,7 +3268,8 @@ export interface UpdateDashboardRequest {
|
|
|
1247
3268
|
*/
|
|
1248
3269
|
Definition?: DashboardVersionDefinition | undefined;
|
|
1249
3270
|
/**
|
|
1250
|
-
* <p>The option to relax the validation needed to update a dashboard with definition
|
|
3271
|
+
* <p>The option to relax the validation needed to update a dashboard with definition
|
|
3272
|
+
* objects. This skips the validation step for specific errors.</p>
|
|
1251
3273
|
* @public
|
|
1252
3274
|
*/
|
|
1253
3275
|
ValidationStrategy?: ValidationStrategy | undefined;
|
|
@@ -1292,7 +3314,8 @@ export interface UpdateDashboardResponse {
|
|
|
1292
3314
|
*/
|
|
1293
3315
|
export interface UpdateDashboardLinksRequest {
|
|
1294
3316
|
/**
|
|
1295
|
-
* <p>The ID of the Amazon Web Services account that contains the dashboard whose links you
|
|
3317
|
+
* <p>The ID of the Amazon Web Services account that contains the dashboard whose links you
|
|
3318
|
+
* want to update.</p>
|
|
1296
3319
|
* @public
|
|
1297
3320
|
*/
|
|
1298
3321
|
AwsAccountId: string | undefined;
|
|
@@ -1337,8 +3360,8 @@ export interface UpdateDashboardLinksResponse {
|
|
|
1337
3360
|
*/
|
|
1338
3361
|
export interface UpdateDashboardPermissionsRequest {
|
|
1339
3362
|
/**
|
|
1340
|
-
* <p>The ID of the Amazon Web Services account that contains the dashboard whose permissions
|
|
1341
|
-
* updating.</p>
|
|
3363
|
+
* <p>The ID of the Amazon Web Services account that contains the dashboard whose permissions
|
|
3364
|
+
* you're updating.</p>
|
|
1342
3365
|
* @public
|
|
1343
3366
|
*/
|
|
1344
3367
|
AwsAccountId: string | undefined;
|
|
@@ -1398,7 +3421,7 @@ export interface UpdateDashboardPermissionsResponse {
|
|
|
1398
3421
|
*/
|
|
1399
3422
|
Status?: number | undefined;
|
|
1400
3423
|
/**
|
|
1401
|
-
* <p>Updates the permissions of a shared link to an
|
|
3424
|
+
* <p>Updates the permissions of a shared link to an Quick Sight dashboard.</p>
|
|
1402
3425
|
* @public
|
|
1403
3426
|
*/
|
|
1404
3427
|
LinkSharingConfiguration?: LinkSharingConfiguration | undefined;
|
|
@@ -1494,8 +3517,7 @@ export interface UpdateDataSetRequest {
|
|
|
1494
3517
|
*/
|
|
1495
3518
|
AwsAccountId: string | undefined;
|
|
1496
3519
|
/**
|
|
1497
|
-
* <p>The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region for each
|
|
1498
|
-
* Amazon Web Services account.</p>
|
|
3520
|
+
* <p>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.</p>
|
|
1499
3521
|
* @public
|
|
1500
3522
|
*/
|
|
1501
3523
|
DataSetId: string | undefined;
|
|
@@ -1510,7 +3532,8 @@ export interface UpdateDataSetRequest {
|
|
|
1510
3532
|
*/
|
|
1511
3533
|
PhysicalTableMap: Record<string, PhysicalTable> | undefined;
|
|
1512
3534
|
/**
|
|
1513
|
-
* <p>Configures the combination and transformation of the data from the physical
|
|
3535
|
+
* <p>Configures the combination and transformation of the data from the physical
|
|
3536
|
+
* tables.</p>
|
|
1514
3537
|
* @public
|
|
1515
3538
|
*/
|
|
1516
3539
|
LogicalTableMap?: Record<string, LogicalTable> | undefined;
|
|
@@ -1520,7 +3543,8 @@ export interface UpdateDataSetRequest {
|
|
|
1520
3543
|
*/
|
|
1521
3544
|
ImportMode: DataSetImportMode | undefined;
|
|
1522
3545
|
/**
|
|
1523
|
-
* <p>Groupings of columns that work together in certain
|
|
3546
|
+
* <p>Groupings of columns that work together in certain Amazon Quick Sight features.
|
|
3547
|
+
* Currently, only geospatial hierarchy is supported.</p>
|
|
1524
3548
|
* @public
|
|
1525
3549
|
*/
|
|
1526
3550
|
ColumnGroups?: ColumnGroup[] | undefined;
|
|
@@ -1535,7 +3559,8 @@ export interface UpdateDataSetRequest {
|
|
|
1535
3559
|
*/
|
|
1536
3560
|
RowLevelPermissionDataSet?: RowLevelPermissionDataSet | undefined;
|
|
1537
3561
|
/**
|
|
1538
|
-
* <p>The configuration of tags on a dataset to set row-level security. Row-level security
|
|
3562
|
+
* <p>The configuration of tags on a dataset to set row-level security. Row-level security
|
|
3563
|
+
* tags are currently supported for anonymous embedding only.</p>
|
|
1539
3564
|
* @public
|
|
1540
3565
|
*/
|
|
1541
3566
|
RowLevelPermissionTagConfiguration?: RowLevelPermissionTagConfiguration | undefined;
|
|
@@ -1557,7 +3582,8 @@ export interface UpdateDataSetRequest {
|
|
|
1557
3582
|
*/
|
|
1558
3583
|
DatasetParameters?: DatasetParameter[] | undefined;
|
|
1559
3584
|
/**
|
|
1560
|
-
* <p>The configuration for the performance optimization of the dataset that contains a
|
|
3585
|
+
* <p>The configuration for the performance optimization of the dataset that contains a
|
|
3586
|
+
* <code>UniqueKey</code> configuration.</p>
|
|
1561
3587
|
* @public
|
|
1562
3588
|
*/
|
|
1563
3589
|
PerformanceConfiguration?: PerformanceConfiguration | undefined;
|
|
@@ -1577,14 +3603,14 @@ export interface UpdateDataSetResponse {
|
|
|
1577
3603
|
*/
|
|
1578
3604
|
DataSetId?: string | undefined;
|
|
1579
3605
|
/**
|
|
1580
|
-
* <p>The ARN for the ingestion, which is triggered as a result of dataset creation if the
|
|
1581
|
-
* mode is SPICE.</p>
|
|
3606
|
+
* <p>The ARN for the ingestion, which is triggered as a result of dataset creation if the
|
|
3607
|
+
* import mode is SPICE.</p>
|
|
1582
3608
|
* @public
|
|
1583
3609
|
*/
|
|
1584
3610
|
IngestionArn?: string | undefined;
|
|
1585
3611
|
/**
|
|
1586
|
-
* <p>The ID of the ingestion, which is triggered as a result of dataset creation if the
|
|
1587
|
-
* mode is SPICE.</p>
|
|
3612
|
+
* <p>The ID of the ingestion, which is triggered as a result of dataset creation if the
|
|
3613
|
+
* import mode is SPICE.</p>
|
|
1588
3614
|
* @public
|
|
1589
3615
|
*/
|
|
1590
3616
|
IngestionId?: string | undefined;
|
|
@@ -1610,7 +3636,7 @@ export interface UpdateDataSetPermissionsRequest {
|
|
|
1610
3636
|
AwsAccountId: string | undefined;
|
|
1611
3637
|
/**
|
|
1612
3638
|
* <p>The ID for the dataset whose permissions you want to update. This ID is unique per
|
|
1613
|
-
*
|
|
3639
|
+
* Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
1614
3640
|
* @public
|
|
1615
3641
|
*/
|
|
1616
3642
|
DataSetId: string | undefined;
|
|
@@ -1636,7 +3662,7 @@ export interface UpdateDataSetPermissionsResponse {
|
|
|
1636
3662
|
DataSetArn?: string | undefined;
|
|
1637
3663
|
/**
|
|
1638
3664
|
* <p>The ID for the dataset whose permissions you want to update. This ID is unique per
|
|
1639
|
-
*
|
|
3665
|
+
* Amazon Web Services Region for each Amazon Web Services account.</p>
|
|
1640
3666
|
* @public
|
|
1641
3667
|
*/
|
|
1642
3668
|
DataSetId?: string | undefined;
|
|
@@ -1661,7 +3687,8 @@ export interface UpdateDataSourceRequest {
|
|
|
1661
3687
|
*/
|
|
1662
3688
|
AwsAccountId: string | undefined;
|
|
1663
3689
|
/**
|
|
1664
|
-
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each
|
|
3690
|
+
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each
|
|
3691
|
+
* Amazon Web Services account. </p>
|
|
1665
3692
|
* @public
|
|
1666
3693
|
*/
|
|
1667
3694
|
DataSourceId: string | undefined;
|
|
@@ -1671,25 +3698,26 @@ export interface UpdateDataSourceRequest {
|
|
|
1671
3698
|
*/
|
|
1672
3699
|
Name: string | undefined;
|
|
1673
3700
|
/**
|
|
1674
|
-
* <p>The parameters that
|
|
3701
|
+
* <p>The parameters that Amazon Quick Sight uses to connect to your underlying
|
|
3702
|
+
* source.</p>
|
|
1675
3703
|
* @public
|
|
1676
3704
|
*/
|
|
1677
3705
|
DataSourceParameters?: DataSourceParameters | undefined;
|
|
1678
3706
|
/**
|
|
1679
|
-
* <p>The credentials that
|
|
1680
|
-
* only credentials based on user name and password are supported.</p>
|
|
3707
|
+
* <p>The credentials that Amazon Quick Sight that uses to connect to your underlying source.
|
|
3708
|
+
* Currently, only credentials based on user name and password are supported.</p>
|
|
1681
3709
|
* @public
|
|
1682
3710
|
*/
|
|
1683
3711
|
Credentials?: DataSourceCredentials | undefined;
|
|
1684
3712
|
/**
|
|
1685
|
-
* <p>Use this parameter only when you want
|
|
1686
|
-
* your underlying source.</p>
|
|
3713
|
+
* <p>Use this parameter only when you want Amazon Quick Sight to use a VPC connection when
|
|
3714
|
+
* connecting to your underlying source.</p>
|
|
1687
3715
|
* @public
|
|
1688
3716
|
*/
|
|
1689
3717
|
VpcConnectionProperties?: VpcConnectionProperties | undefined;
|
|
1690
3718
|
/**
|
|
1691
|
-
* <p>Secure Socket Layer (SSL) properties that apply when
|
|
1692
|
-
* source.</p>
|
|
3719
|
+
* <p>Secure Socket Layer (SSL) properties that apply when Amazon Quick Sight connects to
|
|
3720
|
+
* your underlying source.</p>
|
|
1693
3721
|
* @public
|
|
1694
3722
|
*/
|
|
1695
3723
|
SslProperties?: SslProperties | undefined;
|
|
@@ -1704,7 +3732,8 @@ export interface UpdateDataSourceResponse {
|
|
|
1704
3732
|
*/
|
|
1705
3733
|
Arn?: string | undefined;
|
|
1706
3734
|
/**
|
|
1707
|
-
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each
|
|
3735
|
+
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each
|
|
3736
|
+
* Amazon Web Services account.</p>
|
|
1708
3737
|
* @public
|
|
1709
3738
|
*/
|
|
1710
3739
|
DataSourceId?: string | undefined;
|
|
@@ -1734,7 +3763,8 @@ export interface UpdateDataSourcePermissionsRequest {
|
|
|
1734
3763
|
*/
|
|
1735
3764
|
AwsAccountId: string | undefined;
|
|
1736
3765
|
/**
|
|
1737
|
-
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each
|
|
3766
|
+
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each
|
|
3767
|
+
* Amazon Web Services account. </p>
|
|
1738
3768
|
* @public
|
|
1739
3769
|
*/
|
|
1740
3770
|
DataSourceId: string | undefined;
|
|
@@ -1759,7 +3789,8 @@ export interface UpdateDataSourcePermissionsResponse {
|
|
|
1759
3789
|
*/
|
|
1760
3790
|
DataSourceArn?: string | undefined;
|
|
1761
3791
|
/**
|
|
1762
|
-
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each
|
|
3792
|
+
* <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each
|
|
3793
|
+
* Amazon Web Services account.</p>
|
|
1763
3794
|
* @public
|
|
1764
3795
|
*/
|
|
1765
3796
|
DataSourceId?: string | undefined;
|
|
@@ -1779,12 +3810,12 @@ export interface UpdateDataSourcePermissionsResponse {
|
|
|
1779
3810
|
*/
|
|
1780
3811
|
export interface UpdateDefaultQBusinessApplicationRequest {
|
|
1781
3812
|
/**
|
|
1782
|
-
* <p>The ID of the
|
|
3813
|
+
* <p>The ID of the Quick Sight account that is connected to the Amazon Q Business application that you want to update.</p>
|
|
1783
3814
|
* @public
|
|
1784
3815
|
*/
|
|
1785
3816
|
AwsAccountId: string | undefined;
|
|
1786
3817
|
/**
|
|
1787
|
-
* <p>The
|
|
3818
|
+
* <p>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.</p>
|
|
1788
3819
|
* @public
|
|
1789
3820
|
*/
|
|
1790
3821
|
Namespace?: string | undefined;
|
|
@@ -1809,6 +3840,61 @@ export interface UpdateDefaultQBusinessApplicationResponse {
|
|
|
1809
3840
|
*/
|
|
1810
3841
|
Status?: number | undefined;
|
|
1811
3842
|
}
|
|
3843
|
+
/**
|
|
3844
|
+
* @public
|
|
3845
|
+
*/
|
|
3846
|
+
export interface UpdateFlowPermissionsInput {
|
|
3847
|
+
/**
|
|
3848
|
+
* <p>The ID of the Amazon Web Services account that contains the flow you are updating permissions against.</p>
|
|
3849
|
+
* @public
|
|
3850
|
+
*/
|
|
3851
|
+
AwsAccountId: string | undefined;
|
|
3852
|
+
/**
|
|
3853
|
+
* <p>The unique identifier of the flow to update permissions for.</p>
|
|
3854
|
+
* @public
|
|
3855
|
+
*/
|
|
3856
|
+
FlowId: string | undefined;
|
|
3857
|
+
/**
|
|
3858
|
+
* <p>The permissions that you want to grant on this flow.</p>
|
|
3859
|
+
* @public
|
|
3860
|
+
*/
|
|
3861
|
+
GrantPermissions?: Permission[] | undefined;
|
|
3862
|
+
/**
|
|
3863
|
+
* <p>The permissions that you want to revoke from this flow.</p>
|
|
3864
|
+
* @public
|
|
3865
|
+
*/
|
|
3866
|
+
RevokePermissions?: Permission[] | undefined;
|
|
3867
|
+
}
|
|
3868
|
+
/**
|
|
3869
|
+
* @public
|
|
3870
|
+
*/
|
|
3871
|
+
export interface UpdateFlowPermissionsOutput {
|
|
3872
|
+
/**
|
|
3873
|
+
* <p>The HTTP status of the request.</p>
|
|
3874
|
+
* @public
|
|
3875
|
+
*/
|
|
3876
|
+
Status?: number | undefined;
|
|
3877
|
+
/**
|
|
3878
|
+
* <p>The Amazon Resource Name (ARN) of the flow you are updating permissions against.</p>
|
|
3879
|
+
* @public
|
|
3880
|
+
*/
|
|
3881
|
+
Arn: string | undefined;
|
|
3882
|
+
/**
|
|
3883
|
+
* <p>The permissions on the flow after they are updated.</p>
|
|
3884
|
+
* @public
|
|
3885
|
+
*/
|
|
3886
|
+
Permissions: Permission[] | undefined;
|
|
3887
|
+
/**
|
|
3888
|
+
* <p>The Amazon Web Services request ID for this operation.</p>
|
|
3889
|
+
* @public
|
|
3890
|
+
*/
|
|
3891
|
+
RequestId: string | undefined;
|
|
3892
|
+
/**
|
|
3893
|
+
* <p>The unique identifier of the flow with updated permissions.</p>
|
|
3894
|
+
* @public
|
|
3895
|
+
*/
|
|
3896
|
+
FlowId: string | undefined;
|
|
3897
|
+
}
|
|
1812
3898
|
/**
|
|
1813
3899
|
* @public
|
|
1814
3900
|
*/
|
|
@@ -1925,7 +4011,7 @@ export interface UpdateGroupRequest {
|
|
|
1925
4011
|
Description?: string | undefined;
|
|
1926
4012
|
/**
|
|
1927
4013
|
* <p>The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the
|
|
1928
|
-
* Amazon Web Services account that contains your Amazon
|
|
4014
|
+
* Amazon Web Services account that contains your Amazon Quick Sight account.</p>
|
|
1929
4015
|
* @public
|
|
1930
4016
|
*/
|
|
1931
4017
|
AwsAccountId: string | undefined;
|
|
@@ -2001,13 +4087,13 @@ export interface UpdateIAMPolicyAssignmentRequest {
|
|
|
2001
4087
|
*/
|
|
2002
4088
|
AssignmentStatus?: AssignmentStatus | undefined;
|
|
2003
4089
|
/**
|
|
2004
|
-
* <p>The ARN for the IAM policy to apply to the
|
|
4090
|
+
* <p>The ARN for the IAM policy to apply to the Amazon Quick Sight users and
|
|
2005
4091
|
* groups specified in this assignment.</p>
|
|
2006
4092
|
* @public
|
|
2007
4093
|
*/
|
|
2008
4094
|
PolicyArn?: string | undefined;
|
|
2009
4095
|
/**
|
|
2010
|
-
* <p>The
|
|
4096
|
+
* <p>The Amazon Quick Sight users, groups, or both that you want to assign the policy
|
|
2011
4097
|
* to.</p>
|
|
2012
4098
|
* @public
|
|
2013
4099
|
*/
|
|
@@ -2028,13 +4114,13 @@ export interface UpdateIAMPolicyAssignmentResponse {
|
|
|
2028
4114
|
*/
|
|
2029
4115
|
AssignmentId?: string | undefined;
|
|
2030
4116
|
/**
|
|
2031
|
-
* <p>The ARN for the IAM policy applied to the
|
|
4117
|
+
* <p>The ARN for the IAM policy applied to the Amazon Quick Sight users and
|
|
2032
4118
|
* groups specified in this assignment.</p>
|
|
2033
4119
|
* @public
|
|
2034
4120
|
*/
|
|
2035
4121
|
PolicyArn?: string | undefined;
|
|
2036
4122
|
/**
|
|
2037
|
-
* <p>The
|
|
4123
|
+
* <p>The Amazon Quick Sight users, groups, or both that the IAM policy is
|
|
2038
4124
|
* assigned to.</p>
|
|
2039
4125
|
* @public
|
|
2040
4126
|
*/
|
|
@@ -2167,13 +4253,13 @@ export interface UpdateKeyRegistrationRequest {
|
|
|
2167
4253
|
*/
|
|
2168
4254
|
AwsAccountId: string | undefined;
|
|
2169
4255
|
/**
|
|
2170
|
-
* <p>A list of <code>RegisteredCustomerManagedKey</code> objects to be updated to the
|
|
4256
|
+
* <p>A list of <code>RegisteredCustomerManagedKey</code> objects to be updated to the Quick Sight account.</p>
|
|
2171
4257
|
* @public
|
|
2172
4258
|
*/
|
|
2173
4259
|
KeyRegistration: RegisteredCustomerManagedKey[] | undefined;
|
|
2174
4260
|
}
|
|
2175
4261
|
/**
|
|
2176
|
-
* <p>A success entry that occurs when a <code>KeyRegistration</code> job is successfully applied to the
|
|
4262
|
+
* <p>A success entry that occurs when a <code>KeyRegistration</code> job is successfully applied to the Quick Sight account.</p>
|
|
2177
4263
|
* @public
|
|
2178
4264
|
*/
|
|
2179
4265
|
export interface SuccessfulKeyRegistrationEntry {
|
|
@@ -2213,7 +4299,8 @@ export interface UpdateKeyRegistrationResponse {
|
|
|
2213
4299
|
*/
|
|
2214
4300
|
export interface UpdatePublicSharingSettingsRequest {
|
|
2215
4301
|
/**
|
|
2216
|
-
* <p>The Amazon Web Services account ID associated with your
|
|
4302
|
+
* <p>The Amazon Web Services account ID associated with your Amazon Quick Sight
|
|
4303
|
+
* subscription.</p>
|
|
2217
4304
|
* @public
|
|
2218
4305
|
*/
|
|
2219
4306
|
AwsAccountId: string | undefined;
|
|
@@ -2248,7 +4335,7 @@ export interface UpdateQPersonalizationConfigurationRequest {
|
|
|
2248
4335
|
*/
|
|
2249
4336
|
AwsAccountId: string | undefined;
|
|
2250
4337
|
/**
|
|
2251
|
-
* <p>An option to allow
|
|
4338
|
+
* <p>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.</p>
|
|
2252
4339
|
* @public
|
|
2253
4340
|
*/
|
|
2254
4341
|
PersonalizationMode: PersonalizationMode | undefined;
|
|
@@ -2278,12 +4365,12 @@ export interface UpdateQPersonalizationConfigurationResponse {
|
|
|
2278
4365
|
*/
|
|
2279
4366
|
export interface UpdateQuickSightQSearchConfigurationRequest {
|
|
2280
4367
|
/**
|
|
2281
|
-
* <p>The ID of the Amazon Web Services account that contains the
|
|
4368
|
+
* <p>The ID of the Amazon Web Services account that contains the Quick Sight Q Search configuration that you want to update.</p>
|
|
2282
4369
|
* @public
|
|
2283
4370
|
*/
|
|
2284
4371
|
AwsAccountId: string | undefined;
|
|
2285
4372
|
/**
|
|
2286
|
-
* <p>The status of the
|
|
4373
|
+
* <p>The status of the Quick Sight Q Search configuration that the user wants to update.</p>
|
|
2287
4374
|
* @public
|
|
2288
4375
|
*/
|
|
2289
4376
|
QSearchStatus: QSearchStatus | undefined;
|
|
@@ -2293,7 +4380,7 @@ export interface UpdateQuickSightQSearchConfigurationRequest {
|
|
|
2293
4380
|
*/
|
|
2294
4381
|
export interface UpdateQuickSightQSearchConfigurationResponse {
|
|
2295
4382
|
/**
|
|
2296
|
-
* <p>The status of the
|
|
4383
|
+
* <p>The status of the Quick Sight Q Search configuration.</p>
|
|
2297
4384
|
* @public
|
|
2298
4385
|
*/
|
|
2299
4386
|
QSearchStatus?: QSearchStatus | undefined;
|
|
@@ -2368,7 +4455,7 @@ export interface UpdateRoleCustomPermissionRequest {
|
|
|
2368
4455
|
*/
|
|
2369
4456
|
Role: Role | undefined;
|
|
2370
4457
|
/**
|
|
2371
|
-
* <p>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
|
|
4458
|
+
* <p>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.</p>
|
|
2372
4459
|
* @public
|
|
2373
4460
|
*/
|
|
2374
4461
|
AwsAccountId: string | undefined;
|
|
@@ -2454,7 +4541,7 @@ export interface UpdateTemplateRequest {
|
|
|
2454
4541
|
* analysis. Both of these require an Amazon Resource Name (ARN). For
|
|
2455
4542
|
* <code>SourceTemplate</code>, specify the ARN of the source template. For
|
|
2456
4543
|
* <code>SourceAnalysis</code>, specify the ARN of the source analysis. The <code>SourceTemplate</code>
|
|
2457
|
-
* ARN can contain any Amazon Web Services account and any
|
|
4544
|
+
* ARN can contain any Amazon Web Services account and any Quick Sight-supported Amazon Web Services Region;. </p>
|
|
2458
4545
|
* <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> or
|
|
2459
4546
|
* <code>SourceAnalysis</code> to list the replacement datasets for the placeholders listed
|
|
2460
4547
|
* in the original. The schema in each dataset must match its placeholder. </p>
|
|
@@ -2644,8 +4731,8 @@ export interface UpdateThemeRequest {
|
|
|
2644
4731
|
*/
|
|
2645
4732
|
Name?: string | undefined;
|
|
2646
4733
|
/**
|
|
2647
|
-
* <p>The theme ID, defined by Amazon
|
|
2648
|
-
* All themes initially inherit from a default
|
|
4734
|
+
* <p>The theme ID, defined by Amazon Quick Sight, that a custom theme inherits from.
|
|
4735
|
+
* All themes initially inherit from a default Quick Sight theme.</p>
|
|
2649
4736
|
* @public
|
|
2650
4737
|
*/
|
|
2651
4738
|
BaseThemeId: string | undefined;
|
|
@@ -2970,13 +5057,13 @@ export interface UpdateTopicRefreshScheduleResponse {
|
|
|
2970
5057
|
*/
|
|
2971
5058
|
export interface UpdateUserRequest {
|
|
2972
5059
|
/**
|
|
2973
|
-
* <p>The Amazon
|
|
5060
|
+
* <p>The Amazon Quick Sight user name that you want to update.</p>
|
|
2974
5061
|
* @public
|
|
2975
5062
|
*/
|
|
2976
5063
|
UserName: string | undefined;
|
|
2977
5064
|
/**
|
|
2978
5065
|
* <p>The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the
|
|
2979
|
-
* Amazon Web Services account that contains your Amazon
|
|
5066
|
+
* Amazon Web Services account that contains your Amazon Quick Sight account.</p>
|
|
2980
5067
|
* @public
|
|
2981
5068
|
*/
|
|
2982
5069
|
AwsAccountId: string | undefined;
|
|
@@ -2991,7 +5078,7 @@ export interface UpdateUserRequest {
|
|
|
2991
5078
|
*/
|
|
2992
5079
|
Email: string | undefined;
|
|
2993
5080
|
/**
|
|
2994
|
-
* <p>The Amazon
|
|
5081
|
+
* <p>The Amazon Quick Sight role of the user. The role can be one of the
|
|
2995
5082
|
* following default security cohorts:</p>
|
|
2996
5083
|
* <ul>
|
|
2997
5084
|
* <li>
|
|
@@ -3005,12 +5092,12 @@ export interface UpdateUserRequest {
|
|
|
3005
5092
|
* </li>
|
|
3006
5093
|
* <li>
|
|
3007
5094
|
* <p>
|
|
3008
|
-
* <code>ADMIN</code>: A user who is an author, who can also manage Amazon
|
|
5095
|
+
* <code>ADMIN</code>: A user who is an author, who can also manage Amazon Quick Sight
|
|
3009
5096
|
* settings.</p>
|
|
3010
5097
|
* </li>
|
|
3011
5098
|
* <li>
|
|
3012
5099
|
* <p>
|
|
3013
|
-
* <code>READER_PRO</code>: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in
|
|
5100
|
+
* <code>READER_PRO</code>: 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.</p>
|
|
3014
5101
|
* </li>
|
|
3015
5102
|
* <li>
|
|
3016
5103
|
* <p>
|
|
@@ -3018,10 +5105,10 @@ export interface UpdateUserRequest {
|
|
|
3018
5105
|
* </li>
|
|
3019
5106
|
* <li>
|
|
3020
5107
|
* <p>
|
|
3021
|
-
* <code>ADMIN_PRO</code>: Admin Pros are Author Pros who can also manage Amazon
|
|
5108
|
+
* <code>ADMIN_PRO</code>: Admin Pros are Author Pros who can also manage Amazon Quick Sight administrative settings. Admin Pro users are billed at Author Pro pricing.</p>
|
|
3022
5109
|
* </li>
|
|
3023
5110
|
* </ul>
|
|
3024
|
-
* <p>The name of the
|
|
5111
|
+
* <p>The name of the Quick Sight role is invisible to the user except for the console
|
|
3025
5112
|
* screens dealing with permissions.</p>
|
|
3026
5113
|
* @public
|
|
3027
5114
|
*/
|
|
@@ -3045,13 +5132,13 @@ export interface UpdateUserRequest {
|
|
|
3045
5132
|
* </li>
|
|
3046
5133
|
* </ul>
|
|
3047
5134
|
* <p>A set of custom permissions includes any combination of these restrictions. Currently,
|
|
3048
|
-
* you need to create the profile names for custom permission sets by using the
|
|
5135
|
+
* you need to create the profile names for custom permission sets by using the Quick Sight
|
|
3049
5136
|
* console. Then, you use the <code>RegisterUser</code> API operation to assign the named set of
|
|
3050
|
-
* permissions to a
|
|
3051
|
-
* <p>
|
|
3052
|
-
* override the permissions typically granted by assigning
|
|
3053
|
-
* default security cohorts in
|
|
3054
|
-
* <p>This feature is available only to
|
|
5137
|
+
* permissions to a Quick Sight user. </p>
|
|
5138
|
+
* <p>Quick Sight custom permissions are applied through IAM policies. Therefore, they
|
|
5139
|
+
* override the permissions typically granted by assigning Quick Sight users to one of the
|
|
5140
|
+
* default security cohorts in Quick Sight (admin, author, reader).</p>
|
|
5141
|
+
* <p>This feature is available only to Quick Sight Enterprise edition subscriptions.</p>
|
|
3055
5142
|
* @public
|
|
3056
5143
|
*/
|
|
3057
5144
|
CustomPermissionsName?: string | undefined;
|
|
@@ -3064,7 +5151,7 @@ export interface UpdateUserRequest {
|
|
|
3064
5151
|
*/
|
|
3065
5152
|
UnapplyCustomPermissions?: boolean | undefined;
|
|
3066
5153
|
/**
|
|
3067
|
-
* <p>The type of supported external login provider that provides identity to let a user federate into
|
|
5154
|
+
* <p>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.</p>
|
|
3068
5155
|
* <ul>
|
|
3069
5156
|
* <li>
|
|
3070
5157
|
* <p>
|
|
@@ -3088,7 +5175,7 @@ export interface UpdateUserRequest {
|
|
|
3088
5175
|
ExternalLoginFederationProviderType?: string | undefined;
|
|
3089
5176
|
/**
|
|
3090
5177
|
* <p>The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate
|
|
3091
|
-
* into
|
|
5178
|
+
* into Quick Sight with an associated Identity and Access Management(IAM) role. This parameter should
|
|
3092
5179
|
* only be used when <code>ExternalLoginFederationProviderType</code> parameter is set to <code>CUSTOM_OIDC</code>.</p>
|
|
3093
5180
|
* @public
|
|
3094
5181
|
*/
|
|
@@ -3104,7 +5191,7 @@ export interface UpdateUserRequest {
|
|
|
3104
5191
|
*/
|
|
3105
5192
|
export interface UpdateUserResponse {
|
|
3106
5193
|
/**
|
|
3107
|
-
* <p>The Amazon
|
|
5194
|
+
* <p>The Amazon Quick Sight user.</p>
|
|
3108
5195
|
* @public
|
|
3109
5196
|
*/
|
|
3110
5197
|
User?: User | undefined;
|
|
@@ -3390,6 +5477,22 @@ export interface ListTopicReviewedAnswersResponse {
|
|
|
3390
5477
|
*/
|
|
3391
5478
|
RequestId?: string | undefined;
|
|
3392
5479
|
}
|
|
5480
|
+
/**
|
|
5481
|
+
* @internal
|
|
5482
|
+
*/
|
|
5483
|
+
export declare const PredictQAResultsRequestFilterSensitiveLog: (obj: PredictQAResultsRequest) => any;
|
|
5484
|
+
/**
|
|
5485
|
+
* @internal
|
|
5486
|
+
*/
|
|
5487
|
+
export declare const QAResultFilterSensitiveLog: (obj: QAResult) => any;
|
|
5488
|
+
/**
|
|
5489
|
+
* @internal
|
|
5490
|
+
*/
|
|
5491
|
+
export declare const PredictQAResultsResponseFilterSensitiveLog: (obj: PredictQAResultsResponse) => any;
|
|
5492
|
+
/**
|
|
5493
|
+
* @internal
|
|
5494
|
+
*/
|
|
5495
|
+
export declare const SearchActionConnectorsResponseFilterSensitiveLog: (obj: SearchActionConnectorsResponse) => any;
|
|
3393
5496
|
/**
|
|
3394
5497
|
* @internal
|
|
3395
5498
|
*/
|
|
@@ -3406,6 +5509,10 @@ export declare const SnapshotUserConfigurationFilterSensitiveLog: (obj: Snapshot
|
|
|
3406
5509
|
* @internal
|
|
3407
5510
|
*/
|
|
3408
5511
|
export declare const StartDashboardSnapshotJobRequestFilterSensitiveLog: (obj: StartDashboardSnapshotJobRequest) => any;
|
|
5512
|
+
/**
|
|
5513
|
+
* @internal
|
|
5514
|
+
*/
|
|
5515
|
+
export declare const UpdateActionConnectorRequestFilterSensitiveLog: (obj: UpdateActionConnectorRequest) => any;
|
|
3409
5516
|
/**
|
|
3410
5517
|
* @internal
|
|
3411
5518
|
*/
|