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_knowledge_base(params = {}) ⇒ Types::BatchDeleteKnowledgeBaseResponse
Deletes one or more knowledge bases.
-
#batch_delete_policy_assignment_by_policy(params = {}) ⇒ Types::BatchDeletePolicyAssignmentByPolicyResponse
Removes a governance policy from multiple Amazon Quick Sight principals in a single request.
-
#batch_delete_topic_reviewed_answer(params = {}) ⇒ Types::BatchDeleteTopicReviewedAnswerResponse
Deletes reviewed answers for Q Topic.
-
#batch_describe_user_limits(params = {}) ⇒ Types::BatchDescribeUserLimitsResponse
Describes the effective resource limits for one or more Amazon Quick Sight users, including the limits that apply to each user based on their profile assignments.
-
#batch_put_policy_assignment_by_policy(params = {}) ⇒ Types::BatchPutPolicyAssignmentByPolicyResponse
Assigns a governance policy to multiple Amazon Quick Sight principals in a single request.
-
#cancel_ingestion(params = {}) ⇒ Types::CancelIngestionResponse
Cancels an ongoing ingestion of data into SPICE.
-
#create_access_control_application(params = {}) ⇒ Types::CreateAccessControlApplicationResponse
Creates an access control application in an Amazon Quick Sight account.
-
#create_access_control_application_secret(params = {}) ⇒ Types::CreateAccessControlApplicationSecretResponse
Creates a client secret for an access control application.
-
#create_account_customization(params = {}) ⇒ Types::CreateAccountCustomizationResponse
Creates Amazon Quick Sight customizations.
-
#create_account_subscription(params = {}) ⇒ Types::CreateAccountSubscriptionResponse
Creates an Amazon Quick Sight account, or subscribes to Amazon Quick Sight Q.
-
#create_action_connector(params = {}) ⇒ Types::CreateActionConnectorResponse
Creates an action connector that enables Amazon Quick Sight to connect to external services and perform actions.
-
#create_agent(params = {}) ⇒ Types::CreateAgentResponse
Creates an agent in Amazon QuickSight.
-
#create_analysis(params = {}) ⇒ Types::CreateAnalysisResponse
Creates an analysis in Amazon Quick Sight.
-
#create_approval_policy(params = {}) ⇒ Types::CreateApprovalPolicyResponse
Creates an approval policy in Quick Sight.
-
#create_brand(params = {}) ⇒ Types::CreateBrandResponse
Creates an Quick Sight 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_dlp_setting(params = {}) ⇒ Types::CreateDlpSettingResponse
Creates a data loss prevention (DLP) setting configuration for an Amazon Web Services account.
-
#create_flow(params = {}) ⇒ Types::CreateFlowResponse
Creates a new flow in the specified Amazon Web Services account.
-
#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
CreateGroupoperation to create a group in Quick Sight. -
#create_group_membership(params = {}) ⇒ Types::CreateGroupMembershipResponse
Adds an Amazon Quick Sight user to an Amazon Quick Sight group.
-
#create_iam_policy_assignment(params = {}) ⇒ Types::CreateIAMPolicyAssignmentResponse
Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN).
-
#create_inbound_connector(params = {}) ⇒ Types::CreateInboundConnectorResponse
Creates an inbound connector in a Quick Sight account.
-
#create_ingestion(params = {}) ⇒ Types::CreateIngestionResponse
Creates and starts a new SPICE ingestion for a dataset.
-
#create_knowledge_base(params = {}) ⇒ Types::CreateKnowledgeBaseResponse
Creates a knowledge base from a specified data source.
-
#create_knowledge_base_refresh_schedule(params = {}) ⇒ Types::CreateKnowledgeBaseRefreshScheduleResponse
Creates a schedule that periodically refreshes an Amazon Quick Sight knowledge base at the frequency that you specify.
-
#create_limits_profile(params = {}) ⇒ Types::CreateLimitsProfileResponse
Creates a limits profile that defines resource usage limits for Amazon Quick Sight users.
-
#create_namespace(params = {}) ⇒ Types::CreateNamespaceResponse
(Enterprise edition only) Creates a new namespace for you to use with Amazon Quick Sight.
-
#create_o_auth_client_application(params = {}) ⇒ Types::CreateOAuthClientApplicationResponse
Creates an OAuthClientApplication.
-
#create_refresh_schedule(params = {}) ⇒ Types::CreateRefreshScheduleResponse
Creates a refresh schedule for a dataset.
-
#create_role_membership(params = {}) ⇒ Types::CreateRoleMembershipResponse
Use
CreateRoleMembershipto add an existing Quick Sight group to an existing role. -
#create_space(params = {}) ⇒ Types::CreateSpaceResponse
Creates a new Amazon QuickSight space.
-
#create_template(params = {}) ⇒ Types::CreateTemplateResponse
Creates a template either from a
TemplateDefinitionor from an existing Quick Sight 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_topic_v2(params = {}) ⇒ Types::CreateTopicV2Response
Creates a new Q topic.
-
#create_vpc_connection(params = {}) ⇒ Types::CreateVPCConnectionResponse
Creates a new VPC connection.
-
#delete_access_control_application(params = {}) ⇒ Types::DeleteAccessControlApplicationResponse
Deletes an access control application.
-
#delete_access_control_application_secret(params = {}) ⇒ Types::DeleteAccessControlApplicationSecretResponse
Deletes a client secret from an access control application.
-
#delete_account_custom_permission(params = {}) ⇒ Types::DeleteAccountCustomPermissionResponse
Unapplies a custom permissions profile from an account.
-
#delete_account_customization(params = {}) ⇒ Types::DeleteAccountCustomizationResponse
This API permanently deletes all Quick Sight customizations for the specified Amazon Web Services account and namespace.
-
#delete_account_subscription(params = {}) ⇒ Types::DeleteAccountSubscriptionResponse
Deleting your Quick Sight account subscription has permanent, irreversible consequences across all Amazon Web Services regions:.
-
#delete_action_connector(params = {}) ⇒ Types::DeleteActionConnectorResponse
Hard deletes an action connector, making it unrecoverable.
-
#delete_agent(params = {}) ⇒ Types::DeleteAgentResponse
Deletes an agent.
-
#delete_analysis(params = {}) ⇒ Types::DeleteAnalysisResponse
Deletes an analysis from Amazon Quick Sight.
-
#delete_app(params = {}) ⇒ Types::DeleteAppResponse
Deletes an app.
-
#delete_approval_policy(params = {}) ⇒ Struct
Deletes an approval policy in Quick Sight.
-
#delete_brand(params = {}) ⇒ Types::DeleteBrandResponse
This API permanently deletes the specified Quick Sight 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 Quick Sight account.
-
#delete_dlp_setting(params = {}) ⇒ Types::DeleteDlpSettingResponse
Deletes a DLP setting configuration from an Amazon Web Services account.
-
#delete_flow(params = {}) ⇒ Types::DeleteFlowResponse
Permanently deletes a flow from the specified Amazon Web Services 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 Quick Sight.
-
#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 Quick Sight IAM Identity Center application.
-
#delete_inbound_connector(params = {}) ⇒ Types::DeleteInboundConnectorResponse
Deletes an inbound connector.
-
#delete_knowledge_base(params = {}) ⇒ Types::DeleteKnowledgeBaseResponse
Deletes a knowledge base.
-
#delete_knowledge_base_refresh_schedule(params = {}) ⇒ Types::DeleteKnowledgeBaseRefreshScheduleResponse
Deletes the refresh schedule for an Amazon Quick Sight knowledge base.
-
#delete_limits_profile(params = {}) ⇒ Types::DeleteLimitsProfileResponse
Deletes a limits profile.
-
#delete_namespace(params = {}) ⇒ Types::DeleteNamespaceResponse
Deletes a namespace and the users and groups that are associated with the namespace.
-
#delete_o_auth_client_application(params = {}) ⇒ Types::DeleteOAuthClientApplicationResponse
Deletes an OAuthClientApplication.
-
#delete_policy_assignment(params = {}) ⇒ Struct
Removes a governance policy from an Amazon Quick Sight principal.
-
#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_space(params = {}) ⇒ Types::DeleteSpaceResponse
Deletes an Amazon QuickSight space.
-
#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_topic_v2(params = {}) ⇒ Types::DeleteTopicV2Response
Deletes a Q topic.
-
#delete_user(params = {}) ⇒ Types::DeleteUserResponse
Deletes the Amazon Quick Sight 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_access_control_application(params = {}) ⇒ Types::DescribeAccessControlApplicationResponse
Describes an access control application.
-
#describe_account_custom_permission(params = {}) ⇒ Types::DescribeAccountCustomPermissionResponse
Describes the custom permissions profile that is applied to an account.
-
#describe_account_customization(params = {}) ⇒ Types::DescribeAccountCustomizationResponse
Describes the customizations associated with the provided Amazon Web Services account and Amazon Quick Sight namespace.
-
#describe_account_settings(params = {}) ⇒ Types::DescribeAccountSettingsResponse
Describes the settings that were used when your Quick Sight 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 Quick Sight account's subscription.
-
#describe_action_connector(params = {}) ⇒ Types::DescribeActionConnectorResponse
Retrieves detailed information about an action connector, including its configuration, authentication settings, enabled actions, and current status.
-
#describe_action_connector_permissions(params = {}) ⇒ Types::DescribeActionConnectorPermissionsResponse
Retrieves the permissions configuration for an action connector, showing which users, groups, and namespaces have access and what operations they can perform.
-
#describe_agent(params = {}) ⇒ Types::DescribeAgentResponse
Describes an agent.
-
#describe_agent_permissions(params = {}) ⇒ Types::DescribeAgentPermissionsResponse
Describes the resource permissions for an agent.
-
#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_app(params = {}) ⇒ Types::DescribeAppResponse
Describes an app.
-
#describe_app_permissions(params = {}) ⇒ Types::DescribeAppPermissionsResponse
Describes the resource permissions for an app.
-
#describe_approval_policy(params = {}) ⇒ Types::DescribeApprovalPolicyResponse
Describes an approval policy in Quick Sight.
-
#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_automation_job(params = {}) ⇒ Types::DescribeAutomationJobResponse
Retrieves the status and details of a specified automation job, including its status and outputs.
-
#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 Quick Sight account.
-
#describe_dlp_setting(params = {}) ⇒ Types::DescribeDlpSettingResponse
Describes the full configuration of a DLP setting in an Amazon Web Services account.
-
#describe_flow(params = {}) ⇒ Types::DescribeFlowResponse
Returns the full details of a flow for the latest version of the requested publish state.
-
#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 Quick Sight group's description and Amazon Resource Name (ARN).
-
#describe_group_membership(params = {}) ⇒ Types::DescribeGroupMembershipResponse
Use the
DescribeGroupMembershipoperation 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_inbound_connector(params = {}) ⇒ Types::DescribeInboundConnectorResponse
Describes an inbound connector.
-
#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 Quick Sight account.
-
#describe_knowledge_base(params = {}) ⇒ Types::DescribeKnowledgeBaseResponse
Describes a knowledge base.
-
#describe_knowledge_base_permissions(params = {}) ⇒ Types::DescribeKnowledgeBasePermissionsResponse
Describes the resource permissions for a knowledge base.
-
#describe_knowledge_base_refresh_schedule(params = {}) ⇒ Types::DescribeKnowledgeBaseRefreshScheduleResponse
Describes the refresh schedule for an Amazon Quick Sight knowledge base, including the schedule's frequency, start time, and state.
-
#describe_limits_profile(params = {}) ⇒ Types::DescribeLimitsProfileResponse
Describes the properties of an existing limits profile.
-
#describe_namespace(params = {}) ⇒ Types::DescribeNamespaceResponse
Describes the current namespace.
-
#describe_o_auth_client_application(params = {}) ⇒ Types::DescribeOAuthClientApplicationResponse
Describes an OAuthClientApplication.
-
#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 Quick Sight Q Search configuration.
-
#describe_refresh_schedule(params = {}) ⇒ Types::DescribeRefreshScheduleResponse
Provides a summary of a refresh schedule.
-
#describe_resource_permissions(params = {}) ⇒ Types::DescribeResourcePermissionsResponse
Describes the service role configuration for your Amazon Quick Sight account.
-
#describe_role_custom_permission(params = {}) ⇒ Types::DescribeRoleCustomPermissionResponse
Describes all custom permissions that are mapped to a role.
-
#describe_self_upgrade_configuration(params = {}) ⇒ Types::DescribeSelfUpgradeConfigurationResponse
Describes the self-upgrade configuration for a Quick account.
-
#describe_space(params = {}) ⇒ Types::DescribeSpaceResponse
Describes an Amazon QuickSight space.
-
#describe_space_permissions(params = {}) ⇒ Types::DescribeSpacePermissionsResponse
Describes the permissions for an Amazon QuickSight space.
-
#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_permissions_v2(params = {}) ⇒ Types::DescribeTopicPermissionsV2Response
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_topic_v2(params = {}) ⇒ Types::DescribeTopicV2Response
Describes a Q topic.
-
#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 Quick 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 Quick 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 Quick Sight 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 Quick Sight read-only dashboard in your website or application.
-
#get_flow_metadata(params = {}) ⇒ Types::GetFlowMetadataOutput
Retrieves the metadata of a flow, not including its definition specifying the steps.
-
#get_flow_permissions(params = {}) ⇒ Types::GetFlowPermissionsOutput
Get permissions for a flow.
-
#get_identity_context(params = {}) ⇒ Types::GetIdentityContextResponse
Retrieves the identity context for a Quick Sight user in a specified namespace, allowing you to obtain identity tokens that can be used with identity-enhanced IAM role sessions to call identity-aware APIs.
-
#get_policy_assignment(params = {}) ⇒ Types::GetPolicyAssignmentResponse
Describes the policy of the specified type that an Amazon Quick Sight principal has.
-
#get_session_embed_url(params = {}) ⇒ Types::GetSessionEmbedUrlResponse
Generates a session URL and authorization code that you can use to embed the Amazon Amazon Quick Sight console in your web server code.
-
#list_access_control_applications(params = {}) ⇒ Types::ListAccessControlApplicationsResponse
Lists the access control applications in a Quick Sight account in the current Amazon Web Services Region.
-
#list_action_connectors(params = {}) ⇒ Types::ListActionConnectorsResponse
Lists all action connectors in the specified Amazon Web Services account.
-
#list_agents(params = {}) ⇒ Types::ListAgentsResponse
Lists all agents in an Amazon QuickSight account.
-
#list_analyses(params = {}) ⇒ Types::ListAnalysesResponse
Lists Amazon Quick Sight analyses that exist in the specified Amazon Web Services account.
-
#list_approval_policies(params = {}) ⇒ Types::ListApprovalPoliciesResponse
Lists all approval policies in the specified Quick Sight account.
-
#list_apps(params = {}) ⇒ Types::ListAppsResponse
Lists the apps in an 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 Quick Sight 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 Quick Sight 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_dlp_settings(params = {}) ⇒ Types::ListDlpSettingsResponse
Lists all DLP settings in an Amazon Web Services account.
-
#list_flows(params = {}) ⇒ Types::ListFlowsOutput
Lists flows in an 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 Quick Sight.
-
#list_iam_policy_assignments(params = {}) ⇒ Types::ListIAMPolicyAssignmentsResponse
Lists the IAM policy assignments in the current Amazon Quick Sight 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 Quick Sight IAM Identity Center application can access.
-
#list_inbound_connector_application_associations(params = {}) ⇒ Types::ListInboundConnectorApplicationAssociationsResponse
Lists the access control applications that are associated with an inbound connector.
-
#list_inbound_connectors(params = {}) ⇒ Types::ListInboundConnectorsResponse
Lists the inbound connectors in a Quick Sight account.
-
#list_ingestions(params = {}) ⇒ Types::ListIngestionsResponse
Lists the history of SPICE ingestions for a dataset.
-
#list_knowledge_base_refresh_schedules(params = {}) ⇒ Types::ListKnowledgeBaseRefreshSchedulesResponse
Lists the refresh schedules for an Amazon Quick Sight knowledge base.
-
#list_knowledge_bases(params = {}) ⇒ Types::ListKnowledgeBasesResponse
Lists all knowledge bases in an Amazon QuickSight account.
-
#list_limits_profiles(params = {}) ⇒ Types::ListLimitsProfilesResponse
Lists all limits profiles in an Amazon Quick Sight account.
-
#list_namespaces(params = {}) ⇒ Types::ListNamespacesResponse
Lists the namespaces for the specified Amazon Web Services account.
-
#list_o_auth_client_applications(params = {}) ⇒ Types::ListOAuthClientApplicationsResponse
Lists all OAuthClientApplications in the current Amazon Web Services Region that belong to this Amazon Web Services account.
-
#list_principals_for_policy(params = {}) ⇒ Types::ListPrincipalsForPolicyResponse
Lists the Amazon Quick Sight principals that have a governance policy.
-
#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_self_upgrades(params = {}) ⇒ Types::ListSelfUpgradesResponse
Lists all self-upgrade requests for a Quick account.
-
#list_space_resources(params = {}) ⇒ Types::ListSpaceResourcesResponse
Lists the resources in an Amazon QuickSight space.
-
#list_spaces(params = {}) ⇒ Types::ListSpacesResponse
Lists all Amazon QuickSight spaces in an Amazon Web Services account.
-
#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 Quick Sight account.
-
#list_templates(params = {}) ⇒ Types::ListTemplatesResponse
Lists all the templates in the current Amazon Quick Sight 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_topics_v2(params = {}) ⇒ Types::ListTopicsV2Response
Lists all of the Q topics in the specified Amazon Web Services account in an Amazon Web Services Region.
-
#list_user_groups(params = {}) ⇒ Types::ListUserGroupsResponse
Lists the Amazon Quick Sight groups that an Amazon Quick Sight user is a member of.
-
#list_users(params = {}) ⇒ Types::ListUsersResponse
Returns a list of all of the Amazon Quick Sight users belonging to this account.
-
#list_users_index_capacity(params = {}) ⇒ Types::ListUsersIndexCapacityResponse
Lists per-user index capacity consumption for an 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.
-
#put_policy_assignment(params = {}) ⇒ Types::PutPolicyAssignmentResponse
Assigns a governance policy to an Amazon Quick Sight principal.
-
#register_user(params = {}) ⇒ Types::RegisterUserResponse
Creates an Amazon Quick Sight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request.
-
#restore_analysis(params = {}) ⇒ Types::RestoreAnalysisResponse
Restores an analysis.
-
#search_action_connectors(params = {}) ⇒ Types::SearchActionConnectorsResponse
Searches for action connectors in the specified Amazon Web Services account using filters.
-
#search_agents(params = {}) ⇒ Types::SearchAgentsResponse
Searches for agents based on specified filters.
-
#search_analyses(params = {}) ⇒ Types::SearchAnalysesResponse
Searches for analyses that belong to the user specified in the filter.
-
#search_apps(params = {}) ⇒ Types::SearchAppsResponse
Searches for apps in an Amazon Web Services account using the specified filters.
-
#search_dashboards(params = {}) ⇒ Types::SearchDashboardsResponse
Searches for dashboards that belong to a user.
-
#search_data_sets(params = {}) ⇒ Types::SearchDataSetsResponse
Use the
SearchDataSetsoperation to search for datasets that belong to an account. -
#search_data_sources(params = {}) ⇒ Types::SearchDataSourcesResponse
Use the
SearchDataSourcesoperation to search for data sources that belong to an account. -
#search_flows(params = {}) ⇒ Types::SearchFlowsOutput
Search for the flows in an Amazon Web Services account.
-
#search_folders(params = {}) ⇒ Types::SearchFoldersResponse
Searches the subfolders in a folder.
-
#search_groups(params = {}) ⇒ Types::SearchGroupsResponse
Use the
SearchGroupsoperation to search groups in a specified Quick Sight namespace using the supplied filters. -
#search_knowledge_bases(params = {}) ⇒ Types::SearchKnowledgeBasesResponse
Searches for a subset of knowledge bases based on specified filters.
-
#search_spaces(params = {}) ⇒ Types::SearchSpacesResponse
Searches for Amazon QuickSight spaces that match the specified filters.
-
#search_topics(params = {}) ⇒ Types::SearchTopicsResponse
Searches for any Q topic that exists in an Quick account.
-
#search_topics_v2(params = {}) ⇒ Types::SearchTopicsV2Response
Searches for any Q topic that exists in an Amazon Web Services 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_automation_job(params = {}) ⇒ Types::StartAutomationJobResponse
Starts a new job for a specified automation.
-
#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 Quick Sight resource.
-
#untag_resource(params = {}) ⇒ Types::UntagResourceResponse
Removes a tag or tags from a resource.
-
#update_access_control_application(params = {}) ⇒ Types::UpdateAccessControlApplicationResponse
Updates an access control application.
-
#update_access_control_application_secret(params = {}) ⇒ Types::UpdateAccessControlApplicationSecretResponse
Updates the Amazon Web Services Secrets Manager secret ARNs of an IdP-provided client secret.
-
#update_account_custom_permission(params = {}) ⇒ Types::UpdateAccountCustomPermissionResponse
Applies a custom permissions profile to an account.
-
#update_account_customization(params = {}) ⇒ Types::UpdateAccountCustomizationResponse
Updates Amazon Quick Sight customizations.
-
#update_account_settings(params = {}) ⇒ Types::UpdateAccountSettingsResponse
Updates the Amazon Quick Sight settings in your Amazon Web Services account.
-
#update_action_connector(params = {}) ⇒ Types::UpdateActionConnectorResponse
Updates an existing action connector with new configuration details, authentication settings, or enabled actions.
-
#update_action_connector_permissions(params = {}) ⇒ Types::UpdateActionConnectorPermissionsResponse
Updates the permissions for an action connector by granting or revoking access for specific users and groups.
-
#update_agent(params = {}) ⇒ Types::UpdateAgentResponse
Updates an existing agent.
-
#update_agent_permissions(params = {}) ⇒ Types::UpdateAgentPermissionsResponse
Updates the resource permissions for an agent.
-
#update_analysis(params = {}) ⇒ Types::UpdateAnalysisResponse
Updates an analysis in Amazon Quick Sight.
-
#update_analysis_permissions(params = {}) ⇒ Types::UpdateAnalysisPermissionsResponse
Updates the read and write permissions for an analysis.
-
#update_app_permissions(params = {}) ⇒ Types::UpdateAppPermissionsResponse
Updates the resource permissions for an app.
-
#update_application_with_token_exchange_grant(params = {}) ⇒ Types::UpdateApplicationWithTokenExchangeGrantResponse
Updates an Quick application with a token exchange grant.
-
#update_approval_policy(params = {}) ⇒ Types::UpdateApprovalPolicyResponse
Updates an approval policy in Quick Sight.
-
#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 Quick Sight account.
-
#update_dlp_setting(params = {}) ⇒ Types::UpdateDlpSettingResponse
Updates an existing DLP setting configuration in an Amazon Web Services account.
-
#update_flow(params = {}) ⇒ Types::UpdateFlowResponse
Updates an existing flow.
-
#update_flow_permissions(params = {}) ⇒ Types::UpdateFlowPermissionsOutput
Updates permissions against principals on a flow.
-
#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 Quick Sight IAM Identity Center application can access.
-
#update_inbound_connector(params = {}) ⇒ Types::UpdateInboundConnectorResponse
Updates an inbound connector.
-
#update_inbound_connector_application_associations(params = {}) ⇒ Types::UpdateInboundConnectorApplicationAssociationsResponse
Associates access control applications with an inbound connector, disassociates them from it, or both.
-
#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 Quick Sight account.
-
#update_knowledge_base(params = {}) ⇒ Types::UpdateKnowledgeBaseResponse
Updates the properties of an existing knowledge base.
-
#update_knowledge_base_permissions(params = {}) ⇒ Types::UpdateKnowledgeBasePermissionsResponse
Updates the resource permissions for a knowledge base.
-
#update_knowledge_base_refresh_schedule(params = {}) ⇒ Types::UpdateKnowledgeBaseRefreshScheduleResponse
Updates the refresh schedule for an Amazon Quick Sight knowledge base.
-
#update_limits_profile(params = {}) ⇒ Types::UpdateLimitsProfileResponse
Updates the properties of an existing limits profile.
-
#update_o_auth_client_application(params = {}) ⇒ Types::UpdateOAuthClientApplicationResponse
Updates an OAuthClientApplication.
-
#update_public_sharing_settings(params = {}) ⇒ Types::UpdatePublicSharingSettingsResponse
This API controls public sharing settings for your entire Quick Sight account, affecting data security and access.
-
#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 Quick Sight Q Search configuration.
-
#update_refresh_schedule(params = {}) ⇒ Types::UpdateRefreshScheduleResponse
Updates a refresh schedule for a dataset.
-
#update_resource_permissions(params = {}) ⇒ Types::UpdateResourcePermissionsResponse
Updates the service role configuration that Amazon Quick Sight uses to access resources in your Amazon Web Services account.
-
#update_role_custom_permission(params = {}) ⇒ Types::UpdateRoleCustomPermissionResponse
Updates the custom permissions that are associated with a role.
-
#update_self_upgrade(params = {}) ⇒ Types::UpdateSelfUpgradeResponse
Updates a self-upgrade request for a Quick user by approving, denying, or verifying the request.
-
#update_self_upgrade_configuration(params = {}) ⇒ Types::UpdateSelfUpgradeConfigurationResponse
Updates the self-upgrade configuration for a Quick account.
-
#update_space(params = {}) ⇒ Types::UpdateSpaceResponse
Updates the metadata of an Amazon QuickSight space.
-
#update_space_permissions(params = {}) ⇒ Types::UpdateSpacePermissionsResponse
Updates the permissions for an Amazon QuickSight space.
-
#update_space_resources(params = {}) ⇒ Types::UpdateSpaceResourcesResponse
Adds or removes resources from an Amazon QuickSight space.
-
#update_spice_capacity_configuration(params = {}) ⇒ Types::UpdateSPICECapacityConfigurationResponse
Updates the SPICE capacity configuration for a Quick Sight account.
-
#update_template(params = {}) ⇒ Types::UpdateTemplateResponse
Updates a template from an existing Amazon Quick Sight 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_permissions_v2(params = {}) ⇒ Types::UpdateTopicPermissionsV2Response
Updates the permissions of a topic.
-
#update_topic_refresh_schedule(params = {}) ⇒ Types::UpdateTopicRefreshScheduleResponse
Updates a topic refresh schedule.
-
#update_topic_v2(params = {}) ⇒ Types::UpdateTopicV2Response
Updates the definition of a Q topic.
-
#update_user(params = {}) ⇒ Types::UpdateUserResponse
Updates an Amazon Quick Sight 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.
479 480 481 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 479 def initialize(*args) super end |
Instance Method Details
#batch_create_topic_reviewed_answer(params = {}) ⇒ Types::BatchCreateTopicReviewedAnswerResponse
Creates new reviewed answers for a Q Topic.
1292 1293 1294 1295 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1292 def batch_create_topic_reviewed_answer(params = {}, = {}) req = build_request(:batch_create_topic_reviewed_answer, params) req.send_request() end |
#batch_delete_knowledge_base(params = {}) ⇒ Types::BatchDeleteKnowledgeBaseResponse
Deletes one or more knowledge bases.
1336 1337 1338 1339 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1336 def batch_delete_knowledge_base(params = {}, = {}) req = build_request(:batch_delete_knowledge_base, params) req.send_request() end |
#batch_delete_policy_assignment_by_policy(params = {}) ⇒ Types::BatchDeletePolicyAssignmentByPolicyResponse
Removes a governance policy from multiple Amazon Quick Sight principals in a single request. A principal that doesn't have the policy is reported as a success.
Each entry succeeds or fails independently. Check the Errors list in
the response for entries that failed.
1389 1390 1391 1392 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1389 def batch_delete_policy_assignment_by_policy(params = {}, = {}) req = build_request(:batch_delete_policy_assignment_by_policy, params) req.send_request() end |
#batch_delete_topic_reviewed_answer(params = {}) ⇒ Types::BatchDeleteTopicReviewedAnswerResponse
Deletes reviewed answers for Q Topic.
1441 1442 1443 1444 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1441 def batch_delete_topic_reviewed_answer(params = {}, = {}) req = build_request(:batch_delete_topic_reviewed_answer, params) req.send_request() end |
#batch_describe_user_limits(params = {}) ⇒ Types::BatchDescribeUserLimitsResponse
Describes the effective resource limits for one or more Amazon Quick Sight users, including the limits that apply to each user based on their profile assignments.
1502 1503 1504 1505 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1502 def batch_describe_user_limits(params = {}, = {}) req = build_request(:batch_describe_user_limits, params) req.send_request() end |
#batch_put_policy_assignment_by_policy(params = {}) ⇒ Types::BatchPutPolicyAssignmentByPolicyResponse
Assigns a governance policy to multiple Amazon Quick Sight principals in a single request. If a principal already has a policy of the same type, this operation replaces it.
Each entry succeeds or fails independently. Check the Errors list in
the response for entries that failed.
1561 1562 1563 1564 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1561 def batch_put_policy_assignment_by_policy(params = {}, = {}) req = build_request(:batch_put_policy_assignment_by_policy, params) req.send_request() end |
#cancel_ingestion(params = {}) ⇒ Types::CancelIngestionResponse
Cancels an ongoing ingestion of data into SPICE.
1603 1604 1605 1606 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1603 def cancel_ingestion(params = {}, = {}) req = build_request(:cancel_ingestion, params) req.send_request() end |
#create_access_control_application(params = {}) ⇒ Types::CreateAccessControlApplicationResponse
Creates an access control application in an Amazon Quick Sight account. You use an access control application to define how an external client signs in to Quick Sight with OAuth 2.0.
To connect a client to Quick Sight through an inbound connector,
associate the access control application with the connector by using
the UpdateInboundConnectorApplicationAssociations operation.
1734 1735 1736 1737 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1734 def create_access_control_application(params = {}, = {}) req = build_request(:create_access_control_application, params) req.send_request() end |
#create_access_control_application_secret(params = {}) ⇒ Types::CreateAccessControlApplicationSecretResponse
Creates a client secret for an access control application. An access control application can have up to two client secrets, so that you can rotate a secret without downtime.
Provide the Amazon Web Services Secrets Manager (Secrets Manager) secret ARN for each Region where the client secret, issued by your identity provider (IdP), is stored.
1799 1800 1801 1802 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1799 def create_access_control_application_secret(params = {}, = {}) req = build_request(:create_access_control_application_secret, params) req.send_request() end |
#create_account_customization(params = {}) ⇒ Types::CreateAccountCustomizationResponse
Creates Amazon Quick Sight customizations. Currently, you can add a
custom default theme by using the CreateAccountCustomization or
UpdateAccountCustomization API operation. To further customize
Amazon Quick Sight by removing Amazon Quick Sight sample assets and
videos for all new users, see Customizing Quick Sight in the
Amazon Quick Sight User Guide.
You can create customizations for your Amazon Web Services account or,
if you specify a namespace, for a Quick Sight 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.
1893 1894 1895 1896 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1893 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 Quick Sight account, or subscribes to Amazon Quick Sight 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 Quick Sight User Guide. The person who signs up for Amazon Quick Sight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for Amazon Quick Sight in the Amazon Quick Sight 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 Quick Sight, see Passing IAM roles to Amazon Quick Sight in the Amazon Quick Sight User Guide.
You can't set default resource access on the new account from the Amazon Quick Sight API. Instead, add default resource access from the Amazon Quick Sight 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 Quick Sight User Guide.
2159 2160 2161 2162 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2159 def create_account_subscription(params = {}, = {}) req = build_request(:create_account_subscription, params) req.send_request() end |
#create_action_connector(params = {}) ⇒ Types::CreateActionConnectorResponse
Creates an action connector that enables Amazon Quick Sight to connect to external services and perform actions. Action connectors support various authentication methods and can be configured with specific actions from supported connector types like Amazon S3, Salesforce, JIRA.
2294 2295 2296 2297 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2294 def create_action_connector(params = {}, = {}) req = build_request(:create_action_connector, params) req.send_request() end |
#create_agent(params = {}) ⇒ Types::CreateAgentResponse
Creates an agent in Amazon QuickSight.
2387 2388 2389 2390 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2387 def create_agent(params = {}, = {}) req = build_request(:create_agent, params) req.send_request() end |
#create_analysis(params = {}) ⇒ Types::CreateAnalysisResponse
Creates an analysis in Amazon Quick Sight. Analyses can be created
either from a template or from an AnalysisDefinition.
2476 2477 2478 2479 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2476 def create_analysis(params = {}, = {}) req = build_request(:create_analysis, params) req.send_request() end |
#create_approval_policy(params = {}) ⇒ Types::CreateApprovalPolicyResponse
Creates an approval policy in Quick Sight.
2547 2548 2549 2550 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2547 def create_approval_policy(params = {}, = {}) req = build_request(:create_approval_policy, params) req.send_request() end |
#create_brand(params = {}) ⇒ Types::CreateBrandResponse
Creates an Quick Sight brand.
2753 2754 2755 2756 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2753 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.
3394 3395 3396 3397 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3394 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 Quick Sight that identifies Amazon Quick Sight reports, created from analyses. You can share Amazon Quick Sight 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.
3547 3548 3549 3550 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3547 def create_dashboard(params = {}, = {}) req = build_request(:create_dashboard, params) req.send_request() end |
#create_data_set(params = {}) ⇒ Types::CreateDataSetResponse
Creates a dataset.
4425 4426 4427 4428 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4425 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.
4997 4998 4999 5000 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4997 def create_data_source(params = {}, = {}) req = build_request(:create_data_source, params) req.send_request() end |
#create_dlp_setting(params = {}) ⇒ Types::CreateDlpSettingResponse
Creates a data loss prevention (DLP) setting configuration for an Amazon Web Services account. A DLP setting defines the DLP provider, the enforcement behavior, and the Quick capabilities that the setting applies to.
5088 5089 5090 5091 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5088 def create_dlp_setting(params = {}, = {}) req = build_request(:create_dlp_setting, params) req.send_request() end |
#create_flow(params = {}) ⇒ Types::CreateFlowResponse
Creates a new flow in the specified Amazon Web Services account. Creates both a DRAFT and PUBLISHED (auto-published) version.
This operation is idempotent. Supply a ClientToken to safely retry
without creating duplicate resources.
5170 5171 5172 5173 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5170 def create_flow(params = {}, = {}) req = build_request(:create_flow, params) req.send_request() end |
#create_folder(params = {}) ⇒ Types::CreateFolderResponse
Creates an empty shared folder.
5250 5251 5252 5253 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5250 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.
5296 5297 5298 5299 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5296 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 Quick Sight. You
can create up to 10,000 groups in a namespace. If you want to create
more than 10,000 groups in a namespace, contact Amazon Web Services
Support.
The permissions resource is
arn:aws:quicksight:<your-region>:<relevant-aws-account-id>:group/default/<group-name>
.
The response is a group object.
5354 5355 5356 5357 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5354 def create_group(params = {}, = {}) req = build_request(:create_group, params) req.send_request() end |
#create_group_membership(params = {}) ⇒ Types::CreateGroupMembershipResponse
Adds an Amazon Quick Sight user to an Amazon Quick Sight group.
5401 5402 5403 5404 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5401 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 Quick Sight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.
5482 5483 5484 5485 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5482 def create_iam_policy_assignment(params = {}, = {}) req = build_request(:create_iam_policy_assignment, params) req.send_request() end |
#create_inbound_connector(params = {}) ⇒ Types::CreateInboundConnectorResponse
Creates an inbound connector in a Quick Sight account. An inbound connector is the endpoint that an external client, such as the Quick Sight desktop application, uses to reach Quick Sight in your account.
Your users authenticate through the access control applications that
are associated with the connector. To manage these associations, use
UpdateInboundConnectorApplicationAssociations.
An account can have one QUICK_DESKTOP inbound connector in each
Region.
5566 5567 5568 5569 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5566 def create_inbound_connector(params = {}, = {}) req = build_request(:create_inbound_connector, 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.
5628 5629 5630 5631 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5628 def create_ingestion(params = {}, = {}) req = build_request(:create_ingestion, params) req.send_request() end |
#create_knowledge_base(params = {}) ⇒ Types::CreateKnowledgeBaseResponse
Creates a knowledge base from a specified data source. Supported data source connector types include:
S3_KNOWLEDGE_BASE– Uses an Amazon S3 bucket as the data source.WEB_CRAWLER– Uses web pages indexed by the built-in web crawler as the data source.GOOGLE_DRIVE– Uses Google Drive as the data source. Supports service account authentication only.SHAREPOINT– Uses SharePoint as the data source. Supports two-legged OAuth only.ONE_DRIVE– Uses OneDrive as the data source. Supports two-legged OAuth only.
5770 5771 5772 5773 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5770 def create_knowledge_base(params = {}, = {}) req = build_request(:create_knowledge_base, params) req.send_request() end |
#create_knowledge_base_refresh_schedule(params = {}) ⇒ Types::CreateKnowledgeBaseRefreshScheduleResponse
Creates a schedule that periodically refreshes an Amazon Quick Sight knowledge base at the frequency that you specify.
A knowledge base can have only one refresh schedule. If the knowledge
base already has a refresh schedule, the request fails with a
LimitExceededException.
5845 5846 5847 5848 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5845 def create_knowledge_base_refresh_schedule(params = {}, = {}) req = build_request(:create_knowledge_base_refresh_schedule, params) req.send_request() end |
#create_limits_profile(params = {}) ⇒ Types::CreateLimitsProfileResponse
Creates a limits profile that defines resource usage limits for Amazon Quick Sight users.
5901 5902 5903 5904 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5901 def create_limits_profile(params = {}, = {}) req = build_request(:create_limits_profile, params) req.send_request() end |
#create_namespace(params = {}) ⇒ Types::CreateNamespaceResponse
(Enterprise edition only) Creates a new namespace for you to use with Amazon Quick Sight.
A namespace allows you to isolate the Quick Sight 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 Quick Sight. 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 Services Support.
5972 5973 5974 5975 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5972 def create_namespace(params = {}, = {}) req = build_request(:create_namespace, params) req.send_request() end |
#create_o_auth_client_application(params = {}) ⇒ Types::CreateOAuthClientApplicationResponse
Creates an OAuthClientApplication.
6070 6071 6072 6073 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6070 def create_o_auth_client_application(params = {}, = {}) req = build_request(:create_o_auth_client_application, 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.
6127 6128 6129 6130 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6127 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 Quick Sight group to an
existing role.
6173 6174 6175 6176 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6173 def create_role_membership(params = {}, = {}) req = build_request(:create_role_membership, params) req.send_request() end |
#create_space(params = {}) ⇒ Types::CreateSpaceResponse
Creates a new Amazon QuickSight space. A space is a collection of resources that can be used to organize and manage QuickSight assets.
6219 6220 6221 6222 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6219 def create_space(params = {}, = {}) req = build_request(:create_space, params) req.send_request() end |
#create_template(params = {}) ⇒ Types::CreateTemplateResponse
Creates a template either from a TemplateDefinition or from an
existing Quick Sight analysis or template. You can use the resulting
template to create additional dashboards, templates, or analyses.
A template is an entity in Quick Sight 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.
6319 6320 6321 6322 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6319 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.
6368 6369 6370 6371 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6368 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 Quick Sight in the Amazon Quick Sight User Guide.
6632 6633 6634 6635 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6632 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.
6681 6682 6683 6684 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6681 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.
6995 6996 6997 6998 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6995 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.
7056 7057 7058 7059 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7056 def create_topic_refresh_schedule(params = {}, = {}) req = build_request(:create_topic_refresh_schedule, params) req.send_request() end |
#create_topic_v2(params = {}) ⇒ Types::CreateTopicV2Response
Creates a new Q topic.
7143 7144 7145 7146 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7143 def create_topic_v2(params = {}, = {}) req = build_request(:create_topic_v2, params) req.send_request() end |
#create_vpc_connection(params = {}) ⇒ Types::CreateVPCConnectionResponse
Creates a new VPC connection.
7219 7220 7221 7222 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7219 def create_vpc_connection(params = {}, = {}) req = build_request(:create_vpc_connection, params) req.send_request() end |
#delete_access_control_application(params = {}) ⇒ Types::DeleteAccessControlApplicationResponse
Deletes an access control application. You can't delete an access
control application that is associated with an inbound connector whose
status is ENABLED.
If another update to the same application is in progress, Quick Sight
returns a ConflictException. Retry the request.
7267 7268 7269 7270 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7267 def delete_access_control_application(params = {}, = {}) req = build_request(:delete_access_control_application, params) req.send_request() end |
#delete_access_control_application_secret(params = {}) ⇒ Types::DeleteAccessControlApplicationSecretResponse
Deletes a client secret from an access control application.
7306 7307 7308 7309 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7306 def delete_access_control_application_secret(params = {}, = {}) req = build_request(:delete_access_control_application_secret, params) req.send_request() end |
#delete_account_custom_permission(params = {}) ⇒ Types::DeleteAccountCustomPermissionResponse
Unapplies a custom permissions profile from an account.
7337 7338 7339 7340 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7337 def (params = {}, = {}) req = build_request(:delete_account_custom_permission, params) req.send_request() end |
#delete_account_customization(params = {}) ⇒ Types::DeleteAccountCustomizationResponse
This API permanently deletes all Quick Sight customizations for the specified Amazon Web Services account and namespace. When you delete account customizations:
All customizations are removed including themes, branding, and visual settings
This action cannot be undone through the API
Users will see default Quick Sight styling after customizations are deleted
Before proceeding: Ensure you have backups of any custom themes or branding elements you may want to recreate.
Deletes all Amazon Quick Sight customizations for the specified Amazon Web Services account and Quick Sight namespace.
7390 7391 7392 7393 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7390 def delete_account_customization(params = {}, = {}) req = build_request(:delete_account_customization, params) req.send_request() end |
#delete_account_subscription(params = {}) ⇒ Types::DeleteAccountSubscriptionResponse
Deleting your Quick Sight account subscription has permanent, irreversible consequences across all Amazon Web Services regions:
Global deletion – Running this operation from any single region will delete your Quick Sight account and all data in every Amazon Web Services region where you have Quick Sight resources.
Complete data loss – All dashboards, analyses, datasets, data sources, and custom visuals will be permanently deleted across all regions.
Embedded content failure – All embedded dashboards and visuals in your applications will immediately stop working and display errors to end users.
Shared resources removed – All shared dashboards, folders, and resources will become inaccessible to other users and external recipients.
User access terminated – All Quick Sight users in your account will lose access immediately, including authors, readers, and administrators.
No recovery possible – Once deleted, your Quick Sight account and all associated data cannot be restored.
Consider exporting critical dashboards and data before proceeding with account deletion.
Use the DeleteAccountSubscription operation to delete an Quick Sight
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.
7458 7459 7460 7461 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7458 def delete_account_subscription(params = {}, = {}) req = build_request(:delete_account_subscription, params) req.send_request() end |
#delete_action_connector(params = {}) ⇒ Types::DeleteActionConnectorResponse
Hard deletes an action connector, making it unrecoverable. This operation removes the connector and all its associated configurations. Any resources currently using this action connector will no longer be able to perform actions through it.
7500 7501 7502 7503 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7500 def delete_action_connector(params = {}, = {}) req = build_request(:delete_action_connector, params) req.send_request() end |
#delete_agent(params = {}) ⇒ Types::DeleteAgentResponse
Deletes an agent.
7532 7533 7534 7535 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7532 def delete_agent(params = {}, = {}) req = build_request(:delete_agent, params) req.send_request() end |
#delete_analysis(params = {}) ⇒ Types::DeleteAnalysisResponse
Deletes an analysis from Amazon Quick Sight. You can optionally
include a recovery window during which you can restore the analysis.
If you don't specify a recovery window value, the operation defaults
to 30 days. Amazon Quick Sight attaches a DeletionTime stamp to the
response that specifies the end of the recovery window. At the end of
the recovery window, Amazon Quick Sight deletes the analysis
permanently.
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 Quick Sight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
7603 7604 7605 7606 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7603 def delete_analysis(params = {}, = {}) req = build_request(:delete_analysis, params) req.send_request() end |
#delete_app(params = {}) ⇒ Types::DeleteAppResponse
Deletes an app.
7635 7636 7637 7638 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7635 def delete_app(params = {}, = {}) req = build_request(:delete_app, params) req.send_request() end |
#delete_approval_policy(params = {}) ⇒ Struct
Deletes an approval policy in Quick Sight.
7657 7658 7659 7660 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7657 def delete_approval_policy(params = {}, = {}) req = build_request(:delete_approval_policy, params) req.send_request() end |
#delete_brand(params = {}) ⇒ Types::DeleteBrandResponse
This API permanently deletes the specified Quick Sight brand. When you delete a brand:
The brand and all its associated branding elements are permanently removed
Any applications or dashboards using this brand will revert to default styling
This action cannot be undone through the API
Before proceeding: Verify that the brand is no longer needed and consider the impact on any applications currently using this brand.
Deletes an Quick Sight brand.
7703 7704 7705 7706 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7703 def delete_brand(params = {}, = {}) req = build_request(:delete_brand, params) req.send_request() end |
#delete_brand_assignment(params = {}) ⇒ Types::DeleteBrandAssignmentResponse
Deletes a brand assignment.
7732 7733 7734 7735 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7732 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.
7769 7770 7771 7772 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7769 def (params = {}, = {}) req = build_request(:delete_custom_permissions, params) req.send_request() end |
#delete_dashboard(params = {}) ⇒ Types::DeleteDashboardResponse
Deletes a dashboard.
7813 7814 7815 7816 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7813 def delete_dashboard(params = {}, = {}) req = build_request(:delete_dashboard, params) req.send_request() end |
#delete_data_set(params = {}) ⇒ Types::DeleteDataSetResponse
Deletes a dataset.
7852 7853 7854 7855 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7852 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.
7886 7887 7888 7889 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7886 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.
7926 7927 7928 7929 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7926 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 Quick Sight account
7965 7966 7967 7968 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7965 def delete_default_q_business_application(params = {}, = {}) req = build_request(:delete_default_q_business_application, params) req.send_request() end |
#delete_dlp_setting(params = {}) ⇒ Types::DeleteDlpSettingResponse
Deletes a DLP setting configuration from an Amazon Web Services account.
8003 8004 8005 8006 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8003 def delete_dlp_setting(params = {}, = {}) req = build_request(:delete_dlp_setting, params) req.send_request() end |
#delete_flow(params = {}) ⇒ Types::DeleteFlowResponse
Permanently deletes a flow from the specified Amazon Web Services account. This operation cannot be undone.
8039 8040 8041 8042 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8039 def delete_flow(params = {}, = {}) req = build_request(:delete_flow, params) req.send_request() end |
#delete_folder(params = {}) ⇒ Types::DeleteFolderResponse
Deletes an empty folder.
8077 8078 8079 8080 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8077 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.
8120 8121 8122 8123 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8120 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 Quick Sight.
8160 8161 8162 8163 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8160 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.
8206 8207 8208 8209 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8206 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.
8247 8248 8249 8250 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8247 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 Quick Sight IAM Identity Center application.
This operation is only supported for Quick Sight accounts that use IAM Identity Center.
8287 8288 8289 8290 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8287 def delete_identity_propagation_config(params = {}, = {}) req = build_request(:delete_identity_propagation_config, params) req.send_request() end |
#delete_inbound_connector(params = {}) ⇒ Types::DeleteInboundConnectorResponse
Deletes an inbound connector. You must disable the connector before you can delete it. When you delete a connector, Quick Sight doesn't delete the access control applications that are associated with it.
8326 8327 8328 8329 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8326 def delete_inbound_connector(params = {}, = {}) req = build_request(:delete_inbound_connector, params) req.send_request() end |
#delete_knowledge_base(params = {}) ⇒ Types::DeleteKnowledgeBaseResponse
Deletes a knowledge base.
8365 8366 8367 8368 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8365 def delete_knowledge_base(params = {}, = {}) req = build_request(:delete_knowledge_base, params) req.send_request() end |
#delete_knowledge_base_refresh_schedule(params = {}) ⇒ Types::DeleteKnowledgeBaseRefreshScheduleResponse
Deletes the refresh schedule for an Amazon Quick Sight knowledge base. Delete the schedule when you no longer want the knowledge base to refresh automatically.
8410 8411 8412 8413 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8410 def delete_knowledge_base_refresh_schedule(params = {}, = {}) req = build_request(:delete_knowledge_base_refresh_schedule, params) req.send_request() end |
#delete_limits_profile(params = {}) ⇒ Types::DeleteLimitsProfileResponse
Deletes a limits profile.
8443 8444 8445 8446 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8443 def delete_limits_profile(params = {}, = {}) req = build_request(:delete_limits_profile, 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.
8482 8483 8484 8485 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8482 def delete_namespace(params = {}, = {}) req = build_request(:delete_namespace, params) req.send_request() end |
#delete_o_auth_client_application(params = {}) ⇒ Types::DeleteOAuthClientApplicationResponse
Deletes an OAuthClientApplication.
8520 8521 8522 8523 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8520 def delete_o_auth_client_application(params = {}, = {}) req = build_request(:delete_o_auth_client_application, params) req.send_request() end |
#delete_policy_assignment(params = {}) ⇒ Struct
Removes a governance policy from an Amazon Quick Sight principal. If
the principal doesn't have the specified policy, the request succeeds
and makes no change. If the principal has a different policy of the
same type, the request fails with a ConflictException.
8561 8562 8563 8564 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8561 def delete_policy_assignment(params = {}, = {}) req = build_request(:delete_policy_assignment, params) req.send_request() end |
#delete_refresh_schedule(params = {}) ⇒ Types::DeleteRefreshScheduleResponse
Deletes a refresh schedule from a dataset.
8603 8604 8605 8606 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8603 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.
8643 8644 8645 8646 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8643 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.
8688 8689 8690 8691 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8688 def delete_role_membership(params = {}, = {}) req = build_request(:delete_role_membership, params) req.send_request() end |
#delete_space(params = {}) ⇒ Types::DeleteSpaceResponse
Deletes an Amazon QuickSight space.
8724 8725 8726 8727 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8724 def delete_space(params = {}, = {}) req = build_request(:delete_space, params) req.send_request() end |
#delete_template(params = {}) ⇒ Types::DeleteTemplateResponse
Deletes a template.
8769 8770 8771 8772 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8769 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.
8819 8820 8821 8822 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8819 def delete_template_alias(params = {}, = {}) req = build_request(:delete_template_alias, params) req.send_request() end |
#delete_theme(params = {}) ⇒ Types::DeleteThemeResponse
Deletes a theme.
8865 8866 8867 8868 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8865 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.
8912 8913 8914 8915 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8912 def delete_theme_alias(params = {}, = {}) req = build_request(:delete_theme_alias, params) req.send_request() end |
#delete_topic(params = {}) ⇒ Types::DeleteTopicResponse
Deletes a topic.
8952 8953 8954 8955 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8952 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.
8997 8998 8999 9000 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8997 def delete_topic_refresh_schedule(params = {}, = {}) req = build_request(:delete_topic_refresh_schedule, params) req.send_request() end |
#delete_topic_v2(params = {}) ⇒ Types::DeleteTopicV2Response
Deletes a Q topic.
9037 9038 9039 9040 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9037 def delete_topic_v2(params = {}, = {}) req = build_request(:delete_topic_v2, params) req.send_request() end |
#delete_user(params = {}) ⇒ Types::DeleteUserResponse
Deletes the Amazon Quick Sight user that is associated with the identity of the IAM user or role that's making the call. The IAM user isn't deleted as a result of this call.
9079 9080 9081 9082 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9079 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.
9119 9120 9121 9122 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9119 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.
9159 9160 9161 9162 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9159 def (params = {}, = {}) req = build_request(:delete_user_custom_permission, params) req.send_request() end |
#delete_vpc_connection(params = {}) ⇒ Types::DeleteVPCConnectionResponse
Deletes a VPC connection.
9204 9205 9206 9207 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9204 def delete_vpc_connection(params = {}, = {}) req = build_request(:delete_vpc_connection, params) req.send_request() end |
#describe_access_control_application(params = {}) ⇒ Types::DescribeAccessControlApplicationResponse
Describes an access control application. The response includes client secret metadata, but never client secret values.
9269 9270 9271 9272 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9269 def describe_access_control_application(params = {}, = {}) req = build_request(:describe_access_control_application, params) req.send_request() end |
#describe_account_custom_permission(params = {}) ⇒ Types::DescribeAccountCustomPermissionResponse
Describes the custom permissions profile that is applied to an account.
9303 9304 9305 9306 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9303 def (params = {}, = {}) req = build_request(:describe_account_custom_permission, params) req.send_request() end |
#describe_account_customization(params = {}) ⇒ Types::DescribeAccountCustomizationResponse
Describes the customizations associated with the provided Amazon Web
Services account and Amazon Quick Sight namespace. The Quick Sight
console evaluates which customizations to apply by running this API
operation with the Resolved flag included.
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 Quick Sight, 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 Quick Sight in any supported Amazon Web Services Region.Amazon Web Services Region- You can sign in to Quick Sight in any Amazon Web Services Region. If you have a user directory, it resides in us-east-1, which is US East (N. Virginia). Generally speaking, these users have access to Quick Sight 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 configureto 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 Quick Sight 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- Quick Sight 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.
9407 9408 9409 9410 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9407 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 Quick Sight subscription was first created in this Amazon Web Services account.
9446 9447 9448 9449 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9446 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 Quick Sight account's subscription. A successful API call
returns an AccountInfo object that includes an account's name,
subscription status, authentication type, edition, and notification
email address.
9488 9489 9490 9491 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9488 def describe_account_subscription(params = {}, = {}) req = build_request(:describe_account_subscription, params) req.send_request() end |
#describe_action_connector(params = {}) ⇒ Types::DescribeActionConnectorResponse
Retrieves detailed information about an action connector, including its configuration, authentication settings, enabled actions, and current status.
9556 9557 9558 9559 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9556 def describe_action_connector(params = {}, = {}) req = build_request(:describe_action_connector, params) req.send_request() end |
#describe_action_connector_permissions(params = {}) ⇒ Types::DescribeActionConnectorPermissionsResponse
Retrieves the permissions configuration for an action connector, showing which users, groups, and namespaces have access and what operations they can perform.
9602 9603 9604 9605 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9602 def (params = {}, = {}) req = build_request(:describe_action_connector_permissions, params) req.send_request() end |
#describe_agent(params = {}) ⇒ Types::DescribeAgentResponse
Describes an agent.
9662 9663 9664 9665 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9662 def describe_agent(params = {}, = {}) req = build_request(:describe_agent, params) req.send_request() end |
#describe_agent_permissions(params = {}) ⇒ Types::DescribeAgentPermissionsResponse
Describes the resource permissions for an agent.
9703 9704 9705 9706 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9703 def (params = {}, = {}) req = build_request(:describe_agent_permissions, params) req.send_request() end |
#describe_analysis(params = {}) ⇒ Types::DescribeAnalysisResponse
Provides a summary of the metadata for an analysis.
9794 9795 9796 9797 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9794 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.
9843 9844 9845 9846 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9843 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.
9889 9890 9891 9892 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9889 def (params = {}, = {}) req = build_request(:describe_analysis_permissions, params) req.send_request() end |
#describe_app(params = {}) ⇒ Types::DescribeAppResponse
Describes an app.
9928 9929 9930 9931 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9928 def describe_app(params = {}, = {}) req = build_request(:describe_app, params) req.send_request() end |
#describe_app_permissions(params = {}) ⇒ Types::DescribeAppPermissionsResponse
Describes the resource permissions for an app.
9969 9970 9971 9972 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9969 def (params = {}, = {}) req = build_request(:describe_app_permissions, params) req.send_request() end |
#describe_approval_policy(params = {}) ⇒ Types::DescribeApprovalPolicyResponse
Describes an approval policy in Quick Sight.
10011 10012 10013 10014 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10011 def describe_approval_policy(params = {}, = {}) req = build_request(:describe_approval_policy, 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.
10131 10132 10133 10134 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10131 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.
10477 10478 10479 10480 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10477 def describe_asset_bundle_import_job(params = {}, = {}) req = build_request(:describe_asset_bundle_import_job, params) req.send_request() end |
#describe_automation_job(params = {}) ⇒ Types::DescribeAutomationJobResponse
Retrieves the status and details of a specified automation job, including its status and outputs.
10546 10547 10548 10549 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10546 def describe_automation_job(params = {}, = {}) req = build_request(:describe_automation_job, params) req.send_request() end |
#describe_brand(params = {}) ⇒ Types::DescribeBrandResponse
Describes a brand.
10650 10651 10652 10653 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10650 def describe_brand(params = {}, = {}) req = build_request(:describe_brand, params) req.send_request() end |
#describe_brand_assignment(params = {}) ⇒ Types::DescribeBrandAssignmentResponse
Describes a brand assignment.
10681 10682 10683 10684 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10681 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.
10780 10781 10782 10783 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10780 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.
11398 11399 11400 11401 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11398 def (params = {}, = {}) req = build_request(:describe_custom_permissions, params) req.send_request() end |
#describe_dashboard(params = {}) ⇒ Types::DescribeDashboardResponse
Provides a summary for a dashboard.
11504 11505 11506 11507 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11504 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.
11561 11562 11563 11564 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11561 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.
11610 11611 11612 11613 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11610 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.
Registered user support
This API can be called as before to get status of a job started by the same Quick Sight user.
Possible error scenarios
Request will fail with an Access Denied error in the following scenarios:
The credentials have expired.
Job has been started by a different user.
Impersonated Quick Sight user doesn't have access to the specified dashboard in the job.
11717 11718 11719 11720 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11717 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..
Registered user support
This API can be called as before to get the result of a job started by
the same Quick Sight user. The result for the user will be returned in
RegisteredUsers response attribute. The attribute will contain a
list with at most one object in it.
Possible error scenarios
The request fails with an Access Denied error in the following scenarios:
The credentials have expired.
The job was started by a different user.
The registered user doesn't have access to the specified dashboard.
The request succeeds but the job fails in the following scenarios:
DASHBOARD_ACCESS_DENIED- The registered user lost access to the dashboard.CAPABILITY_RESTRICTED- The registered user is restricted from exporting data in all selected formats.
The request succeeds but the response contains an error code in the following scenarios:
CAPABILITY_RESTRICTED- The registered user is restricted from exporting data in some selected formats.RLS_CHANGED- Row-level security settings have changed. Re-run the job with current settings.CLS_CHANGED- Column-level security settings have changed. Re-run the job with current settings.DATASET_DELETED- The dataset has been deleted. Verify the dataset exists before re-running the job.
11852 11853 11854 11855 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11852 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.
11885 11886 11887 11888 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11885 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.
12299 12300 12301 12302 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12299 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.
12346 12347 12348 12349 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12346 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.
12385 12386 12387 12388 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12385 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.
12684 12685 12686 12687 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12684 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.
12728 12729 12730 12731 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12728 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 Quick Sight account.
12769 12770 12771 12772 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12769 def describe_default_q_business_application(params = {}, = {}) req = build_request(:describe_default_q_business_application, params) req.send_request() end |
#describe_dlp_setting(params = {}) ⇒ Types::DescribeDlpSettingResponse
Describes the full configuration of a DLP setting in an Amazon Web Services account.
12818 12819 12820 12821 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12818 def describe_dlp_setting(params = {}, = {}) req = build_request(:describe_dlp_setting, params) req.send_request() end |
#describe_flow(params = {}) ⇒ Types::DescribeFlowResponse
Returns the full details of a flow for the latest version of the requested publish state.
12872 12873 12874 12875 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12872 def describe_flow(params = {}, = {}) req = build_request(:describe_flow, params) req.send_request() end |
#describe_folder(params = {}) ⇒ Types::DescribeFolderResponse
Describes a folder.
12916 12917 12918 12919 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12916 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.
12975 12976 12977 12978 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12975 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.
13036 13037 13038 13039 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13036 def (params = {}, = {}) req = build_request(:describe_folder_resolved_permissions, params) req.send_request() end |
#describe_group(params = {}) ⇒ Types::DescribeGroupResponse
Returns an Amazon Quick Sight group's description and Amazon Resource Name (ARN).
13082 13083 13084 13085 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13082 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.
13131 13132 13133 13134 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13131 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.
13180 13181 13182 13183 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13180 def describe_iam_policy_assignment(params = {}, = {}) req = build_request(:describe_iam_policy_assignment, params) req.send_request() end |
#describe_inbound_connector(params = {}) ⇒ Types::DescribeInboundConnectorResponse
Describes an inbound connector.
13225 13226 13227 13228 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13225 def describe_inbound_connector(params = {}, = {}) req = build_request(:describe_inbound_connector, params) req.send_request() end |
#describe_ingestion(params = {}) ⇒ Types::DescribeIngestionResponse
Describes a SPICE ingestion.
13279 13280 13281 13282 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13279 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.
13322 13323 13324 13325 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13322 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 Quick Sight account.
13367 13368 13369 13370 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13367 def describe_key_registration(params = {}, = {}) req = build_request(:describe_key_registration, params) req.send_request() end |
#describe_knowledge_base(params = {}) ⇒ Types::DescribeKnowledgeBaseResponse
Describes a knowledge base.
13434 13435 13436 13437 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13434 def describe_knowledge_base(params = {}, = {}) req = build_request(:describe_knowledge_base, params) req.send_request() end |
#describe_knowledge_base_permissions(params = {}) ⇒ Types::DescribeKnowledgeBasePermissionsResponse
Describes the resource permissions for a knowledge base.
13478 13479 13480 13481 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13478 def (params = {}, = {}) req = build_request(:describe_knowledge_base_permissions, params) req.send_request() end |
#describe_knowledge_base_refresh_schedule(params = {}) ⇒ Types::DescribeKnowledgeBaseRefreshScheduleResponse
Describes the refresh schedule for an Amazon Quick Sight knowledge base, including the schedule's frequency, start time, and state.
13527 13528 13529 13530 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13527 def describe_knowledge_base_refresh_schedule(params = {}, = {}) req = build_request(:describe_knowledge_base_refresh_schedule, params) req.send_request() end |
#describe_limits_profile(params = {}) ⇒ Types::DescribeLimitsProfileResponse
Describes the properties of an existing limits profile.
13569 13570 13571 13572 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13569 def describe_limits_profile(params = {}, = {}) req = build_request(:describe_limits_profile, params) req.send_request() end |
#describe_namespace(params = {}) ⇒ Types::DescribeNamespaceResponse
Describes the current namespace.
13614 13615 13616 13617 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13614 def describe_namespace(params = {}, = {}) req = build_request(:describe_namespace, params) req.send_request() end |
#describe_o_auth_client_application(params = {}) ⇒ Types::DescribeOAuthClientApplicationResponse
Describes an OAuthClientApplication.
13660 13661 13662 13663 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13660 def describe_o_auth_client_application(params = {}, = {}) req = build_request(:describe_o_auth_client_application, params) req.send_request() end |
#describe_q_personalization_configuration(params = {}) ⇒ Types::DescribeQPersonalizationConfigurationResponse
Describes a personalization configuration.
13693 13694 13695 13696 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13693 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 Quick Sight Q Search configuration.
13726 13727 13728 13729 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13726 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.
13776 13777 13778 13779 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13776 def describe_refresh_schedule(params = {}, = {}) req = build_request(:describe_refresh_schedule, params) req.send_request() end |
#describe_resource_permissions(params = {}) ⇒ Types::DescribeResourcePermissionsResponse
Describes the service role configuration for your Amazon Quick Sight account.
Call this operation in the Amazon Web Services Region where your Amazon Quick Sight account is registered (the home Region).
13815 13816 13817 13818 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13815 def (params = {}, = {}) req = build_request(:describe_resource_permissions, params) req.send_request() end |
#describe_role_custom_permission(params = {}) ⇒ Types::DescribeRoleCustomPermissionResponse
Describes all custom permissions that are mapped to a role.
13858 13859 13860 13861 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13858 def (params = {}, = {}) req = build_request(:describe_role_custom_permission, params) req.send_request() end |
#describe_self_upgrade_configuration(params = {}) ⇒ Types::DescribeSelfUpgradeConfigurationResponse
Describes the self-upgrade configuration for a Quick account.
13896 13897 13898 13899 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13896 def describe_self_upgrade_configuration(params = {}, = {}) req = build_request(:describe_self_upgrade_configuration, params) req.send_request() end |
#describe_space(params = {}) ⇒ Types::DescribeSpaceResponse
Describes an Amazon QuickSight space.
13953 13954 13955 13956 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13953 def describe_space(params = {}, = {}) req = build_request(:describe_space, params) req.send_request() end |
#describe_space_permissions(params = {}) ⇒ Types::DescribeSpacePermissionsResponse
Describes the permissions for an Amazon QuickSight space.
13994 13995 13996 13997 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13994 def (params = {}, = {}) req = build_request(:describe_space_permissions, params) req.send_request() end |
#describe_template(params = {}) ⇒ Types::DescribeTemplateResponse
Describes a template's metadata.
14117 14118 14119 14120 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14117 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.
14164 14165 14166 14167 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14164 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.
14224 14225 14226 14227 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14224 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.
14268 14269 14270 14271 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14268 def (params = {}, = {}) req = build_request(:describe_template_permissions, params) req.send_request() end |
#describe_theme(params = {}) ⇒ Types::DescribeThemeResponse
Describes a theme.
14427 14428 14429 14430 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14427 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.
14470 14471 14472 14473 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14470 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.
14514 14515 14516 14517 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14514 def (params = {}, = {}) req = build_request(:describe_theme_permissions, params) req.send_request() end |
#describe_topic(params = {}) ⇒ Types::DescribeTopicResponse
Describes a topic.
14731 14732 14733 14734 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14731 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.
14776 14777 14778 14779 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14776 def (params = {}, = {}) req = build_request(:describe_topic_permissions, params) req.send_request() end |
#describe_topic_permissions_v2(params = {}) ⇒ Types::DescribeTopicPermissionsV2Response
Describes the permissions of a topic.
14821 14822 14823 14824 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14821 def (params = {}, = {}) req = build_request(:describe_topic_permissions_v2, params) req.send_request() end |
#describe_topic_refresh(params = {}) ⇒ Types::DescribeTopicRefreshResponse
Describes the status of a topic refresh.
14866 14867 14868 14869 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14866 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.
14919 14920 14921 14922 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14919 def describe_topic_refresh_schedule(params = {}, = {}) req = build_request(:describe_topic_refresh_schedule, params) req.send_request() end |
#describe_topic_v2(params = {}) ⇒ Types::DescribeTopicV2Response
Describes a Q topic.
14974 14975 14976 14977 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14974 def describe_topic_v2(params = {}, = {}) req = build_request(:describe_topic_v2, params) req.send_request() end |
#describe_user(params = {}) ⇒ Types::DescribeUserResponse
Returns information about a user, given the user name.
15026 15027 15028 15029 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 15026 def describe_user(params = {}, = {}) req = build_request(:describe_user, params) req.send_request() end |
#describe_vpc_connection(params = {}) ⇒ Types::DescribeVPCConnectionResponse
Describes a VPC connection.
15083 15084 15085 15086 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 15083 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 Quick dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.
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
SessionLifetimeInMinutesparameter. 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 Quick.
For more information, see Embedded Analytics in the Quick 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 Quick Developer Portal.
15254 15255 15256 15257 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 15254 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 Quick experience in your website. This action can be used for any type of user registered in an Quick account. Before you use this action, make sure that you have configured the relevant Quick 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
SessionLifetimeInMinutesparameter.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 Quick.
For more information, see Embedded Analytics in the Quick 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 Quick Developer Portal.
15431 15432 15433 15434 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 15431 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 Quick Sight experience in your website. This action can be used for any type of user that is registered in an Amazon Quick Sight account that uses IAM Identity Center for authentication. This API requires identity-enhanced IAM Role sessions for the authenticated user that the API call is being made for.
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 Quick Sight with the scope value set to quicksight:read.
Before you use this action, make sure that you have configured the
relevant Amazon Quick Sight resource and permissions.
15585 15586 15587 15588 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 15585 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 Quick Sight read-only dashboard in your website or application. Before you use this command, make sure that you have configured the dashboards and permissions.
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 Quick.
The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional
SessionLifetimeInMinutesparameter to customize session duration.
For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Quick 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 Quick Developer Portal.
15718 15719 15720 15721 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 15718 def (params = {}, = {}) req = build_request(:get_dashboard_embed_url, params) req.send_request() end |
#get_flow_metadata(params = {}) ⇒ Types::GetFlowMetadataOutput
Retrieves the metadata of a flow, not including its definition specifying the steps.
15772 15773 15774 15775 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 15772 def (params = {}, = {}) req = build_request(:get_flow_metadata, params) req.send_request() end |
#get_flow_permissions(params = {}) ⇒ Types::GetFlowPermissionsOutput
Get permissions for a flow.
15816 15817 15818 15819 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 15816 def (params = {}, = {}) req = build_request(:get_flow_permissions, params) req.send_request() end |
#get_identity_context(params = {}) ⇒ Types::GetIdentityContextResponse
Retrieves the identity context for a Quick Sight user in a specified namespace, allowing you to obtain identity tokens that can be used with identity-enhanced IAM role sessions to call identity-aware APIs.
Currently, you can call the following APIs with identity-enhanced Credentials
Supported Authentication Methods
This API supports Quick Sight native users, IAM federated users, and Active Directory users. For Quick Sight users authenticated by Amazon Web Services Identity Center, see Identity Center documentation on identity-enhanced IAM role sessions.
Supported Regions
The GetIdentityContext API works only in regions that support at least one of these identity types:
Amazon Quick Sight native identity
IAM federated identity
Active Directory
To use this API successfully, call it in the same region where your user's identity resides. For example, if your user's identity is in us-east-1, make the API call in us-east-1. For more information about managing identities in Amazon Quick Sight, see Identity and access management in Amazon Quick Sight in the Amazon Quick Sight User Guide.
Getting Identity-Enhanced Credentials
To obtain identity-enhanced credentials, follow these steps:
Call the GetIdentityContext API to retrieve an identity token for the specified user.
Use the identity token with the STS AssumeRole API to obtain identity-enhanced IAM role session credentials.
Usage with STS AssumeRole
The identity token returned by this API should be used with the STS
AssumeRole API to obtain credentials for an identity-enhanced IAM role
session. When calling AssumeRole, include the identity token in the
ProvidedContexts parameter with ProviderArn set to
arn:aws:iam::aws:contextProvider/QuickSight and ContextAssertion
set to the identity token received from this API.
The assumed role must allow the sts:SetContext action in addition to
sts:AssumeRole in its trust relationship policy. The trust policy
should include both actions for the principal that will be assuming
the role.
15958 15959 15960 15961 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 15958 def get_identity_context(params = {}, = {}) req = build_request(:get_identity_context, params) req.send_request() end |
#get_policy_assignment(params = {}) ⇒ Types::GetPolicyAssignmentResponse
Describes the policy of the specified type that an Amazon Quick Sight principal has. If the principal has no policy of that type, the response contains no policy details.
16007 16008 16009 16010 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16007 def get_policy_assignment(params = {}, = {}) req = build_request(:get_policy_assignment, 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 Quick Sight console in your web server code.
Use GetSessionEmbedUrl where you want to provide an authoring portal
that allows users to create data sources, datasets, analyses, and
dashboards. The users who access an embedded Amazon Quick Sight
console need belong to the author or admin security cohort. If you
want to restrict permissions to some of these features, add a custom
permissions profile to the user with the UpdateUser API operation.
Use RegisterUser API operation to add a new user with a custom
permission profile attached. For more information, see the following
sections in the Quick User Guide:
16101 16102 16103 16104 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16101 def (params = {}, = {}) req = build_request(:get_session_embed_url, params) req.send_request() end |
#list_access_control_applications(params = {}) ⇒ Types::ListAccessControlApplicationsResponse
Lists the access control applications in a Quick Sight account in the
current Amazon Web Services Region. You can filter the results by
namespace. Quick Sight paginates the results. To retrieve additional
results, use the NextToken parameter.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
16175 16176 16177 16178 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16175 def list_access_control_applications(params = {}, = {}) req = build_request(:list_access_control_applications, params) req.send_request() end |
#list_action_connectors(params = {}) ⇒ Types::ListActionConnectorsResponse
Lists all action connectors in the specified Amazon Web Services account. Returns summary information for each connector including its name, type, creation time, and status.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
16233 16234 16235 16236 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16233 def list_action_connectors(params = {}, = {}) req = build_request(:list_action_connectors, params) req.send_request() end |
#list_agents(params = {}) ⇒ Types::ListAgentsResponse
Lists all agents in an Amazon QuickSight account.
16281 16282 16283 16284 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16281 def list_agents(params = {}, = {}) req = build_request(:list_agents, params) req.send_request() end |
#list_analyses(params = {}) ⇒ Types::ListAnalysesResponse
Lists Amazon Quick Sight 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.
16332 16333 16334 16335 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16332 def list_analyses(params = {}, = {}) req = build_request(:list_analyses, params) req.send_request() end |
#list_approval_policies(params = {}) ⇒ Types::ListApprovalPoliciesResponse
Lists all approval policies in the specified Quick Sight account. The
results are paginated. If the response includes a NextToken value,
pass it in a subsequent call to retrieve the next set of results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
16389 16390 16391 16392 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16389 def list_approval_policies(params = {}, = {}) req = build_request(:list_approval_policies, params) req.send_request() end |
#list_apps(params = {}) ⇒ Types::ListAppsResponse
Lists the apps in an Amazon Web Services account. Results are
paginated; use the NextToken parameter to retrieve additional
results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
16441 16442 16443 16444 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16441 def list_apps(params = {}, = {}) req = build_request(:list_apps, 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.
16499 16500 16501 16502 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16499 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.
16554 16555 16556 16557 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16554 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 Quick Sight account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
16603 16604 16605 16606 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 16603 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.
17231 17232 17233 17234 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 17231 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 Quick Sight subscription.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
17288 17289 17290 17291 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 17288 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.
17341 17342 17343 17344 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 17341 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.
17410 17411 17412 17413 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 17410 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.
17719 17720 17721 17722 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 17719 def list_data_sources(params = {}, = {}) req = build_request(:list_data_sources, params) req.send_request() end |
#list_dlp_settings(params = {}) ⇒ Types::ListDlpSettingsResponse
Lists all DLP settings in an Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
17770 17771 17772 17773 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 17770 def list_dlp_settings(params = {}, = {}) req = build_request(:list_dlp_settings, params) req.send_request() end |
#list_flows(params = {}) ⇒ Types::ListFlowsOutput
Lists flows in an Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
17829 17830 17831 17832 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 17829 def list_flows(params = {}, = {}) req = build_request(:list_flows, 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.
17880 17881 17882 17883 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 17880 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.
17932 17933 17934 17935 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 17932 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.
17983 17984 17985 17986 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 17983 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.
18039 18040 18041 18042 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 18039 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 Quick Sight.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
18093 18094 18095 18096 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 18093 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 Quick Sight account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
18150 18151 18152 18153 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 18150 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.
18208 18209 18210 18211 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 18208 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 Quick Sight IAM Identity Center application can access.
This operation is only supported for Quick Sight accounts that use IAM Identity Center.
18259 18260 18261 18262 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 18259 def list_identity_propagation_configs(params = {}, = {}) req = build_request(:list_identity_propagation_configs, params) req.send_request() end |
#list_inbound_connector_application_associations(params = {}) ⇒ Types::ListInboundConnectorApplicationAssociationsResponse
Lists the access control applications that are associated with an
inbound connector. Quick Sight paginates the results. To retrieve
additional results, use the NextToken parameter.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
18313 18314 18315 18316 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 18313 def list_inbound_connector_application_associations(params = {}, = {}) req = build_request(:list_inbound_connector_application_associations, params) req.send_request() end |
#list_inbound_connectors(params = {}) ⇒ Types::ListInboundConnectorsResponse
Lists the inbound connectors in a Quick Sight account. You can filter
the results by connector type. Quick Sight paginates the results. To
retrieve additional results, use the NextToken parameter.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
18374 18375 18376 18377 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 18374 def list_inbound_connectors(params = {}, = {}) req = build_request(:list_inbound_connectors, 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.
18439 18440 18441 18442 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 18439 def list_ingestions(params = {}, = {}) req = build_request(:list_ingestions, params) req.send_request() end |
#list_knowledge_base_refresh_schedules(params = {}) ⇒ Types::ListKnowledgeBaseRefreshSchedulesResponse
Lists the refresh schedules for an Amazon Quick Sight knowledge base.
Currently, a knowledge base can have only one refresh schedule, so the
list contains at most one schedule. Results are paginated. To retrieve
the next page of results, use the NextToken value from the previous
response.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
18502 18503 18504 18505 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 18502 def list_knowledge_base_refresh_schedules(params = {}, = {}) req = build_request(:list_knowledge_base_refresh_schedules, params) req.send_request() end |
#list_knowledge_bases(params = {}) ⇒ Types::ListKnowledgeBasesResponse
Lists all knowledge bases in an Amazon QuickSight account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
18560 18561 18562 18563 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 18560 def list_knowledge_bases(params = {}, = {}) req = build_request(:list_knowledge_bases, params) req.send_request() end |
#list_limits_profiles(params = {}) ⇒ Types::ListLimitsProfilesResponse
Lists all limits profiles in an Amazon Quick Sight account. Results
are paginated. Use the maxResults parameter to limit the number of
results returned in a single call, and use the nextToken parameter
to retrieve the next page of results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
18622 18623 18624 18625 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 18622 def list_limits_profiles(params = {}, = {}) req = build_request(:list_limits_profiles, 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.
18684 18685 18686 18687 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 18684 def list_namespaces(params = {}, = {}) req = build_request(:list_namespaces, params) req.send_request() end |
#list_o_auth_client_applications(params = {}) ⇒ Types::ListOAuthClientApplicationsResponse
Lists all OAuthClientApplications in the 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.
18737 18738 18739 18740 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 18737 def list_o_auth_client_applications(params = {}, = {}) req = build_request(:list_o_auth_client_applications, params) req.send_request() end |
#list_principals_for_policy(params = {}) ⇒ Types::ListPrincipalsForPolicyResponse
Lists the Amazon Quick Sight principals that have a governance policy.
This operation returns paginated results. A page can contain fewer
results than MaxResults, or none, and still include a NextToken.
Continue to call the operation until the response doesn't include a
NextToken. We recommend that you use pagination to make sure that
the operation returns quickly and successfully.
Results are eventually consistent and might not reflect recent
changes. If the policy has no assignments, the response contains an
empty Principals list. If the policy doesn't exist, the request
fails with a ResourceNotFoundException.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
18810 18811 18812 18813 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 18810 def list_principals_for_policy(params = {}, = {}) req = build_request(:list_principals_for_policy, 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.
18856 18857 18858 18859 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 18856 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.
18912 18913 18914 18915 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 18912 def list_role_memberships(params = {}, = {}) req = build_request(:list_role_memberships, params) req.send_request() end |
#list_self_upgrades(params = {}) ⇒ Types::ListSelfUpgradesResponse
Lists all self-upgrade requests for a Quick account.
18969 18970 18971 18972 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 18969 def list_self_upgrades(params = {}, = {}) req = build_request(:list_self_upgrades, params) req.send_request() end |
#list_space_resources(params = {}) ⇒ Types::ListSpaceResourcesResponse
Lists the resources in an Amazon QuickSight space.
19011 19012 19013 19014 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 19011 def list_space_resources(params = {}, = {}) req = build_request(:list_space_resources, params) req.send_request() end |
#list_spaces(params = {}) ⇒ Types::ListSpacesResponse
Lists all Amazon QuickSight spaces in an Amazon Web Services account.
19067 19068 19069 19070 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 19067 def list_spaces(params = {}, = {}) req = build_request(:list_spaces, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags assigned to a resource.
19102 19103 19104 19105 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 19102 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.
19155 19156 19157 19158 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 19155 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 Quick Sight account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
19211 19212 19213 19214 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 19211 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 Quick Sight account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
19263 19264 19265 19266 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 19263 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.
19314 19315 19316 19317 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 19314 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.
19370 19371 19372 19373 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 19370 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.
19435 19436 19437 19438 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 19435 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.
19486 19487 19488 19489 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 19486 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.
19959 19960 19961 19962 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 19959 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.
20009 20010 20011 20012 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 20009 def list_topics(params = {}, = {}) req = build_request(:list_topics, params) req.send_request() end |
#list_topics_v2(params = {}) ⇒ Types::ListTopicsV2Response
Lists all of the Q topics in the specified Amazon Web Services account in an Amazon Web Services Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
20059 20060 20061 20062 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 20059 def list_topics_v2(params = {}, = {}) req = build_request(:list_topics_v2, params) req.send_request() end |
#list_user_groups(params = {}) ⇒ Types::ListUserGroupsResponse
Lists the Amazon Quick Sight groups that an Amazon Quick Sight user is a member of.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
20119 20120 20121 20122 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 20119 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 Quick Sight users belonging to this account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
20181 20182 20183 20184 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 20181 def list_users(params = {}, = {}) req = build_request(:list_users, params) req.send_request() end |
#list_users_index_capacity(params = {}) ⇒ Types::ListUsersIndexCapacityResponse
Lists per-user index capacity consumption for an account.
20259 20260 20261 20262 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 20259 def list_users_index_capacity(params = {}, = {}) req = build_request(:list_users_index_capacity, 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.
20325 20326 20327 20328 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 20325 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
Quick with the scope value set to quicksight:read. Before you
use this action, make sure that you have configured the relevant Quick
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.
20431 20432 20433 20434 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 20431 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.
20484 20485 20486 20487 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 20484 def put_data_set_refresh_properties(params = {}, = {}) req = build_request(:put_data_set_refresh_properties, params) req.send_request() end |
#put_policy_assignment(params = {}) ⇒ Types::PutPolicyAssignmentResponse
Assigns a governance policy to an Amazon Quick Sight principal. A principal can have one policy of each policy type. If the principal already has a policy of the same type, this operation replaces it.
To make the change conditional, specify ExistingPolicyArn,
Revision, or both. If the current assignment doesn't match, the
request fails with a ConflictException and makes no change. If the
principal already has the specified policy, the request succeeds and
makes no change.
20548 20549 20550 20551 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 20548 def put_policy_assignment(params = {}, = {}) req = build_request(:put_policy_assignment, params) req.send_request() end |
#register_user(params = {}) ⇒ Types::RegisterUserResponse
Creates an Amazon Quick Sight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Quick Sight API, Quick Sight generates a registration URL. The user accesses this registration URL to create their account. Quick Sight doesn't send a registration email to users who are registered from the Quick Sight API. If you want new users to receive a registration email, then add those users in the Quick Sight console. For more information on registering a new user in the Quick Sight console, see Inviting users to access Quick Sight.
20745 20746 20747 20748 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 20745 def register_user(params = {}, = {}) req = build_request(:register_user, params) req.send_request() end |
#restore_analysis(params = {}) ⇒ Types::RestoreAnalysisResponse
Restores an analysis.
20795 20796 20797 20798 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 20795 def restore_analysis(params = {}, = {}) req = build_request(:restore_analysis, params) req.send_request() end |
#search_action_connectors(params = {}) ⇒ Types::SearchActionConnectorsResponse
Searches for action connectors in the specified Amazon Web Services account using filters. You can search by connector name, type, or user permissions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
20864 20865 20866 20867 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 20864 def search_action_connectors(params = {}, = {}) req = build_request(:search_action_connectors, params) req.send_request() end |
#search_agents(params = {}) ⇒ Types::SearchAgentsResponse
Searches for agents based on specified filters.
20922 20923 20924 20925 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 20922 def search_agents(params = {}, = {}) req = build_request(:search_agents, 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.
20989 20990 20991 20992 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 20989 def search_analyses(params = {}, = {}) req = build_request(:search_analyses, params) req.send_request() end |
#search_apps(params = {}) ⇒ Types::SearchAppsResponse
Searches for apps in an Amazon Web Services account using the
specified filters. This operation is eventually consistent; the
results might not reflect very recent updates. Results are paginated;
use the NextToken parameter to retrieve additional results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
21053 21054 21055 21056 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 21053 def search_apps(params = {}, = {}) req = build_request(:search_apps, 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.
21124 21125 21126 21127 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 21124 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.
21199 21200 21201 21202 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 21199 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.
21260 21261 21262 21263 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 21260 def search_data_sources(params = {}, = {}) req = build_request(:search_data_sources, params) req.send_request() end |
#search_flows(params = {}) ⇒ Types::SearchFlowsOutput
Search for the flows in an Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
21330 21331 21332 21333 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 21330 def search_flows(params = {}, = {}) req = build_request(:search_flows, 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.
21395 21396 21397 21398 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 21395 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 Quick
Sight namespace using the supplied filters.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
21461 21462 21463 21464 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 21461 def search_groups(params = {}, = {}) req = build_request(:search_groups, params) req.send_request() end |
#search_knowledge_bases(params = {}) ⇒ Types::SearchKnowledgeBasesResponse
Searches for a subset of knowledge bases based on specified filters.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
21536 21537 21538 21539 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 21536 def search_knowledge_bases(params = {}, = {}) req = build_request(:search_knowledge_bases, params) req.send_request() end |
#search_spaces(params = {}) ⇒ Types::SearchSpacesResponse
Searches for Amazon QuickSight spaces that match the specified filters.
21603 21604 21605 21606 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 21603 def search_spaces(params = {}, = {}) req = build_request(:search_spaces, params) req.send_request() end |
#search_topics(params = {}) ⇒ Types::SearchTopicsResponse
Searches for any Q topic that exists in an Quick account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
21663 21664 21665 21666 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 21663 def search_topics(params = {}, = {}) req = build_request(:search_topics, params) req.send_request() end |
#search_topics_v2(params = {}) ⇒ Types::SearchTopicsV2Response
Searches for any Q topic that exists in an Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
21723 21724 21725 21726 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 21723 def search_topics_v2(params = {}, = {}) req = build_request(:search_topics_v2, 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 Quick Sight
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 Quick Sight
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.
21911 21912 21913 21914 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 21911 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 Quick Sight assets into an Amazon Quick Sight 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 Quick Sight account. Each Amazon Quick Sight 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.
22476 22477 22478 22479 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 22476 def start_asset_bundle_import_job(params = {}, = {}) req = build_request(:start_asset_bundle_import_job, params) req.send_request() end |
#start_automation_job(params = {}) ⇒ Types::StartAutomationJobResponse
Starts a new job for a specified automation. The job runs the automation with the provided input payload.
22524 22525 22526 22527 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 22524 def start_automation_job(params = {}, = {}) req = build_request(:start_automation_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 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
Quick Sight 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, Quick Sight throttles the API calls to maintin
an optimal experience and reliability for all Quick Sight users.
Common throttling scenarios
The following list provides information about the most commin throttling scenarios that can occur.
A large number of
SnapshotExportAPI jobs are running simultaneously on an Amazon Web Services account. When a newStartDashboardSnapshotJobis created and there are already 12 jobs with theRUNNINGstatus, the new job request fails and returns aLimitExceededExceptionerror. 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 Quick Sight API in one second, a
ThrottlingExceptionis 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 Quick Sight 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.
Registered user support
You can generate snapshots for registered Quick Sight users by using the Snapshot Job APIs with identity-enhanced IAM role session credentials. This approach allows you to create snapshots on behalf of specific Quick Sight users while respecting their row-level security (RLS), column-level security (CLS), dynamic default parameters and dashboard parameter/filter settings.
To generate snapshots for registered Quick Sight users, you need to:
Obtain identity-enhanced IAM role session credentials from Amazon Web Services Security Token Service (STS).
Use these credentials to call the Snapshot Job APIs.
Identity-enhanced credentials are credentials that contain information about the end user (e.g., registered Quick Sight user).
If your Quick Sight users are backed by Amazon Web Services Identity Center, then you need to set up a trusted token issuer. Then, getting identity-enhanced IAM credentials for a Quick Sight user will look like the following:
Authenticate user with your OIDC compliant Identity Provider. You should get auth tokens back.
Use the OIDC API, CreateTokenWithIAM, to exchange auth tokens to IAM tokens. One of the resulted tokens will be identity token.
Call STS AssumeRole API as you normally would, but provide an extra
ProvidedContextsparameter in the API request. The list of contexts must have a single trusted context assertion. TheProviderArnshould bearn:aws:iam::aws:contextProvider/IdentityCenterwhileContextAssertionwill be the identity token you received in response from CreateTokenWithIAM
For more details, see IdC documentation on Identity-enhanced IAM role sessions.
To obtain Identity-enhanced credentials for Quick Sight native users, IAM federated users, or Active Directory users, follow the steps below:
Call Quick Sight GetIdentityContext API to get identity token.
Call STS AssumeRole API as you normally would, but provide extra
ProvidedContextsparameter in the API request. The list of contexts must have a single trusted context assertion. TheProviderArnshould bearn:aws:iam::aws:contextProvider/QuickSightwhileContextAssertionwill be the identity token you received in response from GetIdentityContext
After obtaining the identity-enhanced IAM role session credentials, you can use them to start a job, describe the job and describe job result. You can use the same credentials as long as they haven't expired. All API requests made with these credentials are considered to be made by the impersonated Quick Sight user.
When using identity-enhanced session credentials, set the UserConfiguration request attribute to null. Otherwise, the request will be invalid.
Possible error scenarios
The request fails with an Access Denied error in the following scenarios:
The credentials have expired.
The impersonated Quick Sight user doesn't have access to the specified dashboard.
The impersonated Quick Sight user is restricted from exporting data in the selected formats. For more information about export restrictions, see Customizing access to Amazon Quick Sight capabilities.
22828 22829 22830 22831 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 22828 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 Quick Sight reports by email and Configuring email report settings for a Amazon Quick Sight dashboard in the Amazon Quick Sight User Guide.
22885 22886 22887 22888 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 22885 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 Quick Sight 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 Quick Sight supports tagging on data set, data source, dashboard, template, topic, and user.
Tagging for Amazon Quick Sight 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 Quick Sight. You can't tag other resources that Amazon Quick Sight costs are based on, such as storage capacoty (SPICE), session usage, alert consumption, or reporting units.
Amazon Quick Sight doesn't currently support the tag editor for Resource Groups.
22950 22951 22952 22953 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 22950 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.
22985 22986 22987 22988 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 22985 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_access_control_application(params = {}) ⇒ Types::UpdateAccessControlApplicationResponse
Updates an access control application. You can change its name, description, status, IdP settings such as the client ID and issuer URL, and its Quick Sight authentication settings such as redirect URIs.
You can't change the IdpAuthorizingType, the
QuickAuthenticationType, or the trusted token issuer after the
application is created. To manage client secrets, use
CreateAccessControlApplicationSecret,
UpdateAccessControlApplicationSecret, and
DeleteAccessControlApplicationSecret.
23084 23085 23086 23087 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 23084 def update_access_control_application(params = {}, = {}) req = build_request(:update_access_control_application, params) req.send_request() end |
#update_access_control_application_secret(params = {}) ⇒ Types::UpdateAccessControlApplicationSecretResponse
Updates the Amazon Web Services Secrets Manager secret ARNs of an IdP-provided client secret. You can add, replace, or remove the ARN for a Region, but you can't remove the last remaining Region. To remove it, delete the client secret.
23145 23146 23147 23148 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 23145 def update_access_control_application_secret(params = {}, = {}) req = build_request(:update_access_control_application_secret, params) req.send_request() end |
#update_account_custom_permission(params = {}) ⇒ Types::UpdateAccountCustomPermissionResponse
Applies a custom permissions profile to an account.
23181 23182 23183 23184 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 23181 def (params = {}, = {}) req = build_request(:update_account_custom_permission, params) req.send_request() end |
#update_account_customization(params = {}) ⇒ Types::UpdateAccountCustomizationResponse
Updates Amazon Quick Sight customizations. 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 Quick Sight 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.
23240 23241 23242 23243 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 23240 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 Quick Sight settings in your Amazon Web Services account.
23293 23294 23295 23296 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 23293 def update_account_settings(params = {}, = {}) req = build_request(:update_account_settings, params) req.send_request() end |
#update_action_connector(params = {}) ⇒ Types::UpdateActionConnectorResponse
Updates an existing action connector with new configuration details, authentication settings, or enabled actions. You can modify the connector's name, description, authentication configuration, and which actions are enabled. For more information, https://docs.aws.amazon.com/quicksuite/latest/userguide/quick-action-auth.html.
23403 23404 23405 23406 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 23403 def update_action_connector(params = {}, = {}) req = build_request(:update_action_connector, params) req.send_request() end |
#update_action_connector_permissions(params = {}) ⇒ Types::UpdateActionConnectorPermissionsResponse
Updates the permissions for an action connector by granting or revoking access for specific users and groups. You can control who can view, use, or manage the action connector.
23469 23470 23471 23472 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 23469 def (params = {}, = {}) req = build_request(:update_action_connector_permissions, params) req.send_request() end |
#update_agent(params = {}) ⇒ Types::UpdateAgentResponse
Updates an existing agent.
23585 23586 23587 23588 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 23585 def update_agent(params = {}, = {}) req = build_request(:update_agent, params) req.send_request() end |
#update_agent_permissions(params = {}) ⇒ Types::UpdateAgentPermissionsResponse
Updates the resource permissions for an agent.
23644 23645 23646 23647 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 23644 def (params = {}, = {}) req = build_request(:update_agent_permissions, params) req.send_request() end |
#update_analysis(params = {}) ⇒ Types::UpdateAnalysisResponse
Updates an analysis in Amazon Quick Sight
23709 23710 23711 23712 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 23709 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.
23775 23776 23777 23778 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 23775 def (params = {}, = {}) req = build_request(:update_analysis_permissions, params) req.send_request() end |
#update_app_permissions(params = {}) ⇒ Types::UpdateAppPermissionsResponse
Updates the resource permissions for an app. You can grant or revoke permissions and, optionally, change the app's visibility.
23844 23845 23846 23847 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 23844 def (params = {}, = {}) req = build_request(:update_app_permissions, params) req.send_request() end |
#update_application_with_token_exchange_grant(params = {}) ⇒ Types::UpdateApplicationWithTokenExchangeGrantResponse
Updates an Quick application with a token exchange grant. This operation only supports Quick applications that are registered with IAM Identity Center.
23881 23882 23883 23884 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 23881 def update_application_with_token_exchange_grant(params = {}, = {}) req = build_request(:update_application_with_token_exchange_grant, params) req.send_request() end |
#update_approval_policy(params = {}) ⇒ Types::UpdateApprovalPolicyResponse
Updates an approval policy in Quick Sight.
23951 23952 23953 23954 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 23951 def update_approval_policy(params = {}, = {}) req = build_request(:update_approval_policy, params) req.send_request() end |
#update_brand(params = {}) ⇒ Types::UpdateBrandResponse
Updates a brand.
24148 24149 24150 24151 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 24148 def update_brand(params = {}, = {}) req = build_request(:update_brand, params) req.send_request() end |
#update_brand_assignment(params = {}) ⇒ Types::UpdateBrandAssignmentResponse
Updates a brand assignment.
24183 24184 24185 24186 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 24183 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.
24221 24222 24223 24224 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 24221 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.
24853 24854 24855 24856 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 24853 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.
24976 24977 24978 24979 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 24976 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.
25021 25022 25023 25024 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 25021 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.
25106 25107 25108 25109 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 25106 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.
25149 25150 25151 25152 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 25149 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.
25186 25187 25188 25189 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 25186 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. Partial updates are not supported by this operation.
26035 26036 26037 26038 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 26035 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.
26096 26097 26098 26099 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 26096 def (params = {}, = {}) req = build_request(:update_data_set_permissions, params) req.send_request() end |
#update_data_source(params = {}) ⇒ Types::UpdateDataSourceResponse
Updates a data source.
26637 26638 26639 26640 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 26637 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.
26696 26697 26698 26699 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 26696 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 Quick Sight account.
26739 26740 26741 26742 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 26739 def update_default_q_business_application(params = {}, = {}) req = build_request(:update_default_q_business_application, params) req.send_request() end |
#update_dlp_setting(params = {}) ⇒ Types::UpdateDlpSettingResponse
Updates an existing DLP setting configuration in an Amazon Web Services account. Fields that are omitted from the request retain their current values.
26817 26818 26819 26820 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 26817 def update_dlp_setting(params = {}, = {}) req = build_request(:update_dlp_setting, params) req.send_request() end |
#update_flow(params = {}) ⇒ Types::UpdateFlowResponse
Updates an existing flow. Supply only the fields you want to change.
Updates both DRAFT and PUBLISHED versions. When FlowDefinition is
provided, all existing steps are replaced with the new definition.
26893 26894 26895 26896 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 26893 def update_flow(params = {}, = {}) req = build_request(:update_flow, params) req.send_request() end |
#update_flow_permissions(params = {}) ⇒ Types::UpdateFlowPermissionsOutput
Updates permissions against principals on a flow.
26955 26956 26957 26958 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 26955 def (params = {}, = {}) req = build_request(:update_flow_permissions, params) req.send_request() end |
#update_folder(params = {}) ⇒ Types::UpdateFolderResponse
Updates the name of a folder.
26998 26999 27000 27001 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 26998 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.
27062 27063 27064 27065 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 27062 def (params = {}, = {}) req = build_request(:update_folder_permissions, params) req.send_request() end |
#update_group(params = {}) ⇒ Types::UpdateGroupResponse
Changes a group description.
27111 27112 27113 27114 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 27111 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.
27190 27191 27192 27193 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 27190 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 Quick Sight IAM Identity Center application can access.
This operation is only supported for Quick Sight accounts using IAM Identity Center
27235 27236 27237 27238 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 27235 def update_identity_propagation_config(params = {}, = {}) req = build_request(:update_identity_propagation_config, params) req.send_request() end |
#update_inbound_connector(params = {}) ⇒ Types::UpdateInboundConnectorResponse
Updates an inbound connector. You can change its name, description, status, and configuration. You can't change the connector type after the connector is created.
27299 27300 27301 27302 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 27299 def update_inbound_connector(params = {}, = {}) req = build_request(:update_inbound_connector, params) req.send_request() end |
#update_inbound_connector_application_associations(params = {}) ⇒ Types::UpdateInboundConnectorApplicationAssociationsResponse
Associates access control applications with an inbound connector, disassociates them from it, or both. You can add up to 20 associations and remove up to 20 associations in each request. An inbound connector supports up to 6,000 associations.
27347 27348 27349 27350 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 27347 def update_inbound_connector_application_associations(params = {}, = {}) req = build_request(:update_inbound_connector_application_associations, 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.
27409 27410 27411 27412 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 27409 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 Quick Sight account.
27458 27459 27460 27461 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 27458 def update_key_registration(params = {}, = {}) req = build_request(:update_key_registration, params) req.send_request() end |
#update_knowledge_base(params = {}) ⇒ Types::UpdateKnowledgeBaseResponse
Updates the properties of an existing knowledge base.
27543 27544 27545 27546 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 27543 def update_knowledge_base(params = {}, = {}) req = build_request(:update_knowledge_base, params) req.send_request() end |
#update_knowledge_base_permissions(params = {}) ⇒ Types::UpdateKnowledgeBasePermissionsResponse
Updates the resource permissions for a knowledge base.
27606 27607 27608 27609 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 27606 def (params = {}, = {}) req = build_request(:update_knowledge_base_permissions, params) req.send_request() end |
#update_knowledge_base_refresh_schedule(params = {}) ⇒ Types::UpdateKnowledgeBaseRefreshScheduleResponse
Updates the refresh schedule for an Amazon Quick Sight knowledge base.
Use this operation to change how often the knowledge base refreshes,
or to enable or disable the schedule. Specify the schedule by its
ScheduleId. The operation changes only the fields that you provide.
Any field that you omit keeps its existing value.
27679 27680 27681 27682 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 27679 def update_knowledge_base_refresh_schedule(params = {}, = {}) req = build_request(:update_knowledge_base_refresh_schedule, params) req.send_request() end |
#update_limits_profile(params = {}) ⇒ Types::UpdateLimitsProfileResponse
Updates the properties of an existing limits profile.
27729 27730 27731 27732 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 27729 def update_limits_profile(params = {}, = {}) req = build_request(:update_limits_profile, params) req.send_request() end |
#update_o_auth_client_application(params = {}) ⇒ Types::UpdateOAuthClientApplicationResponse
Updates an OAuthClientApplication.
27809 27810 27811 27812 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 27809 def update_o_auth_client_application(params = {}, = {}) req = build_request(:update_o_auth_client_application, params) req.send_request() end |
#update_public_sharing_settings(params = {}) ⇒ Types::UpdatePublicSharingSettingsResponse
This API controls public sharing settings for your entire Quick Sight account, affecting data security and access. When you enable public sharing:
Dashboards can be shared publicly
This setting affects your entire Amazon Web Services account and all Quick Sight users
Before proceeding: Ensure you understand the security implications and have proper IAM permissions configured.
Use the UpdatePublicSharingSettings operation to turn on or turn off
the public sharing settings of an Amazon Quick Sight dashboard.
To use this operation, turn on session capacity pricing for your Amazon Quick Sight 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 Quick Sight, see Using Quick with IAM in the Amazon Quick Sight User Guide.
27872 27873 27874 27875 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 27872 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.
27911 27912 27913 27914 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 27911 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 Quick Sight Q Search configuration.
27949 27950 27951 27952 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 27949 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.
28005 28006 28007 28008 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 28005 def update_refresh_schedule(params = {}, = {}) req = build_request(:update_refresh_schedule, params) req.send_request() end |
#update_resource_permissions(params = {}) ⇒ Types::UpdateResourcePermissionsResponse
Updates the service role configuration that Amazon Quick Sight uses to
access resources in your Amazon Web Services account. To use this
operation, you must have the quicksight:UpdateResourcePermissions
and iam:PassRole permissions.
Call this operation in the Amazon Web Services Region where your Amazon Quick Sight account is registered (the home Region). You can switch from a role managed by Amazon Quick Sight to a customer-managed role, or replace one customer-managed role with another. You can't use this operation to switch back to a role managed by Amazon Quick Sight.
28086 28087 28088 28089 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 28086 def (params = {}, = {}) req = build_request(:update_resource_permissions, params) req.send_request() end |
#update_role_custom_permission(params = {}) ⇒ Types::UpdateRoleCustomPermissionResponse
Updates the custom permissions that are associated with a role.
28132 28133 28134 28135 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 28132 def (params = {}, = {}) req = build_request(:update_role_custom_permission, params) req.send_request() end |
#update_self_upgrade(params = {}) ⇒ Types::UpdateSelfUpgradeResponse
Updates a self-upgrade request for a Quick user by approving, denying, or verifying the request.
28229 28230 28231 28232 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 28229 def update_self_upgrade(params = {}, = {}) req = build_request(:update_self_upgrade, params) req.send_request() end |
#update_self_upgrade_configuration(params = {}) ⇒ Types::UpdateSelfUpgradeConfigurationResponse
Updates the self-upgrade configuration for a Quick account.
28269 28270 28271 28272 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 28269 def update_self_upgrade_configuration(params = {}, = {}) req = build_request(:update_self_upgrade_configuration, params) req.send_request() end |
#update_space(params = {}) ⇒ Types::UpdateSpaceResponse
Updates the metadata of an Amazon QuickSight space.
28313 28314 28315 28316 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 28313 def update_space(params = {}, = {}) req = build_request(:update_space, params) req.send_request() end |
#update_space_permissions(params = {}) ⇒ Types::UpdateSpacePermissionsResponse
Updates the permissions for an Amazon QuickSight space.
28372 28373 28374 28375 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 28372 def (params = {}, = {}) req = build_request(:update_space_permissions, params) req.send_request() end |
#update_space_resources(params = {}) ⇒ Types::UpdateSpaceResourcesResponse
Adds or removes resources from an Amazon QuickSight space.
28435 28436 28437 28438 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 28435 def update_space_resources(params = {}, = {}) req = build_request(:update_space_resources, params) req.send_request() end |
#update_spice_capacity_configuration(params = {}) ⇒ Types::UpdateSPICECapacityConfigurationResponse
Updates the SPICE capacity configuration for a Quick Sight account.
28174 28175 28176 28177 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 28174 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 Quick Sight analysis or another template.
28509 28510 28511 28512 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 28509 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.
28560 28561 28562 28563 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 28560 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.
28621 28622 28623 28624 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 28621 def (params = {}, = {}) req = build_request(:update_template_permissions, params) req.send_request() end |
#update_theme(params = {}) ⇒ Types::UpdateThemeResponse
Updates a theme.
28855 28856 28857 28858 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 28855 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.
28902 28903 28904 28905 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 28902 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.
29003 29004 29005 29006 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 29003 def (params = {}, = {}) req = build_request(:update_theme_permissions, params) req.send_request() end |
#update_topic(params = {}) ⇒ Types::UpdateTopicResponse
Updates a topic.
29303 29304 29305 29306 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 29303 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.
29366 29367 29368 29369 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 29366 def (params = {}, = {}) req = build_request(:update_topic_permissions, params) req.send_request() end |
#update_topic_permissions_v2(params = {}) ⇒ Types::UpdateTopicPermissionsV2Response
Updates the permissions of a topic.
29429 29430 29431 29432 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 29429 def (params = {}, = {}) req = build_request(:update_topic_permissions_v2, params) req.send_request() end |
#update_topic_refresh_schedule(params = {}) ⇒ Types::UpdateTopicRefreshScheduleResponse
Updates a topic refresh schedule.
29486 29487 29488 29489 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 29486 def update_topic_refresh_schedule(params = {}, = {}) req = build_request(:update_topic_refresh_schedule, params) req.send_request() end |
#update_topic_v2(params = {}) ⇒ Types::UpdateTopicV2Response
Updates the definition of a Q topic.
29562 29563 29564 29565 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 29562 def update_topic_v2(params = {}, = {}) req = build_request(:update_topic_v2, params) req.send_request() end |
#update_user(params = {}) ⇒ Types::UpdateUserResponse
Updates an Amazon Quick Sight user.
29717 29718 29719 29720 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 29717 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.
29761 29762 29763 29764 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 29761 def (params = {}, = {}) req = build_request(:update_user_custom_permission, params) req.send_request() end |
#update_vpc_connection(params = {}) ⇒ Types::UpdateVPCConnectionResponse
Updates a VPC connection.
29827 29828 29829 29830 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 29827 def update_vpc_connection(params = {}, = {}) req = build_request(:update_vpc_connection, params) req.send_request() end |