Class: Aws::QuickSight::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::QuickSight::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb
Overview
An API client for QuickSight. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::QuickSight::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#batch_create_topic_reviewed_answer(params = {}) ⇒ Types::BatchCreateTopicReviewedAnswerResponse
Creates new reviewed answers for a Q Topic.
-
#batch_delete_topic_reviewed_answer(params = {}) ⇒ Types::BatchDeleteTopicReviewedAnswerResponse
Deletes reviewed answers for Q Topic.
-
#cancel_ingestion(params = {}) ⇒ Types::CancelIngestionResponse
Cancels an ongoing ingestion of data into SPICE.
-
#create_account_customization(params = {}) ⇒ Types::CreateAccountCustomizationResponse
Creates Amazon QuickSight customizations for the current Amazon Web Services Region.
-
#create_account_subscription(params = {}) ⇒ Types::CreateAccountSubscriptionResponse
Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.
-
#create_analysis(params = {}) ⇒ Types::CreateAnalysisResponse
Creates an analysis in Amazon QuickSight.
-
#create_dashboard(params = {}) ⇒ Types::CreateDashboardResponse
Creates a dashboard from either a template or directly with a
DashboardDefinition
. -
#create_data_set(params = {}) ⇒ Types::CreateDataSetResponse
Creates a dataset.
-
#create_data_source(params = {}) ⇒ Types::CreateDataSourceResponse
Creates a data source.
-
#create_folder(params = {}) ⇒ Types::CreateFolderResponse
Creates an empty shared folder.
-
#create_folder_membership(params = {}) ⇒ Types::CreateFolderMembershipResponse
Adds an asset, such as a dashboard, analysis, or dataset into a folder.
-
#create_group(params = {}) ⇒ Types::CreateGroupResponse
Use the
CreateGroup
operation to create a group in Amazon QuickSight. -
#create_group_membership(params = {}) ⇒ Types::CreateGroupMembershipResponse
Adds an Amazon QuickSight user to an Amazon QuickSight group.
-
#create_iam_policy_assignment(params = {}) ⇒ Types::CreateIAMPolicyAssignmentResponse
Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN).
-
#create_ingestion(params = {}) ⇒ Types::CreateIngestionResponse
Creates and starts a new SPICE ingestion for a dataset.
-
#create_namespace(params = {}) ⇒ Types::CreateNamespaceResponse
(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
-
#create_refresh_schedule(params = {}) ⇒ Types::CreateRefreshScheduleResponse
Creates a refresh schedule for a dataset.
-
#create_role_membership(params = {}) ⇒ Types::CreateRoleMembershipResponse
Use
CreateRoleMembership
to add an existing Amazon QuickSight group to an existing role. -
#create_template(params = {}) ⇒ Types::CreateTemplateResponse
Creates a template either from a
TemplateDefinition
or from an existing Amazon QuickSight analysis or template. -
#create_template_alias(params = {}) ⇒ Types::CreateTemplateAliasResponse
Creates a template alias for a template.
-
#create_theme(params = {}) ⇒ Types::CreateThemeResponse
Creates a theme.
-
#create_theme_alias(params = {}) ⇒ Types::CreateThemeAliasResponse
Creates a theme alias for a theme.
-
#create_topic(params = {}) ⇒ Types::CreateTopicResponse
Creates a new Q topic.
-
#create_topic_refresh_schedule(params = {}) ⇒ Types::CreateTopicRefreshScheduleResponse
Creates a topic refresh schedule.
-
#create_vpc_connection(params = {}) ⇒ Types::CreateVPCConnectionResponse
Creates a new VPC connection.
-
#delete_account_customization(params = {}) ⇒ Types::DeleteAccountCustomizationResponse
Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace.
-
#delete_account_subscription(params = {}) ⇒ Types::DeleteAccountSubscriptionResponse
Use the
DeleteAccountSubscription
operation to delete an Amazon QuickSight account. -
#delete_analysis(params = {}) ⇒ Types::DeleteAnalysisResponse
Deletes an analysis from Amazon QuickSight.
-
#delete_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_folder(params = {}) ⇒ Types::DeleteFolderResponse
Deletes an empty folder.
-
#delete_folder_membership(params = {}) ⇒ Types::DeleteFolderMembershipResponse
Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
-
#delete_group(params = {}) ⇒ Types::DeleteGroupResponse
Removes a user group from Amazon QuickSight.
-
#delete_group_membership(params = {}) ⇒ Types::DeleteGroupMembershipResponse
Removes a user from a group so that the user is no longer a member of the group.
-
#delete_iam_policy_assignment(params = {}) ⇒ Types::DeleteIAMPolicyAssignmentResponse
Deletes an existing IAM policy assignment.
-
#delete_identity_propagation_config(params = {}) ⇒ Types::DeleteIdentityPropagationConfigResponse
Deletes all access scopes and authorized targets that are associated with a service from the Amazon QuickSight IAM Identity Center application.
-
#delete_namespace(params = {}) ⇒ Types::DeleteNamespaceResponse
Deletes a namespace and the users and groups that are associated with the namespace.
-
#delete_refresh_schedule(params = {}) ⇒ Types::DeleteRefreshScheduleResponse
Deletes a refresh schedule from a dataset.
-
#delete_role_custom_permission(params = {}) ⇒ Types::DeleteRoleCustomPermissionResponse
Removes custom permissions from the role.
-
#delete_role_membership(params = {}) ⇒ Types::DeleteRoleMembershipResponse
Removes a group from a role.
-
#delete_template(params = {}) ⇒ Types::DeleteTemplateResponse
Deletes a template.
-
#delete_template_alias(params = {}) ⇒ Types::DeleteTemplateAliasResponse
Deletes the item that the specified template alias points to.
-
#delete_theme(params = {}) ⇒ Types::DeleteThemeResponse
Deletes a theme.
-
#delete_theme_alias(params = {}) ⇒ Types::DeleteThemeAliasResponse
Deletes the version of the theme that the specified theme alias points to.
-
#delete_topic(params = {}) ⇒ Types::DeleteTopicResponse
Deletes a topic.
-
#delete_topic_refresh_schedule(params = {}) ⇒ Types::DeleteTopicRefreshScheduleResponse
Deletes a topic refresh schedule.
-
#delete_user(params = {}) ⇒ Types::DeleteUserResponse
Deletes the Amazon QuickSight user that is associated with the identity of the IAM user or role that's making the call.
-
#delete_user_by_principal_id(params = {}) ⇒ Types::DeleteUserByPrincipalIdResponse
Deletes a user identified by its principal ID.
-
#delete_vpc_connection(params = {}) ⇒ Types::DeleteVPCConnectionResponse
Deletes a VPC connection.
-
#describe_account_customization(params = {}) ⇒ Types::DescribeAccountCustomizationResponse
Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon QuickSight namespace in an Amazon Web Services Region.
-
#describe_account_settings(params = {}) ⇒ Types::DescribeAccountSettingsResponse
Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account.
-
#describe_account_subscription(params = {}) ⇒ Types::DescribeAccountSubscriptionResponse
Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's subscription.
-
#describe_analysis(params = {}) ⇒ Types::DescribeAnalysisResponse
Provides a summary of the metadata for an analysis.
-
#describe_analysis_definition(params = {}) ⇒ Types::DescribeAnalysisDefinitionResponse
Provides a detailed description of the definition of an analysis.
-
#describe_analysis_permissions(params = {}) ⇒ Types::DescribeAnalysisPermissionsResponse
Provides the read and write permissions for an analysis.
-
#describe_asset_bundle_export_job(params = {}) ⇒ Types::DescribeAssetBundleExportJobResponse
Describes an existing export job.
-
#describe_asset_bundle_import_job(params = {}) ⇒ Types::DescribeAssetBundleImportJobResponse
Describes an existing import job.
-
#describe_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_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_folder(params = {}) ⇒ Types::DescribeFolderResponse
Describes a folder.
-
#describe_folder_permissions(params = {}) ⇒ Types::DescribeFolderPermissionsResponse
Describes permissions for a folder.
-
#describe_folder_resolved_permissions(params = {}) ⇒ Types::DescribeFolderResolvedPermissionsResponse
Describes the folder resolved permissions.
-
#describe_group(params = {}) ⇒ Types::DescribeGroupResponse
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
-
#describe_group_membership(params = {}) ⇒ Types::DescribeGroupMembershipResponse
Use the
DescribeGroupMembership
operation to determine if a user is a member of the specified group. -
#describe_iam_policy_assignment(params = {}) ⇒ Types::DescribeIAMPolicyAssignmentResponse
Describes an existing IAM policy assignment, as specified by the assignment name.
-
#describe_ingestion(params = {}) ⇒ Types::DescribeIngestionResponse
Describes a SPICE ingestion.
-
#describe_ip_restriction(params = {}) ⇒ Types::DescribeIpRestrictionResponse
Provides a summary and status of IP rules.
-
#describe_key_registration(params = {}) ⇒ Types::DescribeKeyRegistrationResponse
Describes all customer managed key registrations in a Amazon QuickSight account.
-
#describe_namespace(params = {}) ⇒ Types::DescribeNamespaceResponse
Describes the current namespace.
-
#describe_refresh_schedule(params = {}) ⇒ Types::DescribeRefreshScheduleResponse
Provides a summary of a refresh schedule.
-
#describe_role_custom_permission(params = {}) ⇒ Types::DescribeRoleCustomPermissionResponse
Describes all custom permissions that are mapped to a role.
-
#describe_template(params = {}) ⇒ Types::DescribeTemplateResponse
Describes a template's metadata.
-
#describe_template_alias(params = {}) ⇒ Types::DescribeTemplateAliasResponse
Describes the template alias for a template.
-
#describe_template_definition(params = {}) ⇒ Types::DescribeTemplateDefinitionResponse
Provides a detailed description of the definition of a template.
-
#describe_template_permissions(params = {}) ⇒ Types::DescribeTemplatePermissionsResponse
Describes read and write permissions on a template.
-
#describe_theme(params = {}) ⇒ Types::DescribeThemeResponse
Describes a theme.
-
#describe_theme_alias(params = {}) ⇒ Types::DescribeThemeAliasResponse
Describes the alias for a theme.
-
#describe_theme_permissions(params = {}) ⇒ Types::DescribeThemePermissionsResponse
Describes the read and write permissions for a theme.
-
#describe_topic(params = {}) ⇒ Types::DescribeTopicResponse
Describes a topic.
-
#describe_topic_permissions(params = {}) ⇒ Types::DescribeTopicPermissionsResponse
Describes the permissions of a topic.
-
#describe_topic_refresh(params = {}) ⇒ Types::DescribeTopicRefreshResponse
Describes the status of a topic refresh.
-
#describe_topic_refresh_schedule(params = {}) ⇒ Types::DescribeTopicRefreshScheduleResponse
Deletes a topic refresh schedule.
-
#describe_user(params = {}) ⇒ Types::DescribeUserResponse
Returns information about a user, given the user name.
-
#describe_vpc_connection(params = {}) ⇒ Types::DescribeVPCConnectionResponse
Describes a VPC connection.
-
#generate_embed_url_for_anonymous_user(params = {}) ⇒ Types::GenerateEmbedUrlForAnonymousUserResponse
Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users.
-
#generate_embed_url_for_registered_user(params = {}) ⇒ Types::GenerateEmbedUrlForRegisteredUserResponse
Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website.
-
#get_dashboard_embed_url(params = {}) ⇒ Types::GetDashboardEmbedUrlResponse
Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon QuickSight read-only dashboard in your website or application.
-
#get_session_embed_url(params = {}) ⇒ Types::GetSessionEmbedUrlResponse
Generates a session URL and authorization code that you can use to embed the Amazon Amazon QuickSight console in your web server code.
-
#list_analyses(params = {}) ⇒ Types::ListAnalysesResponse
Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.
-
#list_asset_bundle_export_jobs(params = {}) ⇒ Types::ListAssetBundleExportJobsResponse
Lists all asset bundle export jobs that have been taken place in the last 14 days.
-
#list_asset_bundle_import_jobs(params = {}) ⇒ Types::ListAssetBundleImportJobsResponse
Lists all asset bundle import jobs that have taken place in the last 14 days.
-
#list_dashboard_versions(params = {}) ⇒ Types::ListDashboardVersionsResponse
Lists all the versions of the dashboards in the Amazon QuickSight subscription.
-
#list_dashboards(params = {}) ⇒ Types::ListDashboardsResponse
Lists dashboards in an Amazon Web Services account.
-
#list_data_sets(params = {}) ⇒ Types::ListDataSetsResponse
Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.
-
#list_data_sources(params = {}) ⇒ Types::ListDataSourcesResponse
Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
-
#list_folder_members(params = {}) ⇒ Types::ListFolderMembersResponse
List all assets (
DASHBOARD
,ANALYSIS
, andDATASET
) in a folder. -
#list_folders(params = {}) ⇒ Types::ListFoldersResponse
Lists all folders in an account.
-
#list_group_memberships(params = {}) ⇒ Types::ListGroupMembershipsResponse
Lists member users in a group.
-
#list_groups(params = {}) ⇒ Types::ListGroupsResponse
Lists all user groups in Amazon QuickSight.
-
#list_iam_policy_assignments(params = {}) ⇒ Types::ListIAMPolicyAssignmentsResponse
Lists the IAM policy assignments in the current Amazon QuickSight account.
-
#list_iam_policy_assignments_for_user(params = {}) ⇒ Types::ListIAMPolicyAssignmentsForUserResponse
Lists all of the IAM policy assignments, including the Amazon Resource Names (ARNs), for the IAM policies assigned to the specified user and group, or groups that the user belongs to.
-
#list_identity_propagation_configs(params = {}) ⇒ Types::ListIdentityPropagationConfigsResponse
Lists all services and authorized targets that the Amazon QuickSight IAM Identity Center application can access.
-
#list_ingestions(params = {}) ⇒ Types::ListIngestionsResponse
Lists the history of SPICE ingestions for a dataset.
-
#list_namespaces(params = {}) ⇒ Types::ListNamespacesResponse
Lists the namespaces for the specified Amazon Web Services account.
-
#list_refresh_schedules(params = {}) ⇒ Types::ListRefreshSchedulesResponse
Lists the refresh schedules of a dataset.
-
#list_role_memberships(params = {}) ⇒ Types::ListRoleMembershipsResponse
Lists all groups that are associated with a role.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags assigned to a resource.
-
#list_template_aliases(params = {}) ⇒ Types::ListTemplateAliasesResponse
Lists all the aliases of a template.
-
#list_template_versions(params = {}) ⇒ Types::ListTemplateVersionsResponse
Lists all the versions of the templates in the current Amazon QuickSight account.
-
#list_templates(params = {}) ⇒ Types::ListTemplatesResponse
Lists all the templates in the current Amazon QuickSight account.
-
#list_theme_aliases(params = {}) ⇒ Types::ListThemeAliasesResponse
Lists all the aliases of a theme.
-
#list_theme_versions(params = {}) ⇒ Types::ListThemeVersionsResponse
Lists all the versions of the themes in the current Amazon Web Services account.
-
#list_themes(params = {}) ⇒ Types::ListThemesResponse
Lists all the themes in the current Amazon Web Services account.
-
#list_topic_refresh_schedules(params = {}) ⇒ Types::ListTopicRefreshSchedulesResponse
Lists all of the refresh schedules for a topic.
-
#list_topic_reviewed_answers(params = {}) ⇒ Types::ListTopicReviewedAnswersResponse
Lists all reviewed answers for a Q Topic.
-
#list_topics(params = {}) ⇒ Types::ListTopicsResponse
Lists all of the topics within an account.
-
#list_user_groups(params = {}) ⇒ Types::ListUserGroupsResponse
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
-
#list_users(params = {}) ⇒ Types::ListUsersResponse
Returns a list of all of the Amazon QuickSight users belonging to this account.
-
#list_vpc_connections(params = {}) ⇒ Types::ListVPCConnectionsResponse
Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.
-
#put_data_set_refresh_properties(params = {}) ⇒ Types::PutDataSetRefreshPropertiesResponse
Creates or updates the dataset refresh properties for the dataset.
-
#register_user(params = {}) ⇒ Types::RegisterUserResponse
Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request.
-
#restore_analysis(params = {}) ⇒ Types::RestoreAnalysisResponse
Restores an analysis.
-
#search_analyses(params = {}) ⇒ Types::SearchAnalysesResponse
Searches for analyses that belong to the user specified in the filter.
-
#search_dashboards(params = {}) ⇒ Types::SearchDashboardsResponse
Searches for dashboards that belong to a user.
-
#search_data_sets(params = {}) ⇒ Types::SearchDataSetsResponse
Use the
SearchDataSets
operation to search for datasets that belong to an account. -
#search_data_sources(params = {}) ⇒ Types::SearchDataSourcesResponse
Use the
SearchDataSources
operation to search for data sources that belong to an account. -
#search_folders(params = {}) ⇒ Types::SearchFoldersResponse
Searches the subfolders in a folder.
-
#search_groups(params = {}) ⇒ Types::SearchGroupsResponse
Use the
SearchGroups
operation to search groups in a specified Amazon QuickSight namespace using the supplied filters. -
#start_asset_bundle_export_job(params = {}) ⇒ Types::StartAssetBundleExportJobResponse
Starts an Asset Bundle export job.
-
#start_asset_bundle_import_job(params = {}) ⇒ Types::StartAssetBundleImportJobResponse
Starts an Asset Bundle import job.
-
#start_dashboard_snapshot_job(params = {}) ⇒ Types::StartDashboardSnapshotJobResponse
Starts an asynchronous job that generates a snapshot of a dashboard's output.
-
#tag_resource(params = {}) ⇒ Types::TagResourceResponse
Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.
-
#untag_resource(params = {}) ⇒ Types::UntagResourceResponse
Removes a tag or tags from a resource.
-
#update_account_customization(params = {}) ⇒ Types::UpdateAccountCustomizationResponse
Updates Amazon QuickSight customizations for the current Amazon Web Services Region.
-
#update_account_settings(params = {}) ⇒ Types::UpdateAccountSettingsResponse
Updates the Amazon QuickSight settings in your Amazon Web Services account.
-
#update_analysis(params = {}) ⇒ Types::UpdateAnalysisResponse
Updates an analysis in Amazon QuickSight.
-
#update_analysis_permissions(params = {}) ⇒ Types::UpdateAnalysisPermissionsResponse
Updates the read and write permissions for an analysis.
-
#update_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_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_folder(params = {}) ⇒ Types::UpdateFolderResponse
Updates the name of a folder.
-
#update_folder_permissions(params = {}) ⇒ Types::UpdateFolderPermissionsResponse
Updates permissions of a folder.
-
#update_group(params = {}) ⇒ Types::UpdateGroupResponse
Changes a group description.
-
#update_iam_policy_assignment(params = {}) ⇒ Types::UpdateIAMPolicyAssignmentResponse
Updates an existing IAM policy assignment.
-
#update_identity_propagation_config(params = {}) ⇒ Types::UpdateIdentityPropagationConfigResponse
Adds or updates services and authorized targets to configure what the Amazon QuickSight IAM Identity Center application can access.
-
#update_ip_restriction(params = {}) ⇒ Types::UpdateIpRestrictionResponse
Updates the content and status of IP rules.
-
#update_key_registration(params = {}) ⇒ Types::UpdateKeyRegistrationResponse
Updates a customer managed key in a Amazon QuickSight account.
-
#update_public_sharing_settings(params = {}) ⇒ Types::UpdatePublicSharingSettingsResponse
Use the
UpdatePublicSharingSettings
operation to turn on or turn off the public sharing settings of an Amazon QuickSight dashboard. -
#update_refresh_schedule(params = {}) ⇒ Types::UpdateRefreshScheduleResponse
Updates a refresh schedule for a dataset.
-
#update_role_custom_permission(params = {}) ⇒ Types::UpdateRoleCustomPermissionResponse
Updates the custom permissions that are associated with a role.
-
#update_spice_capacity_configuration(params = {}) ⇒ Types::UpdateSPICECapacityConfigurationResponse
Updates the SPICE capacity configuration for a Amazon QuickSight account.
-
#update_template(params = {}) ⇒ Types::UpdateTemplateResponse
Updates a template from an existing Amazon QuickSight analysis or another template.
-
#update_template_alias(params = {}) ⇒ Types::UpdateTemplateAliasResponse
Updates the template alias of a template.
-
#update_template_permissions(params = {}) ⇒ Types::UpdateTemplatePermissionsResponse
Updates the resource permissions for a template.
-
#update_theme(params = {}) ⇒ Types::UpdateThemeResponse
Updates a theme.
-
#update_theme_alias(params = {}) ⇒ Types::UpdateThemeAliasResponse
Updates an alias of a theme.
-
#update_theme_permissions(params = {}) ⇒ Types::UpdateThemePermissionsResponse
Updates the resource permissions for a theme.
-
#update_topic(params = {}) ⇒ Types::UpdateTopicResponse
Updates a topic.
-
#update_topic_permissions(params = {}) ⇒ Types::UpdateTopicPermissionsResponse
Updates the permissions of a topic.
-
#update_topic_refresh_schedule(params = {}) ⇒ Types::UpdateTopicRefreshScheduleResponse
Updates a topic refresh schedule.
-
#update_user(params = {}) ⇒ Types::UpdateUserResponse
Updates an Amazon QuickSight user.
-
#update_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.
440 441 442 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 440 def initialize(*args) super end |
Instance Method Details
#batch_create_topic_reviewed_answer(params = {}) ⇒ Types::BatchCreateTopicReviewedAnswerResponse
Creates new reviewed answers for a Q Topic.
1253 1254 1255 1256 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1253 def batch_create_topic_reviewed_answer(params = {}, = {}) req = build_request(:batch_create_topic_reviewed_answer, params) req.send_request() end |
#batch_delete_topic_reviewed_answer(params = {}) ⇒ Types::BatchDeleteTopicReviewedAnswerResponse
Deletes reviewed answers for Q Topic.
1305 1306 1307 1308 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1305 def batch_delete_topic_reviewed_answer(params = {}, = {}) req = build_request(:batch_delete_topic_reviewed_answer, params) req.send_request() end |
#cancel_ingestion(params = {}) ⇒ Types::CancelIngestionResponse
Cancels an ongoing ingestion of data into SPICE.
1347 1348 1349 1350 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1347 def cancel_ingestion(params = {}, = {}) req = build_request(:cancel_ingestion, params) req.send_request() end |
#create_account_customization(params = {}) ⇒ Types::CreateAccountCustomizationResponse
Creates Amazon QuickSight customizations for the current Amazon Web
Services Region. Currently, you can add a custom default theme by
using the CreateAccountCustomization
or UpdateAccountCustomization
API operation. To further customize Amazon QuickSight by removing
Amazon QuickSight sample assets and videos for all new users, see
Customizing Amazon QuickSight in the Amazon QuickSight User
Guide.
You can create customizations for your Amazon Web Services account or,
if you specify a namespace, for a QuickSight namespace instead.
Customizations that apply to a namespace always override
customizations that apply to an Amazon Web Services account. To find
out which customizations apply, use the DescribeAccountCustomization
API operation.
Before you use the CreateAccountCustomization
API operation to add a
theme as the namespace default, make sure that you first share the
theme with the namespace. If you don't share it with the namespace,
the theme isn't visible to your users even if you make it the default
theme. To check if the theme is shared, view the current permissions
by using the DescribeThemePermissions
API operation. To share the
theme, grant permissions by using the UpdateThemePermissions
API
operation.
1444 1445 1446 1447 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1444 def create_account_customization(params = {}, = {}) req = build_request(:create_account_customization, params) req.send_request() end |
#create_account_subscription(params = {}) ⇒ Types::CreateAccountSubscriptionResponse
Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.
The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK.
Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign up for Amazon Web Services in the Amazon QuickSight User Guide. The person who signs up for Amazon QuickSight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for Amazon QuickSight in the Amazon QuickSight User Guide.
If your IAM policy includes both the Subscribe
and
CreateAccountSubscription
actions, make sure that both actions are
set to Allow
. If either action is set to Deny
, the Deny
action
prevails and your API call fails.
You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to Amazon QuickSight, see Passing IAM roles to Amazon QuickSight in the Amazon QuickSight User Guide.
You can't set default resource access on the new account from the Amazon QuickSight API. Instead, add default resource access from the Amazon QuickSight console. For more information about setting default resource access to Amazon Web Services services, see Setting default resource access to Amazon Web Services services in the Amazon QuickSight User Guide.
1712 1713 1714 1715 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1712 def create_account_subscription(params = {}, = {}) req = build_request(:create_account_subscription, params) req.send_request() end |
#create_analysis(params = {}) ⇒ Types::CreateAnalysisResponse
Creates an analysis in Amazon QuickSight. Analyses can be created
either from a template or from an AnalysisDefinition
.
1801 1802 1803 1804 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1801 def create_analysis(params = {}, = {}) req = build_request(:create_analysis, params) req.send_request() end |
#create_dashboard(params = {}) ⇒ Types::CreateDashboardResponse
Creates a dashboard from either a template or directly with a
DashboardDefinition
. To first create a template, see the
CreateTemplate
API operation.
A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.
1936 1937 1938 1939 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1936 def create_dashboard(params = {}, = {}) req = build_request(:create_dashboard, params) req.send_request() end |
#create_data_set(params = {}) ⇒ Types::CreateDataSetResponse
Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.
2251 2252 2253 2254 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2251 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.
2618 2619 2620 2621 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2618 def create_data_source(params = {}, = {}) req = build_request(:create_data_source, params) req.send_request() end |
#create_folder(params = {}) ⇒ Types::CreateFolderResponse
Creates an empty shared folder.
2698 2699 2700 2701 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2698 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.
2744 2745 2746 2747 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2744 def create_folder_membership(params = {}, = {}) req = build_request(:create_folder_membership, params) req.send_request() end |
#create_group(params = {}) ⇒ Types::CreateGroupResponse
Use the CreateGroup
operation to create a group in Amazon
QuickSight. You can create up to 10,000 groups in a namespace. If you
want to create more than 10,000 groups in a namespace, contact Amazon
Web Services Support.
The permissions resource is
arn:aws:quicksight:<your-region>:<relevant-aws-account-id>:group/default/<group-name>
.
The response is a group object.
2802 2803 2804 2805 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2802 def create_group(params = {}, = {}) req = build_request(:create_group, params) req.send_request() end |
#create_group_membership(params = {}) ⇒ Types::CreateGroupMembershipResponse
Adds an Amazon QuickSight user to an Amazon QuickSight group.
2849 2850 2851 2852 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2849 def create_group_membership(params = {}, = {}) req = build_request(:create_group_membership, params) req.send_request() end |
#create_iam_policy_assignment(params = {}) ⇒ Types::CreateIAMPolicyAssignmentResponse
Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.
2930 2931 2932 2933 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2930 def create_iam_policy_assignment(params = {}, = {}) req = build_request(:create_iam_policy_assignment, params) req.send_request() end |
#create_ingestion(params = {}) ⇒ Types::CreateIngestionResponse
Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time.
Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
2992 2993 2994 2995 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2992 def create_ingestion(params = {}, = {}) req = build_request(:create_ingestion, params) req.send_request() end |
#create_namespace(params = {}) ⇒ Types::CreateNamespaceResponse
(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
A namespace allows you to isolate the Amazon QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account is subscribed to Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web Services Support.
3063 3064 3065 3066 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3063 def create_namespace(params = {}, = {}) req = build_request(:create_namespace, params) req.send_request() end |
#create_refresh_schedule(params = {}) ⇒ Types::CreateRefreshScheduleResponse
Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.
3120 3121 3122 3123 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3120 def create_refresh_schedule(params = {}, = {}) req = build_request(:create_refresh_schedule, params) req.send_request() end |
#create_role_membership(params = {}) ⇒ Types::CreateRoleMembershipResponse
Use CreateRoleMembership
to add an existing Amazon QuickSight group
to an existing role.
3166 3167 3168 3169 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3166 def create_role_membership(params = {}, = {}) req = build_request(:create_role_membership, params) req.send_request() end |
#create_template(params = {}) ⇒ Types::CreateTemplateResponse
Creates a template either from a TemplateDefinition
or from an
existing Amazon QuickSight analysis or template. You can use the
resulting template to create additional dashboards, templates, or
analyses.
A template is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
3265 3266 3267 3268 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3265 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.
3314 3315 3316 3317 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3314 def create_template_alias(params = {}, = {}) req = build_request(:create_template_alias, params) req.send_request() end |
#create_theme(params = {}) ⇒ Types::CreateThemeResponse
Creates a theme.
A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User Guide.
3453 3454 3455 3456 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3453 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.
3502 3503 3504 3505 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3502 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.
3777 3778 3779 3780 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3777 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.
3838 3839 3840 3841 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3838 def create_topic_refresh_schedule(params = {}, = {}) req = build_request(:create_topic_refresh_schedule, params) req.send_request() end |
#create_vpc_connection(params = {}) ⇒ Types::CreateVPCConnectionResponse
Creates a new VPC connection.
3914 3915 3916 3917 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3914 def create_vpc_connection(params = {}, = {}) req = build_request(:create_vpc_connection, params) req.send_request() end |
#delete_account_customization(params = {}) ⇒ Types::DeleteAccountCustomizationResponse
Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace.
3953 3954 3955 3956 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3953 def delete_account_customization(params = {}, = {}) req = build_request(:delete_account_customization, params) req.send_request() end |
#delete_account_subscription(params = {}) ⇒ Types::DeleteAccountSubscriptionResponse
Use the DeleteAccountSubscription
operation to delete an Amazon
QuickSight account. This operation will result in an error message if
you have configured your account termination protection settings to
True
. To change this setting and delete your account, call the
UpdateAccountSettings
API and set the value of the
TerminationProtectionEnabled
parameter to False
, then make another
call to the DeleteAccountSubscription
API.
3990 3991 3992 3993 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3990 def delete_account_subscription(params = {}, = {}) req = build_request(:delete_account_subscription, params) req.send_request() end |
#delete_analysis(params = {}) ⇒ Types::DeleteAnalysisResponse
Deletes an analysis from Amazon QuickSight. You can optionally include
a recovery window during which you can restore the analysis. If you
don't specify a recovery window value, the operation defaults to 30
days. Amazon QuickSight attaches a DeletionTime
stamp to the
response that specifies the end of the recovery window. At the end of
the recovery window, Amazon QuickSight deletes the analysis
permanently.
At any time before recovery window ends, you can use the
RestoreAnalysis
API operation to remove the DeletionTime
stamp and
cancel the deletion of the analysis. The analysis remains visible in
the API until it's deleted, so you can describe it but you can't
make a template from it.
An analysis that's scheduled for deletion isn't accessible in the Amazon QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
4061 4062 4063 4064 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4061 def delete_analysis(params = {}, = {}) req = build_request(:delete_analysis, params) req.send_request() end |
#delete_dashboard(params = {}) ⇒ Types::DeleteDashboardResponse
Deletes a dashboard.
4105 4106 4107 4108 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4105 def delete_dashboard(params = {}, = {}) req = build_request(:delete_dashboard, params) req.send_request() end |
#delete_data_set(params = {}) ⇒ Types::DeleteDataSetResponse
Deletes a dataset.
4144 4145 4146 4147 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4144 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.
4178 4179 4180 4181 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4178 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.
4218 4219 4220 4221 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4218 def delete_data_source(params = {}, = {}) req = build_request(:delete_data_source, params) req.send_request() end |
#delete_folder(params = {}) ⇒ Types::DeleteFolderResponse
Deletes an empty folder.
4256 4257 4258 4259 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4256 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.
4299 4300 4301 4302 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4299 def delete_folder_membership(params = {}, = {}) req = build_request(:delete_folder_membership, params) req.send_request() end |
#delete_group(params = {}) ⇒ Types::DeleteGroupResponse
Removes a user group from Amazon QuickSight.
4339 4340 4341 4342 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4339 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.
4385 4386 4387 4388 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4385 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.
4426 4427 4428 4429 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4426 def delete_iam_policy_assignment(params = {}, = {}) req = build_request(:delete_iam_policy_assignment, params) req.send_request() end |
#delete_identity_propagation_config(params = {}) ⇒ Types::DeleteIdentityPropagationConfigResponse
Deletes all access scopes and authorized targets that are associated with a service from the Amazon QuickSight IAM Identity Center application.
This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.
4467 4468 4469 4470 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4467 def delete_identity_propagation_config(params = {}, = {}) req = build_request(:delete_identity_propagation_config, params) req.send_request() end |
#delete_namespace(params = {}) ⇒ Types::DeleteNamespaceResponse
Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset.
4506 4507 4508 4509 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4506 def delete_namespace(params = {}, = {}) req = build_request(:delete_namespace, params) req.send_request() end |
#delete_refresh_schedule(params = {}) ⇒ Types::DeleteRefreshScheduleResponse
Deletes a refresh schedule from a dataset.
4548 4549 4550 4551 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4548 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.
4588 4589 4590 4591 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4588 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.
4633 4634 4635 4636 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4633 def delete_role_membership(params = {}, = {}) req = build_request(:delete_role_membership, params) req.send_request() end |
#delete_template(params = {}) ⇒ Types::DeleteTemplateResponse
Deletes a template.
4678 4679 4680 4681 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4678 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.
4728 4729 4730 4731 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4728 def delete_template_alias(params = {}, = {}) req = build_request(:delete_template_alias, params) req.send_request() end |
#delete_theme(params = {}) ⇒ Types::DeleteThemeResponse
Deletes a theme.
4774 4775 4776 4777 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4774 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.
4821 4822 4823 4824 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4821 def delete_theme_alias(params = {}, = {}) req = build_request(:delete_theme_alias, params) req.send_request() end |
#delete_topic(params = {}) ⇒ Types::DeleteTopicResponse
Deletes a topic.
4861 4862 4863 4864 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4861 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.
4906 4907 4908 4909 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4906 def delete_topic_refresh_schedule(params = {}, = {}) req = build_request(:delete_topic_refresh_schedule, params) req.send_request() end |
#delete_user(params = {}) ⇒ Types::DeleteUserResponse
Deletes the Amazon QuickSight user that is associated with the identity of the IAM user or role that's making the call. The IAM user isn't deleted as a result of this call.
4948 4949 4950 4951 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4948 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.
4988 4989 4990 4991 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4988 def delete_user_by_principal_id(params = {}, = {}) req = build_request(:delete_user_by_principal_id, params) req.send_request() end |
#delete_vpc_connection(params = {}) ⇒ Types::DeleteVPCConnectionResponse
Deletes a VPC connection.
5033 5034 5035 5036 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5033 def delete_vpc_connection(params = {}, = {}) req = build_request(:delete_vpc_connection, params) req.send_request() end |
#describe_account_customization(params = {}) ⇒ Types::DescribeAccountCustomizationResponse
Describes the customizations associated with the provided Amazon Web
Services account and Amazon Amazon QuickSight namespace in an Amazon
Web Services Region. The Amazon QuickSight console evaluates which
customizations to apply by running this API operation with the
Resolved
flag included.
To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved.
Amazon Web Services account
- The Amazon Web Services account exists at the top of the hierarchy. It has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you subscribe to Amazon QuickSight, you choose one Amazon Web Services Region to use as your home Region. That's where your free SPICE capacity is located. You can use Amazon QuickSight in any supported Amazon Web Services Region.Amazon Web Services Region
- In each Amazon Web Services Region where you sign in to Amazon QuickSight at least once, Amazon QuickSight acts as a separate instance of the same service. If you have a user directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have access to Amazon QuickSight in any Amazon Web Services Region, unless they are constrained to a namespace.To run the command in a different Amazon Web Services Region, you change your Region settings. If you're using the CLI, you can use one of the following options:
Use command line options.
Use named profiles.
Run
aws configure
to change your default Amazon Web Services Region. Use Enter to key the same settings for your keys. For more information, see Configuring the CLI.
Namespace
- A QuickSight namespace is a partition that contains users and assets (data sources, datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also be part of the same namespace. People who share a namespace are completely isolated from users and assets in other namespaces, even if they are in the same Amazon Web Services account and Amazon Web Services Region.Applied customizations
- Within an Amazon Web Services Region, a set of Amazon QuickSight customizations can apply to an Amazon Web Services account or to a namespace. Settings that you apply to a namespace override settings that you apply to an Amazon Web Services account. All settings are isolated to a single Amazon Web Services Region. To apply them in other Amazon Web Services Regions, run theCreateAccountCustomization
command in each Amazon Web Services Region where you want to apply the same customizations.
5145 5146 5147 5148 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5145 def describe_account_customization(params = {}, = {}) req = build_request(:describe_account_customization, params) req.send_request() end |
#describe_account_settings(params = {}) ⇒ Types::DescribeAccountSettingsResponse
Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account.
5184 5185 5186 5187 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5184 def describe_account_settings(params = {}, = {}) req = build_request(:describe_account_settings, params) req.send_request() end |
#describe_account_subscription(params = {}) ⇒ Types::DescribeAccountSubscriptionResponse
Use the DescribeAccountSubscription operation to receive a description
of an Amazon QuickSight account's subscription. A successful API call
returns an AccountInfo
object that includes an account's name,
subscription status, authentication type, edition, and notification
email address.
5226 5227 5228 5229 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5226 def describe_account_subscription(params = {}, = {}) req = build_request(:describe_account_subscription, params) req.send_request() end |
#describe_analysis(params = {}) ⇒ Types::DescribeAnalysisResponse
Provides a summary of the metadata for an analysis.
5281 5282 5283 5284 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5281 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.
5330 5331 5332 5333 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5330 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.
5376 5377 5378 5379 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5376 def (params = {}, = {}) req = build_request(:describe_analysis_permissions, params) req.send_request() end |
#describe_asset_bundle_export_job(params = {}) ⇒ Types::DescribeAssetBundleExportJobResponse
Describes an existing export job.
Poll job descriptions after a job starts to know the status of the
job. When a job succeeds, a URL is provided to download the exported
assets' data from. Download URLs are valid for five minutes after
they are generated. You can call the DescribeAssetBundleExportJob
API for a new download URL as needed.
Job descriptions are available for 14 days after the job starts.
5484 5485 5486 5487 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5484 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.
5738 5739 5740 5741 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5738 def describe_asset_bundle_import_job(params = {}, = {}) req = build_request(:describe_asset_bundle_import_job, params) req.send_request() end |
#describe_dashboard(params = {}) ⇒ Types::DescribeDashboardResponse
Provides a summary for a dashboard.
5808 5809 5810 5811 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5808 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.
5865 5866 5867 5868 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5865 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.
5914 5915 5916 5917 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5914 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
.
6004 6005 6006 6007 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6004 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.
.
6081 6082 6083 6084 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6081 def describe_dashboard_snapshot_job_result(params = {}, = {}) req = build_request(:describe_dashboard_snapshot_job_result, params) req.send_request() end |
#describe_data_set(params = {}) ⇒ Types::DescribeDataSetResponse
Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.
6249 6250 6251 6252 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6249 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
.
6296 6297 6298 6299 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6296 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.
6334 6335 6336 6337 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6334 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.
6523 6524 6525 6526 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6523 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.
6567 6568 6569 6570 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6567 def (params = {}, = {}) req = build_request(:describe_data_source_permissions, params) req.send_request() end |
#describe_folder(params = {}) ⇒ Types::DescribeFolderResponse
Describes a folder.
6611 6612 6613 6614 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6611 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.
6670 6671 6672 6673 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6670 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.
6731 6732 6733 6734 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6731 def (params = {}, = {}) req = build_request(:describe_folder_resolved_permissions, params) req.send_request() end |
#describe_group(params = {}) ⇒ Types::DescribeGroupResponse
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
6777 6778 6779 6780 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6777 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.
6826 6827 6828 6829 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6826 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.
6875 6876 6877 6878 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6875 def describe_iam_policy_assignment(params = {}, = {}) req = build_request(:describe_iam_policy_assignment, params) req.send_request() end |
#describe_ingestion(params = {}) ⇒ Types::DescribeIngestionResponse
Describes a SPICE ingestion.
6929 6930 6931 6932 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6929 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.
6972 6973 6974 6975 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6972 def describe_ip_restriction(params = {}, = {}) req = build_request(:describe_ip_restriction, params) req.send_request() end |
#describe_key_registration(params = {}) ⇒ Types::DescribeKeyRegistrationResponse
Describes all customer managed key registrations in a Amazon QuickSight account.
7014 7015 7016 7017 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7014 def describe_key_registration(params = {}, = {}) req = build_request(:describe_key_registration, params) req.send_request() end |
#describe_namespace(params = {}) ⇒ Types::DescribeNamespaceResponse
Describes the current namespace.
7057 7058 7059 7060 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7057 def describe_namespace(params = {}, = {}) req = build_request(:describe_namespace, params) req.send_request() end |
#describe_refresh_schedule(params = {}) ⇒ Types::DescribeRefreshScheduleResponse
Provides a summary of a refresh schedule.
7107 7108 7109 7110 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7107 def describe_refresh_schedule(params = {}, = {}) req = build_request(:describe_refresh_schedule, params) req.send_request() end |
#describe_role_custom_permission(params = {}) ⇒ Types::DescribeRoleCustomPermissionResponse
Describes all custom permissions that are mapped to a role.
7150 7151 7152 7153 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7150 def (params = {}, = {}) req = build_request(:describe_role_custom_permission, params) req.send_request() end |
#describe_template(params = {}) ⇒ Types::DescribeTemplateResponse
Describes a template's metadata.
7229 7230 7231 7232 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7229 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.
7276 7277 7278 7279 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7276 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.
7336 7337 7338 7339 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7336 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.
7380 7381 7382 7383 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7380 def (params = {}, = {}) req = build_request(:describe_template_permissions, params) req.send_request() end |
#describe_theme(params = {}) ⇒ Types::DescribeThemeResponse
Describes a theme.
7471 7472 7473 7474 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7471 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.
7514 7515 7516 7517 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7514 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.
7558 7559 7560 7561 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7558 def (params = {}, = {}) req = build_request(:describe_theme_permissions, params) req.send_request() end |
#describe_topic(params = {}) ⇒ Types::DescribeTopicResponse
Describes a topic.
7753 7754 7755 7756 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7753 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.
7798 7799 7800 7801 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7798 def (params = {}, = {}) req = build_request(:describe_topic_permissions, params) req.send_request() end |
#describe_topic_refresh(params = {}) ⇒ Types::DescribeTopicRefreshResponse
Describes the status of a topic refresh.
7843 7844 7845 7846 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7843 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.
7896 7897 7898 7899 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7896 def describe_topic_refresh_schedule(params = {}, = {}) req = build_request(:describe_topic_refresh_schedule, params) req.send_request() end |
#describe_user(params = {}) ⇒ Types::DescribeUserResponse
Returns information about a user, given the user name.
7948 7949 7950 7951 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7948 def describe_user(params = {}, = {}) req = build_request(:describe_user, params) req.send_request() end |
#describe_vpc_connection(params = {}) ⇒ Types::DescribeVPCConnectionResponse
Describes a VPC connection.
8005 8006 8007 8008 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8005 def describe_vpc_connection(params = {}, = {}) req = build_request(:describe_vpc_connection, params) req.send_request() end |
#generate_embed_url_for_anonymous_user(params = {}) ⇒ Types::GenerateEmbedUrlForAnonymousUserResponse
Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.
The following rules apply to the generated URL:
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
The URL validity period should not be confused with the actual session lifetime that can be customized using the
SessionLifetimeInMinutes
parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.You are charged only when the URL is used or there is interaction with Amazon QuickSight.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
8157 8158 8159 8160 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8157 def (params = {}, = {}) req = build_request(:generate_embed_url_for_anonymous_user, params) req.send_request() end |
#generate_embed_url_for_registered_user(params = {}) ⇒ Types::GenerateEmbedUrlForRegisteredUserResponse
Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.
The following rules apply to the generated URL:
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
The URL validity period should not be confused with the actual session lifetime that can be customized using the
SessionLifetimeInMinutes
parameter.The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
8290 8291 8292 8293 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8290 def (params = {}, = {}) req = build_request(:generate_embed_url_for_registered_user, params) req.send_request() end |
#get_dashboard_embed_url(params = {}) ⇒ Types::GetDashboardEmbedUrlResponse
Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon QuickSight read-only dashboard in your website or application. Before you use this command, make sure that you have configured the dashboards and permissions.
Currently, you can use GetDashboardEmbedURL
only from the server,
not from the user's browser. The following rules apply to the
generated URL:
They must be used together.
They can be used one time only.
They are valid for 5 minutes after you run this command.
You are charged only when the URL is used or there is interaction with Amazon QuickSight.
The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional
SessionLifetimeInMinutes
parameter to customize session duration.
For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
8424 8425 8426 8427 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8424 def (params = {}, = {}) req = build_request(:get_dashboard_embed_url, params) req.send_request() end |
#get_session_embed_url(params = {}) ⇒ Types::GetSessionEmbedUrlResponse
Generates a session URL and authorization code that you can use to
embed the Amazon Amazon QuickSight console in your web server code.
Use GetSessionEmbedUrl
where you want to provide an authoring portal
that allows users to create data sources, datasets, analyses, and
dashboards. The users who access an embedded Amazon QuickSight console
need belong to the author or admin security cohort. If you want to
restrict permissions to some of these features, add a custom
permissions profile to the user with the UpdateUser
API operation.
Use RegisterUser
API operation to add a new user with a custom
permission profile attached. For more information, see the following
sections in the Amazon QuickSight User Guide:
8518 8519 8520 8521 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8518 def (params = {}, = {}) req = build_request(:get_session_embed_url, params) req.send_request() end |
#list_analyses(params = {}) ⇒ Types::ListAnalysesResponse
Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8569 8570 8571 8572 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8569 def list_analyses(params = {}, = {}) req = build_request(:list_analyses, params) req.send_request() end |
#list_asset_bundle_export_jobs(params = {}) ⇒ Types::ListAssetBundleExportJobsResponse
Lists all asset bundle export jobs that have been taken place in the
last 14 days. Jobs created more than 14 days ago are deleted forever
and are not returned. If you are using the same job ID for multiple
jobs, ListAssetBundleExportJobs
only returns the most recent job
that uses the repeated job ID.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8627 8628 8629 8630 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8627 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.
8682 8683 8684 8685 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8682 def list_asset_bundle_import_jobs(params = {}, = {}) req = build_request(:list_asset_bundle_import_jobs, params) req.send_request() end |
#list_dashboard_versions(params = {}) ⇒ Types::ListDashboardVersionsResponse
Lists all the versions of the dashboards in the Amazon QuickSight subscription.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8739 8740 8741 8742 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8739 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.
8792 8793 8794 8795 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8792 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.
8854 8855 8856 8857 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8854 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.
9053 9054 9055 9056 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9053 def list_data_sources(params = {}, = {}) req = build_request(:list_data_sources, params) req.send_request() end |
#list_folder_members(params = {}) ⇒ Types::ListFolderMembersResponse
List all assets (DASHBOARD
, ANALYSIS
, and DATASET
) in a folder.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9104 9105 9106 9107 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9104 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.
9156 9157 9158 9159 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9156 def list_folders(params = {}, = {}) req = build_request(:list_folders, 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.
9212 9213 9214 9215 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9212 def list_group_memberships(params = {}, = {}) req = build_request(:list_group_memberships, params) req.send_request() end |
#list_groups(params = {}) ⇒ Types::ListGroupsResponse
Lists all user groups in Amazon QuickSight.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9266 9267 9268 9269 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9266 def list_groups(params = {}, = {}) req = build_request(:list_groups, params) req.send_request() end |
#list_iam_policy_assignments(params = {}) ⇒ Types::ListIAMPolicyAssignmentsResponse
Lists the IAM policy assignments in the current Amazon QuickSight account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9323 9324 9325 9326 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9323 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.
9381 9382 9383 9384 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9381 def list_iam_policy_assignments_for_user(params = {}, = {}) req = build_request(:list_iam_policy_assignments_for_user, params) req.send_request() end |
#list_identity_propagation_configs(params = {}) ⇒ Types::ListIdentityPropagationConfigsResponse
Lists all services and authorized targets that the Amazon QuickSight IAM Identity Center application can access.
This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.
9432 9433 9434 9435 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9432 def list_identity_propagation_configs(params = {}, = {}) req = build_request(:list_identity_propagation_configs, params) req.send_request() end |
#list_ingestions(params = {}) ⇒ Types::ListIngestionsResponse
Lists the history of SPICE ingestions for a dataset.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9496 9497 9498 9499 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9496 def list_ingestions(params = {}, = {}) req = build_request(:list_ingestions, params) req.send_request() end |
#list_namespaces(params = {}) ⇒ Types::ListNamespacesResponse
Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9556 9557 9558 9559 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9556 def list_namespaces(params = {}, = {}) req = build_request(:list_namespaces, params) req.send_request() end |
#list_refresh_schedules(params = {}) ⇒ Types::ListRefreshSchedulesResponse
Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.
9602 9603 9604 9605 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9602 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.
9658 9659 9660 9661 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9658 def list_role_memberships(params = {}, = {}) req = build_request(:list_role_memberships, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags assigned to a resource.
9693 9694 9695 9696 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9693 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.
9746 9747 9748 9749 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9746 def list_template_aliases(params = {}, = {}) req = build_request(:list_template_aliases, params) req.send_request() end |
#list_template_versions(params = {}) ⇒ Types::ListTemplateVersionsResponse
Lists all the versions of the templates in the current Amazon QuickSight account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9802 9803 9804 9805 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9802 def list_template_versions(params = {}, = {}) req = build_request(:list_template_versions, params) req.send_request() end |
#list_templates(params = {}) ⇒ Types::ListTemplatesResponse
Lists all the templates in the current Amazon QuickSight account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9854 9855 9856 9857 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9854 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.
9905 9906 9907 9908 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9905 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.
9961 9962 9963 9964 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9961 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.
10026 10027 10028 10029 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10026 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.
10077 10078 10079 10080 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10077 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.
10550 10551 10552 10553 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10550 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.
10600 10601 10602 10603 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10600 def list_topics(params = {}, = {}) req = build_request(:list_topics, params) req.send_request() end |
#list_user_groups(params = {}) ⇒ Types::ListUserGroupsResponse
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10660 10661 10662 10663 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10660 def list_user_groups(params = {}, = {}) req = build_request(:list_user_groups, params) req.send_request() end |
#list_users(params = {}) ⇒ Types::ListUsersResponse
Returns a list of all of the Amazon QuickSight users belonging to this account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10722 10723 10724 10725 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10722 def list_users(params = {}, = {}) req = build_request(:list_users, params) req.send_request() end |
#list_vpc_connections(params = {}) ⇒ Types::ListVPCConnectionsResponse
Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
10788 10789 10790 10791 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10788 def list_vpc_connections(params = {}, = {}) req = build_request(:list_vpc_connections, params) req.send_request() end |
#put_data_set_refresh_properties(params = {}) ⇒ Types::PutDataSetRefreshPropertiesResponse
Creates or updates the dataset refresh properties for the dataset.
10836 10837 10838 10839 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10836 def put_data_set_refresh_properties(params = {}, = {}) req = build_request(:put_data_set_refresh_properties, params) req.send_request() end |
#register_user(params = {}) ⇒ Types::RegisterUserResponse
Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Amazon QuickSight API, Amazon QuickSight generates a registration URL. The user accesses this registration URL to create their account. Amazon QuickSight doesn't send a registration email to users who are registered from the Amazon QuickSight API. If you want new users to receive a registration email, then add those users in the Amazon QuickSight console. For more information on registering a new user in the Amazon QuickSight console, see Inviting users to access Amazon QuickSight.
11034 11035 11036 11037 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11034 def register_user(params = {}, = {}) req = build_request(:register_user, params) req.send_request() end |
#restore_analysis(params = {}) ⇒ Types::RestoreAnalysisResponse
Restores an analysis.
11072 11073 11074 11075 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11072 def restore_analysis(params = {}, = {}) req = build_request(:restore_analysis, params) req.send_request() end |
#search_analyses(params = {}) ⇒ Types::SearchAnalysesResponse
Searches for analyses that belong to the user specified in the filter.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11139 11140 11141 11142 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11139 def search_analyses(params = {}, = {}) req = build_request(:search_analyses, params) req.send_request() end |
#search_dashboards(params = {}) ⇒ Types::SearchDashboardsResponse
Searches for dashboards that belong to a user.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11210 11211 11212 11213 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11210 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.
11278 11279 11280 11281 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11278 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.
11339 11340 11341 11342 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11339 def search_data_sources(params = {}, = {}) req = build_request(:search_data_sources, params) req.send_request() end |
#search_folders(params = {}) ⇒ Types::SearchFoldersResponse
Searches the subfolders in a folder.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11404 11405 11406 11407 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11404 def search_folders(params = {}, = {}) req = build_request(:search_folders, params) req.send_request() end |
#search_groups(params = {}) ⇒ Types::SearchGroupsResponse
Use the SearchGroups
operation to search groups in a specified
Amazon QuickSight namespace using the supplied filters.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
11470 11471 11472 11473 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11470 def search_groups(params = {}, = {}) req = build_request(:search_groups, params) req.send_request() end |
#start_asset_bundle_export_job(params = {}) ⇒ Types::StartAssetBundleExportJobResponse
Starts an Asset Bundle export job.
An Asset Bundle export job exports specified Amazon QuickSight assets.
You can also choose to export any asset dependencies in the same job.
Export jobs run asynchronously and can be polled with a
DescribeAssetBundleExportJob
API call. When a job is successfully
completed, a download URL that contains the exported assets is
returned. The URL is valid for 5 minutes and can be refreshed with a
DescribeAssetBundleExportJob
API call. Each Amazon QuickSight
account can run up to 5 export jobs concurrently.
The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.
11635 11636 11637 11638 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11635 def start_asset_bundle_export_job(params = {}, = {}) req = build_request(:start_asset_bundle_export_job, params) req.send_request() end |
#start_asset_bundle_import_job(params = {}) ⇒ Types::StartAssetBundleImportJobResponse
Starts an Asset Bundle import job.
An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight account can run up to 5 import jobs concurrently.
The API caller must have the necessary "create"
, "describe"
, and
"update"
permissions in their IAM role to access each resource type
that is contained in the bundle file before the resources can be
imported.
12041 12042 12043 12044 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12041 def start_asset_bundle_import_job(params = {}, = {}) req = build_request(:start_asset_bundle_import_job, params) req.send_request() end |
#start_dashboard_snapshot_job(params = {}) ⇒ Types::StartDashboardSnapshotJobResponse
Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call.
1 Paginated PDF
1 Excel workbook that includes up to 5 table or pivot table visuals
5 CSVs from table or pivot table visuals
The status of a submitted job can be polled with the
DescribeDashboardSnapshotJob
API. When you call the
DescribeDashboardSnapshotJob
API, check the JobStatus
field in the
response. Once the job reaches a COMPLETED
or FAILED
status, use
the DescribeDashboardSnapshotJobResult
API to obtain the URLs for
the generated files. If the job fails, the
DescribeDashboardSnapshotJobResult
API returns detailed information
about the error that occurred.
StartDashboardSnapshotJob API throttling
Amazon QuickSight utilizes API throttling to create a more consistent
user experience within a time span for customers when they call the
StartDashboardSnapshotJob
. By default, 12 jobs can run
simlutaneously in one Amazon Web Services account and users can submit
up 10 API requests per second before an account is throttled. If an
overwhelming number of API requests are made by the same user in a
short period of time, Amazon QuickSight throttles the API calls to
maintin an optimal experience and reliability for all Amazon
QuickSight users.
Common throttling scenarios
The following list provides information about the most commin throttling scenarios that can occur.
A large number of
SnapshotExport
API jobs are running simultaneously on an Amazon Web Services account. When a newStartDashboardSnapshotJob
is created and there are already 12 jobs with theRUNNING
status, the new job request fails and returns aLimitExceededException
error. Wait for a current job to comlpete before you resubmit the new job.A large number of API requests are submitted on an Amazon Web Services account. When a user makes more than 10 API calls to the Amazon QuickSight API in one second, a
ThrottlingException
is returned.
If your use case requires a higher throttling limit, contact your account admin or Amazon Web ServicesSupport to explore options to tailor a more optimal expereince for your account.
Best practices to handle throttling
If your use case projects high levels of API traffic, try to reduce
the degree of frequency and parallelism of API calls as much as you
can to avoid throttling. You can also perform a timing test to
calculate an estimate for the total processing time of your projected
load that stays within the throttling limits of the Amazon QuickSight
APIs. For example, if your projected traffic is 100 snapshot jobs
before 12:00 PM per day, start 12 jobs in parallel and measure the
amount of time it takes to proccess all 12 jobs. Once you obtain the
result, multiply the duration by 9, for example (12 minutes * 9 = 108
minutes)
. Use the new result to determine the latest time at which
the jobs need to be started to meet your target deadline.
The time that it takes to process a job can be impacted by the following factors:
The dataset type (Direct Query or SPICE).
The size of the dataset.
The complexity of the calculated fields that are used in the dashboard.
The number of visuals that are on a sheet.
The types of visuals that are on the sheet.
The number of formats and snapshots that are requested in the job configuration.
The size of the generated snapshots.
12251 12252 12253 12254 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12251 def start_dashboard_snapshot_job(params = {}, = {}) req = build_request(:start_dashboard_snapshot_job, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Types::TagResourceResponse
Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.
Tags can help you organize and categorize your resources. You can also
use them to scope user permissions, by granting a user permission to
access or change only resources with certain tag values. You can use
the TagResource
operation with a resource that already has tags. If
you specify a new tag key for the resource, this tag is appended to
the list of tags associated with the resource. If you specify a tag
key that is already associated with the resource, the new tag value
that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data set, data source, dashboard, template, topic, and user.
Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for the following:
Tags are used to track costs for users in Amazon QuickSight. You can't tag other resources that Amazon QuickSight costs are based on, such as storage capacoty (SPICE), session usage, alert consumption, or reporting units.
Amazon QuickSight doesn't currently support the tag editor for Resource Groups.
12316 12317 12318 12319 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12316 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.
12351 12352 12353 12354 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12351 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_account_customization(params = {}) ⇒ Types::UpdateAccountCustomizationResponse
Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme.
You can use customizations for your Amazon Web Services account or, if
you specify a namespace, for a Amazon QuickSight namespace instead.
Customizations that apply to a namespace override customizations that
apply to an Amazon Web Services account. To find out which
customizations apply, use the DescribeAccountCustomization
API
operation.
12413 12414 12415 12416 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12413 def update_account_customization(params = {}, = {}) req = build_request(:update_account_customization, params) req.send_request() end |
#update_account_settings(params = {}) ⇒ Types::UpdateAccountSettingsResponse
Updates the Amazon QuickSight settings in your Amazon Web Services account.
12466 12467 12468 12469 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12466 def update_account_settings(params = {}, = {}) req = build_request(:update_account_settings, params) req.send_request() end |
#update_analysis(params = {}) ⇒ Types::UpdateAnalysisResponse
Updates an analysis in Amazon QuickSight
12531 12532 12533 12534 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12531 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.
12597 12598 12599 12600 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12597 def (params = {}, = {}) req = build_request(:update_analysis_permissions, params) req.send_request() end |
#update_dashboard(params = {}) ⇒ Types::UpdateDashboardResponse
Updates a dashboard in an Amazon Web Services account.
UpdateDashboardPublishedVersion
API operation.
12702 12703 12704 12705 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12702 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.
12747 12748 12749 12750 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12747 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.
12832 12833 12834 12835 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12832 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.
12875 12876 12877 12878 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12875 def update_dashboard_published_version(params = {}, = {}) req = build_request(:update_dashboard_published_version, params) req.send_request() end |
#update_data_set(params = {}) ⇒ Types::UpdateDataSetResponse
Updates a dataset. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation.
13166 13167 13168 13169 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13166 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
.
13227 13228 13229 13230 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13227 def (params = {}, = {}) req = build_request(:update_data_set_permissions, params) req.send_request() end |
#update_data_source(params = {}) ⇒ Types::UpdateDataSourceResponse
Updates a data source.
13563 13564 13565 13566 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13563 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.
13622 13623 13624 13625 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13622 def (params = {}, = {}) req = build_request(:update_data_source_permissions, params) req.send_request() end |
#update_folder(params = {}) ⇒ Types::UpdateFolderResponse
Updates the name of a folder.
13665 13666 13667 13668 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13665 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.
13729 13730 13731 13732 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13729 def (params = {}, = {}) req = build_request(:update_folder_permissions, params) req.send_request() end |
#update_group(params = {}) ⇒ Types::UpdateGroupResponse
Changes a group description.
13778 13779 13780 13781 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13778 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
.
13857 13858 13859 13860 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13857 def update_iam_policy_assignment(params = {}, = {}) req = build_request(:update_iam_policy_assignment, params) req.send_request() end |
#update_identity_propagation_config(params = {}) ⇒ Types::UpdateIdentityPropagationConfigResponse
Adds or updates services and authorized targets to configure what the Amazon QuickSight IAM Identity Center application can access.
This operation is only supported for Amazon QuickSight accounts using IAM Identity Center
13902 13903 13904 13905 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13902 def update_identity_propagation_config(params = {}, = {}) req = build_request(:update_identity_propagation_config, params) req.send_request() end |
#update_ip_restriction(params = {}) ⇒ Types::UpdateIpRestrictionResponse
Updates the content and status of IP rules. Traffic from a source is
allowed when the source satisfies either the IpRestrictionRule
,
VpcIdRestrictionRule
, or VpcEndpointIdRestrictionRule
. To use this
operation, you must provide the entire map of rules. You can use the
DescribeIpRestriction
operation to get the current rule map.
13964 13965 13966 13967 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13964 def update_ip_restriction(params = {}, = {}) req = build_request(:update_ip_restriction, params) req.send_request() end |
#update_key_registration(params = {}) ⇒ Types::UpdateKeyRegistrationResponse
Updates a customer managed key in a Amazon QuickSight account.
14013 14014 14015 14016 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14013 def update_key_registration(params = {}, = {}) req = build_request(:update_key_registration, params) req.send_request() end |
#update_public_sharing_settings(params = {}) ⇒ Types::UpdatePublicSharingSettingsResponse
Use the UpdatePublicSharingSettings
operation to turn on or turn off
the public sharing settings of an Amazon QuickSight dashboard.
To use this operation, turn on session capacity pricing for your Amazon QuickSight account.
Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with Amazon QuickSight, see Using Amazon QuickSight with IAM in the Amazon QuickSight User Guide.
14063 14064 14065 14066 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14063 def update_public_sharing_settings(params = {}, = {}) req = build_request(:update_public_sharing_settings, params) req.send_request() end |
#update_refresh_schedule(params = {}) ⇒ Types::UpdateRefreshScheduleResponse
Updates a refresh schedule for a dataset.
14119 14120 14121 14122 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14119 def update_refresh_schedule(params = {}, = {}) req = build_request(:update_refresh_schedule, params) req.send_request() end |
#update_role_custom_permission(params = {}) ⇒ Types::UpdateRoleCustomPermissionResponse
Updates the custom permissions that are associated with a role.
14165 14166 14167 14168 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14165 def (params = {}, = {}) req = build_request(:update_role_custom_permission, params) req.send_request() end |
#update_spice_capacity_configuration(params = {}) ⇒ Types::UpdateSPICECapacityConfigurationResponse
Updates the SPICE capacity configuration for a Amazon QuickSight account.
14208 14209 14210 14211 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14208 def update_spice_capacity_configuration(params = {}, = {}) req = build_request(:update_spice_capacity_configuration, params) req.send_request() end |
#update_template(params = {}) ⇒ Types::UpdateTemplateResponse
Updates a template from an existing Amazon QuickSight analysis or another template.
14280 14281 14282 14283 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14280 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.
14331 14332 14333 14334 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14331 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.
14392 14393 14394 14395 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14392 def (params = {}, = {}) req = build_request(:update_template_permissions, params) req.send_request() end |
#update_theme(params = {}) ⇒ Types::UpdateThemeResponse
Updates a theme.
14502 14503 14504 14505 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14502 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.
14549 14550 14551 14552 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14549 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.
14652 14653 14654 14655 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14652 def (params = {}, = {}) req = build_request(:update_theme_permissions, params) req.send_request() end |
#update_topic(params = {}) ⇒ Types::UpdateTopicResponse
Updates a topic.
14917 14918 14919 14920 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14917 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.
14980 14981 14982 14983 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 14980 def (params = {}, = {}) req = build_request(:update_topic_permissions, params) req.send_request() end |
#update_topic_refresh_schedule(params = {}) ⇒ Types::UpdateTopicRefreshScheduleResponse
Updates a topic refresh schedule.
15037 15038 15039 15040 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 15037 def update_topic_refresh_schedule(params = {}, = {}) req = build_request(:update_topic_refresh_schedule, params) req.send_request() end |
#update_user(params = {}) ⇒ Types::UpdateUserResponse
Updates an Amazon QuickSight user.
15192 15193 15194 15195 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 15192 def update_user(params = {}, = {}) req = build_request(:update_user, params) req.send_request() end |
#update_vpc_connection(params = {}) ⇒ Types::UpdateVPCConnectionResponse
Updates a VPC connection.
15258 15259 15260 15261 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 15258 def update_vpc_connection(params = {}, = {}) req = build_request(:update_vpc_connection, params) req.send_request() end |