QuickSight class

Amazon Quick Sight is a fully managed, serverless business intelligence service for the Amazon Web Services Cloud that makes it easy to extend data and insights to every user in your organization. This API reference contains documentation for a programming interface that you can use to manage Amazon Quick Sight.

Constructors

QuickSight({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

batchCreateTopicReviewedAnswer({required List<CreateTopicReviewedAnswer> answers, required String awsAccountId, required String topicId}) → Future<BatchCreateTopicReviewedAnswerResponse>
Creates new reviewed answers for a Q Topic.
batchDeleteKnowledgeBase({required String awsAccountId, required List<String> knowledgeBaseIds}) → Future<BatchDeleteKnowledgeBaseResponse>
Deletes one or more knowledge bases.
batchDeleteTopicReviewedAnswer({required String awsAccountId, required String topicId, List<String>? answerIds}) → Future<BatchDeleteTopicReviewedAnswerResponse>
Deletes reviewed answers for Q Topic.
cancelIngestion({required String awsAccountId, required String dataSetId, required String ingestionId}) → Future<CancelIngestionResponse>
Cancels an ongoing ingestion of data into SPICE.
close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createAccountCustomization({required AccountCustomization accountCustomization, required String awsAccountId, String? namespace, List<Tag>? tags}) → Future<CreateAccountCustomizationResponse>
Creates Amazon Quick Sight customizations. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize Amazon Quick Sight by removing Amazon Quick Sight sample assets and videos for all new users, see Customizing Quick Sight in the Amazon Quick Sight User Guide.
createAccountSubscription({required String accountName, required AuthenticationMethodOption authenticationMethod, required String awsAccountId, required String notificationEmail, String? activeDirectoryName, List<String>? adminGroup, List<String>? adminProGroup, List<String>? authorGroup, List<String>? authorProGroup, String? contactNumber, String? directoryId, Edition? edition, String? emailAddress, String? firstName, String? iAMIdentityCenterInstanceArn, String? lastName, List<String>? readerGroup, List<String>? readerProGroup, String? realm}) → Future<CreateAccountSubscriptionResponse>
Creates an Amazon Quick Sight account, or subscribes to Amazon Quick Sight Q.
createActionConnector({required String actionConnectorId, required AuthConfig authenticationConfig, required String awsAccountId, required String name, required ActionConnectorType type, String? description, List<ResourcePermission>? permissions, List<Tag>? tags, String? vpcConnectionArn}) → Future<CreateActionConnectorResponse>
Creates an action connector that enables Amazon Quick Sight to connect to external services and perform actions. Action connectors support various authentication methods and can be configured with specific actions from supported connector types like Amazon S3, Salesforce, JIRA.
createAgent({required String agentId, required String awsAccountId, required String name, List<String>? actionConnectors, AgentLifecycle? agentLifecycle, CustomPromptInput? customPromptInput, String? description, String? iconId, List<String>? spaces, List<String>? starterPrompts, String? welcomeMessage}) → Future<CreateAgentResponse>
Creates an agent in Amazon QuickSight.
createAnalysis({required String analysisId, required String awsAccountId, required String name, AnalysisDefinition? definition, List<String>? folderArns, Parameters? parameters, List<ResourcePermission>? permissions, AnalysisSourceEntity? sourceEntity, List<Tag>? tags, String? themeArn, ValidationStrategy? validationStrategy}) → Future<CreateAnalysisResponse>
Creates an analysis in Amazon Quick Sight. Analyses can be created either from a template or from an AnalysisDefinition.
createBrand({required String awsAccountId, required String brandId, BrandDefinition? brandDefinition, List<Tag>? tags}) → Future<CreateBrandResponse>
Creates an Quick Sight brand.
createCustomPermissions({required String awsAccountId, required String customPermissionsName, Capabilities? capabilities, List<Tag>? tags}) → Future<CreateCustomPermissionsResponse>
Creates a custom permissions profile.
createDashboard({required String awsAccountId, required String dashboardId, required String name, DashboardPublishOptions? dashboardPublishOptions, DashboardVersionDefinition? definition, List<String>? folderArns, List<String>? linkEntities, LinkSharingConfiguration? linkSharingConfiguration, Parameters? parameters, List<ResourcePermission>? permissions, DashboardSourceEntity? sourceEntity, List<Tag>? tags, String? themeArn, ValidationStrategy? validationStrategy, String? versionDescription}) → Future<CreateDashboardResponse>
Creates a dashboard from either a template or directly with a DashboardDefinition. To first create a template, see the CreateTemplate API operation.
createDataSet({required String awsAccountId, required String dataSetId, required DataSetImportMode importMode, required String name, required Map<String, PhysicalTable> physicalTableMap, List<ColumnGroup>? columnGroups, List<ColumnLevelPermissionRule>? columnLevelPermissionRules, DataPrepConfiguration? dataPrepConfiguration, DataSetUsageConfiguration? dataSetUsageConfiguration, List<DatasetParameter>? datasetParameters, Map<String, FieldFolder>? fieldFolders, List<String>? folderArns, Map<String, LogicalTable>? logicalTableMap, PerformanceConfiguration? performanceConfiguration, List<ResourcePermission>? permissions, RowLevelPermissionDataSet? rowLevelPermissionDataSet, RowLevelPermissionTagConfiguration? rowLevelPermissionTagConfiguration, SemanticModelConfiguration? semanticModelConfiguration, List<Tag>? tags, DataSetUseAs? useAs}) → Future<CreateDataSetResponse>
Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.
createDataSource({required String awsAccountId, required String dataSourceId, required String name, required DataSourceType type, DataSourceCredentials? credentials, DataSourceParameters? dataSourceParameters, List<String>? folderArns, List<ResourcePermission>? permissions, SslProperties? sslProperties, List<Tag>? tags, VpcConnectionProperties? vpcConnectionProperties}) → Future<CreateDataSourceResponse>
Creates a data source.
createFlow({required String awsAccountId, required Object flowDefinition, required String name, String? clientToken, String? description, List<Permission>? permissions}) → Future<CreateFlowResponse>
Creates a new flow in the specified Amazon Web Services account. Creates both a DRAFT and PUBLISHED (auto-published) version.
createFolder({required String awsAccountId, required String folderId, FolderType? folderType, String? name, String? parentFolderArn, List<ResourcePermission>? permissions, SharingModel? sharingModel, List<Tag>? tags}) → Future<CreateFolderResponse>
Creates an empty shared folder.
createFolderMembership({required String awsAccountId, required String folderId, required String memberId, required MemberType memberType}) → Future<CreateFolderMembershipResponse>
Adds an asset, such as a dashboard, analysis, or dataset into a folder.
createGroup({required String awsAccountId, required String groupName, required String namespace, String? description}) → Future<CreateGroupResponse>
Use the CreateGroup operation to create a group in Quick Sight. You can create up to 10,000 groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact Amazon Web Services Support.
createGroupMembership({required String awsAccountId, required String groupName, required String memberName, required String namespace}) → Future<CreateGroupMembershipResponse>
Adds an Amazon Quick Sight user to an Amazon Quick Sight group.
createIAMPolicyAssignment({required String assignmentName, required AssignmentStatus assignmentStatus, required String awsAccountId, required String namespace, Map<String, List<String>>? identities, String? policyArn}) → Future<CreateIAMPolicyAssignmentResponse>
Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon Quick Sight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.
createIngestion({required String awsAccountId, required String dataSetId, required String ingestionId, IngestionType? ingestionType}) → Future<CreateIngestionResponse>
Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time.
createNamespace({required String awsAccountId, required IdentityStore identityStore, required String namespace, List<Tag>? tags}) → Future<CreateNamespaceResponse>
(Enterprise edition only) Creates a new namespace for you to use with Amazon Quick Sight.
createOAuthClientApplication({required String awsAccountId, required String clientId, required String clientSecret, required String name, required String oAuthClientApplicationId, required OAuthClientAuthenticationType oAuthClientAuthenticationType, required String oAuthTokenEndpointUrl, DataSourceType? dataSourceType, VpcConnectionProperties? identityProviderVpcConnectionProperties, String? oAuthAuthorizationEndpointUrl, String? oAuthScopes, List<Tag>? tags}) → Future<CreateOAuthClientApplicationResponse>
Creates an OAuthClientApplication.
createRefreshSchedule({required String awsAccountId, required String dataSetId, required RefreshSchedule schedule}) → Future<CreateRefreshScheduleResponse>
Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.
createRoleMembership({required String awsAccountId, required String memberName, required String namespace, required Role role}) → Future<CreateRoleMembershipResponse>
Use CreateRoleMembership to add an existing Quick Sight group to an existing role.
createSpace({required String awsAccountId, required String name, required String spaceId, String? description}) → Future<CreateSpaceResponse>
Creates a new Amazon QuickSight space. A space is a collection of resources that can be used to organize and manage QuickSight assets.
createTemplate({required String awsAccountId, required String templateId, TemplateVersionDefinition? definition, String? name, List<ResourcePermission>? permissions, TemplateSourceEntity? sourceEntity, List<Tag>? tags, ValidationStrategy? validationStrategy, String? versionDescription}) → Future<CreateTemplateResponse>
Creates a template either from a TemplateDefinition or from an existing Quick Sight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses.
createTemplateAlias({required String aliasName, required String awsAccountId, required String templateId, required int templateVersionNumber}) → Future<CreateTemplateAliasResponse>
Creates a template alias for a template.
createTheme({required String awsAccountId, required String baseThemeId, required ThemeConfiguration configuration, required String name, required String themeId, List<ResourcePermission>? permissions, List<Tag>? tags, String? versionDescription}) → Future<CreateThemeResponse>
Creates a theme.
createThemeAlias({required String aliasName, required String awsAccountId, required String themeId, required int themeVersionNumber}) → Future<CreateThemeAliasResponse>
Creates a theme alias for a theme.
createTopic({required String awsAccountId, required TopicDetails topic, required String topicId, CustomInstructions? customInstructions, List<String>? folderArns, List<Tag>? tags}) → Future<CreateTopicResponse>
Creates a new Q topic.
createTopicRefreshSchedule({required String awsAccountId, required String datasetArn, required TopicRefreshSchedule refreshSchedule, required String topicId, String? datasetName}) → Future<CreateTopicRefreshScheduleResponse>
Creates a topic refresh schedule.
createVPCConnection({required String awsAccountId, required String name, required String roleArn, required List<String> securityGroupIds, required List<String> subnetIds, required String vPCConnectionId, List<String>? dnsResolvers, List<Tag>? tags}) → Future<CreateVPCConnectionResponse>
Creates a new VPC connection.
deleteAccountCustomization({required String awsAccountId, String? namespace}) → Future<DeleteAccountCustomizationResponse>
May throw AccessDeniedException. May throw ConflictException. May throw InternalFailureException. May throw InvalidParameterValueException. May throw LimitExceededException. May throw PreconditionNotMetException. May throw ResourceNotFoundException. May throw ResourceUnavailableException. May throw ThrottlingException.
deleteAccountCustomPermission({required String awsAccountId}) → Future<DeleteAccountCustomPermissionResponse>
Unapplies a custom permissions profile from an account.
deleteAccountSubscription({required String awsAccountId}) → Future<DeleteAccountSubscriptionResponse>
DeleteAccountSubscription
deleteActionConnector({required String actionConnectorId, required String awsAccountId}) → Future<DeleteActionConnectorResponse>
Hard deletes an action connector, making it unrecoverable. This operation removes the connector and all its associated configurations. Any resources currently using this action connector will no longer be able to perform actions through it.
deleteAgent({required String agentId, required String awsAccountId}) → Future<DeleteAgentResponse>
Deletes an agent.
deleteAnalysis({required String analysisId, required String awsAccountId, bool? forceDeleteWithoutRecovery, int? recoveryWindowInDays}) → Future<DeleteAnalysisResponse>
Deletes an analysis from Amazon Quick Sight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. Amazon Quick Sight attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the end of the recovery window, Amazon Quick Sight deletes the analysis permanently.
deleteBrand({required String awsAccountId, required String brandId}) → Future<DeleteBrandResponse>
May throw AccessDeniedException. May throw ConflictException. May throw InternalServerException. May throw InvalidRequestException. May throw ResourceNotFoundException. May throw ThrottlingException.
deleteBrandAssignment({required String awsAccountId}) → Future<DeleteBrandAssignmentResponse>
Deletes a brand assignment.
deleteCustomPermissions({required String awsAccountId, required String customPermissionsName}) → Future<DeleteCustomPermissionsResponse>
Deletes a custom permissions profile.
deleteDashboard({required String awsAccountId, required String dashboardId, int? versionNumber}) → Future<DeleteDashboardResponse>
Deletes a dashboard.
deleteDataSet({required String awsAccountId, required String dataSetId}) → Future<DeleteDataSetResponse>
Deletes a dataset.
deleteDataSetRefreshProperties({required String awsAccountId, required String dataSetId}) → Future<DeleteDataSetRefreshPropertiesResponse>
Deletes the dataset refresh properties of the dataset.
deleteDataSource({required String awsAccountId, required String dataSourceId}) → Future<DeleteDataSourceResponse>
Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.
deleteDefaultQBusinessApplication({required String awsAccountId, String? namespace}) → Future<DeleteDefaultQBusinessApplicationResponse>
Deletes a linked Amazon Q Business application from an Quick Sight account
deleteFlow({required String awsAccountId, required String flowId}) → Future<DeleteFlowResponse>
Permanently deletes a flow from the specified Amazon Web Services account. This operation cannot be undone.
deleteFolder({required String awsAccountId, required String folderId}) → Future<DeleteFolderResponse>
Deletes an empty folder.
deleteFolderMembership({required String awsAccountId, required String folderId, required String memberId, required MemberType memberType}) → Future<DeleteFolderMembershipResponse>
Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
deleteGroup({required String awsAccountId, required String groupName, required String namespace}) → Future<DeleteGroupResponse>
Removes a user group from Amazon Quick Sight.
deleteGroupMembership({required String awsAccountId, required String groupName, required String memberName, required String namespace}) → Future<DeleteGroupMembershipResponse>
Removes a user from a group so that the user is no longer a member of the group.
deleteIAMPolicyAssignment({required String assignmentName, required String awsAccountId, required String namespace}) → Future<DeleteIAMPolicyAssignmentResponse>
Deletes an existing IAM policy assignment.
deleteIdentityPropagationConfig({required String awsAccountId, required ServiceType service}) → Future<DeleteIdentityPropagationConfigResponse>
Deletes all access scopes and authorized targets that are associated with a service from the Quick Sight IAM Identity Center application.
deleteKnowledgeBase({required String awsAccountId, required String knowledgeBaseId}) → Future<DeleteKnowledgeBaseResponse>
Deletes a knowledge base.
deleteNamespace({required String awsAccountId, required String namespace}) → Future<DeleteNamespaceResponse>
Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset.
deleteOAuthClientApplication({required String awsAccountId, required String oAuthClientApplicationId}) → Future<DeleteOAuthClientApplicationResponse>
Deletes an OAuthClientApplication.
deleteRefreshSchedule({required String awsAccountId, required String dataSetId, required String scheduleId}) → Future<DeleteRefreshScheduleResponse>
Deletes a refresh schedule from a dataset.
deleteRoleCustomPermission({required String awsAccountId, required String namespace, required Role role}) → Future<DeleteRoleCustomPermissionResponse>
Removes custom permissions from the role.
deleteRoleMembership({required String awsAccountId, required String memberName, required String namespace, required Role role}) → Future<DeleteRoleMembershipResponse>
Removes a group from a role.
deleteSpace({required String awsAccountId, required String spaceId}) → Future<DeleteSpaceResponse>
Deletes an Amazon QuickSight space.
deleteTemplate({required String awsAccountId, required String templateId, int? versionNumber}) → Future<DeleteTemplateResponse>
Deletes a template.
deleteTemplateAlias({required String aliasName, required String awsAccountId, required String templateId}) → Future<DeleteTemplateAliasResponse>
Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.
deleteTheme({required String awsAccountId, required String themeId, int? versionNumber}) → Future<DeleteThemeResponse>
Deletes a theme.
deleteThemeAlias({required String aliasName, required String awsAccountId, required String themeId}) → Future<DeleteThemeAliasResponse>
Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.
deleteTopic({required String awsAccountId, required String topicId}) → Future<DeleteTopicResponse>
Deletes a topic.
deleteTopicRefreshSchedule({required String awsAccountId, required String datasetId, required String topicId}) → Future<DeleteTopicRefreshScheduleResponse>
Deletes a topic refresh schedule.
deleteUser({required String awsAccountId, required String namespace, required String userName}) → Future<DeleteUserResponse>
Deletes the Amazon Quick Sight user that is associated with the identity of the IAM user or role that's making the call. The IAM user isn't deleted as a result of this call.
deleteUserByPrincipalId({required String awsAccountId, required String namespace, required String principalId}) → Future<DeleteUserByPrincipalIdResponse>
Deletes a user identified by its principal ID.
deleteUserCustomPermission({required String awsAccountId, required String namespace, required String userName}) → Future<DeleteUserCustomPermissionResponse>
Deletes a custom permissions profile from a user.
deleteVPCConnection({required String awsAccountId, required String vPCConnectionId}) → Future<DeleteVPCConnectionResponse>
Deletes a VPC connection.
describeAccountCustomization({required String awsAccountId, String? namespace, bool? resolved}) → Future<DescribeAccountCustomizationResponse>
Describes the customizations associated with the provided Amazon Web Services account and Amazon Quick Sight namespace. The Quick Sight console evaluates which customizations to apply by running this API operation with the Resolved flag included.
describeAccountCustomPermission({required String awsAccountId}) → Future<DescribeAccountCustomPermissionResponse>
Describes the custom permissions profile that is applied to an account.
describeAccountSettings({required String awsAccountId}) → Future<DescribeAccountSettingsResponse>
Describes the settings that were used when your Quick Sight subscription was first created in this Amazon Web Services account.
describeAccountSubscription({required String awsAccountId}) → Future<DescribeAccountSubscriptionResponse>
Use the DescribeAccountSubscription operation to receive a description of an Quick Sight account's subscription. A successful API call returns an AccountInfo object that includes an account's name, subscription status, authentication type, edition, and notification email address.
describeActionConnector({required String actionConnectorId, required String awsAccountId}) → Future<DescribeActionConnectorResponse>
Retrieves detailed information about an action connector, including its configuration, authentication settings, enabled actions, and current status.
describeActionConnectorPermissions({required String actionConnectorId, required String awsAccountId}) → Future<DescribeActionConnectorPermissionsResponse>
Retrieves the permissions configuration for an action connector, showing which users, groups, and namespaces have access and what operations they can perform.
describeAgent({required String agentId, required String awsAccountId}) → Future<DescribeAgentResponse>
Describes an agent.
describeAgentPermissions({required String agentId, required String awsAccountId}) → Future<DescribeAgentPermissionsResponse>
Describes the resource permissions for an agent.
describeAnalysis({required String analysisId, required String awsAccountId}) → Future<DescribeAnalysisResponse>
Provides a summary of the metadata for an analysis.
describeAnalysisDefinition({required String analysisId, required String awsAccountId}) → Future<DescribeAnalysisDefinitionResponse>
Provides a detailed description of the definition of an analysis.
describeAnalysisPermissions({required String analysisId, required String awsAccountId}) → Future<DescribeAnalysisPermissionsResponse>
Provides the read and write permissions for an analysis.
describeAssetBundleExportJob({required String assetBundleExportJobId, required String awsAccountId}) → Future<DescribeAssetBundleExportJobResponse>
Describes an existing export job.
describeAssetBundleImportJob({required String assetBundleImportJobId, required String awsAccountId}) → Future<DescribeAssetBundleImportJobResponse>
Describes an existing import job.
describeAutomationJob({required String automationGroupId, required String automationId, required String awsAccountId, required String jobId, bool? includeInputPayload, bool? includeOutputPayload}) → Future<DescribeAutomationJobResponse>
Retrieves the status and details of a specified automation job, including its status and outputs.
describeBrand({required String awsAccountId, required String brandId, String? versionId}) → Future<DescribeBrandResponse>
Describes a brand.
describeBrandAssignment({required String awsAccountId}) → Future<DescribeBrandAssignmentResponse>
Describes a brand assignment.
describeBrandPublishedVersion({required String awsAccountId, required String brandId}) → Future<DescribeBrandPublishedVersionResponse>
Describes the published version of the brand.
describeCustomPermissions({required String awsAccountId, required String customPermissionsName}) → Future<DescribeCustomPermissionsResponse>
Describes a custom permissions profile.
describeDashboard({required String awsAccountId, required String dashboardId, String? aliasName, int? versionNumber}) → Future<DescribeDashboardResponse>
Provides a summary for a dashboard.
describeDashboardDefinition({required String awsAccountId, required String dashboardId, String? aliasName, int? versionNumber}) → Future<DescribeDashboardDefinitionResponse>
Provides a detailed description of the definition of a dashboard.
describeDashboardPermissions({required String awsAccountId, required String dashboardId}) → Future<DescribeDashboardPermissionsResponse>
Describes read and write permissions for a dashboard.
describeDashboardSnapshotJob({required String awsAccountId, required String dashboardId, required String snapshotJobId}) → Future<DescribeDashboardSnapshotJobResponse>
Describes an existing snapshot job.
describeDashboardSnapshotJobResult({required String awsAccountId, required String dashboardId, required String snapshotJobId}) → Future<DescribeDashboardSnapshotJobResultResponse>
Describes the result of an existing snapshot job that has finished running.
describeDashboardsQAConfiguration({required String awsAccountId}) → Future<DescribeDashboardsQAConfigurationResponse>
Describes an existing dashboard QA configuration.
describeDataSet({required String awsAccountId, required String dataSetId}) → Future<DescribeDataSetResponse>
Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.
describeDataSetPermissions({required String awsAccountId, required String dataSetId}) → Future<DescribeDataSetPermissionsResponse>
Describes the permissions on a dataset.
describeDataSetRefreshProperties({required String awsAccountId, required String dataSetId}) → Future<DescribeDataSetRefreshPropertiesResponse>
Describes the refresh properties of a dataset.
describeDataSource({required String awsAccountId, required String dataSourceId}) → Future<DescribeDataSourceResponse>
Describes a data source.
describeDataSourcePermissions({required String awsAccountId, required String dataSourceId}) → Future<DescribeDataSourcePermissionsResponse>
Describes the resource permissions for a data source.
describeDefaultQBusinessApplication({required String awsAccountId, String? namespace}) → Future<DescribeDefaultQBusinessApplicationResponse>
Describes a Amazon Q Business application that is linked to an Quick Sight account.
describeFlow({required String awsAccountId, required String flowId, required FlowPublishState publishState}) → Future<DescribeFlowResponse>
Returns the full details of a flow for the latest version of the requested publish state.
describeFolder({required String awsAccountId, required String folderId}) → Future<DescribeFolderResponse>
Describes a folder.
describeFolderPermissions({required String awsAccountId, required String folderId, int? maxResults, String? namespace, String? nextToken}) → Future<DescribeFolderPermissionsResponse>
Describes permissions for a folder.
describeFolderResolvedPermissions({required String awsAccountId, required String folderId, int? maxResults, String? namespace, String? nextToken}) → Future<DescribeFolderResolvedPermissionsResponse>
Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.
describeGroup({required String awsAccountId, required String groupName, required String namespace}) → Future<DescribeGroupResponse>
Returns an Amazon Quick Sight group's description and Amazon Resource Name (ARN).
describeGroupMembership({required String awsAccountId, required String groupName, required String memberName, required String namespace}) → Future<DescribeGroupMembershipResponse>
Use the DescribeGroupMembership operation to determine if a user is a member of the specified group. If the user exists and is a member of the specified group, an associated GroupMember object is returned.
describeIAMPolicyAssignment({required String assignmentName, required String awsAccountId, required String namespace}) → Future<DescribeIAMPolicyAssignmentResponse>
Describes an existing IAM policy assignment, as specified by the assignment name.
describeIngestion({required String awsAccountId, required String dataSetId, required String ingestionId}) → Future<DescribeIngestionResponse>
Describes a SPICE ingestion.
describeIpRestriction({required String awsAccountId}) → Future<DescribeIpRestrictionResponse>
Provides a summary and status of IP rules.
describeKeyRegistration({required String awsAccountId, bool? defaultKeyOnly}) → Future<DescribeKeyRegistrationResponse>
Describes all customer managed key registrations in a Quick Sight account.
describeKnowledgeBase({required String awsAccountId, required String knowledgeBaseId}) → Future<DescribeKnowledgeBaseResponse>
Describes a knowledge base.
describeKnowledgeBasePermissions({required String awsAccountId, required String knowledgeBaseId}) → Future<DescribeKnowledgeBasePermissionsResponse>
Describes the resource permissions for a knowledge base.
describeNamespace({required String awsAccountId, required String namespace}) → Future<DescribeNamespaceResponse>
Describes the current namespace.
describeOAuthClientApplication({required String awsAccountId, required String oAuthClientApplicationId}) → Future<DescribeOAuthClientApplicationResponse>
Describes an OAuthClientApplication.
describeQPersonalizationConfiguration({required String awsAccountId}) → Future<DescribeQPersonalizationConfigurationResponse>
Describes a personalization configuration.
describeQuickSightQSearchConfiguration({required String awsAccountId}) → Future<DescribeQuickSightQSearchConfigurationResponse>
Describes the state of a Quick Sight Q Search configuration.
describeRefreshSchedule({required String awsAccountId, required String dataSetId, required String scheduleId}) → Future<DescribeRefreshScheduleResponse>
Provides a summary of a refresh schedule.
describeRoleCustomPermission({required String awsAccountId, required String namespace, required Role role}) → Future<DescribeRoleCustomPermissionResponse>
Describes all custom permissions that are mapped to a role.
describeSelfUpgradeConfiguration({required String awsAccountId, required String namespace}) → Future<DescribeSelfUpgradeConfigurationResponse>
Describes the self-upgrade configuration for a Quick account.
describeSpace({required String awsAccountId, required String spaceId, int? maxContributors}) → Future<DescribeSpaceResponse>
Describes an Amazon QuickSight space.
describeSpacePermissions({required String awsAccountId, required String spaceId}) → Future<DescribeSpacePermissionsResponse>
Describes the permissions for an Amazon QuickSight space.
describeTemplate({required String awsAccountId, required String templateId, String? aliasName, int? versionNumber}) → Future<DescribeTemplateResponse>
Describes a template's metadata.
describeTemplateAlias({required String aliasName, required String awsAccountId, required String templateId}) → Future<DescribeTemplateAliasResponse>
Describes the template alias for a template.
describeTemplateDefinition({required String awsAccountId, required String templateId, String? aliasName, int? versionNumber}) → Future<DescribeTemplateDefinitionResponse>
Provides a detailed description of the definition of a template.
describeTemplatePermissions({required String awsAccountId, required String templateId}) → Future<DescribeTemplatePermissionsResponse>
Describes read and write permissions on a template.
describeTheme({required String awsAccountId, required String themeId, String? aliasName, int? versionNumber}) → Future<DescribeThemeResponse>
Describes a theme.
describeThemeAlias({required String aliasName, required String awsAccountId, required String themeId}) → Future<DescribeThemeAliasResponse>
Describes the alias for a theme.
describeThemePermissions({required String awsAccountId, required String themeId}) → Future<DescribeThemePermissionsResponse>
Describes the read and write permissions for a theme.
describeTopic({required String awsAccountId, required String topicId}) → Future<DescribeTopicResponse>
Describes a topic.
describeTopicPermissions({required String awsAccountId, required String topicId}) → Future<DescribeTopicPermissionsResponse>
Describes the permissions of a topic.
describeTopicRefresh({required String awsAccountId, required String refreshId, required String topicId}) → Future<DescribeTopicRefreshResponse>
Describes the status of a topic refresh.
describeTopicRefreshSchedule({required String awsAccountId, required String datasetId, required String topicId}) → Future<DescribeTopicRefreshScheduleResponse>
Deletes a topic refresh schedule.
describeUser({required String awsAccountId, required String namespace, required String userName}) → Future<DescribeUserResponse>
Returns information about a user, given the user name.
describeVPCConnection({required String awsAccountId, required String vPCConnectionId}) → Future<DescribeVPCConnectionResponse>
Describes a VPC connection.
generateEmbedUrlForAnonymousUser({required List<String> authorizedResourceArns, required String awsAccountId, required AnonymousUserEmbeddingExperienceConfiguration experienceConfiguration, required String namespace, List<String>? allowedDomains, int? sessionLifetimeInMinutes, List<SessionTag>? sessionTags}) → Future<GenerateEmbedUrlForAnonymousUserResponse>
Generates an embed URL that you can use to embed an Amazon Quick dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.
generateEmbedUrlForRegisteredUser({required String awsAccountId, required RegisteredUserEmbeddingExperienceConfiguration experienceConfiguration, required String userArn, List<String>? allowedDomains, int? sessionLifetimeInMinutes}) → Future<GenerateEmbedUrlForRegisteredUserResponse>
Generates an embed URL that you can use to embed an Amazon Quick experience in your website. This action can be used for any type of user registered in an Amazon Quick account. Before you use this action, make sure that you have configured the relevant Amazon Quick resource and permissions.
generateEmbedUrlForRegisteredUserWithIdentity({required String awsAccountId, required RegisteredUserEmbeddingExperienceConfiguration experienceConfiguration, List<String>? allowedDomains, int? sessionLifetimeInMinutes}) → Future<GenerateEmbedUrlForRegisteredUserWithIdentityResponse>
Generates an embed URL that you can use to embed an Amazon Quick Sight experience in your website. This action can be used for any type of user that is registered in an Amazon Quick Sight account that uses IAM Identity Center for authentication. This API requires identity-enhanced IAM Role sessions for the authenticated user that the API call is being made for.
getDashboardEmbedUrl({required String awsAccountId, required String dashboardId, required EmbeddingIdentityType identityType, List<String>? additionalDashboardIds, String? namespace, bool? resetDisabled, int? sessionLifetimeInMinutes, bool? statePersistenceEnabled, bool? undoRedoDisabled, String? userArn}) → Future<GetDashboardEmbedUrlResponse>
Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon Quick Sight read-only dashboard in your website or application. Before you use this command, make sure that you have configured the dashboards and permissions.
getFlowMetadata({required String awsAccountId, required String flowId}) → Future<GetFlowMetadataOutput>
Retrieves the metadata of a flow, not including its definition specifying the steps.
getFlowPermissions({required String awsAccountId, required String flowId}) → Future<GetFlowPermissionsOutput>
Get permissions for a flow.
getIdentityContext({required String awsAccountId, required UserIdentifier userIdentifier, String? contextRegion, String? namespace, DateTime? sessionExpiresAt}) → Future<GetIdentityContextResponse>
Retrieves the identity context for a Quick Sight user in a specified namespace, allowing you to obtain identity tokens that can be used with identity-enhanced IAM role sessions to call identity-aware APIs.
getSessionEmbedUrl({required String awsAccountId, String? entryPoint, int? sessionLifetimeInMinutes, String? userArn}) → Future<GetSessionEmbedUrlResponse>
Generates a session URL and authorization code that you can use to embed the Amazon Amazon Quick Sight console in your web server code. Use GetSessionEmbedUrl where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded Amazon Quick Sight console need belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the UpdateUser API operation. Use RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon Quick User Guide:
listActionConnectors({required String awsAccountId, int? maxResults, String? nextToken}) → Future<ListActionConnectorsResponse>
Lists all action connectors in the specified Amazon Web Services account. Returns summary information for each connector including its name, type, creation time, and status.
listAgents({required String awsAccountId, int? maxResults, String? nextToken}) → Future<ListAgentsResponse>
Lists all agents in an Amazon QuickSight account.
listAnalyses({required String awsAccountId, int? maxResults, String? nextToken}) → Future<ListAnalysesResponse>
Lists Amazon Quick Sight analyses that exist in the specified Amazon Web Services account.
listAssetBundleExportJobs({required String awsAccountId, int? maxResults, String? nextToken}) → Future<ListAssetBundleExportJobsResponse>
Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleExportJobs only returns the most recent job that uses the repeated job ID.
listAssetBundleImportJobs({required String awsAccountId, int? maxResults, String? nextToken}) → Future<ListAssetBundleImportJobsResponse>
Lists all asset bundle import jobs that have taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleImportJobs only returns the most recent job that uses the repeated job ID.
listBrands({required String awsAccountId, int? maxResults, String? nextToken}) → Future<ListBrandsResponse>
Lists all brands in an Quick Sight account.
listCustomPermissions({required String awsAccountId, int? maxResults, String? nextToken}) → Future<ListCustomPermissionsResponse>
Returns a list of all the custom permissions profiles.
listDashboards({required String awsAccountId, int? maxResults, String? nextToken}) → Future<ListDashboardsResponse>
Lists dashboards in an Amazon Web Services account.
listDashboardVersions({required String awsAccountId, required String dashboardId, int? maxResults, String? nextToken}) → Future<ListDashboardVersionsResponse>
Lists all the versions of the dashboards in the Amazon Quick Sight subscription.
listDataSets({required String awsAccountId, int? maxResults, String? nextToken}) → Future<ListDataSetsResponse>
Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.
listDataSources({required String awsAccountId, int? maxResults, String? nextToken}) → Future<ListDataSourcesResponse>
Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
listFlows({required String awsAccountId, int? maxResults, String? nextToken}) → Future<ListFlowsOutput>
Lists flows in an Amazon Web Services account.
listFolderMembers({required String awsAccountId, required String folderId, int? maxResults, String? nextToken}) → Future<ListFolderMembersResponse>
List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.
listFolders({required String awsAccountId, int? maxResults, String? nextToken}) → Future<ListFoldersResponse>
Lists all folders in an account.
listFoldersForResource({required String awsAccountId, required String resourceArn, int? maxResults, String? nextToken}) → Future<ListFoldersForResourceResponse>
List all folders that a resource is a member of.
listGroupMemberships({required String awsAccountId, required String groupName, required String namespace, int? maxResults, String? nextToken}) → Future<ListGroupMembershipsResponse>
Lists member users in a group.
listGroups({required String awsAccountId, required String namespace, int? maxResults, String? nextToken}) → Future<ListGroupsResponse>
Lists all user groups in Amazon Quick Sight.
listIAMPolicyAssignments({required String awsAccountId, required String namespace, AssignmentStatus? assignmentStatus, int? maxResults, String? nextToken}) → Future<ListIAMPolicyAssignmentsResponse>
Lists the IAM policy assignments in the current Amazon Quick Sight account.
listIAMPolicyAssignmentsForUser({required String awsAccountId, required String namespace, required String userName, int? maxResults, String? nextToken}) → Future<ListIAMPolicyAssignmentsForUserResponse>
Lists all of the IAM policy assignments, including the Amazon Resource Names (ARNs), for the IAM policies assigned to the specified user and group, or groups that the user belongs to.
listIdentityPropagationConfigs({required String awsAccountId, int? maxResults, String? nextToken}) → Future<ListIdentityPropagationConfigsResponse>
Lists all services and authorized targets that the Quick Sight IAM Identity Center application can access.
listIngestions({required String awsAccountId, required String dataSetId, int? maxResults, String? nextToken}) → Future<ListIngestionsResponse>
Lists the history of SPICE ingestions for a dataset. Limited to 5 TPS per user and 25 TPS per account.
listKnowledgeBases({required String awsAccountId, int? maxResults, String? nextToken}) → Future<ListKnowledgeBasesResponse>
Lists all knowledge bases in an Amazon QuickSight account.
listNamespaces({required String awsAccountId, int? maxResults, String? nextToken}) → Future<ListNamespacesResponse>
Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.
listOAuthClientApplications({required String awsAccountId, int? maxResults, String? nextToken}) → Future<ListOAuthClientApplicationsResponse>
Lists all OAuthClientApplications in the current Amazon Web Services Region that belong to this Amazon Web Services account.
listRefreshSchedules({required String awsAccountId, required String dataSetId}) → Future<ListRefreshSchedulesResponse>
Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.
listRoleMemberships({required String awsAccountId, required String namespace, required Role role, int? maxResults, String? nextToken}) → Future<ListRoleMembershipsResponse>
Lists all groups that are associated with a role.
listSelfUpgrades({required String awsAccountId, required String namespace, int? maxResults, String? nextToken}) → Future<ListSelfUpgradesResponse>
Lists all self-upgrade requests for a Quick account.
listSpaceResources({required String awsAccountId, required String spaceId}) → Future<ListSpaceResourcesResponse>
Lists the resources in an Amazon QuickSight space.
listSpaces({required String awsAccountId, int? maxResults, String? nextToken}) → Future<ListSpacesResponse>
Lists all Amazon QuickSight spaces in an Amazon Web Services account.
listTagsForResource({required String resourceArn}) → Future<ListTagsForResourceResponse>
Lists the tags assigned to a resource.
listTemplateAliases({required String awsAccountId, required String templateId, int? maxResults, String? nextToken}) → Future<ListTemplateAliasesResponse>
Lists all the aliases of a template.
listTemplates({required String awsAccountId, int? maxResults, String? nextToken}) → Future<ListTemplatesResponse>
Lists all the templates in the current Amazon Quick Sight account.
listTemplateVersions({required String awsAccountId, required String templateId, int? maxResults, String? nextToken}) → Future<ListTemplateVersionsResponse>
Lists all the versions of the templates in the current Amazon Quick Sight account.
listThemeAliases({required String awsAccountId, required String themeId, int? maxResults, String? nextToken}) → Future<ListThemeAliasesResponse>
Lists all the aliases of a theme.
listThemes({required String awsAccountId, int? maxResults, String? nextToken, ThemeType? type}) → Future<ListThemesResponse>
Lists all the themes in the current Amazon Web Services account.
listThemeVersions({required String awsAccountId, required String themeId, int? maxResults, String? nextToken}) → Future<ListThemeVersionsResponse>
Lists all the versions of the themes in the current Amazon Web Services account.
listTopicRefreshSchedules({required String awsAccountId, required String topicId}) → Future<ListTopicRefreshSchedulesResponse>
Lists all of the refresh schedules for a topic.
listTopicReviewedAnswers({required String awsAccountId, required String topicId}) → Future<ListTopicReviewedAnswersResponse>
Lists all reviewed answers for a Q Topic.
listTopics({required String awsAccountId, int? maxResults, String? nextToken}) → Future<ListTopicsResponse>
Lists all of the topics within an account.
listUserGroups({required String awsAccountId, required String namespace, required String userName, int? maxResults, String? nextToken}) → Future<ListUserGroupsResponse>
Lists the Amazon Quick Sight groups that an Amazon Quick Sight user is a member of.
listUsers({required String awsAccountId, required String namespace, int? maxResults, String? nextToken}) → Future<ListUsersResponse>
Returns a list of all of the Amazon Quick Sight users belonging to this account.
listUsersIndexCapacity({required String awsAccountId, List<UserIndexCapacityFilter>? filters, int? maxResults, String? namespace, String? nextToken, UserIndexCapacitySortBy? sortBy, UserIndexCapacitySortOrder? sortOrder}) → Future<ListUsersIndexCapacityResponse>
Lists per-user index capacity consumption for an account.
listVPCConnections({required String awsAccountId, int? maxResults, String? nextToken}) → Future<ListVPCConnectionsResponse>
Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
predictQAResults({required String awsAccountId, required String queryText, IncludeGeneratedAnswer? includeGeneratedAnswer, IncludeQuickSightQIndex? includeQuickSightQIndex, int? maxTopicsToConsider}) → Future<PredictQAResultsResponse>
Predicts existing visuals or generates new visuals to answer a given query.
putDataSetRefreshProperties({required String awsAccountId, required String dataSetId, required DataSetRefreshProperties dataSetRefreshProperties}) → Future<PutDataSetRefreshPropertiesResponse>
Creates or updates the dataset refresh properties for the dataset.
registerUser({required String awsAccountId, required String email, required IdentityType identityType, required String namespace, required UserRole userRole, String? customFederationProviderUrl, String? customPermissionsName, String? externalLoginFederationProviderType, String? externalLoginId, String? iamArn, String? sessionName, List<Tag>? tags, String? userName}) → Future<RegisterUserResponse>
Creates an Amazon Quick Sight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Quick Sight API, Quick Sight generates a registration URL. The user accesses this registration URL to create their account. Quick Sight doesn't send a registration email to users who are registered from the Quick Sight API. If you want new users to receive a registration email, then add those users in the Quick Sight console. For more information on registering a new user in the Quick Sight console, see Inviting users to access Quick Sight.
restoreAnalysis({required String analysisId, required String awsAccountId, bool? restoreToFolders}) → Future<RestoreAnalysisResponse>
Restores an analysis.
searchActionConnectors({required String awsAccountId, required List<ActionConnectorSearchFilter> filters, int? maxResults, String? nextToken}) → Future<SearchActionConnectorsResponse>
Searches for action connectors in the specified Amazon Web Services account using filters. You can search by connector name, type, or user permissions.
searchAgents({required String awsAccountId, required List<AgentSearchFilter> filters, int? maxResults, String? nextToken}) → Future<SearchAgentsResponse>
Searches for agents based on specified filters.
searchAnalyses({required String awsAccountId, required List<AnalysisSearchFilter> filters, int? maxResults, String? nextToken}) → Future<SearchAnalysesResponse>
Searches for analyses that belong to the user specified in the filter.
searchDashboards({required String awsAccountId, required List<DashboardSearchFilter> filters, int? maxResults, String? nextToken}) → Future<SearchDashboardsResponse>
Searches for dashboards that belong to a user.
searchDataSets({required String awsAccountId, required List<DataSetSearchFilter> filters, int? maxResults, String? nextToken}) → Future<SearchDataSetsResponse>
Use the SearchDataSets operation to search for datasets that belong to an account.
searchDataSources({required String awsAccountId, required List<DataSourceSearchFilter> filters, int? maxResults, String? nextToken}) → Future<SearchDataSourcesResponse>
Use the SearchDataSources operation to search for data sources that belong to an account.
searchFlows({required String awsAccountId, required List<SearchFlowsFilter> filters, int? maxResults, String? nextToken}) → Future<SearchFlowsOutput>
Search for the flows in an Amazon Web Services account.
searchFolders({required String awsAccountId, required List<FolderSearchFilter> filters, int? maxResults, String? nextToken}) → Future<SearchFoldersResponse>
Searches the subfolders in a folder.
searchGroups({required String awsAccountId, required List<GroupSearchFilter> filters, required String namespace, int? maxResults, String? nextToken}) → Future<SearchGroupsResponse>
Use the SearchGroups operation to search groups in a specified Quick Sight namespace using the supplied filters.
searchKnowledgeBases({required String awsAccountId, List<KnowledgeBaseSearchFilter>? filters, int? maxResults, String? nextToken, KnowledgeBaseSortBy? sortBy}) → Future<SearchKnowledgeBasesResponse>
Searches for a subset of knowledge bases based on specified filters.
searchSpaces({required String awsAccountId, required List<SpaceQuicksightSearchFilter> filters, int? maxResults, String? nextToken}) → Future<SearchSpacesResponse>
Searches for Amazon QuickSight spaces that match the specified filters.
searchTopics({required String awsAccountId, required List<TopicSearchFilter> filters, int? maxResults, String? nextToken}) → Future<SearchTopicsResponse>
Searches for any Q topic that exists in an Quick account.
startAssetBundleExportJob({required String assetBundleExportJobId, required String awsAccountId, required AssetBundleExportFormat exportFormat, required List<String> resourceArns, AssetBundleCloudFormationOverridePropertyConfiguration? cloudFormationOverridePropertyConfiguration, bool? includeAllDependencies, IncludeFolderMembers? includeFolderMembers, bool? includeFolderMemberships, bool? includePermissions, bool? includeTags, AssetBundleExportJobValidationStrategy? validationStrategy}) → Future<StartAssetBundleExportJobResponse>
Starts an Asset Bundle export job.
startAssetBundleImportJob({required String assetBundleImportJobId, required AssetBundleImportSource assetBundleImportSource, required String awsAccountId, AssetBundleImportFailureAction? failureAction, AssetBundleImportJobOverrideParameters? overrideParameters, AssetBundleImportJobOverridePermissions? overridePermissions, AssetBundleImportJobOverrideTags? overrideTags, AssetBundleImportJobOverrideValidationStrategy? overrideValidationStrategy}) → Future<StartAssetBundleImportJobResponse>
Starts an Asset Bundle import job.
startAutomationJob({required String automationGroupId, required String automationId, required String awsAccountId, String? inputPayload}) → Future<StartAutomationJobResponse>
Starts a new job for a specified automation. The job runs the automation with the provided input payload.
startDashboardSnapshotJob({required String awsAccountId, required String dashboardId, required SnapshotConfiguration snapshotConfiguration, required String snapshotJobId, SnapshotUserConfiguration? userConfiguration}) → Future<StartDashboardSnapshotJobResponse>
Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call.
startDashboardSnapshotJobSchedule({required String awsAccountId, required String dashboardId, required String scheduleId}) → Future<StartDashboardSnapshotJobScheduleResponse>
Starts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email.
tagResource({required String resourceArn, required List<Tag> tags}) → Future<TagResourceResponse>
Assigns one or more tags (key-value pairs) to the specified Amazon Quick Sight resource.
toString() → String
A string representation of this object.
inherited
untagResource({required String resourceArn, required List<String> tagKeys}) → Future<UntagResourceResponse>
Removes a tag or tags from a resource.
updateAccountCustomization({required AccountCustomization accountCustomization, required String awsAccountId, String? namespace}) → Future<UpdateAccountCustomizationResponse>
Updates Amazon Quick Sight customizations. Currently, the only customization that you can use is a theme.
updateAccountCustomPermission({required String awsAccountId, required String customPermissionsName}) → Future<UpdateAccountCustomPermissionResponse>
Applies a custom permissions profile to an account.
updateAccountSettings({required String awsAccountId, required String defaultNamespace, String? notificationEmail, bool? terminationProtectionEnabled}) → Future<UpdateAccountSettingsResponse>
Updates the Amazon Quick Sight settings in your Amazon Web Services account.
updateActionConnector({required String actionConnectorId, required AuthConfig authenticationConfig, required String awsAccountId, required String name, String? description, String? vpcConnectionArn}) → Future<UpdateActionConnectorResponse>
Updates an existing action connector with new configuration details, authentication settings, or enabled actions. You can modify the connector's name, description, authentication configuration, and which actions are enabled. For more information, https://docs.aws.amazon.com/quicksuite/latest/userguide/quick-action-auth.html.
updateActionConnectorPermissions({required String actionConnectorId, required String awsAccountId, List<ResourcePermission>? grantPermissions, List<ResourcePermission>? revokePermissions}) → Future<UpdateActionConnectorPermissionsResponse>
Updates the permissions for an action connector by granting or revoking access for specific users and groups. You can control who can view, use, or manage the action connector.
updateAgent({required String agentId, required String awsAccountId, required String name, List<String>? actionConnectorsToAdd, List<String>? actionConnectorsToRemove, CustomPromptInput? customPromptInput, String? description, String? iconId, List<String>? spacesToAdd, List<String>? spacesToRemove, List<String>? starterPrompts, String? welcomeMessage}) → Future<UpdateAgentResponse>
Updates an existing agent.
updateAgentPermissions({required String agentId, required String awsAccountId, List<ResourcePermission>? grantPermissions, List<ResourcePermission>? revokePermissions}) → Future<UpdateAgentPermissionsResponse>
Updates the resource permissions for an agent.
updateAnalysis({required String analysisId, required String awsAccountId, required String name, AnalysisDefinition? definition, Parameters? parameters, AnalysisSourceEntity? sourceEntity, String? themeArn, ValidationStrategy? validationStrategy}) → Future<UpdateAnalysisResponse>
Updates an analysis in Amazon Quick Sight
updateAnalysisPermissions({required String analysisId, required String awsAccountId, List<ResourcePermission>? grantPermissions, List<ResourcePermission>? revokePermissions}) → Future<UpdateAnalysisPermissionsResponse>
Updates the read and write permissions for an analysis.
updateApplicationWithTokenExchangeGrant({required String awsAccountId, required String namespace}) → Future<UpdateApplicationWithTokenExchangeGrantResponse>
Updates an Quick application with a token exchange grant. This operation only supports Quick applications that are registered with IAM Identity Center.
updateBrand({required String awsAccountId, required String brandId, BrandDefinition? brandDefinition}) → Future<UpdateBrandResponse>
Updates a brand.
updateBrandAssignment({required String awsAccountId, required String brandArn}) → Future<UpdateBrandAssignmentResponse>
Updates a brand assignment.
updateBrandPublishedVersion({required String awsAccountId, required String brandId, required String versionId}) → Future<UpdateBrandPublishedVersionResponse>
Updates the published version of a brand.
updateCustomPermissions({required String awsAccountId, required String customPermissionsName, Capabilities? capabilities}) → Future<UpdateCustomPermissionsResponse>
Updates a custom permissions profile.
updateDashboard({required String awsAccountId, required String dashboardId, required String name, DashboardPublishOptions? dashboardPublishOptions, DashboardVersionDefinition? definition, Parameters? parameters, DashboardSourceEntity? sourceEntity, String? themeArn, ValidationStrategy? validationStrategy, String? versionDescription}) → Future<UpdateDashboardResponse>
Updates a dashboard in an Amazon Web Services account.
Updates the linked analyses on a dashboard.
updateDashboardPermissions({required String awsAccountId, required String dashboardId, List<ResourcePermission>? grantLinkPermissions, List<ResourcePermission>? grantPermissions, List<ResourcePermission>? revokeLinkPermissions, List<ResourcePermission>? revokePermissions}) → Future<UpdateDashboardPermissionsResponse>
Updates read and write permissions on a dashboard.
updateDashboardPublishedVersion({required String awsAccountId, required String dashboardId, required int versionNumber}) → Future<UpdateDashboardPublishedVersionResponse>
Updates the published version of a dashboard.
updateDashboardsQAConfiguration({required String awsAccountId, required DashboardsQAStatus dashboardsQAStatus}) → Future<UpdateDashboardsQAConfigurationResponse>
Updates a Dashboard QA configuration.
updateDataSet({required String awsAccountId, required String dataSetId, required DataSetImportMode importMode, required String name, required Map<String, PhysicalTable> physicalTableMap, List<ColumnGroup>? columnGroups, List<ColumnLevelPermissionRule>? columnLevelPermissionRules, DataPrepConfiguration? dataPrepConfiguration, DataSetUsageConfiguration? dataSetUsageConfiguration, List<DatasetParameter>? datasetParameters, Map<String, FieldFolder>? fieldFolders, Map<String, LogicalTable>? logicalTableMap, PerformanceConfiguration? performanceConfiguration, RowLevelPermissionDataSet? rowLevelPermissionDataSet, RowLevelPermissionTagConfiguration? rowLevelPermissionTagConfiguration, SemanticModelConfiguration? semanticModelConfiguration}) → Future<UpdateDataSetResponse>
Updates a dataset. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation.
updateDataSetPermissions({required String awsAccountId, required String dataSetId, List<ResourcePermission>? grantPermissions, List<ResourcePermission>? revokePermissions}) → Future<UpdateDataSetPermissionsResponse>
Updates the permissions on a dataset.
updateDataSource({required String awsAccountId, required String dataSourceId, required String name, DataSourceCredentials? credentials, DataSourceParameters? dataSourceParameters, SslProperties? sslProperties, VpcConnectionProperties? vpcConnectionProperties}) → Future<UpdateDataSourceResponse>
Updates a data source.
updateDataSourcePermissions({required String awsAccountId, required String dataSourceId, List<ResourcePermission>? grantPermissions, List<ResourcePermission>? revokePermissions}) → Future<UpdateDataSourcePermissionsResponse>
Updates the permissions to a data source.
updateDefaultQBusinessApplication({required String applicationId, required String awsAccountId, String? namespace}) → Future<UpdateDefaultQBusinessApplicationResponse>
Updates a Amazon Q Business application that is linked to a Quick Sight account.
updateFlow({required String awsAccountId, required String flowId, String? clientToken, String? description, Object? flowDefinition, String? name}) → Future<UpdateFlowResponse>
Updates an existing flow. Supply only the fields you want to change. Updates both DRAFT and PUBLISHED versions. When FlowDefinition is provided, all existing steps are replaced with the new definition.
updateFlowPermissions({required String awsAccountId, required String flowId, List<Permission>? grantPermissions, List<Permission>? revokePermissions}) → Future<UpdateFlowPermissionsOutput>
Updates permissions against principals on a flow.
updateFolder({required String awsAccountId, required String folderId, required String name}) → Future<UpdateFolderResponse>
Updates the name of a folder.
updateFolderPermissions({required String awsAccountId, required String folderId, List<ResourcePermission>? grantPermissions, List<ResourcePermission>? revokePermissions}) → Future<UpdateFolderPermissionsResponse>
Updates permissions of a folder.
updateGroup({required String awsAccountId, required String groupName, required String namespace, String? description}) → Future<UpdateGroupResponse>
Changes a group description.
updateIAMPolicyAssignment({required String assignmentName, required String awsAccountId, required String namespace, AssignmentStatus? assignmentStatus, Map<String, List<String>>? identities, String? policyArn}) → Future<UpdateIAMPolicyAssignmentResponse>
Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request. This overwrites all of the users included in Identities.
updateIdentityPropagationConfig({required String awsAccountId, required ServiceType service, List<String>? authorizedTargets}) → Future<UpdateIdentityPropagationConfigResponse>
Adds or updates services and authorized targets to configure what the Quick Sight IAM Identity Center application can access.
updateIpRestriction({required String awsAccountId, bool? enabled, Map<String, String>? ipRestrictionRuleMap, Map<String, String>? vpcEndpointIdRestrictionRuleMap, Map<String, String>? vpcIdRestrictionRuleMap}) → Future<UpdateIpRestrictionResponse>
Updates the content and status of IP rules. Traffic from a source is allowed when the source satisfies either the IpRestrictionRule, VpcIdRestrictionRule, or VpcEndpointIdRestrictionRule. To use this operation, you must provide the entire map of rules. You can use the DescribeIpRestriction operation to get the current rule map.
updateKeyRegistration({required String awsAccountId, required List<RegisteredCustomerManagedKey> keyRegistration}) → Future<UpdateKeyRegistrationResponse>
Updates a customer managed key in a Quick Sight account.
updateKnowledgeBasePermissions({required String awsAccountId, required String knowledgeBaseId, List<ResourcePermission>? grantPermissions, List<ResourcePermission>? revokePermissions}) → Future<UpdateKnowledgeBasePermissionsResponse>
Updates the resource permissions for a knowledge base.
updateOAuthClientApplication({required String awsAccountId, required String name, required String oAuthClientApplicationId, String? clientId, String? clientSecret, DataSourceType? dataSourceType, VpcConnectionProperties? identityProviderVpcConnectionProperties, String? oAuthAuthorizationEndpointUrl, String? oAuthScopes, String? oAuthTokenEndpointUrl}) → Future<UpdateOAuthClientApplicationResponse>
Updates an OAuthClientApplication.
updatePublicSharingSettings({required String awsAccountId, bool? publicSharingEnabled}) → Future<UpdatePublicSharingSettingsResponse>
UpdatePublicSharingSettings
updateQPersonalizationConfiguration({required String awsAccountId, required PersonalizationMode personalizationMode}) → Future<UpdateQPersonalizationConfigurationResponse>
Updates a personalization configuration.
updateQuickSightQSearchConfiguration({required String awsAccountId, required QSearchStatus qSearchStatus}) → Future<UpdateQuickSightQSearchConfigurationResponse>
Updates the state of a Quick Sight Q Search configuration.
updateRefreshSchedule({required String awsAccountId, required String dataSetId, required RefreshSchedule schedule}) → Future<UpdateRefreshScheduleResponse>
Updates a refresh schedule for a dataset.
updateRoleCustomPermission({required String awsAccountId, required String customPermissionsName, required String namespace, required Role role}) → Future<UpdateRoleCustomPermissionResponse>
Updates the custom permissions that are associated with a role.
updateSelfUpgrade({required SelfUpgradeAdminAction action, required String awsAccountId, required String namespace, required String upgradeRequestId}) → Future<UpdateSelfUpgradeResponse>
Updates a self-upgrade request for a Quick user by approving, denying, or verifying the request.
updateSelfUpgradeConfiguration({required String awsAccountId, required String namespace, required SelfUpgradeStatus selfUpgradeStatus}) → Future<UpdateSelfUpgradeConfigurationResponse>
Updates the self-upgrade configuration for a Quick account.
updateSpace({required String awsAccountId, required String spaceId, String? description, String? name}) → Future<UpdateSpaceResponse>
Updates the metadata of an Amazon QuickSight space.
updateSpacePermissions({required String awsAccountId, required String spaceId, List<ResourcePermission>? grantPermissions, List<ResourcePermission>? revokePermissions}) → Future<UpdateSpacePermissionsResponse>
Updates the permissions for an Amazon QuickSight space.
updateSpaceResources({required String awsAccountId, required String spaceId, List<SpaceResourceOperation>? addResources, List<SpaceResourceOperation>? removeResources}) → Future<UpdateSpaceResourcesResponse>
Adds or removes resources from an Amazon QuickSight space.
updateSPICECapacityConfiguration({required String awsAccountId, required PurchaseMode purchaseMode}) → Future<UpdateSPICECapacityConfigurationResponse>
Updates the SPICE capacity configuration for a Quick Sight account.
updateTemplate({required String awsAccountId, required String templateId, TemplateVersionDefinition? definition, String? name, TemplateSourceEntity? sourceEntity, ValidationStrategy? validationStrategy, String? versionDescription}) → Future<UpdateTemplateResponse>
Updates a template from an existing Amazon Quick Sight analysis or another template.
updateTemplateAlias({required String aliasName, required String awsAccountId, required String templateId, required int templateVersionNumber}) → Future<UpdateTemplateAliasResponse>
Updates the template alias of a template.
updateTemplatePermissions({required String awsAccountId, required String templateId, List<ResourcePermission>? grantPermissions, List<ResourcePermission>? revokePermissions}) → Future<UpdateTemplatePermissionsResponse>
Updates the resource permissions for a template.
updateTheme({required String awsAccountId, required String baseThemeId, required String themeId, ThemeConfiguration? configuration, String? name, String? versionDescription}) → Future<UpdateThemeResponse>
Updates a theme.
updateThemeAlias({required String aliasName, required String awsAccountId, required String themeId, required int themeVersionNumber}) → Future<UpdateThemeAliasResponse>
Updates an alias of a theme.
updateThemePermissions({required String awsAccountId, required String themeId, List<ResourcePermission>? grantPermissions, List<ResourcePermission>? revokePermissions}) → Future<UpdateThemePermissionsResponse>
Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example "quicksight:DescribeTheme".
updateTopic({required String awsAccountId, required TopicDetails topic, required String topicId, CustomInstructions? customInstructions}) → Future<UpdateTopicResponse>
Updates a topic.
updateTopicPermissions({required String awsAccountId, required String topicId, List<ResourcePermission>? grantPermissions, List<ResourcePermission>? revokePermissions}) → Future<UpdateTopicPermissionsResponse>
Updates the permissions of a topic.
updateTopicRefreshSchedule({required String awsAccountId, required String datasetId, required TopicRefreshSchedule refreshSchedule, required String topicId}) → Future<UpdateTopicRefreshScheduleResponse>
Updates a topic refresh schedule.
updateUser({required String awsAccountId, required String email, required String namespace, required UserRole role, required String userName, String? customFederationProviderUrl, String? customPermissionsName, String? externalLoginFederationProviderType, String? externalLoginId, bool? unapplyCustomPermissions}) → Future<UpdateUserResponse>
Updates an Amazon Quick Sight user.
updateUserCustomPermission({required String awsAccountId, required String customPermissionsName, required String namespace, required String userName}) → Future<UpdateUserCustomPermissionResponse>
Updates a custom permissions profile for a user.
updateVPCConnection({required String awsAccountId, required String name, required String roleArn, required List<String> securityGroupIds, required List<String> subnetIds, required String vPCConnectionId, List<String>? dnsResolvers}) → Future<UpdateVPCConnectionResponse>
Updates a VPC connection.

Operators

operator ==(Object other) → bool
The equality operator.
inherited