View on GitHub
QuickSight Structure Reference
QuickSight
public struct QuickSightClient object for interacting with AWS QuickSight service.
Amazon QuickSight API Reference Amazon QuickSight is a fully managed, serverless business intelligence service for the AWS 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 QuickSight.
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the QuickSight client
Declaration
Swift
public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)Parameters
accessKeyIdPublic access key provided by AWS
secretAccessKeyPrivate access key provided by AWS
sessionTokenToken provided by STS.AssumeRole() which allows access to another AWS account
regionRegion of server you want to communicate with
endpointCustom endpoint URL to use instead of standard AWS servers
middlewaresArray of middlewares to apply to requests and responses
eventLoopGroupProviderEventLoopGroup to use. Use
useAWSClientSharedif the client shall manage its own EventLoopGroup.
-
Cancels an ongoing ingestion of data into SPICE.
Declaration
Swift
public func cancelIngestion(_ input: CancelIngestionRequest) -> EventLoopFuture<CancelIngestionResponse> -
Creates Amazon QuickSight customizations the current AWS Region. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize QuickSight by removing QuickSight sample assets and videos for all new users, see Customizing QuickSight in the Amazon QuickSight User Guide. You can create customizations for your AWS account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an AWS account. To find out which customizations apply, use the DescribeAccountCustomization API operation. Before you add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don’t share it with the namespace, the theme won’t be visible to your users even if you use this API operation to make it the default theme.
Declaration
Swift
public func createAccountCustomization(_ input: CreateAccountCustomizationRequest) -> EventLoopFuture<CreateAccountCustomizationResponse> -
Creates an analysis in Amazon QuickSight.
Declaration
Swift
public func createAnalysis(_ input: CreateAnalysisRequest) -> EventLoopFuture<CreateAnalysisResponse> -
Creates a dashboard from a template. To first create a template, see the CreateTemplate API operation. A dashboard is an entity in QuickSight that identifies QuickSight reports, created from analyses. You can share QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different AWS account.
Declaration
Swift
public func createDashboard(_ input: CreateDashboardRequest) -> EventLoopFuture<CreateDashboardResponse> -
Creates a dataset.
Declaration
Swift
public func createDataSet(_ input: CreateDataSetRequest) -> EventLoopFuture<CreateDataSetResponse> -
Creates a data source.
Declaration
Swift
public func createDataSource(_ input: CreateDataSourceRequest) -> EventLoopFuture<CreateDataSourceResponse> -
Creates an Amazon QuickSight group. The permissions resource is arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name> . The response is a group object.
Declaration
Swift
public func createGroup(_ input: CreateGroupRequest) -> EventLoopFuture<CreateGroupResponse> -
Adds an Amazon QuickSight user to an Amazon QuickSight group.
Declaration
Swift
public func createGroupMembership(_ input: CreateGroupMembershipRequest) -> EventLoopFuture<CreateGroupMembershipResponse> -
Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy will be assigned to specified groups or users of Amazon QuickSight. The users and groups need to be in the same namespace.
Declaration
Swift
public func createIAMPolicyAssignment(_ input: CreateIAMPolicyAssignmentRequest) -> EventLoopFuture<CreateIAMPolicyAssignmentResponse> -
Creates and starts a new SPICE ingestion on a dataset Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the AWS Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
Declaration
Swift
public func createIngestion(_ input: CreateIngestionRequest) -> EventLoopFuture<CreateIngestionResponse> -
(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight. A namespace allows you to isolate the QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can’t see users and groups in other namespaces. You can create a namespace after your AWS account is subscribed to QuickSight. The namespace must be unique within the AWS account. By default, there is a limit of 100 namespaces per AWS account. To increase your limit, create a ticket with AWS Support.
Declaration
Swift
public func createNamespace(_ input: CreateNamespaceRequest) -> EventLoopFuture<CreateNamespaceResponse> -
Creates a template from an existing QuickSight analysis or template. You can use the resulting template to create a dashboard. A template is an entity in QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
Declaration
Swift
public func createTemplate(_ input: CreateTemplateRequest) -> EventLoopFuture<CreateTemplateResponse> -
Creates a template alias for a template.
Declaration
Swift
public func createTemplateAlias(_ input: CreateTemplateAliasRequest) -> EventLoopFuture<CreateTemplateAliasResponse> -
Creates a theme. A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User Guide.
Declaration
Swift
public func createTheme(_ input: CreateThemeRequest) -> EventLoopFuture<CreateThemeResponse> -
Creates a theme alias for a theme.
Declaration
Swift
public func createThemeAlias(_ input: CreateThemeAliasRequest) -> EventLoopFuture<CreateThemeAliasResponse> -
Deletes all Amazon QuickSight customizations in this AWS Region for the specified AWS Account and QuickSight namespace.
Declaration
Swift
public func deleteAccountCustomization(_ input: DeleteAccountCustomizationRequest) -> EventLoopFuture<DeleteAccountCustomizationResponse> -
Deletes an analysis from Amazon QuickSight. 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. QuickSight attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the end of the recovery window, QuickSight deletes the analysis permanently. At any time before recovery window ends, you can use the RestoreAnalysis API operation to remove the DeletionTime stamp and cancel the deletion of the analysis. The analysis remains visible in the API until it’s deleted, so you can describe it but you can’t make a template from it. An analysis that’s scheduled for deletion isn’t accessible in the QuickSight console. To access it in the console, restore it. Deleting an analysis doesn’t delete the dashboards that you publish from it.
Declaration
Swift
public func deleteAnalysis(_ input: DeleteAnalysisRequest) -> EventLoopFuture<DeleteAnalysisResponse> -
Deletes a dashboard.
Declaration
Swift
public func deleteDashboard(_ input: DeleteDashboardRequest) -> EventLoopFuture<DeleteDashboardResponse> -
Deletes a dataset.
Declaration
Swift
public func deleteDataSet(_ input: DeleteDataSetRequest) -> EventLoopFuture<DeleteDataSetResponse> -
Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.
Declaration
Swift
public func deleteDataSource(_ input: DeleteDataSourceRequest) -> EventLoopFuture<DeleteDataSourceResponse> -
Removes a user group from Amazon QuickSight.
Declaration
Swift
public func deleteGroup(_ input: DeleteGroupRequest) -> EventLoopFuture<DeleteGroupResponse> -
Removes a user from a group so that the user is no longer a member of the group.
Declaration
Swift
public func deleteGroupMembership(_ input: DeleteGroupMembershipRequest) -> EventLoopFuture<DeleteGroupMembershipResponse> -
Deletes an existing IAM policy assignment.
Declaration
Swift
public func deleteIAMPolicyAssignment(_ input: DeleteIAMPolicyAssignmentRequest) -> EventLoopFuture<DeleteIAMPolicyAssignmentResponse> -
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.
Declaration
Swift
public func deleteNamespace(_ input: DeleteNamespaceRequest) -> EventLoopFuture<DeleteNamespaceResponse> -
Deletes a template.
Declaration
Swift
public func deleteTemplate(_ input: DeleteTemplateRequest) -> EventLoopFuture<DeleteTemplateResponse> -
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.
Declaration
Swift
public func deleteTemplateAlias(_ input: DeleteTemplateAliasRequest) -> EventLoopFuture<DeleteTemplateAliasResponse> -
Deletes a theme.
Declaration
Swift
public func deleteTheme(_ input: DeleteThemeRequest) -> EventLoopFuture<DeleteThemeResponse> -
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.
Declaration
Swift
public func deleteThemeAlias(_ input: DeleteThemeAliasRequest) -> EventLoopFuture<DeleteThemeAliasResponse> -
Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that’s making the call. The IAM user isn’t deleted as a result of this call.
Declaration
Swift
public func deleteUser(_ input: DeleteUserRequest) -> EventLoopFuture<DeleteUserResponse> -
Deletes a user identified by its principal ID.
Declaration
Swift
public func deleteUserByPrincipalId(_ input: DeleteUserByPrincipalIdRequest) -> EventLoopFuture<DeleteUserByPrincipalIdResponse> -
Describes the customizations associated with the provided AWS account and Amazon QuickSight namespace in an AWS Region. The QuickSight console evaluates which customizations to apply by running this API operation with the Resolved flag included. To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved. AWS Account - The AWS account exists at the top of the hierarchy. It has the potential to use all of the AWS Regions and AWS Services. When you subscribe to QuickSight, you choose one AWS Region to use as your home region. That’s where your free SPICE capacity is located. You can use QuickSight in any supported AWS Region. AWS Region - In each AWS Region where you sign in to QuickSight at least once, QuickSight acts as a separate instance of the same service. If you have a user directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have access to QuickSight in any AWS Region, unless they are constrained to a namespace. To run the command in a different AWS Region, you change your region settings. If you’re using the AWS CLI, you can use one of the following options: Use command line options. Use named profiles. Run aws configure to change your default AWS Region. Use Enter to key the same settings for your keys. For more information, see Configuring the AWS CLI. Namespace - A QuickSight namespace is a partition that contains users and assets (data sources, datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also be part of the same namespace. People who share a namespace are completely isolated from users and assets in other namespaces, even if they are in the same AWS account and AWS Region. Applied customizations - Within an AWS Region, a set of QuickSight customizations can apply to an AWS account or to a namespace. Settings that you apply to a namespace override settings that you apply to an AWS Account. All settings are isolated to a single AWS Region. To apply them in other AWS Regions, run the CreateAccountCustomization command in each AWS Region where you want to apply the same customizations.
Declaration
Swift
public func describeAccountCustomization(_ input: DescribeAccountCustomizationRequest) -> EventLoopFuture<DescribeAccountCustomizationResponse> -
Describes the settings that were used when your QuickSight subscription was first created in this AWS Account.
Declaration
Swift
public func describeAccountSettings(_ input: DescribeAccountSettingsRequest) -> EventLoopFuture<DescribeAccountSettingsResponse> -
Provides a summary of the metadata for an analysis.
Declaration
Swift
public func describeAnalysis(_ input: DescribeAnalysisRequest) -> EventLoopFuture<DescribeAnalysisResponse> -
Provides the read and write permissions for an analysis.
Declaration
Swift
public func describeAnalysisPermissions(_ input: DescribeAnalysisPermissionsRequest) -> EventLoopFuture<DescribeAnalysisPermissionsResponse> -
Provides a summary for a dashboard.
Declaration
Swift
public func describeDashboard(_ input: DescribeDashboardRequest) -> EventLoopFuture<DescribeDashboardResponse> -
Describes read and write permissions for a dashboard.
Declaration
Swift
public func describeDashboardPermissions(_ input: DescribeDashboardPermissionsRequest) -> EventLoopFuture<DescribeDashboardPermissionsResponse> -
Describes a dataset.
Declaration
Swift
public func describeDataSet(_ input: DescribeDataSetRequest) -> EventLoopFuture<DescribeDataSetResponse> -
Describes the permissions on a dataset. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
Declaration
Swift
public func describeDataSetPermissions(_ input: DescribeDataSetPermissionsRequest) -> EventLoopFuture<DescribeDataSetPermissionsResponse> -
Describes a data source.
Declaration
Swift
public func describeDataSource(_ input: DescribeDataSourceRequest) -> EventLoopFuture<DescribeDataSourceResponse> -
Describes the resource permissions for a data source.
Declaration
Swift
public func describeDataSourcePermissions(_ input: DescribeDataSourcePermissionsRequest) -> EventLoopFuture<DescribeDataSourcePermissionsResponse> -
Returns an Amazon QuickSight group’s description and Amazon Resource Name (ARN).
Declaration
Swift
public func describeGroup(_ input: DescribeGroupRequest) -> EventLoopFuture<DescribeGroupResponse> -
Describes an existing IAM policy assignment, as specified by the assignment name.
Declaration
Swift
public func describeIAMPolicyAssignment(_ input: DescribeIAMPolicyAssignmentRequest) -> EventLoopFuture<DescribeIAMPolicyAssignmentResponse> -
Describes a SPICE ingestion.
Declaration
Swift
public func describeIngestion(_ input: DescribeIngestionRequest) -> EventLoopFuture<DescribeIngestionResponse> -
Describes the current namespace.
Declaration
Swift
public func describeNamespace(_ input: DescribeNamespaceRequest) -> EventLoopFuture<DescribeNamespaceResponse> -
Describes a template’s metadata.
Declaration
Swift
public func describeTemplate(_ input: DescribeTemplateRequest) -> EventLoopFuture<DescribeTemplateResponse> -
Describes the template alias for a template.
Declaration
Swift
public func describeTemplateAlias(_ input: DescribeTemplateAliasRequest) -> EventLoopFuture<DescribeTemplateAliasResponse> -
Describes read and write permissions on a template.
Declaration
Swift
public func describeTemplatePermissions(_ input: DescribeTemplatePermissionsRequest) -> EventLoopFuture<DescribeTemplatePermissionsResponse> -
Describes a theme.
Declaration
Swift
public func describeTheme(_ input: DescribeThemeRequest) -> EventLoopFuture<DescribeThemeResponse> -
Describes the alias for a theme.
Declaration
Swift
public func describeThemeAlias(_ input: DescribeThemeAliasRequest) -> EventLoopFuture<DescribeThemeAliasResponse> -
Describes the read and write permissions for a theme.
Declaration
Swift
public func describeThemePermissions(_ input: DescribeThemePermissionsRequest) -> EventLoopFuture<DescribeThemePermissionsResponse> -
Returns information about a user, given the user name.
Declaration
Swift
public func describeUser(_ input: DescribeUserRequest) -> EventLoopFuture<DescribeUserResponse> -
Generates a session URL and authorization code that you can use to embed an Amazon QuickSight read-only dashboard in your web server code. Before you use this command, make sure that you have configured the dashboards and permissions. Currently, you can use GetDashboardEmbedURL only from the server, not from the user’s browser. The following rules apply to the combination of URL and authorization code: They must be used together. They can be used one time only. They are valid for 5 minutes after you run this command. The resulting user session is valid for 10 hours. For more information, see Embedding Amazon QuickSight in the Amazon QuickSight User Guide .
Declaration
Swift
public func getDashboardEmbedUrl(_ input: GetDashboardEmbedUrlRequest) -> EventLoopFuture<GetDashboardEmbedUrlResponse> -
Generates a session URL and authorization code that you can use to embed the Amazon QuickSight 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 QuickSight 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 QuickSight User Guide: Embedding the Amazon QuickSight Console Customizing Access to the Amazon QuickSight Console
Declaration
Swift
public func getSessionEmbedUrl(_ input: GetSessionEmbedUrlRequest) -> EventLoopFuture<GetSessionEmbedUrlResponse> -
Lists Amazon QuickSight analyses that exist in the specified AWS account.
Declaration
Swift
public func listAnalyses(_ input: ListAnalysesRequest) -> EventLoopFuture<ListAnalysesResponse> -
Lists all the versions of the dashboards in the QuickSight subscription.
Declaration
Swift
public func listDashboardVersions(_ input: ListDashboardVersionsRequest) -> EventLoopFuture<ListDashboardVersionsResponse> -
Lists dashboards in an AWS account.
Declaration
Swift
public func listDashboards(_ input: ListDashboardsRequest) -> EventLoopFuture<ListDashboardsResponse> -
Lists all of the datasets belonging to the current AWS account in an AWS Region. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
Declaration
Swift
public func listDataSets(_ input: ListDataSetsRequest) -> EventLoopFuture<ListDataSetsResponse> -
Lists data sources in current AWS Region that belong to this AWS account.
Declaration
Swift
public func listDataSources(_ input: ListDataSourcesRequest) -> EventLoopFuture<ListDataSourcesResponse> -
Lists member users in a group.
Declaration
Swift
public func listGroupMemberships(_ input: ListGroupMembershipsRequest) -> EventLoopFuture<ListGroupMembershipsResponse> -
Lists all user groups in Amazon QuickSight.
Declaration
Swift
public func listGroups(_ input: ListGroupsRequest) -> EventLoopFuture<ListGroupsResponse> -
Lists IAM policy assignments in the current Amazon QuickSight account.
Declaration
Swift
public func listIAMPolicyAssignments(_ input: ListIAMPolicyAssignmentsRequest) -> EventLoopFuture<ListIAMPolicyAssignmentsResponse> -
Lists all 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.
Declaration
Swift
public func listIAMPolicyAssignmentsForUser(_ input: ListIAMPolicyAssignmentsForUserRequest) -> EventLoopFuture<ListIAMPolicyAssignmentsForUserResponse> -
Lists the history of SPICE ingestions for a dataset.
Declaration
Swift
public func listIngestions(_ input: ListIngestionsRequest) -> EventLoopFuture<ListIngestionsResponse> -
Lists the namespaces for the specified AWS account.
Declaration
Swift
public func listNamespaces(_ input: ListNamespacesRequest) -> EventLoopFuture<ListNamespacesResponse> -
Lists the tags assigned to a resource.
Declaration
Swift
public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse> -
Lists all the aliases of a template.
Declaration
Swift
public func listTemplateAliases(_ input: ListTemplateAliasesRequest) -> EventLoopFuture<ListTemplateAliasesResponse> -
Lists all the versions of the templates in the current Amazon QuickSight account.
Declaration
Swift
public func listTemplateVersions(_ input: ListTemplateVersionsRequest) -> EventLoopFuture<ListTemplateVersionsResponse> -
Lists all the templates in the current Amazon QuickSight account.
Declaration
Swift
public func listTemplates(_ input: ListTemplatesRequest) -> EventLoopFuture<ListTemplatesResponse> -
Lists all the aliases of a theme.
Declaration
Swift
public func listThemeAliases(_ input: ListThemeAliasesRequest) -> EventLoopFuture<ListThemeAliasesResponse> -
Lists all the versions of the themes in the current AWS account.
Declaration
Swift
public func listThemeVersions(_ input: ListThemeVersionsRequest) -> EventLoopFuture<ListThemeVersionsResponse> -
Lists all the themes in the current AWS account.
Declaration
Swift
public func listThemes(_ input: ListThemesRequest) -> EventLoopFuture<ListThemesResponse> -
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
Declaration
Swift
public func listUserGroups(_ input: ListUserGroupsRequest) -> EventLoopFuture<ListUserGroupsResponse> -
Returns a list of all of the Amazon QuickSight users belonging to this account.
Declaration
Swift
public func listUsers(_ input: ListUsersRequest) -> EventLoopFuture<ListUsersResponse> -
Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.
Declaration
Swift
public func registerUser(_ input: RegisterUserRequest) -> EventLoopFuture<RegisterUserResponse> -
Restores an analysis.
Declaration
Swift
public func restoreAnalysis(_ input: RestoreAnalysisRequest) -> EventLoopFuture<RestoreAnalysisResponse> -
Searches for analyses that belong to the user specified in the filter.
Declaration
Swift
public func searchAnalyses(_ input: SearchAnalysesRequest) -> EventLoopFuture<SearchAnalysesResponse> -
Searches for dashboards that belong to a user.
Declaration
Swift
public func searchDashboards(_ input: SearchDashboardsRequest) -> EventLoopFuture<SearchDashboardsResponse> -
Assigns one or more tags (key-value pairs) to the specified QuickSight resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource. QuickSight supports tagging on data set, data source, dashboard, and template. Tagging for QuickSight works in a similar way to tagging for other AWS services, except for the following: You can’t use tags to track AWS costs for QuickSight. This restriction is because QuickSight costs are based on users and SPICE capacity, which aren’t taggable resources. QuickSight doesn’t currently support the Tag Editor for AWS Resource Groups.
Declaration
Swift
public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<TagResourceResponse> -
Removes a tag or tags from a resource.
Declaration
Swift
public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<UntagResourceResponse> -
Updates Amazon QuickSight customizations the current AWS Region. Currently, the only customization you can use is a theme. You can use customizations for your AWS account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an AWS account. To find out which customizations apply, use the DescribeAccountCustomization API operation.
Declaration
Swift
public func updateAccountCustomization(_ input: UpdateAccountCustomizationRequest) -> EventLoopFuture<UpdateAccountCustomizationResponse> -
Updates the Amazon QuickSight settings in your AWS Account.
Declaration
Swift
public func updateAccountSettings(_ input: UpdateAccountSettingsRequest) -> EventLoopFuture<UpdateAccountSettingsResponse> -
Updates an analysis in Amazon QuickSight
Declaration
Swift
public func updateAnalysis(_ input: UpdateAnalysisRequest) -> EventLoopFuture<UpdateAnalysisResponse> -
Updates the read and write permissions for an analysis.
Declaration
Swift
public func updateAnalysisPermissions(_ input: UpdateAnalysisPermissionsRequest) -> EventLoopFuture<UpdateAnalysisPermissionsResponse> -
Updates a dashboard in an AWS account.
Declaration
Swift
public func updateDashboard(_ input: UpdateDashboardRequest) -> EventLoopFuture<UpdateDashboardResponse> -
Updates read and write permissions on a dashboard.
Declaration
Swift
public func updateDashboardPermissions(_ input: UpdateDashboardPermissionsRequest) -> EventLoopFuture<UpdateDashboardPermissionsResponse> -
Updates the published version of a dashboard.
Declaration
Swift
public func updateDashboardPublishedVersion(_ input: UpdateDashboardPublishedVersionRequest) -> EventLoopFuture<UpdateDashboardPublishedVersionResponse> -
Updates a dataset.
Declaration
Swift
public func updateDataSet(_ input: UpdateDataSetRequest) -> EventLoopFuture<UpdateDataSetResponse> -
Updates the permissions on a dataset. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
Declaration
Swift
public func updateDataSetPermissions(_ input: UpdateDataSetPermissionsRequest) -> EventLoopFuture<UpdateDataSetPermissionsResponse> -
Updates a data source.
Declaration
Swift
public func updateDataSource(_ input: UpdateDataSourceRequest) -> EventLoopFuture<UpdateDataSourceResponse> -
Updates the permissions to a data source.
Declaration
Swift
public func updateDataSourcePermissions(_ input: UpdateDataSourcePermissionsRequest) -> EventLoopFuture<UpdateDataSourcePermissionsResponse> -
Changes a group description.
Declaration
Swift
public func updateGroup(_ input: UpdateGroupRequest) -> EventLoopFuture<UpdateGroupResponse> -
Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request.
Declaration
Swift
public func updateIAMPolicyAssignment(_ input: UpdateIAMPolicyAssignmentRequest) -> EventLoopFuture<UpdateIAMPolicyAssignmentResponse> -
Updates a template from an existing Amazon QuickSight analysis or another template.
Declaration
Swift
public func updateTemplate(_ input: UpdateTemplateRequest) -> EventLoopFuture<UpdateTemplateResponse> -
Updates the template alias of a template.
Declaration
Swift
public func updateTemplateAlias(_ input: UpdateTemplateAliasRequest) -> EventLoopFuture<UpdateTemplateAliasResponse> -
Updates the resource permissions for a template.
Declaration
Swift
public func updateTemplatePermissions(_ input: UpdateTemplatePermissionsRequest) -> EventLoopFuture<UpdateTemplatePermissionsResponse> -
Updates a theme.
Declaration
Swift
public func updateTheme(_ input: UpdateThemeRequest) -> EventLoopFuture<UpdateThemeResponse> -
Updates an alias of a theme.
Declaration
Swift
public func updateThemeAlias(_ input: UpdateThemeAliasRequest) -> EventLoopFuture<UpdateThemeAliasResponse> -
Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example “quicksight:DescribeTheme”. Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions: User “quicksight:DescribeTheme” “quicksight:DescribeThemeAlias” “quicksight:ListThemeAliases” “quicksight:ListThemeVersions” Owner “quicksight:DescribeTheme” “quicksight:DescribeThemeAlias” “quicksight:ListThemeAliases” “quicksight:ListThemeVersions” “quicksight:DeleteTheme” “quicksight:UpdateTheme” “quicksight:CreateThemeAlias” “quicksight:DeleteThemeAlias” “quicksight:UpdateThemeAlias” “quicksight:UpdateThemePermissions” “quicksight:DescribeThemePermissions” To specify no permissions, omit the permissions list.
Declaration
Swift
public func updateThemePermissions(_ input: UpdateThemePermissionsRequest) -> EventLoopFuture<UpdateThemePermissionsResponse> -
Updates an Amazon QuickSight user.
Declaration
Swift
public func updateUser(_ input: UpdateUserRequest) -> EventLoopFuture<UpdateUserResponse>
-
Lists Amazon QuickSight analyses that exist in the specified AWS account.
Declaration
Swift
public func listAnalysesPaginator(_ input: ListAnalysesRequest, onPage: @escaping (ListAnalysesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Lists all the versions of the dashboards in the QuickSight subscription.
Declaration
Swift
public func listDashboardVersionsPaginator(_ input: ListDashboardVersionsRequest, onPage: @escaping (ListDashboardVersionsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Lists dashboards in an AWS account.
Declaration
Swift
public func listDashboardsPaginator(_ input: ListDashboardsRequest, onPage: @escaping (ListDashboardsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Lists all of the datasets belonging to the current AWS account in an AWS Region. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
Declaration
Swift
public func listDataSetsPaginator(_ input: ListDataSetsRequest, onPage: @escaping (ListDataSetsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Lists data sources in current AWS Region that belong to this AWS account.
Declaration
Swift
public func listDataSourcesPaginator(_ input: ListDataSourcesRequest, onPage: @escaping (ListDataSourcesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Lists the history of SPICE ingestions for a dataset.
Declaration
Swift
public func listIngestionsPaginator(_ input: ListIngestionsRequest, onPage: @escaping (ListIngestionsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Lists the namespaces for the specified AWS account.
Declaration
Swift
public func listNamespacesPaginator(_ input: ListNamespacesRequest, onPage: @escaping (ListNamespacesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Lists all the aliases of a template.
Declaration
Swift
public func listTemplateAliasesPaginator(_ input: ListTemplateAliasesRequest, onPage: @escaping (ListTemplateAliasesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Lists all the versions of the templates in the current Amazon QuickSight account.
Declaration
Swift
public func listTemplateVersionsPaginator(_ input: ListTemplateVersionsRequest, onPage: @escaping (ListTemplateVersionsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Lists all the templates in the current Amazon QuickSight account.
Declaration
Swift
public func listTemplatesPaginator(_ input: ListTemplatesRequest, onPage: @escaping (ListTemplatesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Searches for analyses that belong to the user specified in the filter.
Declaration
Swift
public func searchAnalysesPaginator(_ input: SearchAnalysesRequest, onPage: @escaping (SearchAnalysesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Searches for dashboards that belong to a user.
Declaration
Swift
public func searchDashboardsPaginator(_ input: SearchDashboardsRequest, onPage: @escaping (SearchDashboardsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Undocumented
See moreDeclaration
Swift
public struct ListAnalysesRequest : AWSShapeextension QuickSight.ListAnalysesRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListDashboardVersionsRequest : AWSShapeextension QuickSight.ListDashboardVersionsRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListDashboardsRequest : AWSShapeextension QuickSight.ListDashboardsRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListDataSetsRequest : AWSShapeextension QuickSight.ListDataSetsRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListDataSourcesRequest : AWSShapeextension QuickSight.ListDataSourcesRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListIngestionsRequest : AWSShapeextension QuickSight.ListIngestionsRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListNamespacesRequest : AWSShapeextension QuickSight.ListNamespacesRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListTemplateAliasesRequest : AWSShapeextension QuickSight.ListTemplateAliasesRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListTemplateVersionsRequest : AWSShapeextension QuickSight.ListTemplateVersionsRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListTemplatesRequest : AWSShapeextension QuickSight.ListTemplatesRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct SearchAnalysesRequest : AWSShapeextension QuickSight.SearchAnalysesRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct SearchDashboardsRequest : AWSShapeextension QuickSight.SearchDashboardsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public enum AnalysisErrorType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum AnalysisFilterAttribute : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum AssignmentStatus : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ColumnDataType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum DashboardBehavior : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum DashboardErrorType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum DashboardFilterAttribute : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum DashboardUIState : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum DataSetImportMode : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum DataSourceErrorInfoType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum DataSourceType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum Edition : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum FileFormat : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum FilterOperator : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum GeoSpatialCountryCode : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum GeoSpatialDataRole : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum IdentityStore : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum IdentityType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum IngestionErrorType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum IngestionRequestSource : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum IngestionRequestType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum IngestionStatus : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum InputColumnDataType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum JoinType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum NamespaceErrorType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum NamespaceStatus : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ResourceStatus : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum RowLevelPermissionPolicy : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum TemplateErrorType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum TextQualifier : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ThemeErrorType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ThemeType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum UserRole : String, CustomStringConvertible, Codable