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
-
#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_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.
410 411 412 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 410 def initialize(*args) super end |
Instance Method Details
#cancel_ingestion(params = {}) ⇒ Types::CancelIngestionResponse
Cancels an ongoing ingestion of data into SPICE.
453 454 455 456 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 453 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.
550 551 552 553 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 550 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.
818 819 820 821 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 818 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
.
907 908 909 910 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 907 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.
1042 1043 1044 1045 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1042 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.
1357 1358 1359 1360 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1357 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.
1724 1725 1726 1727 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1724 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.
1804 1805 1806 1807 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1804 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.
1850 1851 1852 1853 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1850 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.
1908 1909 1910 1911 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1908 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.
1955 1956 1957 1958 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1955 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.
2036 2037 2038 2039 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2036 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.
2098 2099 2100 2101 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2098 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.
2169 2170 2171 2172 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2169 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.
2226 2227 2228 2229 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2226 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.
2272 2273 2274 2275 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2272 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.
2371 2372 2373 2374 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2371 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.
2420 2421 2422 2423 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2420 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.
2559 2560 2561 2562 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2559 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.
2608 2609 2610 2611 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2608 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.
2883 2884 2885 2886 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2883 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.
2944 2945 2946 2947 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2944 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.
3020 3021 3022 3023 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3020 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.
3059 3060 3061 3062 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3059 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.
3096 3097 3098 3099 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3096 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.
3167 3168 3169 3170 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3167 def delete_analysis(params = {}, = {}) req = build_request(:delete_analysis, params) req.send_request() end |
#delete_dashboard(params = {}) ⇒ Types::DeleteDashboardResponse
Deletes a dashboard.
3211 3212 3213 3214 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3211 def delete_dashboard(params = {}, = {}) req = build_request(:delete_dashboard, params) req.send_request() end |
#delete_data_set(params = {}) ⇒ Types::DeleteDataSetResponse
Deletes a dataset.
3250 3251 3252 3253 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3250 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.
3284 3285 3286 3287 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3284 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.
3324 3325 3326 3327 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3324 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.
3362 3363 3364 3365 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3362 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.
3405 3406 3407 3408 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3405 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.
3445 3446 3447 3448 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3445 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.
3491 3492 3493 3494 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3491 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.
3532 3533 3534 3535 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3532 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.
3573 3574 3575 3576 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3573 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.
3612 3613 3614 3615 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3612 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.
3654 3655 3656 3657 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3654 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.
3694 3695 3696 3697 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3694 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.
3739 3740 3741 3742 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3739 def delete_role_membership(params = {}, = {}) req = build_request(:delete_role_membership, params) req.send_request() end |
#delete_template(params = {}) ⇒ Types::DeleteTemplateResponse
Deletes a template.
3784 3785 3786 3787 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3784 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.
3834 3835 3836 3837 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3834 def delete_template_alias(params = {}, = {}) req = build_request(:delete_template_alias, params) req.send_request() end |
#delete_theme(params = {}) ⇒ Types::DeleteThemeResponse
Deletes a theme.
3880 3881 3882 3883 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3880 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.
3927 3928 3929 3930 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3927 def delete_theme_alias(params = {}, = {}) req = build_request(:delete_theme_alias, params) req.send_request() end |
#delete_topic(params = {}) ⇒ Types::DeleteTopicResponse
Deletes a topic.
3967 3968 3969 3970 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3967 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.
4012 4013 4014 4015 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4012 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.
4054 4055 4056 4057 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4054 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.
4094 4095 4096 4097 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4094 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.
4139 4140 4141 4142 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4139 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.
4251 4252 4253 4254 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4251 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.
4290 4291 4292 4293 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4290 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.
4332 4333 4334 4335 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4332 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.
4387 4388 4389 4390 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4387 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.
4436 4437 4438 4439 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4436 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.
4482 4483 4484 4485 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4482 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.
4590 4591 4592 4593 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4590 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.
4844 4845 4846 4847 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4844 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.
4914 4915 4916 4917 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4914 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.
4971 4972 4973 4974 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4971 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.
5020 5021 5022 5023 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5020 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
.
5110 5111 5112 5113 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5110 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.
.
5187 5188 5189 5190 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5187 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.
5355 5356 5357 5358 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5355 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
.
5402 5403 5404 5405 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5402 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.
5440 5441 5442 5443 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5440 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.
5629 5630 5631 5632 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5629 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.
5673 5674 5675 5676 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5673 def (params = {}, = {}) req = build_request(:describe_data_source_permissions, params) req.send_request() end |
#describe_folder(params = {}) ⇒ Types::DescribeFolderResponse
Describes a folder.
5717 5718 5719 5720 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5717 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.
5776 5777 5778 5779 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5776 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.
5837 5838 5839 5840 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5837 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).
5883 5884 5885 5886 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5883 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.
5932 5933 5934 5935 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5932 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.
5981 5982 5983 5984 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5981 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.
6035 6036 6037 6038 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6035 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.
6078 6079 6080 6081 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6078 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.
6120 6121 6122 6123 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6120 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.
6163 6164 6165 6166 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6163 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.
6213 6214 6215 6216 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6213 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.
6256 6257 6258 6259 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6256 def (params = {}, = {}) req = build_request(:describe_role_custom_permission, params) req.send_request() end |
#describe_template(params = {}) ⇒ Types::DescribeTemplateResponse
Describes a template's metadata.
6335 6336 6337 6338 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6335 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.
6382 6383 6384 6385 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6382 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.
6442 6443 6444 6445 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6442 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.
6486 6487 6488 6489 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6486 def (params = {}, = {}) req = build_request(:describe_template_permissions, params) req.send_request() end |
#describe_theme(params = {}) ⇒ Types::DescribeThemeResponse
Describes a theme.
6577 6578 6579 6580 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6577 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.
6620 6621 6622 6623 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6620 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.
6664 6665 6666 6667 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6664 def (params = {}, = {}) req = build_request(:describe_theme_permissions, params) req.send_request() end |
#describe_topic(params = {}) ⇒ Types::DescribeTopicResponse
Describes a topic.
6859 6860 6861 6862 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6859 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.
6904 6905 6906 6907 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6904 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.
6949 6950 6951 6952 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 6949 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.
7002 7003 7004 7005 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7002 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.
7054 7055 7056 7057 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7054 def describe_user(params = {}, = {}) req = build_request(:describe_user, params) req.send_request() end |
#describe_vpc_connection(params = {}) ⇒ Types::DescribeVPCConnectionResponse
Describes a VPC connection.
7111 7112 7113 7114 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7111 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.
7256 7257 7258 7259 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7256 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.
7383 7384 7385 7386 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7383 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.
7517 7518 7519 7520 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7517 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:
7611 7612 7613 7614 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7611 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.
7662 7663 7664 7665 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7662 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.
7720 7721 7722 7723 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7720 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.
7775 7776 7777 7778 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7775 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.
7832 7833 7834 7835 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7832 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.
7885 7886 7887 7888 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7885 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.
7947 7948 7949 7950 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 7947 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.
8146 8147 8148 8149 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8146 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.
8197 8198 8199 8200 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8197 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.
8249 8250 8251 8252 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8249 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.
8305 8306 8307 8308 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8305 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.
8359 8360 8361 8362 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8359 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.
8416 8417 8418 8419 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8416 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.
8474 8475 8476 8477 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8474 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.
8525 8526 8527 8528 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8525 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.
8589 8590 8591 8592 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8589 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.
8649 8650 8651 8652 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8649 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.
8695 8696 8697 8698 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8695 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.
8751 8752 8753 8754 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8751 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.
8786 8787 8788 8789 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8786 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.
8839 8840 8841 8842 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8839 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.
8895 8896 8897 8898 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8895 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.
8947 8948 8949 8950 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8947 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.
8998 8999 9000 9001 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 8998 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.
9054 9055 9056 9057 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9054 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.
9119 9120 9121 9122 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9119 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.
9170 9171 9172 9173 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9170 def list_topic_refresh_schedules(params = {}, = {}) req = build_request(:list_topic_refresh_schedules, 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.
9220 9221 9222 9223 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9220 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.
9280 9281 9282 9283 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9280 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.
9342 9343 9344 9345 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9342 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.
9408 9409 9410 9411 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9408 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.
9456 9457 9458 9459 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9456 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.
9654 9655 9656 9657 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9654 def register_user(params = {}, = {}) req = build_request(:register_user, params) req.send_request() end |
#restore_analysis(params = {}) ⇒ Types::RestoreAnalysisResponse
Restores an analysis.
9692 9693 9694 9695 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9692 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.
9759 9760 9761 9762 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9759 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.
9830 9831 9832 9833 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9830 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.
9898 9899 9900 9901 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9898 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.
9959 9960 9961 9962 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 9959 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.
10024 10025 10026 10027 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10024 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.
10090 10091 10092 10093 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10090 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.
10255 10256 10257 10258 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10255 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.
10661 10662 10663 10664 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10661 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.
10871 10872 10873 10874 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10871 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.
10936 10937 10938 10939 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10936 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.
10971 10972 10973 10974 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 10971 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.
11033 11034 11035 11036 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11033 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.
11086 11087 11088 11089 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11086 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
11151 11152 11153 11154 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11151 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.
11217 11218 11219 11220 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11217 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.
11322 11323 11324 11325 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11322 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.
11367 11368 11369 11370 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11367 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.
11452 11453 11454 11455 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11452 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.
11495 11496 11497 11498 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11495 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.
11786 11787 11788 11789 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11786 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
.
11847 11848 11849 11850 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 11847 def (params = {}, = {}) req = build_request(:update_data_set_permissions, params) req.send_request() end |
#update_data_source(params = {}) ⇒ Types::UpdateDataSourceResponse
Updates a data source.
12183 12184 12185 12186 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12183 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.
12242 12243 12244 12245 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12242 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.
12285 12286 12287 12288 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12285 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.
12349 12350 12351 12352 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12349 def (params = {}, = {}) req = build_request(:update_folder_permissions, params) req.send_request() end |
#update_group(params = {}) ⇒ Types::UpdateGroupResponse
Changes a group description.
12398 12399 12400 12401 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12398 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
.
12477 12478 12479 12480 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12477 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
12522 12523 12524 12525 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12522 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.
12584 12585 12586 12587 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12584 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.
12633 12634 12635 12636 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12633 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.
12683 12684 12685 12686 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12683 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.
12739 12740 12741 12742 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12739 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.
12785 12786 12787 12788 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12785 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.
12828 12829 12830 12831 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12828 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.
12900 12901 12902 12903 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12900 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.
12951 12952 12953 12954 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 12951 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.
13012 13013 13014 13015 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13012 def (params = {}, = {}) req = build_request(:update_template_permissions, params) req.send_request() end |
#update_theme(params = {}) ⇒ Types::UpdateThemeResponse
Updates a theme.
13122 13123 13124 13125 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13122 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.
13169 13170 13171 13172 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13169 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.
13272 13273 13274 13275 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13272 def (params = {}, = {}) req = build_request(:update_theme_permissions, params) req.send_request() end |
#update_topic(params = {}) ⇒ Types::UpdateTopicResponse
Updates a topic.
13537 13538 13539 13540 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13537 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.
13600 13601 13602 13603 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13600 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.
13657 13658 13659 13660 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13657 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.
13812 13813 13814 13815 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13812 def update_user(params = {}, = {}) req = build_request(:update_user, params) req.send_request() end |
#update_vpc_connection(params = {}) ⇒ Types::UpdateVPCConnectionResponse
Updates a VPC connection.
13878 13879 13880 13881 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 13878 def update_vpc_connection(params = {}, = {}) req = build_request(:update_vpc_connection, params) req.send_request() end |