Class: Aws::QuickSight::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::QuickSight::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb
Overview
An API client for QuickSight. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::QuickSight::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#batch_create_topic_reviewed_answer(params = {}) ⇒ Types::BatchCreateTopicReviewedAnswerResponse
Creates new reviewed answers for a Q Topic.
-
#batch_delete_topic_reviewed_answer(params = {}) ⇒ Types::BatchDeleteTopicReviewedAnswerResponse
Deletes reviewed answers for Q Topic.
-
#cancel_ingestion(params = {}) ⇒ Types::CancelIngestionResponse
Cancels an ongoing ingestion of data into SPICE.
-
#create_account_customization(params = {}) ⇒ Types::CreateAccountCustomizationResponse
Creates Amazon QuickSight customizations for the current Amazon Web Services Region.
-
#create_account_subscription(params = {}) ⇒ Types::CreateAccountSubscriptionResponse
Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.
-
#create_analysis(params = {}) ⇒ Types::CreateAnalysisResponse
Creates an analysis in Amazon QuickSight.
-
#create_brand(params = {}) ⇒ Types::CreateBrandResponse
Creates an Amazon QuickSight brand.
-
#create_custom_permissions(params = {}) ⇒ Types::CreateCustomPermissionsResponse
Creates a custom permissions profile.
-
#create_dashboard(params = {}) ⇒ Types::CreateDashboardResponse
Creates a dashboard from either a template or directly with a
DashboardDefinition
. -
#create_data_set(params = {}) ⇒ Types::CreateDataSetResponse
Creates a dataset.
-
#create_data_source(params = {}) ⇒ Types::CreateDataSourceResponse
Creates a data source.
-
#create_folder(params = {}) ⇒ Types::CreateFolderResponse
Creates an empty shared folder.
-
#create_folder_membership(params = {}) ⇒ Types::CreateFolderMembershipResponse
Adds an asset, such as a dashboard, analysis, or dataset into a folder.
-
#create_group(params = {}) ⇒ Types::CreateGroupResponse
Use the
CreateGroup
operation to create a group in Amazon QuickSight. -
#create_group_membership(params = {}) ⇒ Types::CreateGroupMembershipResponse
Adds an Amazon QuickSight user to an Amazon QuickSight group.
-
#create_iam_policy_assignment(params = {}) ⇒ Types::CreateIAMPolicyAssignmentResponse
Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN).
-
#create_ingestion(params = {}) ⇒ Types::CreateIngestionResponse
Creates and starts a new SPICE ingestion for a dataset.
-
#create_namespace(params = {}) ⇒ Types::CreateNamespaceResponse
(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
-
#create_refresh_schedule(params = {}) ⇒ Types::CreateRefreshScheduleResponse
Creates a refresh schedule for a dataset.
-
#create_role_membership(params = {}) ⇒ Types::CreateRoleMembershipResponse
Use
CreateRoleMembership
to add an existing Amazon QuickSight group to an existing role. -
#create_template(params = {}) ⇒ Types::CreateTemplateResponse
Creates a template either from a
TemplateDefinition
or from an existing Amazon QuickSight analysis or template. -
#create_template_alias(params = {}) ⇒ Types::CreateTemplateAliasResponse
Creates a template alias for a template.
-
#create_theme(params = {}) ⇒ Types::CreateThemeResponse
Creates a theme.
-
#create_theme_alias(params = {}) ⇒ Types::CreateThemeAliasResponse
Creates a theme alias for a theme.
-
#create_topic(params = {}) ⇒ Types::CreateTopicResponse
Creates a new Q topic.
-
#create_topic_refresh_schedule(params = {}) ⇒ Types::CreateTopicRefreshScheduleResponse
Creates a topic refresh schedule.
-
#create_vpc_connection(params = {}) ⇒ Types::CreateVPCConnectionResponse
Creates a new VPC connection.
-
#delete_account_customization(params = {}) ⇒ Types::DeleteAccountCustomizationResponse
Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace.
-
#delete_account_subscription(params = {}) ⇒ Types::DeleteAccountSubscriptionResponse
Use the
DeleteAccountSubscription
operation to delete an Amazon QuickSight account. -
#delete_analysis(params = {}) ⇒ Types::DeleteAnalysisResponse
Deletes an analysis from Amazon QuickSight.
-
#delete_brand(params = {}) ⇒ Types::DeleteBrandResponse
Deletes an Amazon QuickSight brand.
-
#delete_brand_assignment(params = {}) ⇒ Types::DeleteBrandAssignmentResponse
Deletes a brand assignment.
-
#delete_custom_permissions(params = {}) ⇒ Types::DeleteCustomPermissionsResponse
Deletes a custom permissions profile.
-
#delete_dashboard(params = {}) ⇒ Types::DeleteDashboardResponse
Deletes a dashboard.
-
#delete_data_set(params = {}) ⇒ Types::DeleteDataSetResponse
Deletes a dataset.
-
#delete_data_set_refresh_properties(params = {}) ⇒ Types::DeleteDataSetRefreshPropertiesResponse
Deletes the dataset refresh properties of the dataset.
-
#delete_data_source(params = {}) ⇒ Types::DeleteDataSourceResponse
Deletes the data source permanently.
-
#delete_default_q_business_application(params = {}) ⇒ Types::DeleteDefaultQBusinessApplicationResponse
Deletes a linked Amazon Q Business application from an Amazon QuickSight account.
-
#delete_folder(params = {}) ⇒ Types::DeleteFolderResponse
Deletes an empty folder.
-
#delete_folder_membership(params = {}) ⇒ Types::DeleteFolderMembershipResponse
Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
-
#delete_group(params = {}) ⇒ Types::DeleteGroupResponse
Removes a user group from Amazon QuickSight.
-
#delete_group_membership(params = {}) ⇒ Types::DeleteGroupMembershipResponse
Removes a user from a group so that the user is no longer a member of the group.
-
#delete_iam_policy_assignment(params = {}) ⇒ Types::DeleteIAMPolicyAssignmentResponse
Deletes an existing IAM policy assignment.
-
#delete_identity_propagation_config(params = {}) ⇒ Types::DeleteIdentityPropagationConfigResponse
Deletes all access scopes and authorized targets that are associated with a service from the Amazon QuickSight IAM Identity Center application.
-
#delete_namespace(params = {}) ⇒ Types::DeleteNamespaceResponse
Deletes a namespace and the users and groups that are associated with the namespace.
-
#delete_refresh_schedule(params = {}) ⇒ Types::DeleteRefreshScheduleResponse
Deletes a refresh schedule from a dataset.
-
#delete_role_custom_permission(params = {}) ⇒ Types::DeleteRoleCustomPermissionResponse
Removes custom permissions from the role.
-
#delete_role_membership(params = {}) ⇒ Types::DeleteRoleMembershipResponse
Removes a group from a role.
-
#delete_template(params = {}) ⇒ Types::DeleteTemplateResponse
Deletes a template.
-
#delete_template_alias(params = {}) ⇒ Types::DeleteTemplateAliasResponse
Deletes the item that the specified template alias points to.
-
#delete_theme(params = {}) ⇒ Types::DeleteThemeResponse
Deletes a theme.
-
#delete_theme_alias(params = {}) ⇒ Types::DeleteThemeAliasResponse
Deletes the version of the theme that the specified theme alias points to.
-
#delete_topic(params = {}) ⇒ Types::DeleteTopicResponse
Deletes a topic.
-
#delete_topic_refresh_schedule(params = {}) ⇒ Types::DeleteTopicRefreshScheduleResponse
Deletes a topic refresh schedule.
-
#delete_user(params = {}) ⇒ Types::DeleteUserResponse
Deletes the Amazon QuickSight user that is associated with the identity of the IAM user or role that's making the call.
-
#delete_user_by_principal_id(params = {}) ⇒ Types::DeleteUserByPrincipalIdResponse
Deletes a user identified by its principal ID.
-
#delete_user_custom_permission(params = {}) ⇒ Types::DeleteUserCustomPermissionResponse
Deletes a custom permissions profile from a user.
-
#delete_vpc_connection(params = {}) ⇒ Types::DeleteVPCConnectionResponse
Deletes a VPC connection.
-
#describe_account_customization(params = {}) ⇒ Types::DescribeAccountCustomizationResponse
Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon QuickSight namespace in an Amazon Web Services Region.
-
#describe_account_settings(params = {}) ⇒ Types::DescribeAccountSettingsResponse
Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account.
-
#describe_account_subscription(params = {}) ⇒ Types::DescribeAccountSubscriptionResponse
Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's subscription.
-
#describe_analysis(params = {}) ⇒ Types::DescribeAnalysisResponse
Provides a summary of the metadata for an analysis.
-
#describe_analysis_definition(params = {}) ⇒ Types::DescribeAnalysisDefinitionResponse
Provides a detailed description of the definition of an analysis.
-
#describe_analysis_permissions(params = {}) ⇒ Types::DescribeAnalysisPermissionsResponse
Provides the read and write permissions for an analysis.
-
#describe_asset_bundle_export_job(params = {}) ⇒ Types::DescribeAssetBundleExportJobResponse
Describes an existing export job.
-
#describe_asset_bundle_import_job(params = {}) ⇒ Types::DescribeAssetBundleImportJobResponse
Describes an existing import job.
-
#describe_brand(params = {}) ⇒ Types::DescribeBrandResponse
Describes a brand.
-
#describe_brand_assignment(params = {}) ⇒ Types::DescribeBrandAssignmentResponse
Describes a brand assignment.
-
#describe_brand_published_version(params = {}) ⇒ Types::DescribeBrandPublishedVersionResponse
Describes the published version of the brand.
-
#describe_custom_permissions(params = {}) ⇒ Types::DescribeCustomPermissionsResponse
Describes a custom permissions profile.
-
#describe_dashboard(params = {}) ⇒ Types::DescribeDashboardResponse
Provides a summary for a dashboard.
-
#describe_dashboard_definition(params = {}) ⇒ Types::DescribeDashboardDefinitionResponse
Provides a detailed description of the definition of a dashboard.
-
#describe_dashboard_permissions(params = {}) ⇒ Types::DescribeDashboardPermissionsResponse
Describes read and write permissions for a dashboard.
-
#describe_dashboard_snapshot_job(params = {}) ⇒ Types::DescribeDashboardSnapshotJobResponse
Describes an existing snapshot job.
-
#describe_dashboard_snapshot_job_result(params = {}) ⇒ Types::DescribeDashboardSnapshotJobResultResponse
Describes the result of an existing snapshot job that has finished running.
-
#describe_dashboards_qa_configuration(params = {}) ⇒ Types::DescribeDashboardsQAConfigurationResponse
Describes an existing dashboard QA configuration.
-
#describe_data_set(params = {}) ⇒ Types::DescribeDataSetResponse
Describes a dataset.
-
#describe_data_set_permissions(params = {}) ⇒ Types::DescribeDataSetPermissionsResponse
Describes the permissions on a dataset.
-
#describe_data_set_refresh_properties(params = {}) ⇒ Types::DescribeDataSetRefreshPropertiesResponse
Describes the refresh properties of a dataset.
-
#describe_data_source(params = {}) ⇒ Types::DescribeDataSourceResponse
Describes a data source.
-
#describe_data_source_permissions(params = {}) ⇒ Types::DescribeDataSourcePermissionsResponse
Describes the resource permissions for a data source.
-
#describe_default_q_business_application(params = {}) ⇒ Types::DescribeDefaultQBusinessApplicationResponse
Describes a Amazon Q Business application that is linked to an Amazon QuickSight account.
-
#describe_folder(params = {}) ⇒ Types::DescribeFolderResponse
Describes a folder.
-
#describe_folder_permissions(params = {}) ⇒ Types::DescribeFolderPermissionsResponse
Describes permissions for a folder.
-
#describe_folder_resolved_permissions(params = {}) ⇒ Types::DescribeFolderResolvedPermissionsResponse
Describes the folder resolved permissions.
-
#describe_group(params = {}) ⇒ Types::DescribeGroupResponse
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
-
#describe_group_membership(params = {}) ⇒ Types::DescribeGroupMembershipResponse
Use the
DescribeGroupMembership
operation to determine if a user is a member of the specified group. -
#describe_iam_policy_assignment(params = {}) ⇒ Types::DescribeIAMPolicyAssignmentResponse
Describes an existing IAM policy assignment, as specified by the assignment name.
-
#describe_ingestion(params = {}) ⇒ Types::DescribeIngestionResponse
Describes a SPICE ingestion.
-
#describe_ip_restriction(params = {}) ⇒ Types::DescribeIpRestrictionResponse
Provides a summary and status of IP rules.
-
#describe_key_registration(params = {}) ⇒ Types::DescribeKeyRegistrationResponse
Describes all customer managed key registrations in a Amazon QuickSight account.
-
#describe_namespace(params = {}) ⇒ Types::DescribeNamespaceResponse
Describes the current namespace.
-
#describe_q_personalization_configuration(params = {}) ⇒ Types::DescribeQPersonalizationConfigurationResponse
Describes a personalization configuration.
-
#describe_quick_sight_q_search_configuration(params = {}) ⇒ Types::DescribeQuickSightQSearchConfigurationResponse
Describes the state of a Amazon QuickSight Q Search configuration.
-
#describe_refresh_schedule(params = {}) ⇒ Types::DescribeRefreshScheduleResponse
Provides a summary of a refresh schedule.
-
#describe_role_custom_permission(params = {}) ⇒ Types::DescribeRoleCustomPermissionResponse
Describes all custom permissions that are mapped to a role.
-
#describe_template(params = {}) ⇒ Types::DescribeTemplateResponse
Describes a template's metadata.
-
#describe_template_alias(params = {}) ⇒ Types::DescribeTemplateAliasResponse
Describes the template alias for a template.
-
#describe_template_definition(params = {}) ⇒ Types::DescribeTemplateDefinitionResponse
Provides a detailed description of the definition of a template.
-
#describe_template_permissions(params = {}) ⇒ Types::DescribeTemplatePermissionsResponse
Describes read and write permissions on a template.
-
#describe_theme(params = {}) ⇒ Types::DescribeThemeResponse
Describes a theme.
-
#describe_theme_alias(params = {}) ⇒ Types::DescribeThemeAliasResponse
Describes the alias for a theme.
-
#describe_theme_permissions(params = {}) ⇒ Types::DescribeThemePermissionsResponse
Describes the read and write permissions for a theme.
-
#describe_topic(params = {}) ⇒ Types::DescribeTopicResponse
Describes a topic.
-
#describe_topic_permissions(params = {}) ⇒ Types::DescribeTopicPermissionsResponse
Describes the permissions of a topic.
-
#describe_topic_refresh(params = {}) ⇒ Types::DescribeTopicRefreshResponse
Describes the status of a topic refresh.
-
#describe_topic_refresh_schedule(params = {}) ⇒ Types::DescribeTopicRefreshScheduleResponse
Deletes a topic refresh schedule.
-
#describe_user(params = {}) ⇒ Types::DescribeUserResponse
Returns information about a user, given the user name.
-
#describe_vpc_connection(params = {}) ⇒ Types::DescribeVPCConnectionResponse
Describes a VPC connection.
-
#generate_embed_url_for_anonymous_user(params = {}) ⇒ Types::GenerateEmbedUrlForAnonymousUserResponse
Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users.
-
#generate_embed_url_for_registered_user(params = {}) ⇒ Types::GenerateEmbedUrlForRegisteredUserResponse
Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website.
-
#generate_embed_url_for_registered_user_with_identity(params = {}) ⇒ Types::GenerateEmbedUrlForRegisteredUserWithIdentityResponse
Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website.
-
#get_dashboard_embed_url(params = {}) ⇒ Types::GetDashboardEmbedUrlResponse
Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon QuickSight read-only dashboard in your website or application.
-
#get_session_embed_url(params = {}) ⇒ Types::GetSessionEmbedUrlResponse
Generates a session URL and authorization code that you can use to embed the Amazon Amazon QuickSight console in your web server code.
-
#list_analyses(params = {}) ⇒ Types::ListAnalysesResponse
Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.
-
#list_asset_bundle_export_jobs(params = {}) ⇒ Types::ListAssetBundleExportJobsResponse
Lists all asset bundle export jobs that have been taken place in the last 14 days.
-
#list_asset_bundle_import_jobs(params = {}) ⇒ Types::ListAssetBundleImportJobsResponse
Lists all asset bundle import jobs that have taken place in the last 14 days.
-
#list_brands(params = {}) ⇒ Types::ListBrandsResponse
Lists all brands in an Amazon QuickSight account.
-
#list_custom_permissions(params = {}) ⇒ Types::ListCustomPermissionsResponse
Returns a list of all the custom permissions profiles.
-
#list_dashboard_versions(params = {}) ⇒ Types::ListDashboardVersionsResponse
Lists all the versions of the dashboards in the Amazon QuickSight subscription.
-
#list_dashboards(params = {}) ⇒ Types::ListDashboardsResponse
Lists dashboards in an Amazon Web Services account.
-
#list_data_sets(params = {}) ⇒ Types::ListDataSetsResponse
Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.
-
#list_data_sources(params = {}) ⇒ Types::ListDataSourcesResponse
Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
-
#list_folder_members(params = {}) ⇒ Types::ListFolderMembersResponse
List all assets (
DASHBOARD
,ANALYSIS
, andDATASET
) in a folder. -
#list_folders(params = {}) ⇒ Types::ListFoldersResponse
Lists all folders in an account.
-
#list_folders_for_resource(params = {}) ⇒ Types::ListFoldersForResourceResponse
List all folders that a resource is a member of.
-
#list_group_memberships(params = {}) ⇒ Types::ListGroupMembershipsResponse
Lists member users in a group.
-
#list_groups(params = {}) ⇒ Types::ListGroupsResponse
Lists all user groups in Amazon QuickSight.
-
#list_iam_policy_assignments(params = {}) ⇒ Types::ListIAMPolicyAssignmentsResponse
Lists the IAM policy assignments in the current Amazon QuickSight account.
-
#list_iam_policy_assignments_for_user(params = {}) ⇒ Types::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.
-
#list_identity_propagation_configs(params = {}) ⇒ Types::ListIdentityPropagationConfigsResponse
Lists all services and authorized targets that the Amazon QuickSight IAM Identity Center application can access.
-
#list_ingestions(params = {}) ⇒ Types::ListIngestionsResponse
Lists the history of SPICE ingestions for a dataset.
-
#list_namespaces(params = {}) ⇒ Types::ListNamespacesResponse
Lists the namespaces for the specified Amazon Web Services account.
-
#list_refresh_schedules(params = {}) ⇒ Types::ListRefreshSchedulesResponse
Lists the refresh schedules of a dataset.
-
#list_role_memberships(params = {}) ⇒ Types::ListRoleMembershipsResponse
Lists all groups that are associated with a role.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags assigned to a resource.
-
#list_template_aliases(params = {}) ⇒ Types::ListTemplateAliasesResponse
Lists all the aliases of a template.
-
#list_template_versions(params = {}) ⇒ Types::ListTemplateVersionsResponse
Lists all the versions of the templates in the current Amazon QuickSight account.
-
#list_templates(params = {}) ⇒ Types::ListTemplatesResponse
Lists all the templates in the current Amazon QuickSight account.
-
#list_theme_aliases(params = {}) ⇒ Types::ListThemeAliasesResponse
Lists all the aliases of a theme.
-
#list_theme_versions(params = {}) ⇒ Types::ListThemeVersionsResponse
Lists all the versions of the themes in the current Amazon Web Services account.
-
#list_themes(params = {}) ⇒ Types::ListThemesResponse
Lists all the themes in the current Amazon Web Services account.
-
#list_topic_refresh_schedules(params = {}) ⇒ Types::ListTopicRefreshSchedulesResponse
Lists all of the refresh schedules for a topic.
-
#list_topic_reviewed_answers(params = {}) ⇒ Types::ListTopicReviewedAnswersResponse
Lists all reviewed answers for a Q Topic.
-
#list_topics(params = {}) ⇒ Types::ListTopicsResponse
Lists all of the topics within an account.
-
#list_user_groups(params = {}) ⇒ Types::ListUserGroupsResponse
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
-
#list_users(params = {}) ⇒ Types::ListUsersResponse
Returns a list of all of the Amazon QuickSight users belonging to this account.
-
#list_vpc_connections(params = {}) ⇒ Types::ListVPCConnectionsResponse
Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.
-
#predict_qa_results(params = {}) ⇒ Types::PredictQAResultsResponse
Predicts existing visuals or generates new visuals to answer a given query.
-
#put_data_set_refresh_properties(params = {}) ⇒ Types::PutDataSetRefreshPropertiesResponse
Creates or updates the dataset refresh properties for the dataset.
-
#register_user(params = {}) ⇒ Types::RegisterUserResponse
Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request.
-
#restore_analysis(params = {}) ⇒ Types::RestoreAnalysisResponse
Restores an analysis.
-
#search_analyses(params = {}) ⇒ Types::SearchAnalysesResponse
Searches for analyses that belong to the user specified in the filter.
-
#search_dashboards(params = {}) ⇒ Types::SearchDashboardsResponse
Searches for dashboards that belong to a user.
-
#search_data_sets(params = {}) ⇒ Types::SearchDataSetsResponse
Use the
SearchDataSets
operation to search for datasets that belong to an account. -
#search_data_sources(params = {}) ⇒ Types::SearchDataSourcesResponse
Use the
SearchDataSources
operation to search for data sources that belong to an account. -
#search_folders(params = {}) ⇒ Types::SearchFoldersResponse
Searches the subfolders in a folder.
-
#search_groups(params = {}) ⇒ Types::SearchGroupsResponse
Use the
SearchGroups
operation to search groups in a specified Amazon QuickSight namespace using the supplied filters. -
#search_topics(params = {}) ⇒ Types::SearchTopicsResponse
Searches for any Q topic that exists in an Amazon QuickSight account.
-
#start_asset_bundle_export_job(params = {}) ⇒ Types::StartAssetBundleExportJobResponse
Starts an Asset Bundle export job.
-
#start_asset_bundle_import_job(params = {}) ⇒ Types::StartAssetBundleImportJobResponse
Starts an Asset Bundle import job.
-
#start_dashboard_snapshot_job(params = {}) ⇒ Types::StartDashboardSnapshotJobResponse
Starts an asynchronous job that generates a snapshot of a dashboard's output.
-
#start_dashboard_snapshot_job_schedule(params = {}) ⇒ Types::StartDashboardSnapshotJobScheduleResponse
Starts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email.
-
#tag_resource(params = {}) ⇒ Types::TagResourceResponse
Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.
-
#untag_resource(params = {}) ⇒ Types::UntagResourceResponse
Removes a tag or tags from a resource.
-
#update_account_customization(params = {}) ⇒ Types::UpdateAccountCustomizationResponse
Updates Amazon QuickSight customizations for the current Amazon Web Services Region.
-
#update_account_settings(params = {}) ⇒ Types::UpdateAccountSettingsResponse
Updates the Amazon QuickSight settings in your Amazon Web Services account.
-
#update_analysis(params = {}) ⇒ Types::UpdateAnalysisResponse
Updates an analysis in Amazon QuickSight.
-
#update_analysis_permissions(params = {}) ⇒ Types::UpdateAnalysisPermissionsResponse
Updates the read and write permissions for an analysis.
-
#update_application_with_token_exchange_grant(params = {}) ⇒ Types::UpdateApplicationWithTokenExchangeGrantResponse
Updates an Amazon QuickSight application with a token exchange grant.
-
#update_brand(params = {}) ⇒ Types::UpdateBrandResponse
Updates a brand.
-
#update_brand_assignment(params = {}) ⇒ Types::UpdateBrandAssignmentResponse
Updates a brand assignment.
-
#update_brand_published_version(params = {}) ⇒ Types::UpdateBrandPublishedVersionResponse
Updates the published version of a brand.
-
#update_custom_permissions(params = {}) ⇒ Types::UpdateCustomPermissionsResponse
Updates a custom permissions profile.
-
#update_dashboard(params = {}) ⇒ Types::UpdateDashboardResponse
Updates a dashboard in an Amazon Web Services account.
-
#update_dashboard_links(params = {}) ⇒ Types::UpdateDashboardLinksResponse
Updates the linked analyses on a dashboard.
-
#update_dashboard_permissions(params = {}) ⇒ Types::UpdateDashboardPermissionsResponse
Updates read and write permissions on a dashboard.
-
#update_dashboard_published_version(params = {}) ⇒ Types::UpdateDashboardPublishedVersionResponse
Updates the published version of a dashboard.
-
#update_dashboards_qa_configuration(params = {}) ⇒ Types::UpdateDashboardsQAConfigurationResponse
Updates a Dashboard QA configuration.
-
#update_data_set(params = {}) ⇒ Types::UpdateDataSetResponse
Updates a dataset.
-
#update_data_set_permissions(params = {}) ⇒ Types::UpdateDataSetPermissionsResponse
Updates the permissions on a dataset.
-
#update_data_source(params = {}) ⇒ Types::UpdateDataSourceResponse
Updates a data source.
-
#update_data_source_permissions(params = {}) ⇒ Types::UpdateDataSourcePermissionsResponse
Updates the permissions to a data source.
-
#update_default_q_business_application(params = {}) ⇒ Types::UpdateDefaultQBusinessApplicationResponse
Updates a Amazon Q Business application that is linked to a Amazon QuickSight account.
-
#update_folder(params = {}) ⇒ Types::UpdateFolderResponse
Updates the name of a folder.
-
#update_folder_permissions(params = {}) ⇒ Types::UpdateFolderPermissionsResponse
Updates permissions of a folder.
-
#update_group(params = {}) ⇒ Types::UpdateGroupResponse
Changes a group description.
-
#update_iam_policy_assignment(params = {}) ⇒ Types::UpdateIAMPolicyAssignmentResponse
Updates an existing IAM policy assignment.
-
#update_identity_propagation_config(params = {}) ⇒ Types::UpdateIdentityPropagationConfigResponse
Adds or updates services and authorized targets to configure what the Amazon QuickSight IAM Identity Center application can access.
-
#update_ip_restriction(params = {}) ⇒ Types::UpdateIpRestrictionResponse
Updates the content and status of IP rules.
-
#update_key_registration(params = {}) ⇒ Types::UpdateKeyRegistrationResponse
Updates a customer managed key in a Amazon QuickSight account.
-
#update_public_sharing_settings(params = {}) ⇒ Types::UpdatePublicSharingSettingsResponse
Use the
UpdatePublicSharingSettings
operation to turn on or turn off the public sharing settings of an Amazon QuickSight dashboard. -
#update_q_personalization_configuration(params = {}) ⇒ Types::UpdateQPersonalizationConfigurationResponse
Updates a personalization configuration.
-
#update_quick_sight_q_search_configuration(params = {}) ⇒ Types::UpdateQuickSightQSearchConfigurationResponse
Updates the state of a Amazon QuickSight Q Search configuration.
-
#update_refresh_schedule(params = {}) ⇒ Types::UpdateRefreshScheduleResponse
Updates a refresh schedule for a dataset.
-
#update_role_custom_permission(params = {}) ⇒ Types::UpdateRoleCustomPermissionResponse
Updates the custom permissions that are associated with a role.
-
#update_spice_capacity_configuration(params = {}) ⇒ Types::UpdateSPICECapacityConfigurationResponse
Updates the SPICE capacity configuration for a Amazon QuickSight account.
-
#update_template(params = {}) ⇒ Types::UpdateTemplateResponse
Updates a template from an existing Amazon QuickSight analysis or another template.
-
#update_template_alias(params = {}) ⇒ Types::UpdateTemplateAliasResponse
Updates the template alias of a template.
-
#update_template_permissions(params = {}) ⇒ Types::UpdateTemplatePermissionsResponse
Updates the resource permissions for a template.
-
#update_theme(params = {}) ⇒ Types::UpdateThemeResponse
Updates a theme.
-
#update_theme_alias(params = {}) ⇒ Types::UpdateThemeAliasResponse
Updates an alias of a theme.
-
#update_theme_permissions(params = {}) ⇒ Types::UpdateThemePermissionsResponse
Updates the resource permissions for a theme.
-
#update_topic(params = {}) ⇒ Types::UpdateTopicResponse
Updates a topic.
-
#update_topic_permissions(params = {}) ⇒ Types::UpdateTopicPermissionsResponse
Updates the permissions of a topic.
-
#update_topic_refresh_schedule(params = {}) ⇒ Types::UpdateTopicRefreshScheduleResponse
Updates a topic refresh schedule.
-
#update_user(params = {}) ⇒ Types::UpdateUserResponse
Updates an Amazon QuickSight user.
-
#update_user_custom_permission(params = {}) ⇒ Types::UpdateUserCustomPermissionResponse
Updates a custom permissions profile for a user.
-
#update_vpc_connection(params = {}) ⇒ Types::UpdateVPCConnectionResponse
Updates a VPC connection.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
476 477 478 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 476 def initialize(*args) super end |
Instance Method Details
#batch_create_topic_reviewed_answer(params = {}) ⇒ Types::BatchCreateTopicReviewedAnswerResponse
Creates new reviewed answers for a Q Topic.
1289 1290 1291 1292 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1289 def batch_create_topic_reviewed_answer(params = {}, = {}) req = build_request(:batch_create_topic_reviewed_answer, params) req.send_request() end |
#batch_delete_topic_reviewed_answer(params = {}) ⇒ Types::BatchDeleteTopicReviewedAnswerResponse
Deletes reviewed answers for Q Topic.
1341 1342 1343 1344 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1341 def batch_delete_topic_reviewed_answer(params = {}, = {}) req = build_request(:batch_delete_topic_reviewed_answer, params) req.send_request() end |
#cancel_ingestion(params = {}) ⇒ Types::CancelIngestionResponse
Cancels an ongoing ingestion of data into SPICE.
1383 1384 1385 1386 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1383 def cancel_ingestion(params = {}, = {}) req = build_request(:cancel_ingestion, params) req.send_request() end |
#create_account_customization(params = {}) ⇒ Types::CreateAccountCustomizationResponse
Creates Amazon QuickSight customizations for the current Amazon Web
Services Region. Currently, you can add a custom default theme by
using the CreateAccountCustomization
or UpdateAccountCustomization
API operation. To further customize Amazon QuickSight by removing
Amazon QuickSight sample assets and videos for all new users, see
Customizing Amazon QuickSight in the Amazon QuickSight User
Guide.
You can create customizations for your Amazon Web Services 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 Amazon Web Services account. To find
out which customizations apply, use the DescribeAccountCustomization
API operation.
Before you use the CreateAccountCustomization
API operation to 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 isn't visible to your users even if you make it the default
theme. To check if the theme is shared, view the current permissions
by using the DescribeThemePermissions
API operation. To share the
theme, grant permissions by using the UpdateThemePermissions
API
operation.
1480 1481 1482 1483 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1480 def create_account_customization(params = {}, = {}) req = build_request(:create_account_customization, params) req.send_request() end |
#create_account_subscription(params = {}) ⇒ Types::CreateAccountSubscriptionResponse
Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.
The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK.
Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign up for Amazon Web Services in the Amazon QuickSight User Guide. The person who signs up for Amazon QuickSight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for Amazon QuickSight in the Amazon QuickSight User Guide.
If your IAM policy includes both the Subscribe
and
CreateAccountSubscription
actions, make sure that both actions are
set to Allow
. If either action is set to Deny
, the Deny
action
prevails and your API call fails.
You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to Amazon QuickSight, see Passing IAM roles to Amazon QuickSight in the Amazon QuickSight User Guide.
You can't set default resource access on the new account from the Amazon QuickSight API. Instead, add default resource access from the Amazon QuickSight console. For more information about setting default resource access to Amazon Web Services services, see Setting default resource access to Amazon Web Services services in the Amazon QuickSight User Guide.
1748 1749 1750 1751 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1748 def create_account_subscription(params = {}, = {}) req = build_request(:create_account_subscription, params) req.send_request() end |
#create_analysis(params = {}) ⇒ Types::CreateAnalysisResponse
Creates an analysis in Amazon QuickSight. Analyses can be created
either from a template or from an AnalysisDefinition
.
1837 1838 1839 1840 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1837 def create_analysis(params = {}, = {}) req = build_request(:create_analysis, params) req.send_request() end |
#create_brand(params = {}) ⇒ Types::CreateBrandResponse
Creates an Amazon QuickSight brand.
2017 2018 2019 2020 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2017 def create_brand(params = {}, = {}) req = build_request(:create_brand, params) req.send_request() end |
#create_custom_permissions(params = {}) ⇒ Types::CreateCustomPermissionsResponse
Creates a custom permissions profile.
2091 2092 2093 2094 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2091 def (params = {}, = {}) req = build_request(:create_custom_permissions, params) req.send_request() end |
#create_dashboard(params = {}) ⇒ Types::CreateDashboardResponse
Creates a dashboard from either a template or directly with a
DashboardDefinition
. To first create a template, see the
CreateTemplate
API operation.
A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon 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 Amazon Web Services account.
2226 2227 2228 2229 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2226 def create_dashboard(params = {}, = {}) req = build_request(:create_dashboard, params) req.send_request() end |
#create_data_set(params = {}) ⇒ Types::CreateDataSetResponse
Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.
2557 2558 2559 2560 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2557 def create_data_set(params = {}, = {}) req = build_request(:create_data_set, params) req.send_request() end |
#create_data_source(params = {}) ⇒ Types::CreateDataSourceResponse
Creates a data source.
2984 2985 2986 2987 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2984 def create_data_source(params = {}, = {}) req = build_request(:create_data_source, params) req.send_request() end |
#create_folder(params = {}) ⇒ Types::CreateFolderResponse
Creates an empty shared folder.
3064 3065 3066 3067 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3064 def create_folder(params = {}, = {}) req = build_request(:create_folder, params) req.send_request() end |
#create_folder_membership(params = {}) ⇒ Types::CreateFolderMembershipResponse
Adds an asset, such as a dashboard, analysis, or dataset into a folder.
3110 3111 3112 3113 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3110 def create_folder_membership(params = {}, = {}) req = build_request(:create_folder_membership, params) req.send_request() end |
#create_group(params = {}) ⇒ Types::CreateGroupResponse
Use the CreateGroup
operation to create a group in Amazon
QuickSight. 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.
The permissions resource is
arn:aws:quicksight:<your-region>:<relevant-aws-account-id>:group/default/<group-name>
.
The response is a group object.
3168 3169 3170 3171 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3168 def create_group(params = {}, = {}) req = build_request(:create_group, params) req.send_request() end |
#create_group_membership(params = {}) ⇒ Types::CreateGroupMembershipResponse
Adds an Amazon QuickSight user to an Amazon QuickSight group.
3215 3216 3217 3218 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3215 def create_group_membership(params = {}, = {}) req = build_request(:create_group_membership, params) req.send_request() end |
#create_iam_policy_assignment(params = {}) ⇒ Types::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 QuickSight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.
3296 3297 3298 3299 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3296 def create_iam_policy_assignment(params = {}, = {}) req = build_request(:create_iam_policy_assignment, params) req.send_request() end |
#create_ingestion(params = {}) ⇒ Types::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.
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 Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
3358 3359 3360 3361 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3358 def create_ingestion(params = {}, = {}) req = build_request(:create_ingestion, params) req.send_request() end |
#create_namespace(params = {}) ⇒ Types::CreateNamespaceResponse
(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
A namespace allows you to isolate the Amazon 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 Amazon Web Services account is subscribed to Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web ServicesSupport.
3429 3430 3431 3432 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3429 def create_namespace(params = {}, = {}) req = build_request(:create_namespace, params) req.send_request() end |
#create_refresh_schedule(params = {}) ⇒ Types::CreateRefreshScheduleResponse
Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.
3486 3487 3488 3489 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3486 def create_refresh_schedule(params = {}, = {}) req = build_request(:create_refresh_schedule, params) req.send_request() end |
#create_role_membership(params = {}) ⇒ Types::CreateRoleMembershipResponse
Use CreateRoleMembership
to add an existing Amazon QuickSight group
to an existing role.
3532 3533 3534 3535 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3532 def create_role_membership(params = {}, = {}) req = build_request(:create_role_membership, params) req.send_request() end |
#create_template(params = {}) ⇒ Types::CreateTemplateResponse
Creates a template either from a TemplateDefinition
or from an
existing Amazon QuickSight analysis or template. You can use the
resulting template to create additional dashboards, templates, or
analyses.
A template is an entity in Amazon 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.
3631 3632 3633 3634 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3631 def create_template(params = {}, = {}) req = build_request(:create_template, params) req.send_request() end |
#create_template_alias(params = {}) ⇒ Types::CreateTemplateAliasResponse
Creates a template alias for a template.
3680 3681 3682 3683 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3680 def create_template_alias(params = {}, = {}) req = build_request(:create_template_alias, params) req.send_request() end |
#create_theme(params = {}) ⇒ Types::CreateThemeResponse
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.
3819 3820 3821 3822 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3819 def create_theme(params = {}, = {}) req = build_request(:create_theme, params) req.send_request() end |
#create_theme_alias(params = {}) ⇒ Types::CreateThemeAliasResponse
Creates a theme alias for a theme.
3868 3869 3870 3871 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3868 def create_theme_alias(params = {}, = {}) req = build_request(:create_theme_alias, params) req.send_request() end |
#create_topic(params = {}) ⇒ Types::CreateTopicResponse
Creates a new Q topic.
4156 4157 4158 4159 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4156 def create_topic(params = {}, = {}) req = build_request(:create_topic, params) req.send_request() end |
#create_topic_refresh_schedule(params = {}) ⇒ Types::CreateTopicRefreshScheduleResponse
Creates a topic refresh schedule.
4217 4218 4219 4220 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4217 def create_topic_refresh_schedule(params = {}, = {}) req = build_request(:create_topic_refresh_schedule, params) req.send_request() end |
#create_vpc_connection(params = {}) ⇒ Types::CreateVPCConnectionResponse
Creates a new VPC connection.
4293 4294 4295 4296 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4293 def create_vpc_connection(params = {}, = {}) req = build_request(:create_vpc_connection, params) req.send_request() end |
#delete_account_customization(params = {}) ⇒ Types::DeleteAccountCustomizationResponse
Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace.
4332 4333 4334 4335 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4332 def delete_account_customization(params = {}, = {}) req = build_request(:delete_account_customization, params) req.send_request() end |
#delete_account_subscription(params = {}) ⇒ Types::DeleteAccountSubscriptionResponse
Use the DeleteAccountSubscription
operation to delete an Amazon
QuickSight account. This operation will result in an error message if
you have configured your account termination protection settings to
True
. To change this setting and delete your account, call the
UpdateAccountSettings
API and set the value of the
TerminationProtectionEnabled
parameter to False
, then make another
call to the DeleteAccountSubscription
API.
4369 4370 4371 4372 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4369 def delete_account_subscription(params = {}, = {}) req = build_request(:delete_account_subscription, params) req.send_request() end |
#delete_analysis(params = {}) ⇒ Types::DeleteAnalysisResponse
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. Amazon QuickSight attaches a DeletionTime
stamp to the
response that specifies the end of the recovery window. At the end of
the recovery window, Amazon 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 Amazon QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
4440 4441 4442 4443 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4440 def delete_analysis(params = {}, = {}) req = build_request(:delete_analysis, params) req.send_request() end |
#delete_brand(params = {}) ⇒ Types::DeleteBrandResponse
Deletes an Amazon QuickSight brand.
4472 4473 4474 4475 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4472 def delete_brand(params = {}, = {}) req = build_request(:delete_brand, params) req.send_request() end |
#delete_brand_assignment(params = {}) ⇒ Types::DeleteBrandAssignmentResponse
Deletes a brand assignment.
4501 4502 4503 4504 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4501 def delete_brand_assignment(params = {}, = {}) req = build_request(:delete_brand_assignment, params) req.send_request() end |
#delete_custom_permissions(params = {}) ⇒ Types::DeleteCustomPermissionsResponse
Deletes a custom permissions profile.
4538 4539 4540 4541 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4538 def (params = {}, = {}) req = build_request(:delete_custom_permissions, params) req.send_request() end |
#delete_dashboard(params = {}) ⇒ Types::DeleteDashboardResponse
Deletes a dashboard.
4582 4583 4584 4585 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4582 def delete_dashboard(params = {}, = {}) req = build_request(:delete_dashboard, params) req.send_request() end |
#delete_data_set(params = {}) ⇒ Types::DeleteDataSetResponse
Deletes a dataset.
4621 4622 4623 4624 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4621 def delete_data_set(params = {}, = {}) req = build_request(:delete_data_set, params) req.send_request() end |
#delete_data_set_refresh_properties(params = {}) ⇒ Types::DeleteDataSetRefreshPropertiesResponse
Deletes the dataset refresh properties of the dataset.
4655 4656 4657 4658 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4655 def delete_data_set_refresh_properties(params = {}, = {}) req = build_request(:delete_data_set_refresh_properties, params) req.send_request() end |
#delete_data_source(params = {}) ⇒ Types::DeleteDataSourceResponse
Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.
4695 4696 4697 4698 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4695 def delete_data_source(params = {}, = {}) req = build_request(:delete_data_source, params) req.send_request() end |
#delete_default_q_business_application(params = {}) ⇒ Types::DeleteDefaultQBusinessApplicationResponse
Deletes a linked Amazon Q Business application from an Amazon QuickSight account
4735 4736 4737 4738 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4735 def delete_default_q_business_application(params = {}, = {}) req = build_request(:delete_default_q_business_application, params) req.send_request() end |
#delete_folder(params = {}) ⇒ Types::DeleteFolderResponse
Deletes an empty folder.
4773 4774 4775 4776 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4773 def delete_folder(params = {}, = {}) req = build_request(:delete_folder, params) req.send_request() end |
#delete_folder_membership(params = {}) ⇒ Types::DeleteFolderMembershipResponse
Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
4816 4817 4818 4819 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4816 def delete_folder_membership(params = {}, = {}) req = build_request(:delete_folder_membership, params) req.send_request() end |
#delete_group(params = {}) ⇒ Types::DeleteGroupResponse
Removes a user group from Amazon QuickSight.
4856 4857 4858 4859 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4856 def delete_group(params = {}, = {}) req = build_request(:delete_group, params) req.send_request() end |
#delete_group_membership(params = {}) ⇒ Types::DeleteGroupMembershipResponse
Removes a user from a group so that the user is no longer a member of the group.
4902 4903 4904 4905 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4902 def delete_group_membership(params = {}, = {}) req = build_request(:delete_group_membership, params) req.send_request() end |
#delete_iam_policy_assignment(params = {}) ⇒ Types::DeleteIAMPolicyAssignmentResponse
Deletes an existing IAM policy assignment.
4943 4944 4945 4946 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4943 def delete_iam_policy_assignment(params = {}, = {}) req = build_request(:delete_iam_policy_assignment, params) req.send_request() end |
#delete_identity_propagation_config(params = {}) ⇒ Types::DeleteIdentityPropagationConfigResponse
Deletes all access scopes and authorized targets that are associated with a service from the Amazon QuickSight IAM Identity Center application.
This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.
4984 4985 4986 4987 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4984 def delete_identity_propagation_config(params = {}, = {}) req = build_request(:delete_identity_propagation_config, params) req.send_request() end |
#delete_namespace(params = {}) ⇒ Types::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.
5023 5024 5025 5026 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5023 def delete_namespace(params = {}, = {}) req = build_request(:delete_namespace, params) req.send_request() end |
#delete_refresh_schedule(params = {}) ⇒ Types::DeleteRefreshScheduleResponse
Deletes a refresh schedule from a dataset.
5065 5066 5067 5068 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5065 def delete_refresh_schedule(params = {}, = {}) req = build_request(:delete_refresh_schedule, params) req.send_request() end |
#delete_role_custom_permission(params = {}) ⇒ Types::DeleteRoleCustomPermissionResponse
Removes custom permissions from the role.
5105 5106 5107 5108 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5105 def (params = {}, = {}) req = build_request(:delete_role_custom_permission, params) req.send_request() end |
#delete_role_membership(params = {}) ⇒ Types::DeleteRoleMembershipResponse
Removes a group from a role.
5150 5151 5152 5153 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5150 def delete_role_membership(params = {}, = {}) req = build_request(:delete_role_membership, params) req.send_request() end |
#delete_template(params = {}) ⇒ Types::DeleteTemplateResponse
Deletes a template.
5195 5196 5197 5198 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5195 def delete_template(params = {}, = {}) req = build_request(:delete_template, params) req.send_request() end |
#delete_template_alias(params = {}) ⇒ Types::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.
5245 5246 5247 5248 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5245 def delete_template_alias(params = {}, = {}) req = build_request(:delete_template_alias, params) req.send_request() end |
#delete_theme(params = {}) ⇒ Types::DeleteThemeResponse
Deletes a theme.
5291 5292 5293 5294 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5291 def delete_theme(params = {}, = {}) req = build_request(:delete_theme, params) req.send_request() end |
#delete_theme_alias(params = {}) ⇒ Types::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.
5338 5339 5340 5341 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5338 def delete_theme_alias(params = {}, = {}) req = build_request(:delete_theme_alias, params) req.send_request() end |
#delete_topic(params = {}) ⇒ Types::DeleteTopicResponse
Deletes a topic.
5378 5379 5380 5381 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5378 def delete_topic(params = {}, = {}) req = build_request(:delete_topic, params) req.send_request() end |
#delete_topic_refresh_schedule(params = {}) ⇒ Types::DeleteTopicRefreshScheduleResponse
Deletes a topic refresh schedule.
5423 5424 5425 5426 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5423 def delete_topic_refresh_schedule(params = {}, = {}) req = build_request(:delete_topic_refresh_schedule, params) req.send_request() end |
#delete_user(params = {}) ⇒ Types::DeleteUserResponse
Deletes the Amazon QuickSight 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.
5465 5466 5467 5468 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5465 def delete_user(params = {}, = {}) req = build_request(:delete_user, params) req.send_request() end |
#delete_user_by_principal_id(params = {}) ⇒ Types::DeleteUserByPrincipalIdResponse
Deletes a user identified by its principal ID.
5505 5506 5507 5508 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5505 def delete_user_by_principal_id(params = {}, = {}) req = build_request(:delete_user_by_principal_id, params) req.send_request() end |
#delete_user_custom_permission(params = {}) ⇒ Types::DeleteUserCustomPermissionResponse
Deletes a custom permissions profile from a user.
5545 5546 5547 5548 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5545 def (params = {}, = {}) req = build_request(:delete_user_custom_permission, params) req.send_request() end |
#delete_vpc_connection(params = {}) ⇒ Types::DeleteVPCConnectionResponse
Deletes a VPC connection.
5590 5591 5592 5593 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5590 def delete_vpc_connection(params = {}, = {}) req = build_request(:delete_vpc_connection, params) req.send_request() end |
#describe_account_customization(params = {}) ⇒ Types::DescribeAccountCustomizationResponse
Describes the customizations associated with the provided Amazon Web
Services account and Amazon Amazon QuickSight namespace in an Amazon
Web Services Region. The Amazon 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.
Amazon Web Services account
- The Amazon Web Services account exists at the top of the hierarchy. It has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you subscribe to Amazon QuickSight, you choose one Amazon Web Services Region to use as your home Region. That's where your free SPICE capacity is located. You can use Amazon QuickSight in any supported Amazon Web Services Region.Amazon Web Services Region
- In each Amazon Web Services Region where you sign in to Amazon QuickSight at least once, Amazon 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 Amazon QuickSight in any Amazon Web Services Region, unless they are constrained to a namespace.To run the command in a different Amazon Web Services Region, you change your Region settings. If you're using the CLI, you can use one of the following options:
Use command line options.
Use named profiles.
Run
aws configure
to change your default Amazon Web Services Region. Use Enter to key the same settings for your keys. For more information, see Configuring the 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 Amazon Web Services account and Amazon Web Services Region.Applied customizations
- Within an Amazon Web Services Region, a set of Amazon QuickSight customizations can apply to an Amazon Web Services account or to a namespace. Settings that you apply to a namespace override settings that you apply to an Amazon Web Services account. All settings are isolated to a single Amazon Web Services Region. To apply them in other Amazon Web Services Regions, run theCreateAccountCustomization
command in each Amazon Web Services Region where you want to apply the same customizations.
5701 5702 5703 5704 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5701 def describe_account_customization(params = {}, = {}) req = build_request(:describe_account_customization, params) req.send_request() end |
#describe_account_settings(params = {}) ⇒ Types::DescribeAccountSettingsResponse
Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account.
5740 5741 5742 5743 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5740 def describe_account_settings(params = {}, = {}) req = build_request(:describe_account_settings, params) req.send_request() end |
#describe_account_subscription(params = {}) ⇒ Types::DescribeAccountSubscriptionResponse
Use the DescribeAccountSubscription operation to receive a description
of an Amazon QuickSight 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.
5782 5783 5784 5785 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5782 def describe_account_subscription(params = {}, = {}) req = build_request(:describe_account_subscription, params) req.send_request() end |
#describe_analysis(params = {}) ⇒ Types::DescribeAnalysisResponse
Provides a summary of the metadata for an analysis.
5870 5871 5872 5873 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5870 def describe_analysis(params = {}, = {}) req = build_request(:describe_analysis, params) req.send_request() end |
#describe_analysis_definition(params = {}) ⇒ Types::DescribeAnalysisDefinitionResponse
Provides a detailed description of the definition of an analysis.
DescribeAnalysis
instead.
5919 5920 5921 5922 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5919 def describe_analysis_definition(params = {}, = {}) req = build_request(:describe_analysis_definition, params) req.send_request() end |
#describe_analysis_permissions(params = {}) ⇒ Types::DescribeAnalysisPermissionsResponse
Provides the read and write permissions for an analysis.
5965 5966 5967 5968 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5965 def (params = {}, = {}) req = build_request(:describe_analysis_permissions, params) req.send_request() end |
#describe_asset_bundle_export_job(params = {}) ⇒ Types::DescribeAssetBundleExportJobResponse
Describes an existing export job.
Poll job descriptions after a job starts to know the status of the
job. When a job succeeds, a URL is provided to download the exported
assets' data from. Download URLs are valid for five minutes after
they are generated. You can call the DescribeAssetBundleExportJob
API for a new download URL as needed.
Job descriptions are available for 14 days after the job starts.
6081 6082 6083 6084 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6081 def describe_asset_bundle_export_job(params = {}, = {}) req = build_request(:describe_asset_bundle_export_job, params) req.send_request() end |
#describe_asset_bundle_import_job(params = {}) ⇒ Types::DescribeAssetBundleImportJobResponse
Describes an existing import job.
Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.
6374 6375 6376 6377 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6374 def describe_asset_bundle_import_job(params = {}, = {}) req = build_request(:describe_asset_bundle_import_job, params) req.send_request() end |
#describe_brand(params = {}) ⇒ Types::DescribeBrandResponse
Describes a brand.
6470 6471 6472 6473 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6470 def describe_brand(params = {}, = {}) req = build_request(:describe_brand, params) req.send_request() end |
#describe_brand_assignment(params = {}) ⇒ Types::DescribeBrandAssignmentResponse
Describes a brand assignment.
6501 6502 6503 6504 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6501 def describe_brand_assignment(params = {}, = {}) req = build_request(:describe_brand_assignment, params) req.send_request() end |
#describe_brand_published_version(params = {}) ⇒ Types::DescribeBrandPublishedVersionResponse
Describes the published version of the brand.
6592 6593 6594 6595 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6592 def describe_brand_published_version(params = {}, = {}) req = build_request(:describe_brand_published_version, params) req.send_request() end |
#describe_custom_permissions(params = {}) ⇒ Types::DescribeCustomPermissionsResponse
Describes a custom permissions profile.
6653 6654 6655 6656 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6653 def (params = {}, = {}) req = build_request(:describe_custom_permissions, params) req.send_request() end |
#describe_dashboard(params = {}) ⇒ Types::DescribeDashboardResponse
Provides a summary for a dashboard.
6756 6757 6758 6759 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6756 def describe_dashboard(params = {}, = {}) req = build_request(:describe_dashboard, params) req.send_request() end |
#describe_dashboard_definition(params = {}) ⇒ Types::DescribeDashboardDefinitionResponse
Provides a detailed description of the definition of a dashboard.
DescribeDashboard
instead.
6813 6814 6815 6816 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6813 def describe_dashboard_definition(params = {}, = {}) req = build_request(:describe_dashboard_definition, params) req.send_request() end |
#describe_dashboard_permissions(params = {}) ⇒ Types::DescribeDashboardPermissionsResponse
Describes read and write permissions for a dashboard.
6862 6863 6864 6865 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6862 def (params = {}, = {}) req = build_request(:describe_dashboard_permissions, params) req.send_request() end |
#describe_dashboard_snapshot_job(params = {}) ⇒ Types::DescribeDashboardSnapshotJobResponse
Describes an existing snapshot job.
Poll job descriptions after a job starts to know the status of the
job. For information on available status codes, see JobStatus
.
6952 6953 6954 6955 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6952 def describe_dashboard_snapshot_job(params = {}, = {}) req = build_request(:describe_dashboard_snapshot_job, params) req.send_request() end |
#describe_dashboard_snapshot_job_result(params = {}) ⇒ Types::DescribeDashboardSnapshotJobResultResponse
Describes the result of an existing snapshot job that has finished running.
A finished snapshot job will return a COMPLETED
or FAILED
status
when you poll the job with a DescribeDashboardSnapshotJob
API call.
If the job has not finished running, this operation returns a message
that says Dashboard Snapshot Job with id <SnapshotjobId> has not
reached a terminal state.
.
7029 7030 7031 7032 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7029 def describe_dashboard_snapshot_job_result(params = {}, = {}) req = build_request(:describe_dashboard_snapshot_job_result, params) req.send_request() end |
#describe_dashboards_qa_configuration(params = {}) ⇒ Types::DescribeDashboardsQAConfigurationResponse
Describes an existing dashboard QA configuration.
7062 7063 7064 7065 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7062 def describe_dashboards_qa_configuration(params = {}, = {}) req = build_request(:describe_dashboards_qa_configuration, params) req.send_request() end |
#describe_data_set(params = {}) ⇒ Types::DescribeDataSetResponse
Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.
7234 7235 7236 7237 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7234 def describe_data_set(params = {}, = {}) req = build_request(:describe_data_set, params) req.send_request() end |
#describe_data_set_permissions(params = {}) ⇒ Types::DescribeDataSetPermissionsResponse
Describes the permissions on a dataset.
The permissions resource is
arn:aws:quicksight:region:aws-account-id:dataset/data-set-id
.
7281 7282 7283 7284 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7281 def (params = {}, = {}) req = build_request(:describe_data_set_permissions, params) req.send_request() end |
#describe_data_set_refresh_properties(params = {}) ⇒ Types::DescribeDataSetRefreshPropertiesResponse
Describes the refresh properties of a dataset.
7320 7321 7322 7323 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7320 def describe_data_set_refresh_properties(params = {}, = {}) req = build_request(:describe_data_set_refresh_properties, params) req.send_request() end |
#describe_data_source(params = {}) ⇒ Types::DescribeDataSourceResponse
Describes a data source.
7545 7546 7547 7548 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7545 def describe_data_source(params = {}, = {}) req = build_request(:describe_data_source, params) req.send_request() end |
#describe_data_source_permissions(params = {}) ⇒ Types::DescribeDataSourcePermissionsResponse
Describes the resource permissions for a data source.
7589 7590 7591 7592 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7589 def (params = {}, = {}) req = build_request(:describe_data_source_permissions, params) req.send_request() end |
#describe_default_q_business_application(params = {}) ⇒ Types::DescribeDefaultQBusinessApplicationResponse
Describes a Amazon Q Business application that is linked to an Amazon QuickSight account.
7630 7631 7632 7633 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7630 def describe_default_q_business_application(params = {}, = {}) req = build_request(:describe_default_q_business_application, params) req.send_request() end |
#describe_folder(params = {}) ⇒ Types::DescribeFolderResponse
Describes a folder.
7674 7675 7676 7677 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7674 def describe_folder(params = {}, = {}) req = build_request(:describe_folder, params) req.send_request() end |
#describe_folder_permissions(params = {}) ⇒ Types::DescribeFolderPermissionsResponse
Describes permissions for a folder.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7733 7734 7735 7736 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7733 def (params = {}, = {}) req = build_request(:describe_folder_permissions, params) req.send_request() end |
#describe_folder_resolved_permissions(params = {}) ⇒ Types::DescribeFolderResolvedPermissionsResponse
Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7794 7795 7796 7797 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7794 def (params = {}, = {}) req = build_request(:describe_folder_resolved_permissions, params) req.send_request() end |
#describe_group(params = {}) ⇒ Types::DescribeGroupResponse
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
7840 7841 7842 7843 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7840 def describe_group(params = {}, = {}) req = build_request(:describe_group, params) req.send_request() end |
#describe_group_membership(params = {}) ⇒ Types::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.
7889 7890 7891 7892 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7889 def describe_group_membership(params = {}, = {}) req = build_request(:describe_group_membership, params) req.send_request() end |
#describe_iam_policy_assignment(params = {}) ⇒ Types::DescribeIAMPolicyAssignmentResponse
Describes an existing IAM policy assignment, as specified by the assignment name.
7938 7939 7940 7941 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7938 def describe_iam_policy_assignment(params = {}, = {}) req = build_request(:describe_iam_policy_assignment, params) req.send_request() end |
#describe_ingestion(params = {}) ⇒ Types::DescribeIngestionResponse
Describes a SPICE ingestion.
7992 7993 7994 7995 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7992 def describe_ingestion(params = {}, = {}) req = build_request(:describe_ingestion, params) req.send_request() end |
#describe_ip_restriction(params = {}) ⇒ Types::DescribeIpRestrictionResponse
Provides a summary and status of IP rules.
8035 8036 8037 8038 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8035 def describe_ip_restriction(params = {}, = {}) req = build_request(:describe_ip_restriction, params) req.send_request() end |
#describe_key_registration(params = {}) ⇒ Types::DescribeKeyRegistrationResponse
Describes all customer managed key registrations in a Amazon QuickSight account.
8077 8078 8079 8080 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8077 def describe_key_registration(params = {}, = {}) req = build_request(:describe_key_registration, params) req.send_request() end |
#describe_namespace(params = {}) ⇒ Types::DescribeNamespaceResponse
Describes the current namespace.
8122 8123 8124 8125 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8122 def describe_namespace(params = {}, = {}) req = build_request(:describe_namespace, params) req.send_request() end |
#describe_q_personalization_configuration(params = {}) ⇒ Types::DescribeQPersonalizationConfigurationResponse
Describes a personalization configuration.
8155 8156 8157 8158 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8155 def describe_q_personalization_configuration(params = {}, = {}) req = build_request(:describe_q_personalization_configuration, params) req.send_request() end |
#describe_quick_sight_q_search_configuration(params = {}) ⇒ Types::DescribeQuickSightQSearchConfigurationResponse
Describes the state of a Amazon QuickSight Q Search configuration.
8188 8189 8190 8191 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8188 def describe_quick_sight_q_search_configuration(params = {}, = {}) req = build_request(:describe_quick_sight_q_search_configuration, params) req.send_request() end |
#describe_refresh_schedule(params = {}) ⇒ Types::DescribeRefreshScheduleResponse
Provides a summary of a refresh schedule.
8238 8239 8240 8241 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8238 def describe_refresh_schedule(params = {}, = {}) req = build_request(:describe_refresh_schedule, params) req.send_request() end |
#describe_role_custom_permission(params = {}) ⇒ Types::DescribeRoleCustomPermissionResponse
Describes all custom permissions that are mapped to a role.
8281 8282 8283 8284 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8281 def (params = {}, = {}) req = build_request(:describe_role_custom_permission, params) req.send_request() end |
#describe_template(params = {}) ⇒ Types::DescribeTemplateResponse
Describes a template's metadata.
8393 8394 8395 8396 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8393 def describe_template(params = {}, = {}) req = build_request(:describe_template, params) req.send_request() end |
#describe_template_alias(params = {}) ⇒ Types::DescribeTemplateAliasResponse
Describes the template alias for a template.
8440 8441 8442 8443 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8440 def describe_template_alias(params = {}, = {}) req = build_request(:describe_template_alias, params) req.send_request() end |
#describe_template_definition(params = {}) ⇒ Types::DescribeTemplateDefinitionResponse
Provides a detailed description of the definition of a template.
DescribeTemplate
instead.
8500 8501 8502 8503 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8500 def describe_template_definition(params = {}, = {}) req = build_request(:describe_template_definition, params) req.send_request() end |
#describe_template_permissions(params = {}) ⇒ Types::DescribeTemplatePermissionsResponse
Describes read and write permissions on a template.
8544 8545 8546 8547 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8544 def (params = {}, = {}) req = build_request(:describe_template_permissions, params) req.send_request() end |
#describe_theme(params = {}) ⇒ Types::DescribeThemeResponse
Describes a theme.
8635 8636 8637 8638 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8635 def describe_theme(params = {}, = {}) req = build_request(:describe_theme, params) req.send_request() end |
#describe_theme_alias(params = {}) ⇒ Types::DescribeThemeAliasResponse
Describes the alias for a theme.
8678 8679 8680 8681 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8678 def describe_theme_alias(params = {}, = {}) req = build_request(:describe_theme_alias, params) req.send_request() end |
#describe_theme_permissions(params = {}) ⇒ Types::DescribeThemePermissionsResponse
Describes the read and write permissions for a theme.
8722 8723 8724 8725 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8722 def (params = {}, = {}) req = build_request(:describe_theme_permissions, params) req.send_request() end |
#describe_topic(params = {}) ⇒ Types::DescribeTopicResponse
Describes a topic.
8920 8921 8922 8923 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8920 def describe_topic(params = {}, = {}) req = build_request(:describe_topic, params) req.send_request() end |
#describe_topic_permissions(params = {}) ⇒ Types::DescribeTopicPermissionsResponse
Describes the permissions of a topic.
8965 8966 8967 8968 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8965 def (params = {}, = {}) req = build_request(:describe_topic_permissions, params) req.send_request() end |
#describe_topic_refresh(params = {}) ⇒ Types::DescribeTopicRefreshResponse
Describes the status of a topic refresh.
9010 9011 9012 9013 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9010 def describe_topic_refresh(params = {}, = {}) req = build_request(:describe_topic_refresh, params) req.send_request() end |
#describe_topic_refresh_schedule(params = {}) ⇒ Types::DescribeTopicRefreshScheduleResponse
Deletes a topic refresh schedule.
9063 9064 9065 9066 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9063 def describe_topic_refresh_schedule(params = {}, = {}) req = build_request(:describe_topic_refresh_schedule, params) req.send_request() end |
#describe_user(params = {}) ⇒ Types::DescribeUserResponse
Returns information about a user, given the user name.
9115 9116 9117 9118 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9115 def describe_user(params = {}, = {}) req = build_request(:describe_user, params) req.send_request() end |
#describe_vpc_connection(params = {}) ⇒ Types::DescribeVPCConnectionResponse
Describes a VPC connection.
9172 9173 9174 9175 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9172 def describe_vpc_connection(params = {}, = {}) req = build_request(:describe_vpc_connection, params) req.send_request() end |
#generate_embed_url_for_anonymous_user(params = {}) ⇒ Types::GenerateEmbedUrlForAnonymousUserResponse
Generates an embed URL that you can use to embed an Amazon QuickSight 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.
The following rules apply to the generated URL:
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
The URL validity period should not be confused with the actual session lifetime that can be customized using the
SessionLifetimeInMinutes
parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.You are charged only when the URL is used or there is interaction with Amazon QuickSight.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
9324 9325 9326 9327 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9324 def (params = {}, = {}) req = build_request(:generate_embed_url_for_anonymous_user, params) req.send_request() end |
#generate_embed_url_for_registered_user(params = {}) ⇒ Types::GenerateEmbedUrlForRegisteredUserResponse
Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.
The following rules apply to the generated URL:
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
The URL validity period should not be confused with the actual session lifetime that can be customized using the
SessionLifetimeInMinutes
parameter.The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
9494 9495 9496 9497 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9494 def (params = {}, = {}) req = build_request(:generate_embed_url_for_registered_user, params) req.send_request() end |
#generate_embed_url_for_registered_user_with_identity(params = {}) ⇒ Types::GenerateEmbedUrlForRegisteredUserWithIdentityResponse
Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user that is registered in an Amazon QuickSight 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.
This API uses trusted identity propagation to ensure that an end
user is authenticated and receives the embed URL that is specific to
that user. The IAM Identity Center application that the user has
logged into needs to have trusted Identity Propagation enabled for
Amazon QuickSight with the scope value set to quicksight:read
.
Before you use this action, make sure that you have configured the
relevant Amazon QuickSight resource and permissions.
9641 9642 9643 9644 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9641 def (params = {}, = {}) req = build_request(:generate_embed_url_for_registered_user_with_identity, params) req.send_request() end |
#get_dashboard_embed_url(params = {}) ⇒ Types::GetDashboardEmbedUrlResponse
Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon QuickSight read-only dashboard in your website or application. 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
generated URL:
They must be used together.
They can be used one time only.
They are valid for 5 minutes after you run this command.
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional
SessionLifetimeInMinutes
parameter to customize session duration.
For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
9775 9776 9777 9778 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9775 def (params = {}, = {}) req = build_request(:get_dashboard_embed_url, params) req.send_request() end |
#get_session_embed_url(params = {}) ⇒ Types::GetSessionEmbedUrlResponse
Generates a session URL and authorization code that you can use to
embed the Amazon 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 Amazon 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:
9869 9870 9871 9872 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9869 def (params = {}, = {}) req = build_request(:get_session_embed_url, params) req.send_request() end |
#list_analyses(params = {}) ⇒ Types::ListAnalysesResponse
Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9920 9921 9922 9923 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9920 def list_analyses(params = {}, = {}) req = build_request(:list_analyses, params) req.send_request() end |
#list_asset_bundle_export_jobs(params = {}) ⇒ Types::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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9978 9979 9980 9981 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9978 def list_asset_bundle_export_jobs(params = {}, = {}) req = build_request(:list_asset_bundle_export_jobs, params) req.send_request() end |
#list_asset_bundle_import_jobs(params = {}) ⇒ Types::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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10033 10034 10035 10036 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10033 def list_asset_bundle_import_jobs(params = {}, = {}) req = build_request(:list_asset_bundle_import_jobs, params) req.send_request() end |
#list_brands(params = {}) ⇒ Types::ListBrandsResponse
Lists all brands in an Amazon QuickSight account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10082 10083 10084 10085 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10082 def list_brands(params = {}, = {}) req = build_request(:list_brands, params) req.send_request() end |
#list_custom_permissions(params = {}) ⇒ Types::ListCustomPermissionsResponse
Returns a list of all the custom permissions profiles.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10153 10154 10155 10156 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10153 def (params = {}, = {}) req = build_request(:list_custom_permissions, params) req.send_request() end |
#list_dashboard_versions(params = {}) ⇒ Types::ListDashboardVersionsResponse
Lists all the versions of the dashboards in the Amazon QuickSight subscription.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10210 10211 10212 10213 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10210 def list_dashboard_versions(params = {}, = {}) req = build_request(:list_dashboard_versions, params) req.send_request() end |
#list_dashboards(params = {}) ⇒ Types::ListDashboardsResponse
Lists dashboards in an Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10263 10264 10265 10266 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10263 def list_dashboards(params = {}, = {}) req = build_request(:list_dashboards, params) req.send_request() end |
#list_data_sets(params = {}) ⇒ Types::ListDataSetsResponse
Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.
The permissions resource is
arn:aws:quicksight:region:aws-account-id:dataset/*
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10326 10327 10328 10329 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10326 def list_data_sets(params = {}, = {}) req = build_request(:list_data_sets, params) req.send_request() end |
#list_data_sources(params = {}) ⇒ Types::ListDataSourcesResponse
Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10561 10562 10563 10564 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10561 def list_data_sources(params = {}, = {}) req = build_request(:list_data_sources, params) req.send_request() end |
#list_folder_members(params = {}) ⇒ Types::ListFolderMembersResponse
List all assets (DASHBOARD
, ANALYSIS
, and DATASET
) in a folder.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10612 10613 10614 10615 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10612 def list_folder_members(params = {}, = {}) req = build_request(:list_folder_members, params) req.send_request() end |
#list_folders(params = {}) ⇒ Types::ListFoldersResponse
Lists all folders in an account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10664 10665 10666 10667 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10664 def list_folders(params = {}, = {}) req = build_request(:list_folders, params) req.send_request() end |
#list_folders_for_resource(params = {}) ⇒ Types::ListFoldersForResourceResponse
List all folders that a resource is a member of.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10715 10716 10717 10718 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10715 def list_folders_for_resource(params = {}, = {}) req = build_request(:list_folders_for_resource, params) req.send_request() end |
#list_group_memberships(params = {}) ⇒ Types::ListGroupMembershipsResponse
Lists member users in a group.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10771 10772 10773 10774 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10771 def list_group_memberships(params = {}, = {}) req = build_request(:list_group_memberships, params) req.send_request() end |
#list_groups(params = {}) ⇒ Types::ListGroupsResponse
Lists all user groups in Amazon QuickSight.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10825 10826 10827 10828 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10825 def list_groups(params = {}, = {}) req = build_request(:list_groups, params) req.send_request() end |
#list_iam_policy_assignments(params = {}) ⇒ Types::ListIAMPolicyAssignmentsResponse
Lists the IAM policy assignments in the current Amazon QuickSight account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10882 10883 10884 10885 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10882 def list_iam_policy_assignments(params = {}, = {}) req = build_request(:list_iam_policy_assignments, params) req.send_request() end |
#list_iam_policy_assignments_for_user(params = {}) ⇒ Types::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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10940 10941 10942 10943 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10940 def list_iam_policy_assignments_for_user(params = {}, = {}) req = build_request(:list_iam_policy_assignments_for_user, params) req.send_request() end |
#list_identity_propagation_configs(params = {}) ⇒ Types::ListIdentityPropagationConfigsResponse
Lists all services and authorized targets that the Amazon QuickSight IAM Identity Center application can access.
This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.
10991 10992 10993 10994 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10991 def list_identity_propagation_configs(params = {}, = {}) req = build_request(:list_identity_propagation_configs, params) req.send_request() end |
#list_ingestions(params = {}) ⇒ Types::ListIngestionsResponse
Lists the history of SPICE ingestions for a dataset. Limited to 5 TPS per user and 25 TPS per account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11056 11057 11058 11059 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11056 def list_ingestions(params = {}, = {}) req = build_request(:list_ingestions, params) req.send_request() end |
#list_namespaces(params = {}) ⇒ Types::ListNamespacesResponse
Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11118 11119 11120 11121 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11118 def list_namespaces(params = {}, = {}) req = build_request(:list_namespaces, params) req.send_request() end |
#list_refresh_schedules(params = {}) ⇒ Types::ListRefreshSchedulesResponse
Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.
11164 11165 11166 11167 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11164 def list_refresh_schedules(params = {}, = {}) req = build_request(:list_refresh_schedules, params) req.send_request() end |
#list_role_memberships(params = {}) ⇒ Types::ListRoleMembershipsResponse
Lists all groups that are associated with a role.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11220 11221 11222 11223 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11220 def list_role_memberships(params = {}, = {}) req = build_request(:list_role_memberships, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags assigned to a resource.
11255 11256 11257 11258 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11255 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_template_aliases(params = {}) ⇒ Types::ListTemplateAliasesResponse
Lists all the aliases of a template.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11308 11309 11310 11311 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11308 def list_template_aliases(params = {}, = {}) req = build_request(:list_template_aliases, params) req.send_request() end |
#list_template_versions(params = {}) ⇒ Types::ListTemplateVersionsResponse
Lists all the versions of the templates in the current Amazon QuickSight account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11364 11365 11366 11367 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11364 def list_template_versions(params = {}, = {}) req = build_request(:list_template_versions, params) req.send_request() end |
#list_templates(params = {}) ⇒ Types::ListTemplatesResponse
Lists all the templates in the current Amazon QuickSight account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11416 11417 11418 11419 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11416 def list_templates(params = {}, = {}) req = build_request(:list_templates, params) req.send_request() end |
#list_theme_aliases(params = {}) ⇒ Types::ListThemeAliasesResponse
Lists all the aliases of a theme.
11467 11468 11469 11470 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11467 def list_theme_aliases(params = {}, = {}) req = build_request(:list_theme_aliases, params) req.send_request() end |
#list_theme_versions(params = {}) ⇒ Types::ListThemeVersionsResponse
Lists all the versions of the themes in the current Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11523 11524 11525 11526 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11523 def list_theme_versions(params = {}, = {}) req = build_request(:list_theme_versions, params) req.send_request() end |
#list_themes(params = {}) ⇒ Types::ListThemesResponse
Lists all the themes in the current Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11588 11589 11590 11591 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11588 def list_themes(params = {}, = {}) req = build_request(:list_themes, params) req.send_request() end |
#list_topic_refresh_schedules(params = {}) ⇒ Types::ListTopicRefreshSchedulesResponse
Lists all of the refresh schedules for a topic.
11639 11640 11641 11642 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11639 def list_topic_refresh_schedules(params = {}, = {}) req = build_request(:list_topic_refresh_schedules, params) req.send_request() end |
#list_topic_reviewed_answers(params = {}) ⇒ Types::ListTopicReviewedAnswersResponse
Lists all reviewed answers for a Q Topic.
12112 12113 12114 12115 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12112 def list_topic_reviewed_answers(params = {}, = {}) req = build_request(:list_topic_reviewed_answers, params) req.send_request() end |
#list_topics(params = {}) ⇒ Types::ListTopicsResponse
Lists all of the topics within an account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12162 12163 12164 12165 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12162 def list_topics(params = {}, = {}) req = build_request(:list_topics, params) req.send_request() end |
#list_user_groups(params = {}) ⇒ Types::ListUserGroupsResponse
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12222 12223 12224 12225 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12222 def list_user_groups(params = {}, = {}) req = build_request(:list_user_groups, params) req.send_request() end |
#list_users(params = {}) ⇒ Types::ListUsersResponse
Returns a list of all of the Amazon QuickSight users belonging to this account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12284 12285 12286 12287 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12284 def list_users(params = {}, = {}) req = build_request(:list_users, params) req.send_request() end |
#list_vpc_connections(params = {}) ⇒ Types::ListVPCConnectionsResponse
Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12350 12351 12352 12353 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12350 def list_vpc_connections(params = {}, = {}) req = build_request(:list_vpc_connections, params) req.send_request() end |
#predict_qa_results(params = {}) ⇒ Types::PredictQAResultsResponse
Predicts existing visuals or generates new visuals to answer a given query.
This API uses trusted identity propagation to ensure that an end
user is authenticated and receives the embed URL that is specific to
that user. The IAM Identity Center application that the user has
logged into needs to have trusted Identity Propagation enabled for
Amazon QuickSight with the scope value set to quicksight:read
.
Before you use this action, make sure that you have configured the
relevant Amazon QuickSight resource and permissions.
We recommend enabling the QSearchStatus
API to unlock the full
potential of PredictQnA
. When QSearchStatus
is enabled, it first
checks the specified dashboard for any existing visuals that match the
question. If no matching visuals are found, PredictQnA
uses
generative Q&A to provide an answer. To update the
QSearchStatus
, see UpdateQuickSightQSearchConfiguration.
12456 12457 12458 12459 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12456 def predict_qa_results(params = {}, = {}) req = build_request(:predict_qa_results, params) req.send_request() end |
#put_data_set_refresh_properties(params = {}) ⇒ Types::PutDataSetRefreshPropertiesResponse
Creates or updates the dataset refresh properties for the dataset.
12509 12510 12511 12512 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12509 def put_data_set_refresh_properties(params = {}, = {}) req = build_request(:put_data_set_refresh_properties, params) req.send_request() end |
#register_user(params = {}) ⇒ Types::RegisterUserResponse
Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Amazon QuickSight API, Amazon QuickSight generates a registration URL. The user accesses this registration URL to create their account. Amazon QuickSight doesn't send a registration email to users who are registered from the Amazon QuickSight API. If you want new users to receive a registration email, then add those users in the Amazon QuickSight console. For more information on registering a new user in the Amazon QuickSight console, see Inviting users to access Amazon QuickSight.
12707 12708 12709 12710 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12707 def register_user(params = {}, = {}) req = build_request(:register_user, params) req.send_request() end |
#restore_analysis(params = {}) ⇒ Types::RestoreAnalysisResponse
Restores an analysis.
12757 12758 12759 12760 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12757 def restore_analysis(params = {}, = {}) req = build_request(:restore_analysis, params) req.send_request() end |
#search_analyses(params = {}) ⇒ Types::SearchAnalysesResponse
Searches for analyses that belong to the user specified in the filter.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12824 12825 12826 12827 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12824 def search_analyses(params = {}, = {}) req = build_request(:search_analyses, params) req.send_request() end |
#search_dashboards(params = {}) ⇒ Types::SearchDashboardsResponse
Searches for dashboards that belong to a user.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12895 12896 12897 12898 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12895 def search_dashboards(params = {}, = {}) req = build_request(:search_dashboards, params) req.send_request() end |
#search_data_sets(params = {}) ⇒ Types::SearchDataSetsResponse
Use the SearchDataSets
operation to search for datasets that belong
to an account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
12964 12965 12966 12967 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12964 def search_data_sets(params = {}, = {}) req = build_request(:search_data_sets, params) req.send_request() end |
#search_data_sources(params = {}) ⇒ Types::SearchDataSourcesResponse
Use the SearchDataSources
operation to search for data sources that
belong to an account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
13025 13026 13027 13028 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13025 def search_data_sources(params = {}, = {}) req = build_request(:search_data_sources, params) req.send_request() end |
#search_folders(params = {}) ⇒ Types::SearchFoldersResponse
Searches the subfolders in a folder.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
13090 13091 13092 13093 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13090 def search_folders(params = {}, = {}) req = build_request(:search_folders, params) req.send_request() end |
#search_groups(params = {}) ⇒ Types::SearchGroupsResponse
Use the SearchGroups
operation to search groups in a specified
Amazon QuickSight namespace using the supplied filters.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
13156 13157 13158 13159 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13156 def search_groups(params = {}, = {}) req = build_request(:search_groups, params) req.send_request() end |
#search_topics(params = {}) ⇒ Types::SearchTopicsResponse
Searches for any Q topic that exists in an Amazon QuickSight account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
13216 13217 13218 13219 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13216 def search_topics(params = {}, = {}) req = build_request(:search_topics, params) req.send_request() end |
#start_asset_bundle_export_job(params = {}) ⇒ Types::StartAssetBundleExportJobResponse
Starts an Asset Bundle export job.
An Asset Bundle export job exports specified Amazon QuickSight assets.
You can also choose to export any asset dependencies in the same job.
Export jobs run asynchronously and can be polled with a
DescribeAssetBundleExportJob
API call. When a job is successfully
completed, a download URL that contains the exported assets is
returned. The URL is valid for 5 minutes and can be refreshed with a
DescribeAssetBundleExportJob
API call. Each Amazon QuickSight
account can run up to 5 export jobs concurrently.
The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.
13398 13399 13400 13401 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13398 def start_asset_bundle_export_job(params = {}, = {}) req = build_request(:start_asset_bundle_export_job, params) req.send_request() end |
#start_asset_bundle_import_job(params = {}) ⇒ Types::StartAssetBundleImportJobResponse
Starts an Asset Bundle import job.
An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight account can run up to 5 import jobs concurrently.
The API caller must have the necessary "create"
, "describe"
, and
"update"
permissions in their IAM role to access each resource type
that is contained in the bundle file before the resources can be
imported.
13877 13878 13879 13880 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13877 def start_asset_bundle_import_job(params = {}, = {}) req = build_request(:start_asset_bundle_import_job, params) req.send_request() end |
#start_dashboard_snapshot_job(params = {}) ⇒ Types::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.
1 Paginated PDF
1 Excel workbook that includes up to 5 table or pivot table visuals
5 CSVs from table or pivot table visuals
The status of a submitted job can be polled with the
DescribeDashboardSnapshotJob
API. When you call the
DescribeDashboardSnapshotJob
API, check the JobStatus
field in the
response. Once the job reaches a COMPLETED
or FAILED
status, use
the DescribeDashboardSnapshotJobResult
API to obtain the URLs for
the generated files. If the job fails, the
DescribeDashboardSnapshotJobResult
API returns detailed information
about the error that occurred.
StartDashboardSnapshotJob API throttling
Amazon QuickSight utilizes API throttling to create a more consistent
user experience within a time span for customers when they call the
StartDashboardSnapshotJob
. By default, 12 jobs can run
simlutaneously in one Amazon Web Services account and users can submit
up 10 API requests per second before an account is throttled. If an
overwhelming number of API requests are made by the same user in a
short period of time, Amazon QuickSight throttles the API calls to
maintin an optimal experience and reliability for all Amazon
QuickSight users.
Common throttling scenarios
The following list provides information about the most commin throttling scenarios that can occur.
A large number of
SnapshotExport
API jobs are running simultaneously on an Amazon Web Services account. When a newStartDashboardSnapshotJob
is created and there are already 12 jobs with theRUNNING
status, the new job request fails and returns aLimitExceededException
error. Wait for a current job to comlpete before you resubmit the new job.A large number of API requests are submitted on an Amazon Web Services account. When a user makes more than 10 API calls to the Amazon QuickSight API in one second, a
ThrottlingException
is returned.
If your use case requires a higher throttling limit, contact your account admin or Amazon Web ServicesSupport to explore options to tailor a more optimal expereince for your account.
Best practices to handle throttling
If your use case projects high levels of API traffic, try to reduce
the degree of frequency and parallelism of API calls as much as you
can to avoid throttling. You can also perform a timing test to
calculate an estimate for the total processing time of your projected
load that stays within the throttling limits of the Amazon QuickSight
APIs. For example, if your projected traffic is 100 snapshot jobs
before 12:00 PM per day, start 12 jobs in parallel and measure the
amount of time it takes to proccess all 12 jobs. Once you obtain the
result, multiply the duration by 9, for example (12 minutes * 9 = 108
minutes)
. Use the new result to determine the latest time at which
the jobs need to be started to meet your target deadline.
The time that it takes to process a job can be impacted by the following factors:
The dataset type (Direct Query or SPICE).
The size of the dataset.
The complexity of the calculated fields that are used in the dashboard.
The number of visuals that are on a sheet.
The types of visuals that are on the sheet.
The number of formats and snapshots that are requested in the job configuration.
The size of the generated snapshots.
14087 14088 14089 14090 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14087 def start_dashboard_snapshot_job(params = {}, = {}) req = build_request(:start_dashboard_snapshot_job, params) req.send_request() end |
#start_dashboard_snapshot_job_schedule(params = {}) ⇒ Types::StartDashboardSnapshotJobScheduleResponse
Starts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email.
Only one job can run simultaneously in a given schedule. Repeated
requests are skipped with a 202
HTTP status code.
For more information, see Scheduling and sending Amazon QuickSight reports by email and Configuring email report settings for a Amazon QuickSight dashboard in the Amazon QuickSight User Guide.
14143 14144 14145 14146 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14143 def start_dashboard_snapshot_job_schedule(params = {}, = {}) req = build_request(:start_dashboard_snapshot_job_schedule, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Types::TagResourceResponse
Assigns one or more tags (key-value pairs) to the specified Amazon 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. Amazon QuickSight supports tagging on data set, data source, dashboard, template, topic, and user.
Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for the following:
Tags are used to track costs for users in Amazon QuickSight. You can't tag other resources that Amazon QuickSight costs are based on, such as storage capacoty (SPICE), session usage, alert consumption, or reporting units.
Amazon QuickSight doesn't currently support the tag editor for Resource Groups.
14208 14209 14210 14211 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14208 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Types::UntagResourceResponse
Removes a tag or tags from a resource.
14243 14244 14245 14246 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14243 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_account_customization(params = {}) ⇒ Types::UpdateAccountCustomizationResponse
Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme.
You can use customizations for your Amazon Web Services account or, if
you specify a namespace, for a Amazon QuickSight namespace instead.
Customizations that apply to a namespace override customizations that
apply to an Amazon Web Services account. To find out which
customizations apply, use the DescribeAccountCustomization
API
operation.
14305 14306 14307 14308 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14305 def update_account_customization(params = {}, = {}) req = build_request(:update_account_customization, params) req.send_request() end |
#update_account_settings(params = {}) ⇒ Types::UpdateAccountSettingsResponse
Updates the Amazon QuickSight settings in your Amazon Web Services account.
14358 14359 14360 14361 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14358 def update_account_settings(params = {}, = {}) req = build_request(:update_account_settings, params) req.send_request() end |
#update_analysis(params = {}) ⇒ Types::UpdateAnalysisResponse
Updates an analysis in Amazon QuickSight
14423 14424 14425 14426 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14423 def update_analysis(params = {}, = {}) req = build_request(:update_analysis, params) req.send_request() end |
#update_analysis_permissions(params = {}) ⇒ Types::UpdateAnalysisPermissionsResponse
Updates the read and write permissions for an analysis.
14489 14490 14491 14492 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14489 def (params = {}, = {}) req = build_request(:update_analysis_permissions, params) req.send_request() end |
#update_application_with_token_exchange_grant(params = {}) ⇒ Types::UpdateApplicationWithTokenExchangeGrantResponse
Updates an Amazon QuickSight application with a token exchange grant. This operation only supports Amazon QuickSight applications that are registered with IAM Identity Center.
14526 14527 14528 14529 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14526 def update_application_with_token_exchange_grant(params = {}, = {}) req = build_request(:update_application_with_token_exchange_grant, params) req.send_request() end |
#update_brand(params = {}) ⇒ Types::UpdateBrandResponse
Updates a brand.
14697 14698 14699 14700 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14697 def update_brand(params = {}, = {}) req = build_request(:update_brand, params) req.send_request() end |
#update_brand_assignment(params = {}) ⇒ Types::UpdateBrandAssignmentResponse
Updates a brand assignment.
14732 14733 14734 14735 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14732 def update_brand_assignment(params = {}, = {}) req = build_request(:update_brand_assignment, params) req.send_request() end |
#update_brand_published_version(params = {}) ⇒ Types::UpdateBrandPublishedVersionResponse
Updates the published version of a brand.
14770 14771 14772 14773 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14770 def update_brand_published_version(params = {}, = {}) req = build_request(:update_brand_published_version, params) req.send_request() end |
#update_custom_permissions(params = {}) ⇒ Types::UpdateCustomPermissionsResponse
Updates a custom permissions profile.
14835 14836 14837 14838 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14835 def (params = {}, = {}) req = build_request(:update_custom_permissions, params) req.send_request() end |
#update_dashboard(params = {}) ⇒ Types::UpdateDashboardResponse
Updates a dashboard in an Amazon Web Services account.
UpdateDashboardPublishedVersion
API operation.
14940 14941 14942 14943 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14940 def update_dashboard(params = {}, = {}) req = build_request(:update_dashboard, params) req.send_request() end |
#update_dashboard_links(params = {}) ⇒ Types::UpdateDashboardLinksResponse
Updates the linked analyses on a dashboard.
14985 14986 14987 14988 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14985 def update_dashboard_links(params = {}, = {}) req = build_request(:update_dashboard_links, params) req.send_request() end |
#update_dashboard_permissions(params = {}) ⇒ Types::UpdateDashboardPermissionsResponse
Updates read and write permissions on a dashboard.
15070 15071 15072 15073 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 15070 def (params = {}, = {}) req = build_request(:update_dashboard_permissions, params) req.send_request() end |
#update_dashboard_published_version(params = {}) ⇒ Types::UpdateDashboardPublishedVersionResponse
Updates the published version of a dashboard.
15113 15114 15115 15116 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 15113 def update_dashboard_published_version(params = {}, = {}) req = build_request(:update_dashboard_published_version, params) req.send_request() end |
#update_dashboards_qa_configuration(params = {}) ⇒ Types::UpdateDashboardsQAConfigurationResponse
Updates a Dashboard QA configuration.
15150 15151 15152 15153 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 15150 def update_dashboards_qa_configuration(params = {}, = {}) req = build_request(:update_dashboards_qa_configuration, params) req.send_request() end |
#update_data_set(params = {}) ⇒ Types::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.
15452 15453 15454 15455 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 15452 def update_data_set(params = {}, = {}) req = build_request(:update_data_set, params) req.send_request() end |
#update_data_set_permissions(params = {}) ⇒ Types::UpdateDataSetPermissionsResponse
Updates the permissions on a dataset.
The permissions resource is
arn:aws:quicksight:region:aws-account-id:dataset/data-set-id
.
15513 15514 15515 15516 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 15513 def (params = {}, = {}) req = build_request(:update_data_set_permissions, params) req.send_request() end |
#update_data_source(params = {}) ⇒ Types::UpdateDataSourceResponse
Updates a data source.
15909 15910 15911 15912 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 15909 def update_data_source(params = {}, = {}) req = build_request(:update_data_source, params) req.send_request() end |
#update_data_source_permissions(params = {}) ⇒ Types::UpdateDataSourcePermissionsResponse
Updates the permissions to a data source.
15968 15969 15970 15971 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 15968 def (params = {}, = {}) req = build_request(:update_data_source_permissions, params) req.send_request() end |
#update_default_q_business_application(params = {}) ⇒ Types::UpdateDefaultQBusinessApplicationResponse
Updates a Amazon Q Business application that is linked to a Amazon QuickSight account.
16011 16012 16013 16014 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16011 def update_default_q_business_application(params = {}, = {}) req = build_request(:update_default_q_business_application, params) req.send_request() end |
#update_folder(params = {}) ⇒ Types::UpdateFolderResponse
Updates the name of a folder.
16054 16055 16056 16057 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16054 def update_folder(params = {}, = {}) req = build_request(:update_folder, params) req.send_request() end |
#update_folder_permissions(params = {}) ⇒ Types::UpdateFolderPermissionsResponse
Updates permissions of a folder.
16118 16119 16120 16121 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16118 def (params = {}, = {}) req = build_request(:update_folder_permissions, params) req.send_request() end |
#update_group(params = {}) ⇒ Types::UpdateGroupResponse
Changes a group description.
16167 16168 16169 16170 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16167 def update_group(params = {}, = {}) req = build_request(:update_group, params) req.send_request() end |
#update_iam_policy_assignment(params = {}) ⇒ Types::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
.
16246 16247 16248 16249 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16246 def update_iam_policy_assignment(params = {}, = {}) req = build_request(:update_iam_policy_assignment, params) req.send_request() end |
#update_identity_propagation_config(params = {}) ⇒ Types::UpdateIdentityPropagationConfigResponse
Adds or updates services and authorized targets to configure what the Amazon QuickSight IAM Identity Center application can access.
This operation is only supported for Amazon QuickSight accounts using IAM Identity Center
16291 16292 16293 16294 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16291 def update_identity_propagation_config(params = {}, = {}) req = build_request(:update_identity_propagation_config, params) req.send_request() end |
#update_ip_restriction(params = {}) ⇒ Types::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.
16353 16354 16355 16356 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16353 def update_ip_restriction(params = {}, = {}) req = build_request(:update_ip_restriction, params) req.send_request() end |
#update_key_registration(params = {}) ⇒ Types::UpdateKeyRegistrationResponse
Updates a customer managed key in a Amazon QuickSight account.
16402 16403 16404 16405 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16402 def update_key_registration(params = {}, = {}) req = build_request(:update_key_registration, params) req.send_request() end |
#update_public_sharing_settings(params = {}) ⇒ Types::UpdatePublicSharingSettingsResponse
Use the UpdatePublicSharingSettings
operation to turn on or turn off
the public sharing settings of an Amazon QuickSight dashboard.
To use this operation, turn on session capacity pricing for your Amazon QuickSight account.
Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with Amazon QuickSight, see Using Amazon QuickSight with IAM in the Amazon QuickSight User Guide.
16452 16453 16454 16455 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16452 def update_public_sharing_settings(params = {}, = {}) req = build_request(:update_public_sharing_settings, params) req.send_request() end |
#update_q_personalization_configuration(params = {}) ⇒ Types::UpdateQPersonalizationConfigurationResponse
Updates a personalization configuration.
16491 16492 16493 16494 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16491 def update_q_personalization_configuration(params = {}, = {}) req = build_request(:update_q_personalization_configuration, params) req.send_request() end |
#update_quick_sight_q_search_configuration(params = {}) ⇒ Types::UpdateQuickSightQSearchConfigurationResponse
Updates the state of a Amazon QuickSight Q Search configuration.
16529 16530 16531 16532 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16529 def update_quick_sight_q_search_configuration(params = {}, = {}) req = build_request(:update_quick_sight_q_search_configuration, params) req.send_request() end |
#update_refresh_schedule(params = {}) ⇒ Types::UpdateRefreshScheduleResponse
Updates a refresh schedule for a dataset.
16585 16586 16587 16588 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16585 def update_refresh_schedule(params = {}, = {}) req = build_request(:update_refresh_schedule, params) req.send_request() end |
#update_role_custom_permission(params = {}) ⇒ Types::UpdateRoleCustomPermissionResponse
Updates the custom permissions that are associated with a role.
16631 16632 16633 16634 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16631 def (params = {}, = {}) req = build_request(:update_role_custom_permission, params) req.send_request() end |
#update_spice_capacity_configuration(params = {}) ⇒ Types::UpdateSPICECapacityConfigurationResponse
Updates the SPICE capacity configuration for a Amazon QuickSight account.
16674 16675 16676 16677 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16674 def update_spice_capacity_configuration(params = {}, = {}) req = build_request(:update_spice_capacity_configuration, params) req.send_request() end |
#update_template(params = {}) ⇒ Types::UpdateTemplateResponse
Updates a template from an existing Amazon QuickSight analysis or another template.
16746 16747 16748 16749 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16746 def update_template(params = {}, = {}) req = build_request(:update_template, params) req.send_request() end |
#update_template_alias(params = {}) ⇒ Types::UpdateTemplateAliasResponse
Updates the template alias of a template.
16797 16798 16799 16800 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16797 def update_template_alias(params = {}, = {}) req = build_request(:update_template_alias, params) req.send_request() end |
#update_template_permissions(params = {}) ⇒ Types::UpdateTemplatePermissionsResponse
Updates the resource permissions for a template.
16858 16859 16860 16861 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16858 def (params = {}, = {}) req = build_request(:update_template_permissions, params) req.send_request() end |
#update_theme(params = {}) ⇒ Types::UpdateThemeResponse
Updates a theme.
16968 16969 16970 16971 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16968 def update_theme(params = {}, = {}) req = build_request(:update_theme, params) req.send_request() end |
#update_theme_alias(params = {}) ⇒ Types::UpdateThemeAliasResponse
Updates an alias of a theme.
17015 17016 17017 17018 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 17015 def update_theme_alias(params = {}, = {}) req = build_request(:update_theme_alias, params) req.send_request() end |
#update_theme_permissions(params = {}) ⇒ Types::UpdateThemePermissionsResponse
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.
17116 17117 17118 17119 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 17116 def (params = {}, = {}) req = build_request(:update_theme_permissions, params) req.send_request() end |
#update_topic(params = {}) ⇒ Types::UpdateTopicResponse
Updates a topic.
17390 17391 17392 17393 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 17390 def update_topic(params = {}, = {}) req = build_request(:update_topic, params) req.send_request() end |
#update_topic_permissions(params = {}) ⇒ Types::UpdateTopicPermissionsResponse
Updates the permissions of a topic.
17453 17454 17455 17456 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 17453 def (params = {}, = {}) req = build_request(:update_topic_permissions, params) req.send_request() end |
#update_topic_refresh_schedule(params = {}) ⇒ Types::UpdateTopicRefreshScheduleResponse
Updates a topic refresh schedule.
17510 17511 17512 17513 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 17510 def update_topic_refresh_schedule(params = {}, = {}) req = build_request(:update_topic_refresh_schedule, params) req.send_request() end |
#update_user(params = {}) ⇒ Types::UpdateUserResponse
Updates an Amazon QuickSight user.
17665 17666 17667 17668 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 17665 def update_user(params = {}, = {}) req = build_request(:update_user, params) req.send_request() end |
#update_user_custom_permission(params = {}) ⇒ Types::UpdateUserCustomPermissionResponse
Updates a custom permissions profile for a user.
17709 17710 17711 17712 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 17709 def (params = {}, = {}) req = build_request(:update_user_custom_permission, params) req.send_request() end |
#update_vpc_connection(params = {}) ⇒ Types::UpdateVPCConnectionResponse
Updates a VPC connection.
17775 17776 17777 17778 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 17775 def update_vpc_connection(params = {}, = {}) req = build_request(:update_vpc_connection, params) req.send_request() end |