Quicksight

This page documents function available when using the Quicksight module, created with @service Quicksight.

Index

Documentation

Main.Quicksight.cancel_ingestionMethod
cancel_ingestion(aws_account_id, data_set_id, ingestion_id)
cancel_ingestion(aws_account_id, data_set_id, ingestion_id, params::Dict{String,<:Any})

Cancels an ongoing ingestion of data into SPICE.

Arguments

  • aws_account_id: The Amazon Web Services account ID.
  • data_set_id: The ID of the dataset used in the ingestion.
  • ingestion_id: An ID for the ingestion.
source
Main.Quicksight.create_account_customizationMethod
create_account_customization(account_customization, aws_account_id)
create_account_customization(account_customization, aws_account_id, params::Dict{String,<:Any})

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.

Arguments

  • account_customization: The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region. You can add these to an Amazon Web Services account and a QuickSight namespace. For example, you can add a default theme by setting AccountCustomization to the midnight theme: "AccountCustomization": { "DefaultTheme": "arn:aws:quicksight::aws:theme/MIDNIGHT" }. Or, you can add a custom theme by specifying "AccountCustomization": { "DefaultTheme": "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639" }.
  • aws_account_id: The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Tags": A list of the tags that you want to attach to this resource.
  • "namespace": The Amazon QuickSight namespace that you want to add customizations to.
source
Main.Quicksight.create_account_subscriptionMethod
create_account_subscription(account_name, authentication_method, aws_account_id, edition, notification_email)
create_account_subscription(account_name, authentication_method, aws_account_id, edition, notification_email, params::Dict{String,<:Any})

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.

Arguments

  • account_name: The name of your Amazon QuickSight account. This name is unique over all of Amazon Web Services, and it appears only when users sign in. You can't change AccountName value after the Amazon QuickSight account is created.
  • authentication_method: The method that you want to use to authenticate your Amazon QuickSight account. Currently, the valid values for this parameter are IAMANDQUICKSIGHT, IAMONLY, and ACTIVEDIRECTORY. If you choose ACTIVE_DIRECTORY, provide an ActiveDirectoryName and an AdminGroup associated with your Active Directory.
  • aws_account_id: The Amazon Web Services account ID of the account that you're using to create your Amazon QuickSight account.
  • edition: The edition of Amazon QuickSight that you want your account to have. Currently, you can choose from ENTERPRISE or ENTERPRISEANDQ. If you choose ENTERPRISEANDQ, the following parameters are required: FirstName LastName EmailAddress ContactNumber
  • notification_email: The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ActiveDirectoryName": The name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.
  • "AdminGroup": The admin group associated with your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
  • "AuthorGroup": The author group associated with your Active Directory. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
  • "ContactNumber": A 10-digit phone number for the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISEANDQ is the selected edition of the new Amazon QuickSight account.
  • "DirectoryId": The ID of the Active Directory that is associated with your Amazon QuickSight account.
  • "EmailAddress": The email address of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISEANDQ is the selected edition of the new Amazon QuickSight account.
  • "FirstName": The first name of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISEANDQ is the selected edition of the new Amazon QuickSight account.
  • "LastName": The last name of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISEANDQ is the selected edition of the new Amazon QuickSight account.
  • "ReaderGroup": The reader group associated with your Active Direcrtory. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
  • "Realm": The realm of the Active Directory that is associated with your Amazon QuickSight account. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.
source
Main.Quicksight.create_analysisMethod
create_analysis(analysis_id, aws_account_id, name)
create_analysis(analysis_id, aws_account_id, name, params::Dict{String,<:Any})

Creates an analysis in Amazon QuickSight.

Arguments

  • analysis_id: The ID for the analysis that you're creating. This ID displays in the URL of the analysis.
  • aws_account_id: The ID of the Amazon Web Services account where you are creating an analysis.
  • name: A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon QuickSight console.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Definition": The definition of an analysis. A definition is the data model of all features in a Dashboard, Template, or Analysis.
  • "Parameters": The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.
  • "Permissions": A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN). To specify no permissions, omit Permissions.
  • "SourceEntity": A source entity to use for the analysis that you're creating. This metadata structure contains details that describe a source template and one or more datasets.
  • "Tags": Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
  • "ThemeArn": The ARN for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.
source
Main.Quicksight.create_dashboardMethod
create_dashboard(aws_account_id, dashboard_id, name)
create_dashboard(aws_account_id, dashboard_id, name, params::Dict{String,<:Any})

Creates a dashboard from a template. 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.

Arguments

  • aws_account_id: The ID of the Amazon Web Services account where you want to create the dashboard.
  • dashboard_id: The ID for the dashboard, also added to the IAM policy.
  • name: The display name of the dashboard.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "DashboardPublishOptions": Options for publishing the dashboard when you create it: AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default. AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default. VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.
  • "Definition": The definition of a dashboard. A definition is the data model of all features in a Dashboard, Template, or Analysis.
  • "Parameters": The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.
  • "Permissions": A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN. To specify no permissions, omit the permissions list.
  • "SourceEntity": The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplateARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region. Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
  • "Tags": Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
  • "ThemeArn": The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.
  • "VersionDescription": A description for the first version of the dashboard being created.
source
Main.Quicksight.create_data_setMethod
create_data_set(aws_account_id, data_set_id, import_mode, name, physical_table_map)
create_data_set(aws_account_id, data_set_id, import_mode, name, physical_table_map, params::Dict{String,<:Any})

Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.

Arguments

  • aws_account_id: The Amazon Web Services account ID.
  • data_set_id: An ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  • import_mode: Indicates whether you want to import the data into SPICE.
  • name: The display name for the dataset.
  • physical_table_map: Declares the physical tables that are available in the underlying data sources.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ColumnGroups": Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
  • "ColumnLevelPermissionRules": A set of one or more definitions of a ColumnLevelPermissionRule .
  • "DataSetUsageConfiguration":
  • "FieldFolders": The folder that contains fields and nested subfolders for your dataset.
  • "LogicalTableMap": Configures the combination and transformation of the data from the physical tables.
  • "Permissions": A list of resource permissions on the dataset.
  • "RowLevelPermissionDataSet": The row-level security configuration for the data that you want to create.
  • "RowLevelPermissionTagConfiguration": The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.
  • "Tags": Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
source
Main.Quicksight.create_data_sourceMethod
create_data_source(aws_account_id, data_source_id, name, type)
create_data_source(aws_account_id, data_source_id, name, type, params::Dict{String,<:Any})

Creates a data source.

Arguments

  • aws_account_id: The Amazon Web Services account ID.
  • data_source_id: An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  • name: A display name for the data source.
  • type: The type of the data source. To return a list of all data sources, use ListDataSources. Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Credentials": The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
  • "DataSourceParameters": The parameters that Amazon QuickSight uses to connect to your underlying source.
  • "Permissions": A list of resource permissions on the data source.
  • "SslProperties": Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
  • "Tags": Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
  • "VpcConnectionProperties": Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
source
Main.Quicksight.create_folderMethod
create_folder(aws_account_id, folder_id)
create_folder(aws_account_id, folder_id, params::Dict{String,<:Any})

Creates an empty shared folder.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account where you want to create the folder.
  • folder_id: The ID of the folder.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "FolderType": The type of folder. By default, folderType is SHARED.
  • "Name": The name of the folder.
  • "ParentFolderArn": The Amazon Resource Name (ARN) for the parent folder. ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.
  • "Permissions": A structure that describes the principals and the resource-level permissions of a folder. To specify no permissions, omit Permissions.
  • "Tags": Tags for the folder.
source
Main.Quicksight.create_folder_membershipMethod
create_folder_membership(aws_account_id, folder_id, member_id, member_type)
create_folder_membership(aws_account_id, folder_id, member_id, member_type, params::Dict{String,<:Any})

Adds an asset, such as a dashboard, analysis, or dataset into a folder.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that contains the folder.
  • folder_id: The ID of the folder.
  • member_id: The ID of the asset (the dashboard, analysis, or dataset).
  • member_type: The type of the member, including DASHBOARD, ANALYSIS, and DATASET.
source
Main.Quicksight.create_groupMethod
create_group(aws_account_id, group_name, namespace)
create_group(aws_account_id, group_name, namespace, params::Dict{String,<:Any})

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:&lt;your-region&gt;:&lt;relevant-aws-account-id&gt;:group/default/&lt;gro up-name&gt; . The response is a group object.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  • group_name: A name for the group that you want to create.
  • namespace: The namespace that you want the group to be a part of.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": A description for the group that you want to create.
