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_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_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_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_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_namespace(params = {}) ⇒ Types::DescribeNamespaceResponse
Describes the current namespace.
-
#describe_refresh_schedule(params = {}) ⇒ Types::DescribeRefreshScheduleResponse
Provides a summary of a refresh schedule.
-
#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_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_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.
-
#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_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_ip_restriction(params = {}) ⇒ Types::UpdateIpRestrictionResponse
Updates the content and status of IP rules.
-
#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_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.
365 366 367 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 365 def initialize(*args) super end |
Instance Method Details
#cancel_ingestion(params = {}) ⇒ Types::CancelIngestionResponse
Cancels an ongoing ingestion of data into SPICE.
408 409 410 411 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 408 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.
505 506 507 508 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 505 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. This operation isn't supported in the US East (Ohio) Region, South America (Sao Paulo) Region, or Asia Pacific (Singapore) Region.
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.
698 699 700 701 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 698 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
.
778 779 780 781 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 778 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.
896 897 898 899 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 896 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.
1202 1203 1204 1205 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1202 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.
1516 1517 1518 1519 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1516 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.
1591 1592 1593 1594 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1591 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.
1638 1639 1640 1641 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1638 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 AWS
Support.
The permissions resource is
arn:aws:quicksight:<your-region>:<relevant-aws-account-id>:group/default/<group-name>
.
The response is a group object.
1696 1697 1698 1699 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1696 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.
1743 1744 1745 1746 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1743 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.
1824 1825 1826 1827 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1824 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.
1886 1887 1888 1889 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1886 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.
1957 1958 1959 1960 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 1957 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.
2014 2015 2016 2017 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2014 def create_refresh_schedule(params = {}, = {}) req = build_request(:create_refresh_schedule, 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.
2108 2109 2110 2111 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2108 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.
2157 2158 2159 2160 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2157 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.
2296 2297 2298 2299 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2296 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.
2345 2346 2347 2348 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2345 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.
2617 2618 2619 2620 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2617 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.
2678 2679 2680 2681 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2678 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.
2754 2755 2756 2757 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2754 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.
2793 2794 2795 2796 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2793 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.
2830 2831 2832 2833 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2830 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.
2901 2902 2903 2904 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2901 def delete_analysis(params = {}, = {}) req = build_request(:delete_analysis, params) req.send_request() end |
#delete_dashboard(params = {}) ⇒ Types::DeleteDashboardResponse
Deletes a dashboard.
2945 2946 2947 2948 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2945 def delete_dashboard(params = {}, = {}) req = build_request(:delete_dashboard, params) req.send_request() end |
#delete_data_set(params = {}) ⇒ Types::DeleteDataSetResponse
Deletes a dataset.
2984 2985 2986 2987 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 2984 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.
3018 3019 3020 3021 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3018 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.
3058 3059 3060 3061 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3058 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.
3096 3097 3098 3099 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3096 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.
3141 3142 3143 3144 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3141 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.
3181 3182 3183 3184 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3181 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.
3227 3228 3229 3230 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3227 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.
3268 3269 3270 3271 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3268 def delete_iam_policy_assignment(params = {}, = {}) req = build_request(:delete_iam_policy_assignment, 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.
3307 3308 3309 3310 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3307 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.
3349 3350 3351 3352 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3349 def delete_refresh_schedule(params = {}, = {}) req = build_request(:delete_refresh_schedule, params) req.send_request() end |
#delete_template(params = {}) ⇒ Types::DeleteTemplateResponse
Deletes a template.
3394 3395 3396 3397 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3394 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.
3444 3445 3446 3447 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3444 def delete_template_alias(params = {}, = {}) req = build_request(:delete_template_alias, params) req.send_request() end |
#delete_theme(params = {}) ⇒ Types::DeleteThemeResponse
Deletes a theme.
3490 3491 3492 3493 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3490 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.
3537 3538 3539 3540 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3537 def delete_theme_alias(params = {}, = {}) req = build_request(:delete_theme_alias, params) req.send_request() end |
#delete_topic(params = {}) ⇒ Types::DeleteTopicResponse
Deletes a topic.
3577 3578 3579 3580 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3577 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.
3622 3623 3624 3625 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3622 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.
3664 3665 3666 3667 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3664 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.
3704 3705 3706 3707 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3704 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.
3749 3750 3751 3752 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3749 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.
3861 3862 3863 3864 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3861 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.
3900 3901 3902 3903 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3900 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.
3941 3942 3943 3944 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3941 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.
3996 3997 3998 3999 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 3996 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.
4045 4046 4047 4048 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4045 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.
4091 4092 4093 4094 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4091 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.
4189 4190 4191 4192 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4189 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.
4345 4346 4347 4348 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4345 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.
4413 4414 4415 4416 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4413 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.
4470 4471 4472 4473 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4470 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.
4519 4520 4521 4522 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4519 def (params = {}, = {}) req = build_request(:describe_dashboard_permissions, 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.
4682 4683 4684 4685 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4682 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
.
4729 4730 4731 4732 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4729 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.
4767 4768 4769 4770 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4767 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.
4926 4927 4928 4929 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4926 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.
4970 4971 4972 4973 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 4970 def (params = {}, = {}) req = build_request(:describe_data_source_permissions, params) req.send_request() end |
#describe_folder(params = {}) ⇒ Types::DescribeFolderResponse
Describes a folder.
5013 5014 5015 5016 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5013 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.
5056 5057 5058 5059 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/client.rb', line 5056 def (params = {}, = {}) req = build_request(:describe_folder_permissions, params) req.send_request() end |