source
Main.Quicksight.create_group_membershipMethod
create_group_membership(aws_account_id, group_name, member_name, namespace)
create_group_membership(aws_account_id, group_name, member_name, namespace, params::Dict{String,<:Any})

Adds an Amazon QuickSight user to an Amazon QuickSight group.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  • group_name: The name of the group that you want to add the user to.
  • member_name: The name of the user that you want to add to the group membership.
  • namespace: The namespace that you want the user to be a part of.
source
Main.Quicksight.create_iampolicy_assignmentMethod
create_iampolicy_assignment(assignment_name, assignment_status, aws_account_id, namespace)
create_iampolicy_assignment(assignment_name, assignment_status, aws_account_id, namespace, params::Dict{String,<:Any})

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.

Arguments

  • assignment_name: The name of the assignment, also called a rule. It must be unique within an Amazon Web Services account.
  • assignment_status: The status of the assignment. Possible values are as follows: ENABLED - Anything specified in this assignment is used when creating the data source. DISABLED - This assignment isn't used when creating the data source. DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.
  • aws_account_id: The ID of the Amazon Web Services account where you want to assign an IAM policy to Amazon QuickSight users or groups.
  • namespace: The namespace that contains the assignment.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Identities": The Amazon QuickSight users, groups, or both that you want to assign the policy to.
  • "PolicyArn": The ARN for the IAM policy to apply to the Amazon QuickSight users and groups specified in this assignment.
source
Main.Quicksight.create_ingestionMethod
create_ingestion(aws_account_id, data_set_id, ingestion_id)
create_ingestion(aws_account_id, data_set_id, ingestion_id, params::Dict{String,<:Any})

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.

Arguments

  • aws_account_id: The Amazon Web Services account ID.
  • data_set_id: The ID of the dataset used in the ingestion.
  • ingestion_id: An ID for the ingestion.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "IngestionType": The type of ingestion that you want to create.
source
Main.Quicksight.create_namespaceMethod
create_namespace(aws_account_id, identity_store, namespace)
create_namespace(aws_account_id, identity_store, namespace, params::Dict{String,<:Any})

(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.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that you want to create the Amazon QuickSight namespace in.
  • identity_store: Specifies the type of your user identity directory. Currently, this supports users with an identity type of QUICKSIGHT.
  • namespace: The name that you want to use to describe the new namespace.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Tags": The tags that you want to associate with the namespace that you're creating.
source
Main.Quicksight.create_templateMethod
create_template(aws_account_id, template_id)
create_template(aws_account_id, template_id, params::Dict{String,<:Any})

Creates a template from an existing Amazon QuickSight analysis or template. You can use the resulting template to create a dashboard. 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.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that the group is in. You use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  • template_id: An ID for the template that you want to create. This template is unique per Amazon Web Services Region; in each Amazon Web Services account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Definition": The definition of a template. A definition is the data model of all features in a Dashboard, Template, or Analysis.
  • "Name": A display name for the template.
  • "Permissions": A list of resource permissions to be set on the template.
  • "SourceEntity": The entity that you are using as a source when you create the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region. Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
  • "Tags": Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
  • "VersionDescription": A description of the current template version being created. This API operation creates the first version of the template. Every time UpdateTemplate is called, a new version is created. Each version of the template maintains a description of the version in the VersionDescription field.
source
Main.Quicksight.create_template_aliasMethod
create_template_alias(alias_name, aws_account_id, template_id, template_version_number)
create_template_alias(alias_name, aws_account_id, template_id, template_version_number, params::Dict{String,<:Any})

Creates a template alias for a template.

Arguments

  • alias_name: The name that you want to give to the template alias that you're creating. Don't start the alias name with the character. Alias names that start with are reserved by Amazon QuickSight.
  • aws_account_id: The ID of the Amazon Web Services account that contains the template that you creating an alias for.
  • template_id: An ID for the template.
  • template_version_number: The version number of the template.
source
Main.Quicksight.create_themeMethod
create_theme(aws_account_id, base_theme_id, configuration, name, theme_id)
create_theme(aws_account_id, base_theme_id, configuration, name, theme_id, params::Dict{String,<:Any})

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.

Arguments

  • aws_account_id: The ID of the Amazon Web Services account where you want to store the new theme.
  • base_theme_id: The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting themes defined by Amazon QuickSight. For a list of the starting themes, use ListThemes or choose Themes from within an analysis.
  • configuration: The theme configuration, which contains the theme display properties.
  • name: A display name for the theme.
  • theme_id: An ID for the theme that you want to create. The theme ID is unique per Amazon Web Services Region in each Amazon Web Services account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Permissions": A valid grouping of resource permissions to apply to the new theme.
  • "Tags": A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
  • "VersionDescription": A description of the first version of the theme that you're creating. Every time UpdateTheme is called, a new version is created. Each version of the theme has a description of the version in the VersionDescription field.
source
Main.Quicksight.create_theme_aliasMethod
create_theme_alias(alias_name, aws_account_id, theme_id, theme_version_number)
create_theme_alias(alias_name, aws_account_id, theme_id, theme_version_number, params::Dict{String,<:Any})

Creates a theme alias for a theme.

Arguments

  • alias_name: The name that you want to give to the theme alias that you are creating. The alias name can't begin with a . Alias names that start with are reserved by Amazon QuickSight.
  • aws_account_id: The ID of the Amazon Web Services account that contains the theme for the new theme alias.
  • theme_id: An ID for the theme alias.
  • theme_version_number: The version number of the theme.
source
Main.Quicksight.delete_account_customizationMethod
delete_account_customization(aws_account_id)
delete_account_customization(aws_account_id, params::Dict{String,<:Any})

Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that you want to delete Amazon QuickSight customizations from in this Amazon Web Services Region.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "namespace": The Amazon QuickSight namespace that you're deleting the customizations from.
source
Main.Quicksight.delete_account_subscriptionMethod
delete_account_subscription(aws_account_id)
delete_account_subscription(aws_account_id, params::Dict{String,<:Any})

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.

Arguments

  • aws_account_id: The Amazon Web Services account ID of the account that you want to delete.
source
Main.Quicksight.delete_analysisMethod
delete_analysis(analysis_id, aws_account_id)
delete_analysis(analysis_id, aws_account_id, params::Dict{String,<:Any})

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.

Arguments

  • analysis_id: The ID of the analysis that you're deleting.
  • aws_account_id: The ID of the Amazon Web Services account where you want to delete an analysis.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "force-delete-without-recovery": This option defaults to the value NoForceDeleteWithoutRecovery. To immediately delete the analysis, add the ForceDeleteWithoutRecovery option. You can't restore an analysis after it's deleted.
  • "recovery-window-in-days": A value that specifies the number of days that Amazon QuickSight waits before it deletes the analysis. You can't use this parameter with the ForceDeleteWithoutRecovery option in the same API call. The default value is 30.
source
Main.Quicksight.delete_dashboardMethod
delete_dashboard(aws_account_id, dashboard_id)
delete_dashboard(aws_account_id, dashboard_id, params::Dict{String,<:Any})

Deletes a dashboard.

Arguments

  • aws_account_id: The ID of the Amazon Web Services account that contains the dashboard that you're deleting.
  • dashboard_id: The ID for the dashboard.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "version-number": The version number of the dashboard. If the version number property is provided, only the specified version of the dashboard is deleted.
source
Main.Quicksight.delete_data_setMethod
delete_data_set(aws_account_id, data_set_id)
delete_data_set(aws_account_id, data_set_id, params::Dict{String,<:Any})

Deletes a dataset.

Arguments

  • aws_account_id: The Amazon Web Services account ID.
  • data_set_id: The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
source
Main.Quicksight.delete_data_sourceMethod
delete_data_source(aws_account_id, data_source_id)
delete_data_source(aws_account_id, data_source_id, params::Dict{String,<:Any})

Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.

Arguments

  • aws_account_id: The Amazon Web Services account ID.
  • data_source_id: The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
source
Main.Quicksight.delete_folderMethod
delete_folder(aws_account_id, folder_id)
delete_folder(aws_account_id, folder_id, params::Dict{String,<:Any})

Deletes an empty folder.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that contains the folder.
  • folder_id: The ID of the folder.
source
Main.Quicksight.delete_folder_membershipMethod
delete_folder_membership(aws_account_id, folder_id, member_id, member_type)
delete_folder_membership(aws_account_id, folder_id, member_id, member_type, params::Dict{String,<:Any})

Removes an asset, such as a dashboard, analysis, or dataset, from a folder.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that contains the folder.
  • folder_id: The Folder ID.
  • member_id: The ID of the asset (the dashboard, analysis, or dataset) that you want to delete.
  • member_type: The type of the member, including DASHBOARD, ANALYSIS, and DATASET
source
Main.Quicksight.delete_groupMethod
delete_group(aws_account_id, group_name, namespace)
delete_group(aws_account_id, group_name, namespace, params::Dict{String,<:Any})

Removes a user group from Amazon QuickSight.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  • group_name: The name of the group that you want to delete.
  • namespace: The namespace of the group that you want to delete.
source
Main.Quicksight.delete_group_membershipMethod
delete_group_membership(aws_account_id, group_name, member_name, namespace)
delete_group_membership(aws_account_id, group_name, member_name, namespace, params::Dict{String,<:Any})

Removes a user from a group so that the user is no longer a member of the group.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  • group_name: The name of the group that you want to delete the user from.
  • member_name: The name of the user that you want to delete from the group membership.
  • namespace: The namespace of the group that you want to remove a user from.
source
Main.Quicksight.delete_iampolicy_assignmentMethod
delete_iampolicy_assignment(assignment_name, aws_account_id, namespace)
delete_iampolicy_assignment(assignment_name, aws_account_id, namespace, params::Dict{String,<:Any})

Deletes an existing IAM policy assignment.

Arguments

  • assignment_name: The name of the assignment.
  • aws_account_id: The Amazon Web Services account ID where you want to delete the IAM policy assignment.
  • namespace: The namespace that contains the assignment.
source
Main.Quicksight.delete_namespaceMethod
delete_namespace(aws_account_id, namespace)
delete_namespace(aws_account_id, namespace, params::Dict{String,<:Any})

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.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that you want to delete the Amazon QuickSight namespace from.
  • namespace: The namespace that you want to delete.
source
Main.Quicksight.delete_templateMethod
delete_template(aws_account_id, template_id)
delete_template(aws_account_id, template_id, params::Dict{String,<:Any})

Deletes a template.

Arguments

  • aws_account_id: The ID of the Amazon Web Services account that contains the template that you're deleting.
  • template_id: An ID for the template you want to delete.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "version-number": Specifies the version of the template that you want to delete. If you don't provide a version number, DeleteTemplate deletes all versions of the template.
source
Main.Quicksight.delete_template_aliasMethod
delete_template_alias(alias_name, aws_account_id, template_id)
delete_template_alias(alias_name, aws_account_id, template_id, params::Dict{String,<:Any})

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.

Arguments

  • alias_name: The name for the template alias. To delete a specific alias, you delete the version that the alias points to. You can specify the alias name, or specify the latest version of the template by providing the keyword LATEST in the AliasName parameter.
  • aws_account_id: The ID of the Amazon Web Services account that contains the item to delete.
  • template_id: The ID for the template that the specified alias is for.
source
Main.Quicksight.delete_themeMethod
delete_theme(aws_account_id, theme_id)
delete_theme(aws_account_id, theme_id, params::Dict{String,<:Any})

Deletes a theme.

Arguments

  • aws_account_id: The ID of the Amazon Web Services account that contains the theme that you're deleting.
  • theme_id: An ID for the theme that you want to delete.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "version-number": The version of the theme that you want to delete. Note: If you don't provide a version number, you're using this call to DeleteTheme to delete all versions of the theme.
source
Main.Quicksight.delete_theme_aliasMethod
delete_theme_alias(alias_name, aws_account_id, theme_id)
delete_theme_alias(alias_name, aws_account_id, theme_id, params::Dict{String,<:Any})

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.

Arguments

  • alias_name: The unique name for the theme alias to delete.
  • aws_account_id: The ID of the Amazon Web Services account that contains the theme alias to delete.
  • theme_id: The ID for the theme that the specified alias is for.
source
Main.Quicksight.delete_userMethod
delete_user(aws_account_id, namespace, user_name)
delete_user(aws_account_id, namespace, user_name, params::Dict{String,<:Any})

Deletes the Amazon QuickSight user that is associated with the identity of the Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  • namespace: The namespace. Currently, you should set this to default.
  • user_name: The name of the user that you want to delete.
source
Main.Quicksight.delete_user_by_principal_idMethod
delete_user_by_principal_id(aws_account_id, namespace, principal_id)
delete_user_by_principal_id(aws_account_id, namespace, principal_id, params::Dict{String,<:Any})

Deletes a user identified by its principal ID.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  • namespace: The namespace. Currently, you should set this to default.
  • principal_id: The principal ID of the user.
source
Main.Quicksight.describe_account_customizationMethod
describe_account_customization(aws_account_id)
describe_account_customization(aws_account_id, params::Dict{String,<:Any})

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 the CreateAccountCustomization command in each Amazon Web Services Region where you want to apply the same customizations.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that you want to describe Amazon QuickSight customizations for.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "namespace": The Amazon QuickSight namespace that you want to describe Amazon QuickSight customizations for.
  • "resolved": The Resolved flag works with the other parameters to determine which view of Amazon QuickSight customizations is returned. You can add this flag to your command to use the same view that Amazon QuickSight uses to identify which customizations to apply to the console. Omit this flag, or set it to no-resolved, to reveal customizations that are configured at different levels.
source
Main.Quicksight.describe_account_settingsMethod
describe_account_settings(aws_account_id)
describe_account_settings(aws_account_id, params::Dict{String,<:Any})

Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that contains the settings that you want to list.
source
Main.Quicksight.describe_account_subscriptionMethod
describe_account_subscription(aws_account_id)
describe_account_subscription(aws_account_id, params::Dict{String,<:Any})

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.

Arguments

  • aws_account_id: The Amazon Web Services account ID associated with your Amazon QuickSight account.
source
Main.Quicksight.describe_analysisMethod
describe_analysis(analysis_id, aws_account_id)
describe_analysis(analysis_id, aws_account_id, params::Dict{String,<:Any})

Provides a summary of the metadata for an analysis.

Arguments

  • analysis_id: The ID of the analysis that you're describing. The ID is part of the URL of the analysis.
  • aws_account_id: The ID of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.
source
Main.Quicksight.describe_analysis_definitionMethod
describe_analysis_definition(analysis_id, aws_account_id)
describe_analysis_definition(analysis_id, aws_account_id, params::Dict{String,<:Any})

Provides a detailed description of the definition of an analysis. If you do not need to know details about the content of an Analysis, for instance if you are trying to check the status of a recently created or updated Analysis, use the DescribeAnalysis instead.

Arguments

  • analysis_id: The ID of the analysis that you're describing. The ID is part of the URL of the analysis.
  • aws_account_id: The ID of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.
source
Main.Quicksight.describe_analysis_permissionsMethod
describe_analysis_permissions(analysis_id, aws_account_id)
describe_analysis_permissions(analysis_id, aws_account_id, params::Dict{String,<:Any})

Provides the read and write permissions for an analysis.

Arguments

  • analysis_id: The ID of the analysis whose permissions you're describing. The ID is part of the analysis URL.
  • aws_account_id: The ID of the Amazon Web Services account that contains the analysis whose permissions you're describing. You must be using the Amazon Web Services account that the analysis is in.
source
Main.Quicksight.describe_dashboardMethod
describe_dashboard(aws_account_id, dashboard_id)
describe_dashboard(aws_account_id, dashboard_id, params::Dict{String,<:Any})

Provides a summary for a dashboard.

Arguments

  • aws_account_id: The ID of the Amazon Web Services account that contains the dashboard that you're describing.
  • dashboard_id: The ID for the dashboard.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "alias-name": The alias name.
  • "version-number": The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.
source
Main.Quicksight.describe_dashboard_definitionMethod
describe_dashboard_definition(aws_account_id, dashboard_id)
describe_dashboard_definition(aws_account_id, dashboard_id, params::Dict{String,<:Any})

Provides a detailed description of the definition of a dashboard. If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the DescribeDashboard instead.

Arguments

  • aws_account_id: The ID of the Amazon Web Services account that contains the dashboard that you're describing.
  • dashboard_id: The ID for the dashboard.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "alias-name": The alias name.
  • "version-number": The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.
source
Main.Quicksight.describe_dashboard_permissionsMethod
describe_dashboard_permissions(aws_account_id, dashboard_id)
describe_dashboard_permissions(aws_account_id, dashboard_id, params::Dict{String,<:Any})

Describes read and write permissions for a dashboard.

Arguments

  • aws_account_id: The ID of the Amazon Web Services account that contains the dashboard that you're describing permissions for.
  • dashboard_id: The ID for the dashboard, also added to the IAM policy.
source
Main.Quicksight.describe_data_setMethod
describe_data_set(aws_account_id, data_set_id)
describe_data_set(aws_account_id, data_set_id, params::Dict{String,<:Any})

Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.

Arguments

  • aws_account_id: The Amazon Web Services account ID.
  • data_set_id: The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
source
Main.Quicksight.describe_data_set_permissionsMethod
describe_data_set_permissions(aws_account_id, data_set_id)
describe_data_set_permissions(aws_account_id, data_set_id, params::Dict{String,<:Any})

Describes the permissions on a dataset. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.

Arguments

  • aws_account_id: The Amazon Web Services account ID.
  • data_set_id: The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
source
Main.Quicksight.describe_data_sourceMethod
describe_data_source(aws_account_id, data_source_id)
describe_data_source(aws_account_id, data_source_id, params::Dict{String,<:Any})

Describes a data source.

Arguments

  • aws_account_id: The Amazon Web Services account ID.
  • data_source_id: The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
source
Main.Quicksight.describe_data_source_permissionsMethod
describe_data_source_permissions(aws_account_id, data_source_id)
describe_data_source_permissions(aws_account_id, data_source_id, params::Dict{String,<:Any})

Describes the resource permissions for a data source.

Arguments

  • aws_account_id: The Amazon Web Services account ID.
  • data_source_id: The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
source
Main.Quicksight.describe_folderMethod
describe_folder(aws_account_id, folder_id)
describe_folder(aws_account_id, folder_id, params::Dict{String,<:Any})

Describes a folder.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that contains the folder.
  • folder_id: The ID of the folder.
source
Main.Quicksight.describe_folder_permissionsMethod
describe_folder_permissions(aws_account_id, folder_id)
describe_folder_permissions(aws_account_id, folder_id, params::Dict{String,<:Any})

Describes permissions for a folder.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that contains the folder.
  • folder_id: The ID of the folder.
source
Main.Quicksight.describe_folder_resolved_permissionsMethod
describe_folder_resolved_permissions(aws_account_id, folder_id)
describe_folder_resolved_permissions(aws_account_id, folder_id, params::Dict{String,<:Any})

Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that contains the folder.
  • folder_id: The ID of the folder.
source
Main.Quicksight.describe_groupMethod
describe_group(aws_account_id, group_name, namespace)
describe_group(aws_account_id, group_name, namespace, params::Dict{String,<:Any})

Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  • group_name: The name of the group that you want to describe.
  • namespace: The namespace of the group that you want described.
source
Main.Quicksight.describe_group_membershipMethod
describe_group_membership(aws_account_id, group_name, member_name, namespace)
describe_group_membership(aws_account_id, group_name, member_name, namespace, params::Dict{String,<:Any})

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.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  • group_name: The name of the group that you want to search.
  • member_name: The user name of the user that you want to search for.
  • namespace: The namespace that includes the group you are searching within.
source
Main.Quicksight.describe_iampolicy_assignmentMethod
describe_iampolicy_assignment(assignment_name, aws_account_id, namespace)
describe_iampolicy_assignment(assignment_name, aws_account_id, namespace, params::Dict{String,<:Any})

Describes an existing IAM policy assignment, as specified by the assignment name.

Arguments

  • assignment_name: The name of the assignment, also called a rule.
  • aws_account_id: The ID of the Amazon Web Services account that contains the assignment that you want to describe.
  • namespace: The namespace that contains the assignment.
source
Main.Quicksight.describe_ingestionMethod
describe_ingestion(aws_account_id, data_set_id, ingestion_id)
describe_ingestion(aws_account_id, data_set_id, ingestion_id, params::Dict{String,<:Any})

Describes a SPICE ingestion.

Arguments

  • aws_account_id: The Amazon Web Services account ID.
  • data_set_id: The ID of the dataset used in the ingestion.
  • ingestion_id: An ID for the ingestion.
source
Main.Quicksight.describe_ip_restrictionMethod
describe_ip_restriction(aws_account_id)
describe_ip_restriction(aws_account_id, params::Dict{String,<:Any})

Provides a summary and status of IP rules.

Arguments

  • aws_account_id: The ID of the Amazon Web Services account that contains the IP rules.
source
Main.Quicksight.describe_namespaceMethod
describe_namespace(aws_account_id, namespace)
describe_namespace(aws_account_id, namespace, params::Dict{String,<:Any})

Describes the current namespace.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that contains the Amazon QuickSight namespace that you want to describe.
  • namespace: The namespace that you want to describe.
source
Main.Quicksight.describe_templateMethod
describe_template(aws_account_id, template_id)
describe_template(aws_account_id, template_id, params::Dict{String,<:Any})

Describes a template's metadata.

Arguments

  • aws_account_id: The ID of the Amazon Web Services account that contains the template that you're describing.
  • template_id: The ID for the template.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "alias-name": The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword LATEST in the AliasName parameter. The keyword PUBLISHED doesn't apply to templates.
  • "version-number": (Optional) The number for the version to describe. If a VersionNumber parameter value isn't provided, the latest version of the template is described.
source
Main.Quicksight.describe_template_aliasMethod
describe_template_alias(alias_name, aws_account_id, template_id)
describe_template_alias(alias_name, aws_account_id, template_id, params::Dict{String,<:Any})

Describes the template alias for a template.

Arguments

  • alias_name: The name of the template alias that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword LATEST in the AliasName parameter. The keyword PUBLISHED doesn't apply to templates.
  • aws_account_id: The ID of the Amazon Web Services account that contains the template alias that you're describing.
  • template_id: The ID for the template.
source
Main.Quicksight.describe_template_definitionMethod
describe_template_definition(aws_account_id, template_id)
describe_template_definition(aws_account_id, template_id, params::Dict{String,<:Any})

Provides a detailed description of the definition of a template. If you do not need to know details about the content of a template, for instance if you are trying to check the status of a recently created or updated template, use the DescribeTemplate instead.

Arguments

  • aws_account_id: The ID of the Amazon Web Services account that contains the template. You must be using the Amazon Web Services account that the template is in.
  • template_id: The ID of the template that you're describing.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "alias-name": The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword LATEST in the AliasName parameter. The keyword PUBLISHED doesn't apply to templates.
  • "version-number": The version number of the template.
source
Main.Quicksight.describe_template_permissionsMethod
describe_template_permissions(aws_account_id, template_id)
describe_template_permissions(aws_account_id, template_id, params::Dict{String,<:Any})

Describes read and write permissions on a template.

Arguments

  • aws_account_id: The ID of the Amazon Web Services account that contains the template that you're describing.
  • template_id: The ID for the template.
source
Main.Quicksight.describe_themeMethod
describe_theme(aws_account_id, theme_id)
describe_theme(aws_account_id, theme_id, params::Dict{String,<:Any})

Describes a theme.

Arguments

  • aws_account_id: The ID of the Amazon Web Services account that contains the theme that you're describing.
  • theme_id: The ID for the theme.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "alias-name": The alias of the theme that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the theme by providing the keyword LATEST in the AliasName parameter. The keyword PUBLISHED doesn't apply to themes.
  • "version-number": The version number for the version to describe. If a VersionNumber parameter value isn't provided, the latest version of the theme is described.
source
Main.Quicksight.describe_theme_aliasMethod
describe_theme_alias(alias_name, aws_account_id, theme_id)
describe_theme_alias(alias_name, aws_account_id, theme_id, params::Dict{String,<:Any})

Describes the alias for a theme.

Arguments

  • alias_name: The name of the theme alias that you want to describe.
  • aws_account_id: The ID of the Amazon Web Services account that contains the theme alias that you're describing.
  • theme_id: The ID for the theme.
source
Main.Quicksight.describe_theme_permissionsMethod
describe_theme_permissions(aws_account_id, theme_id)
describe_theme_permissions(aws_account_id, theme_id, params::Dict{String,<:Any})

Describes the read and write permissions for a theme.

Arguments

  • aws_account_id: The ID of the Amazon Web Services account that contains the theme that you're describing.
  • theme_id: The ID for the theme that you want to describe permissions for.
source
Main.Quicksight.describe_userMethod
describe_user(aws_account_id, namespace, user_name)
describe_user(aws_account_id, namespace, user_name, params::Dict{String,<:Any})

Returns information about a user, given the user name.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  • namespace: The namespace. Currently, you should set this to default.
  • user_name: The name of the user that you want to describe.
source
Main.Quicksight.generate_embed_url_for_anonymous_userMethod
generate_embed_url_for_anonymous_user(authorized_resource_arns, aws_account_id, experience_configuration, namespace)
generate_embed_url_for_anonymous_user(authorized_resource_arns, aws_account_id, experience_configuration, namespace, params::Dict{String,<:Any})

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.

Arguments

  • authorized_resource_arns: The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user is authorized to access during the lifetime of the session. If you choose Dashboard embedding experience, pass the list of dashboard ARNs in the account that you want the user to be able to view. Currently, you can pass up to 25 dashboard ARNs in each API call.
  • aws_account_id: The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
  • experience_configuration: The configuration of the experience that you are embedding.
  • namespace: The Amazon QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon QuickSight custom namespace, set this to default.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AllowedDomains": The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call. To include all subdomains under a specific domain to the allow list, use . For example, https://.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.
  • "SessionLifetimeInMinutes": How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.
  • "SessionTags": The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the DataSetRowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security. These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.
source
Main.Quicksight.generate_embed_url_for_registered_userMethod
generate_embed_url_for_registered_user(aws_account_id, experience_configuration, user_arn)
generate_embed_url_for_registered_user(aws_account_id, experience_configuration, user_arn, params::Dict{String,<:Any})

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.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
  • experience_configuration: The experience you are embedding. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, or the entire Amazon QuickSight console.
  • user_arn: The Amazon Resource Name for the registered user.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AllowedDomains": The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call. To include all subdomains under a specific domain to the allow list, use . For example, https://.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.
  • "SessionLifetimeInMinutes": How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.
source
Main.Quicksight.get_dashboard_embed_urlMethod
get_dashboard_embed_url(aws_account_id, dashboard_id, creds-type)
get_dashboard_embed_url(aws_account_id, dashboard_id, creds-type, params::Dict{String,<:Any})

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.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
  • dashboard_id: The ID for the dashboard, also added to the Identity and Access Management (IAM) policy.
  • creds-type: The authentication method that the user uses to sign in.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "additional-dashboard-ids": A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the IdentityType parameter must be set to ANONYMOUS because other identity types authenticate as Amazon QuickSight or IAM users. For example, if you set "–dashboard-id dashid1 –dashboard-id dashid2 dash_id3 identity-type ANONYMOUS", the session can access all three dashboards.
  • "namespace": The Amazon QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set Namespace = default.
  • "reset-disabled": Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.
  • "session-lifetime": How many minutes the session is valid. The session lifetime must be 15-600 minutes.
  • "state-persistence-enabled": Adds persistence of state for the user session in an embedded dashboard. Persistence applies to the sheet and the parameter settings. These are control settings that the dashboard subscriber (Amazon QuickSight reader) chooses while viewing the dashboard. If this is set to TRUE, the settings are the same when the subscriber reopens the same dashboard URL. The state is stored in Amazon QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default is FALSE.
  • "undo-redo-disabled": Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.
  • "user-arn": The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following: Active Directory (AD) users or group members Invited nonfederated users IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation. Omit this parameter for users in the third group – IAM users and IAM role-based sessions.
source
Main.Quicksight.get_session_embed_urlMethod
get_session_embed_url(aws_account_id)
get_session_embed_url(aws_account_id, params::Dict{String,<:Any})

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: Embedding Analytics Customizing Access to the Amazon QuickSight Console

Arguments

  • aws_account_id: The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "entry-point": The URL you use to access the embedded session. The entry point URL is constrained to the following paths: /start /start/analyses /start/dashboards /start/favorites /dashboards/DashboardId - where DashboardId is the actual ID key from the Amazon QuickSight console URL of the dashboard /analyses/AnalysisId - where AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis
  • "session-lifetime": How many minutes the session is valid. The session lifetime must be 15-600 minutes.
  • "user-arn": The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any type of Amazon QuickSight users in your account (readers, authors, or admins). They need to be authenticated as one of the following: Active Directory (AD) users or group members Invited nonfederated users Identity and Access Management (IAM) users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation Omit this parameter for users in the third group, IAM users and IAM role-based sessions.
source
Main.Quicksight.list_analysesMethod
list_analyses(aws_account_id)
list_analyses(aws_account_id, params::Dict{String,<:Any})

Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.

Arguments

  • aws_account_id: The ID of the Amazon Web Services account that contains the analyses.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of results to return.
  • "next-token": A pagination token that can be used in a subsequent request.
source
Main.Quicksight.list_dashboard_versionsMethod
list_dashboard_versions(aws_account_id, dashboard_id)
list_dashboard_versions(aws_account_id, dashboard_id, params::Dict{String,<:Any})

Lists all the versions of the dashboards in the Amazon QuickSight subscription.

Arguments

  • aws_account_id: The ID of the Amazon Web Services account that contains the dashboard that you're listing versions for.
  • dashboard_id: The ID for the dashboard.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of results to be returned per request.
  • "next-token": The token for the next set of results, or null if there are no more results.
source
Main.Quicksight.list_dashboardsMethod
list_dashboards(aws_account_id)
list_dashboards(aws_account_id, params::Dict{String,<:Any})

Lists dashboards in an Amazon Web Services account.

Arguments

  • aws_account_id: The ID of the Amazon Web Services account that contains the dashboards that you're listing.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of results to be returned per request.
  • "next-token": The token for the next set of results, or null if there are no more results.
source
Main.Quicksight.list_data_setsMethod
list_data_sets(aws_account_id)
list_data_sets(aws_account_id, params::Dict{String,<:Any})

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/*.

Arguments

  • aws_account_id: The Amazon Web Services account ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of results to be returned per request.
  • "next-token": The token for the next set of results, or null if there are no more results.
source
Main.Quicksight.list_data_sourcesMethod
list_data_sources(aws_account_id)
list_data_sources(aws_account_id, params::Dict{String,<:Any})

Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.

Arguments

  • aws_account_id: The Amazon Web Services account ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of results to be returned per request.
  • "next-token": The token for the next set of results, or null if there are no more results.
source
Main.Quicksight.list_folder_membersMethod
list_folder_members(aws_account_id, folder_id)
list_folder_members(aws_account_id, folder_id, params::Dict{String,<:Any})

List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that contains the folder.
  • folder_id: The ID of the folder.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of results to be returned per request.
  • "next-token": The token for the next set of results, or null if there are no more results.
source
Main.Quicksight.list_foldersMethod
list_folders(aws_account_id)
list_folders(aws_account_id, params::Dict{String,<:Any})

Lists all folders in an account.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that contains the folder.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of results to be returned per request.
  • "next-token": The token for the next set of results, or null if there are no more results.
source
Main.Quicksight.list_group_membershipsMethod
list_group_memberships(aws_account_id, group_name, namespace)
list_group_memberships(aws_account_id, group_name, namespace, params::Dict{String,<:Any})

Lists member users in a group.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  • group_name: The name of the group that you want to see a membership list of.
  • namespace: The namespace of the group that you want a list of users from.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of results to return from this request.
  • "next-token": A pagination token that can be used in a subsequent request.
source
Main.Quicksight.list_groupsMethod
list_groups(aws_account_id, namespace)
list_groups(aws_account_id, namespace, params::Dict{String,<:Any})

Lists all user groups in Amazon QuickSight.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  • namespace: The namespace that you want a list of groups from.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of results to return.
  • "next-token": A pagination token that can be used in a subsequent request.
source
Main.Quicksight.list_iampolicy_assignmentsMethod
list_iampolicy_assignments(aws_account_id, namespace)
list_iampolicy_assignments(aws_account_id, namespace, params::Dict{String,<:Any})

Lists IAM policy assignments in the current Amazon QuickSight account.

Arguments

  • aws_account_id: The ID of the Amazon Web Services account that contains these IAM policy assignments.
  • namespace: The namespace for the assignments.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AssignmentStatus": The status of the assignments.
  • "max-results": The maximum number of results to be returned per request.
  • "next-token": The token for the next set of results, or null if there are no more results.
source
Main.Quicksight.list_iampolicy_assignments_for_userMethod
list_iampolicy_assignments_for_user(aws_account_id, namespace, user_name)
list_iampolicy_assignments_for_user(aws_account_id, namespace, user_name, params::Dict{String,<:Any})

Lists all 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.

Arguments

  • aws_account_id: The ID of the Amazon Web Services account that contains the assignments.
  • namespace: The namespace of the assignment.
  • user_name: The name of the user.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of results to be returned per request.
  • "next-token": The token for the next set of results, or null if there are no more results.
source
Main.Quicksight.list_ingestionsMethod
list_ingestions(aws_account_id, data_set_id)
list_ingestions(aws_account_id, data_set_id, params::Dict{String,<:Any})

Lists the history of SPICE ingestions for a dataset.

Arguments

  • aws_account_id: The Amazon Web Services account ID.
  • data_set_id: The ID of the dataset used in the ingestion.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of results to be returned per request.
  • "next-token": The token for the next set of results, or null if there are no more results.
source
Main.Quicksight.list_namespacesMethod
list_namespaces(aws_account_id)
list_namespaces(aws_account_id, params::Dict{String,<:Any})

Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that contains the Amazon QuickSight namespaces that you want to list.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of results to return.
  • "next-token": A unique pagination token that can be used in a subsequent request. You will receive a pagination token in the response body of a previous ListNameSpaces API call if there is more data that can be returned. To receive the data, make another ListNamespaces API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a ListNamespaces API call with an expired token, you will receive a HTTP 400 InvalidNextTokenException error.
source
Main.Quicksight.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

Lists the tags assigned to a resource.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the resource that you want a list of tags for.
source
Main.Quicksight.list_template_aliasesMethod
list_template_aliases(aws_account_id, template_id)
list_template_aliases(aws_account_id, template_id, params::Dict{String,<:Any})

Lists all the aliases of a template.

Arguments

  • aws_account_id: The ID of the Amazon Web Services account that contains the template aliases that you're listing.
  • template_id: The ID for the template.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-result": The maximum number of results to be returned per request.
  • "next-token": The token for the next set of results, or null if there are no more results.
source
Main.Quicksight.list_template_versionsMethod
list_template_versions(aws_account_id, template_id)
list_template_versions(aws_account_id, template_id, params::Dict{String,<:Any})

Lists all the versions of the templates in the current Amazon QuickSight account.

Arguments

  • aws_account_id: The ID of the Amazon Web Services account that contains the templates that you're listing.
  • template_id: The ID for the template.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of results to be returned per request.
  • "next-token": The token for the next set of results, or null if there are no more results.
source
Main.Quicksight.list_templatesMethod
list_templates(aws_account_id)
list_templates(aws_account_id, params::Dict{String,<:Any})

Lists all the templates in the current Amazon QuickSight account.

Arguments

  • aws_account_id: The ID of the Amazon Web Services account that contains the templates that you're listing.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-result": The maximum number of results to be returned per request.
  • "next-token": The token for the next set of results, or null if there are no more results.
source
Main.Quicksight.list_theme_aliasesMethod
list_theme_aliases(aws_account_id, theme_id)
list_theme_aliases(aws_account_id, theme_id, params::Dict{String,<:Any})

Lists all the aliases of a theme.

Arguments

  • aws_account_id: The ID of the Amazon Web Services account that contains the theme aliases that you're listing.
  • theme_id: The ID for the theme.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-result": The maximum number of results to be returned per request.
  • "next-token": The token for the next set of results, or null if there are no more results.
source
Main.Quicksight.list_theme_versionsMethod
list_theme_versions(aws_account_id, theme_id)
list_theme_versions(aws_account_id, theme_id, params::Dict{String,<:Any})

Lists all the versions of the themes in the current Amazon Web Services account.

Arguments

  • aws_account_id: The ID of the Amazon Web Services account that contains the themes that you're listing.
  • theme_id: The ID for the theme.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of results to be returned per request.
  • "next-token": The token for the next set of results, or null if there are no more results.
source
Main.Quicksight.list_themesMethod
list_themes(aws_account_id)
list_themes(aws_account_id, params::Dict{String,<:Any})

Lists all the themes in the current Amazon Web Services account.

Arguments

  • aws_account_id: The ID of the Amazon Web Services account that contains the themes that you're listing.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of results to be returned per request.
  • "next-token": The token for the next set of results, or null if there are no more results.
  • "type": The type of themes that you want to list. Valid options include the following: ALL (default)- Display all existing themes. CUSTOM - Display only the themes created by people using Amazon QuickSight. QUICKSIGHT - Display only the starting themes defined by Amazon QuickSight.
source
Main.Quicksight.list_user_groupsMethod
list_user_groups(aws_account_id, namespace, user_name)
list_user_groups(aws_account_id, namespace, user_name, params::Dict{String,<:Any})

Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.

Arguments

  • aws_account_id: The Amazon Web Services account ID that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  • namespace: The namespace. Currently, you should set this to default.
  • user_name: The Amazon QuickSight user name that you want to list group memberships for.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of results to return from this request.
  • "next-token": A pagination token that can be used in a subsequent request.
source
Main.Quicksight.list_usersMethod
list_users(aws_account_id, namespace)
list_users(aws_account_id, namespace, params::Dict{String,<:Any})

Returns a list of all of the Amazon QuickSight users belonging to this account.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  • namespace: The namespace. Currently, you should set this to default.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of results to return from this request.
  • "next-token": A pagination token that can be used in a subsequent request.
source
Main.Quicksight.register_userMethod
register_user(aws_account_id, email, identity_type, namespace, user_role)
register_user(aws_account_id, email, identity_type, namespace, user_role, params::Dict{String,<:Any})

Creates an Amazon QuickSight user, whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  • email: The email address of the user that you want to register.
  • identity_type: Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values: IAM: A user whose identity maps to an existing IAM user or role. QUICKSIGHT: A user whose identity is owned and managed internally by Amazon QuickSight.
  • namespace: The namespace. Currently, you should set this to default.
  • user_role: The Amazon QuickSight role for the user. The user role can be one of the following: READER: A user who has read-only access to dashboards. AUTHOR: A user who can create data sources, datasets, analyses, and dashboards. ADMIN: A user who is an author, who can also manage Amazon QuickSight settings. RESTRICTEDREADER: This role isn't currently available for use. RESTRICTEDAUTHOR: This role isn't currently available for use.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "CustomFederationProviderUrl": The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.
  • "CustomPermissionsName": (Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations: Create and update data sources Create and update datasets Create and update email reports Subscribe to email reports To add custom permissions to an existing user, use UpdateUser instead. A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the Amazon QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Amazon QuickSight user. Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Amazon QuickSight users to one of the default security cohorts in Amazon QuickSight (admin, author, reader). This feature is available only to Amazon QuickSight Enterprise edition subscriptions.
  • "ExternalLoginFederationProviderType": The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following. COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom. CUSTOMOIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOMOIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.
  • "ExternalLoginId": The identity ID for a user in the external login provider.
  • "IamArn": The ARN of the IAM user or role that you are registering with Amazon QuickSight.
  • "SessionName": You need to use this parameter only when you register one or more users using an assumed IAM role. You don't need to provide the session name for other scenarios, for example when you are registering an IAM user or an Amazon QuickSight user. You can register multiple users using the same IAM role if each user has a different session name. For more information on assuming IAM roles, see assume-role in the CLI Reference.
  • "UserName": The Amazon QuickSight user name that you want to create for the user you are registering.
source
Main.Quicksight.restore_analysisMethod
restore_analysis(analysis_id, aws_account_id)
restore_analysis(analysis_id, aws_account_id, params::Dict{String,<:Any})

Restores an analysis.

Arguments

  • analysis_id: The ID of the analysis that you're restoring.
  • aws_account_id: The ID of the Amazon Web Services account that contains the analysis.
source
Main.Quicksight.search_analysesMethod
search_analyses(aws_account_id, filters)
search_analyses(aws_account_id, filters, params::Dict{String,<:Any})

Searches for analyses that belong to the user specified in the filter. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

Arguments

  • aws_account_id: The ID of the Amazon Web Services account that contains the analyses that you're searching for.
  • filters: The structure for the search filters that you want to apply to your search.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to return.
  • "NextToken": A pagination token that can be used in a subsequent request.
source
Main.Quicksight.search_dashboardsMethod
search_dashboards(aws_account_id, filters)
search_dashboards(aws_account_id, filters, params::Dict{String,<:Any})

Searches for dashboards that belong to a user. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

Arguments

  • aws_account_id: The ID of the Amazon Web Services account that contains the user whose dashboards you're searching for.
  • filters: The filters to apply to the search. Currently, you can search only by user name, for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to be returned per request.
  • "NextToken": The token for the next set of results, or null if there are no more results.
source
Main.Quicksight.search_data_setsMethod
search_data_sets(aws_account_id, filters)
search_data_sets(aws_account_id, filters, params::Dict{String,<:Any})

Use the SearchDataSets operation to search for datasets that belong to an account.

Arguments

  • aws_account_id: The Amazon Web Services account ID.
  • filters: The filters to apply to the search.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to be returned per request.
  • "NextToken": A pagination token that can be used in a subsequent request.
source
Main.Quicksight.search_data_sourcesMethod
search_data_sources(aws_account_id, filters)
search_data_sources(aws_account_id, filters, params::Dict{String,<:Any})

Use the SearchDataSources operation to search for data sources that belong to an account.

Arguments

  • aws_account_id: The Amazon Web Services account ID.
  • filters: The filters to apply to the search.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to be returned per request.
  • "NextToken": A pagination token that can be used in a subsequent request.
source
Main.Quicksight.search_foldersMethod
search_folders(aws_account_id, filters)
search_folders(aws_account_id, filters, params::Dict{String,<:Any})

Searches the subfolders in a folder.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that contains the folder.
  • filters: The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example, "Filters": [ { "Name": "PARENTFOLDERARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" } ].

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to be returned per request.
  • "NextToken": The token for the next set of results, or null if there are no more results.
source
Main.Quicksight.search_groupsMethod
search_groups(aws_account_id, filters, namespace)
search_groups(aws_account_id, filters, namespace, params::Dict{String,<:Any})

Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  • filters: The structure for the search filters that you want to apply to your search.
  • namespace: The namespace that you want to search.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of results to return from this request.
  • "next-token": A pagination token that can be used in a subsequent request.
source
Main.Quicksight.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

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, and template. Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for the following: You can't use tags to track costs for Amazon QuickSight. This isn't possible because you can't tag the resources that Amazon QuickSight costs are based on, for example Amazon QuickSight storage capacity (SPICE), number of users, type of users, and usage metrics. Amazon QuickSight doesn't currently support the tag editor for Resource Groups.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the resource that you want to tag.
  • tags: Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
source
Main.Quicksight.untag_resourceMethod
untag_resource(resource_arn, keys)
untag_resource(resource_arn, keys, params::Dict{String,<:Any})

Removes a tag or tags from a resource.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the resource that you want to untag.
  • keys: The keys of the key-value pairs for the resource tag or tags assigned to the resource.
source
Main.Quicksight.update_account_customizationMethod
update_account_customization(account_customization, aws_account_id)
update_account_customization(account_customization, aws_account_id, params::Dict{String,<:Any})

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.

Arguments

  • account_customization: The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.
  • aws_account_id: The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations for.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "namespace": The namespace that you want to update Amazon QuickSight customizations for.
source
Main.Quicksight.update_account_settingsMethod
update_account_settings(aws_account_id, default_namespace)
update_account_settings(aws_account_id, default_namespace, params::Dict{String,<:Any})

Updates the Amazon QuickSight settings in your Amazon Web Services account.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that contains the Amazon QuickSight settings that you want to list.
  • default_namespace: The default namespace for this Amazon Web Services account. Currently, the default is default. Identity and Access Management (IAM) users that register for the first time with Amazon QuickSight provide an email address that becomes associated with the default namespace.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "NotificationEmail": The email address that you want Amazon QuickSight to send notifications to regarding your Amazon Web Services account or Amazon QuickSight subscription.
  • "TerminationProtectionEnabled": A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A True value doesn't allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubscription request. A False value will allow the account to be deleted.
source
Main.Quicksight.update_analysisMethod
update_analysis(analysis_id, aws_account_id, name)
update_analysis(analysis_id, aws_account_id, name, params::Dict{String,<:Any})

Updates an analysis in Amazon QuickSight

Arguments

  • analysis_id: The ID for the analysis that you're updating. This ID displays in the URL of the analysis.
  • aws_account_id: The ID of the Amazon Web Services account that contains the analysis that you're updating.
  • name: A descriptive name for the analysis that you're updating. This name displays for the analysis in the Amazon QuickSight console.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Definition": The definition of an analysis. A definition is the data model of all features in a Dashboard, Template, or Analysis.
  • "Parameters": The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.
  • "SourceEntity": A source entity to use for the analysis that you're updating. This metadata structure contains details that describe a source template and one or more datasets.
  • "ThemeArn": The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.
source
Main.Quicksight.update_analysis_permissionsMethod
update_analysis_permissions(analysis_id, aws_account_id)
update_analysis_permissions(analysis_id, aws_account_id, params::Dict{String,<:Any})

Updates the read and write permissions for an analysis.

Arguments

  • analysis_id: The ID of the analysis whose permissions you're updating. The ID is part of the analysis URL.
  • aws_account_id: The ID of the Amazon Web Services account that contains the analysis whose permissions you're updating. You must be using the Amazon Web Services account that the analysis is in.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "GrantPermissions": A structure that describes the permissions to add and the principal to add them to.
  • "RevokePermissions": A structure that describes the permissions to remove and the principal to remove them from.
source
Main.Quicksight.update_dashboardMethod
update_dashboard(aws_account_id, dashboard_id, name)
update_dashboard(aws_account_id, dashboard_id, name, params::Dict{String,<:Any})

Updates a dashboard in an Amazon Web Services account. Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the UpdateDashboardPublishedVersion API operation.

Arguments

  • aws_account_id: The ID of the Amazon Web Services account that contains the dashboard that you're updating.
  • dashboard_id: The ID for the dashboard.
  • name: The display name of the dashboard.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "DashboardPublishOptions": Options for publishing the dashboard when you create it: AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default. AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default. VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.
  • "Definition": The definition of a dashboard. A definition is the data model of all features in a Dashboard, Template, or Analysis.
  • "Parameters": A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters, and some parameters might accept multiple values.
  • "SourceEntity": The entity that you are using as a source when you update the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a SourceTemplate entity. If you need to update a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region. Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
  • "ThemeArn": The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that was originally associated with the entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.
  • "VersionDescription": A description for the first version of the dashboard being created.
source
Main.Quicksight.update_dashboard_permissionsMethod
update_dashboard_permissions(aws_account_id, dashboard_id)
update_dashboard_permissions(aws_account_id, dashboard_id, params::Dict{String,<:Any})

Updates read and write permissions on a dashboard.

Arguments

  • aws_account_id: The ID of the Amazon Web Services account that contains the dashboard whose permissions you're updating.
  • dashboard_id: The ID for the dashboard.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "GrantLinkPermissions": Grants link permissions to all users in a defined namespace.
  • "GrantPermissions": The permissions that you want to grant on this resource.
  • "RevokeLinkPermissions": Revokes link permissions from all users in a defined namespace.
  • "RevokePermissions": The permissions that you want to revoke from this resource.
source
Main.Quicksight.update_dashboard_published_versionMethod
update_dashboard_published_version(aws_account_id, dashboard_id, version_number)
update_dashboard_published_version(aws_account_id, dashboard_id, version_number, params::Dict{String,<:Any})

Updates the published version of a dashboard.

Arguments

  • aws_account_id: The ID of the Amazon Web Services account that contains the dashboard that you're updating.
  • dashboard_id: The ID for the dashboard.
  • version_number: The version number of the dashboard.
source
Main.Quicksight.update_data_setMethod
update_data_set(aws_account_id, data_set_id, import_mode, name, physical_table_map)
update_data_set(aws_account_id, data_set_id, import_mode, name, physical_table_map, params::Dict{String,<:Any})

Updates a dataset. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation.

Arguments

  • aws_account_id: The Amazon Web Services account ID.
  • data_set_id: The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  • import_mode: Indicates whether you want to import the data into SPICE.
  • name: The display name for the dataset.
  • physical_table_map: Declares the physical tables that are available in the underlying data sources.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ColumnGroups": Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
  • "ColumnLevelPermissionRules": A set of one or more definitions of a ColumnLevelPermissionRule .
  • "DataSetUsageConfiguration":
  • "FieldFolders": The folder that contains fields and nested subfolders for your dataset.
  • "LogicalTableMap": Configures the combination and transformation of the data from the physical tables.
  • "RowLevelPermissionDataSet": The row-level security configuration for the data you want to create.
  • "RowLevelPermissionTagConfiguration": The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.
source
Main.Quicksight.update_data_set_permissionsMethod
update_data_set_permissions(aws_account_id, data_set_id)
update_data_set_permissions(aws_account_id, data_set_id, params::Dict{String,<:Any})

Updates the permissions on a dataset. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.

Arguments

  • aws_account_id: The Amazon Web Services account ID.
  • data_set_id: The ID for the dataset whose permissions you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "GrantPermissions": The resource permissions that you want to grant to the dataset.
  • "RevokePermissions": The resource permissions that you want to revoke from the dataset.
source
Main.Quicksight.update_data_sourceMethod
update_data_source(aws_account_id, data_source_id, name)
update_data_source(aws_account_id, data_source_id, name, params::Dict{String,<:Any})

Updates a data source.

Arguments

  • aws_account_id: The Amazon Web Services account ID.
  • data_source_id: The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  • name: A display name for the data source.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Credentials": The credentials that Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
  • "DataSourceParameters": The parameters that Amazon QuickSight uses to connect to your underlying source.
  • "SslProperties": Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
  • "VpcConnectionProperties": Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
source
Main.Quicksight.update_data_source_permissionsMethod
update_data_source_permissions(aws_account_id, data_source_id)
update_data_source_permissions(aws_account_id, data_source_id, params::Dict{String,<:Any})

Updates the permissions to a data source.

Arguments

  • aws_account_id: The Amazon Web Services account ID.
  • data_source_id: The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "GrantPermissions": A list of resource permissions that you want to grant on the data source.
  • "RevokePermissions": A list of resource permissions that you want to revoke on the data source.
source
Main.Quicksight.update_folderMethod
update_folder(aws_account_id, folder_id, name)
update_folder(aws_account_id, folder_id, name, params::Dict{String,<:Any})

Updates the name of a folder.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that contains the folder to update.
  • folder_id: The ID of the folder.
  • name: The name of the folder.
source
Main.Quicksight.update_folder_permissionsMethod
update_folder_permissions(aws_account_id, folder_id)
update_folder_permissions(aws_account_id, folder_id, params::Dict{String,<:Any})

Updates permissions of a folder.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that contains the folder to update.
  • folder_id: The ID of the folder.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "GrantPermissions": The permissions that you want to grant on a resource.
  • "RevokePermissions": The permissions that you want to revoke from a resource.
source
Main.Quicksight.update_groupMethod
update_group(aws_account_id, group_name, namespace)
update_group(aws_account_id, group_name, namespace, params::Dict{String,<:Any})

Changes a group description.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  • group_name: The name of the group that you want to update.
  • namespace: The namespace of the group that you want to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": The description for the group that you want to update.
source
Main.Quicksight.update_iampolicy_assignmentMethod
update_iampolicy_assignment(assignment_name, aws_account_id, namespace)
update_iampolicy_assignment(assignment_name, aws_account_id, namespace, params::Dict{String,<:Any})

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.

Arguments

  • assignment_name: The name of the assignment, also called a rule. This name must be unique within an Amazon Web Services account.
  • aws_account_id: The ID of the Amazon Web Services account that contains the IAM policy assignment.
  • namespace: The namespace of the assignment.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AssignmentStatus": The status of the assignment. Possible values are as follows: ENABLED - Anything specified in this assignment is used when creating the data source. DISABLED - This assignment isn't used when creating the data source. DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.
  • "Identities": The Amazon QuickSight users, groups, or both that you want to assign the policy to.
  • "PolicyArn": The ARN for the IAM policy to apply to the Amazon QuickSight users and groups specified in this assignment.
source
Main.Quicksight.update_ip_restrictionMethod
update_ip_restriction(aws_account_id)
update_ip_restriction(aws_account_id, params::Dict{String,<:Any})

Updates the content and status of IP rules. To use this operation, you need to provide the entire map of rules. You can use the DescribeIpRestriction operation to get the current rule map.

Arguments

  • aws_account_id: The ID of the Amazon Web Services account that contains the IP rules.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Enabled": A value that specifies whether IP rules are turned on.
  • "IpRestrictionRuleMap": A map that describes the updated IP rules with CIDR ranges and descriptions.
source
Main.Quicksight.update_public_sharing_settingsMethod
update_public_sharing_settings(aws_account_id)
update_public_sharing_settings(aws_account_id, params::Dict{String,<:Any})

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.

Arguments

  • aws_account_id: The Amazon Web Services account ID associated with your Amazon QuickSight subscription.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "PublicSharingEnabled": A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account.
source
Main.Quicksight.update_templateMethod
update_template(aws_account_id, template_id)
update_template(aws_account_id, template_id, params::Dict{String,<:Any})

Updates a template from an existing Amazon QuickSight analysis or another template.

Arguments

  • aws_account_id: The ID of the Amazon Web Services account that contains the template that you're updating.
  • template_id: The ID for the template.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Definition": The definition of a template. A definition is the data model of all features in a Dashboard, Template, or Analysis.
  • "Name": The name for the template.
  • "SourceEntity": The entity that you are using as a source when you update the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region;. Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
  • "VersionDescription": A description of the current template version that is being updated. Every time you call UpdateTemplate, you create a new version of the template. Each version of the template maintains a description of the version in the VersionDescription field.
source
Main.Quicksight.update_template_aliasMethod
update_template_alias(alias_name, aws_account_id, template_id, template_version_number)
update_template_alias(alias_name, aws_account_id, template_id, template_version_number, params::Dict{String,<:Any})

Updates the template alias of a template.

Arguments

  • alias_name: The alias of the template that you want to update. If you name a specific alias, you update the version that the alias points to. You can specify the latest version of the template by providing the keyword LATEST in the AliasName parameter. The keyword PUBLISHED doesn't apply to templates.
  • aws_account_id: The ID of the Amazon Web Services account that contains the template alias that you're updating.
  • template_id: The ID for the template.
  • template_version_number: The version number of the template.
source
Main.Quicksight.update_template_permissionsMethod
update_template_permissions(aws_account_id, template_id)
update_template_permissions(aws_account_id, template_id, params::Dict{String,<:Any})

Updates the resource permissions for a template.

Arguments

  • aws_account_id: The ID of the Amazon Web Services account that contains the template.
  • template_id: The ID for the template.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "GrantPermissions": A list of resource permissions to be granted on the template.
  • "RevokePermissions": A list of resource permissions to be revoked from the template.
source
Main.Quicksight.update_themeMethod
update_theme(aws_account_id, base_theme_id, theme_id)
update_theme(aws_account_id, base_theme_id, theme_id, params::Dict{String,<:Any})

Updates a theme.

Arguments

  • aws_account_id: The ID of the Amazon Web Services account that contains the theme that you're updating.
  • base_theme_id: The theme ID, defined by Amazon QuickSight, that a custom theme inherits from. All themes initially inherit from a default Amazon QuickSight theme.
  • theme_id: The ID for the theme.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Configuration": The theme configuration, which contains the theme display properties.
  • "Name": The name for the theme.
  • "VersionDescription": A description of the theme version that you're updating Every time that you call UpdateTheme, you create a new version of the theme. Each version of the theme maintains a description of the version in VersionDescription.
source
Main.Quicksight.update_theme_aliasMethod
update_theme_alias(alias_name, aws_account_id, theme_id, theme_version_number)
update_theme_alias(alias_name, aws_account_id, theme_id, theme_version_number, params::Dict{String,<:Any})

Updates an alias of a theme.

Arguments

  • alias_name: The name of the theme alias that you want to update.
  • aws_account_id: The ID of the Amazon Web Services account that contains the theme alias that you're updating.
  • theme_id: The ID for the theme.
  • theme_version_number: The version number of the theme that the alias should reference.
source
Main.Quicksight.update_theme_permissionsMethod
update_theme_permissions(aws_account_id, theme_id)
update_theme_permissions(aws_account_id, theme_id, params::Dict{String,<:Any})

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.

Arguments

  • aws_account_id: The ID of the Amazon Web Services account that contains the theme.
  • theme_id: The ID for the theme.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "GrantPermissions": A list of resource permissions to be granted for the theme.
  • "RevokePermissions": A list of resource permissions to be revoked from the theme.
source
Main.Quicksight.update_userMethod
update_user(aws_account_id, email, namespace, role, user_name)
update_user(aws_account_id, email, namespace, role, user_name, params::Dict{String,<:Any})

Updates an Amazon QuickSight user.

Arguments

  • aws_account_id: The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  • email: The email address of the user that you want to update.
  • namespace: The namespace. Currently, you should set this to default.
  • role: The Amazon QuickSight role of the user. The role can be one of the following default security cohorts: READER: A user who has read-only access to dashboards. AUTHOR: A user who can create data sources, datasets, analyses, and dashboards. ADMIN: A user who is an author, who can also manage Amazon QuickSight settings. The name of the Amazon QuickSight role is invisible to the user except for the console screens dealing with permissions.
  • user_name: The Amazon QuickSight user name that you want to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "CustomFederationProviderUrl": The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.
  • "CustomPermissionsName": (Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations: Create and update data sources Create and update datasets Create and update email reports Subscribe to email reports A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the Amazon QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Amazon QuickSight user. Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Amazon QuickSight users to one of the default security cohorts in Amazon QuickSight (admin, author, reader). This feature is available only to Amazon QuickSight Enterprise edition subscriptions.
  • "ExternalLoginFederationProviderType": The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following. COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom. CUSTOMOIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOMOIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL. NONE: This clears all the previously saved external login information for a user. Use the DescribeUser API operation to check the external login information.
  • "ExternalLoginId": The identity ID for a user in the external login provider.
  • "UnapplyCustomPermissions": A flag that you use to indicate that you want to remove all custom permissions from this user. Using this parameter resets the user to the state it was in before a custom permissions profile was applied. This parameter defaults to NULL and it doesn't accept any other value.
source