AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon QuickSight GenerateEmbedUrlForRegisteredUserWithIdentity API operation.

Syntax

Initialize-QSEmbedUrlForRegisteredUserWithIdentity
-AwsAccountId <String>
-AllowedDomain <String[]>
-InitialDashboardVisualId_DashboardId <String>
-Dashboard_ExecutiveSummary_Enabled <Boolean>
-Bookmarks_Enabled <Boolean>
-Dashboard_RecentSnapshots_Enabled <Boolean>
-Dashboard_Schedules_Enabled <Boolean>
-ExperienceConfiguration_Dashboard_FeatureConfigurations_SharedView_Enabled <Boolean>
-ExperienceConfiguration_Dashboard_FeatureConfigurations_StatePersistence_Enabled <Boolean>
-Dashboard_ThresholdAlerts_Enabled <Boolean>
-DataQnA_Enabled <Boolean>
-DataStories_Enabled <Boolean>
-Console_ExecutiveSummary_Enabled <Boolean>
-GenerativeAuthoring_Enabled <Boolean>
-Console_RecentSnapshots_Enabled <Boolean>
-Console_Schedules_Enabled <Boolean>
-ExperienceConfiguration_QuickSightConsole_FeatureConfigurations_SharedView_Enabled_SharedView_Enabled <Boolean>
-ExperienceConfiguration_QuickSightConsole_FeatureConfigurations_StatePersistence_Enabled <Boolean>
-Console_ThresholdAlerts_Enabled <Boolean>
-Dashboard_InitialDashboardId <String>
-QuickSightConsole_InitialPath <String>
-GenerativeQnA_InitialTopicId <String>
-QSearchBar_InitialTopicId <String>
-ExperienceConfiguration_QuickChat <RegisteredUserQuickChatEmbeddingConfiguration>
-SessionLifetimeInMinute <Int64>
-InitialDashboardVisualId_SheetId <String>
-InitialDashboardVisualId_VisualId <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonQuickSightConfig>

Description

Generates an embed URL that you can use to embed an Amazon Quick Sight experience in your website. This action can be used for any type of user that is registered in an Amazon Quick Sight account that uses IAM Identity Center for authentication. This API requires identity-enhanced IAM Role sessions for the authenticated user that the API call is being made for. This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for Amazon Quick Sight with the scope value set to quicksight:read. Before you use this action, make sure that you have configured the relevant Amazon Quick Sight resource and permissions.

Parameters

-AllowedDomain <String[]>
A list of domains to be allowed to generate the embed URL. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAllowedDomains
-AwsAccountId <String>
The ID of the Amazon Web Services registered user.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Bookmarks_Enabled <Boolean>
A Boolean value that determines whether a user can bookmark an embedded dashboard.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExperienceConfiguration_Dashboard_FeatureConfigurations_Bookmarks_Enabled
-ClientConfig <AmazonQuickSightConfig>
Amazon.PowerShell.Cmdlets.QS.AmazonQuickSightClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Console_ExecutiveSummary_Enabled <Boolean>
The executive summary settings of an embedded Quick Sight console or dashboard.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExperienceConfiguration_QuickSightConsole_FeatureConfigurations_AmazonQInQuickSight_ExecutiveSummary_Enabled
-Console_RecentSnapshots_Enabled <Boolean>
The recent snapshots configuration for an embedded Quick Sight dashboard.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExperienceConfiguration_QuickSightConsole_FeatureConfigurations_RecentSnapshots_Enabled
-Console_Schedules_Enabled <Boolean>
The schedules configuration for an embedded Quick Sight dashboard.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExperienceConfiguration_QuickSightConsole_FeatureConfigurations_Schedules_Enabled
-Console_ThresholdAlerts_Enabled <Boolean>
The threshold alerts configuration for an embedded Quick Sight dashboard.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExperienceConfiguration_QuickSightConsole_FeatureConfigurations_ThresholdAlerts_Enabled
-Dashboard_ExecutiveSummary_Enabled <Boolean>
The executive summary settings of an embedded Quick Sight console or dashboard.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExperienceConfiguration_Dashboard_FeatureConfigurations_AmazonQInQuickSight_ExecutiveSummary_Enabled
-Dashboard_InitialDashboardId <String>
The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon Quick Sight renders this dashboard if the user has permissions to view it.If the user does not have permission to view this dashboard, they see a permissions error message.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExperienceConfiguration_Dashboard_InitialDashboardId
-Dashboard_RecentSnapshots_Enabled <Boolean>
The recent snapshots configuration for an embedded Quick Sight dashboard.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExperienceConfiguration_Dashboard_FeatureConfigurations_RecentSnapshots_Enabled
-Dashboard_Schedules_Enabled <Boolean>
The schedules configuration for an embedded Quick Sight dashboard.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExperienceConfiguration_Dashboard_FeatureConfigurations_Schedules_Enabled
-Dashboard_ThresholdAlerts_Enabled <Boolean>
The threshold alerts configuration for an embedded Quick Sight dashboard.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExperienceConfiguration_Dashboard_FeatureConfigurations_ThresholdAlerts_Enabled
-DataQnA_Enabled <Boolean>
The generative Q&A settings of an embedded Quick Sight console.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExperienceConfiguration_QuickSightConsole_FeatureConfigurations_AmazonQInQuickSight_DataQnA_Enabled
-DataStories_Enabled <Boolean>
The data story settings of an embedded Quick Sight console.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExperienceConfiguration_QuickSightConsole_FeatureConfigurations_AmazonQInQuickSight_DataStories_Enabled
-ExperienceConfiguration_Dashboard_FeatureConfigurations_SharedView_Enabled <Boolean>
The shared view settings of an embedded dashboard.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExperienceConfiguration_Dashboard_FeatureConfigurations_StatePersistence_Enabled <Boolean>
Determines if a Quick Sight dashboard's state persistence settings are turned on or off.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExperienceConfiguration_QuickChat <RegisteredUserQuickChatEmbeddingConfiguration>
The configuration details for embedding the Quick chat agent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExperienceConfiguration_QuickSightConsole_FeatureConfigurations_SharedView_Enabled_SharedView_Enabled <Boolean>
The shared view settings of an embedded dashboard.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExperienceConfiguration_QuickSightConsole_FeatureConfigurations_SharedView_Enabled
-ExperienceConfiguration_QuickSightConsole_FeatureConfigurations_StatePersistence_Enabled <Boolean>
Determines if a Quick Sight dashboard's state persistence settings are turned on or off.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-GenerativeAuthoring_Enabled <Boolean>
The generative BI authoring settings of an embedded Quick Sight console.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExperienceConfiguration_QuickSightConsole_FeatureConfigurations_AmazonQInQuickSight_GenerativeAuthoring_Enabled
-GenerativeQnA_InitialTopicId <String>
The ID of the new Q reader experience topic that you want to make the starting topic in the Generative Q&A experience. You can find a topic ID by navigating to the Topics pane in the Quick Suite application and opening a topic. The ID is in the URL for the topic that you open.If you don't specify an initial topic or you specify a legacy topic, a list of all shared new reader experience topics is shown in the Generative Q&A experience for your readers. When you select an initial new reader experience topic, you can specify whether or not readers are allowed to select other new reader experience topics from the available ones in the list.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExperienceConfiguration_GenerativeQnA_InitialTopicId
-InitialDashboardVisualId_DashboardId <String>
The ID of the dashboard that has the visual that you want to embed. The DashboardId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Quick Suite console. You can also get the DashboardId with a ListDashboards API operation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExperienceConfiguration_DashboardVisual_InitialDashboardVisualId_DashboardId
-InitialDashboardVisualId_SheetId <String>
The ID of the sheet that the has visual that you want to embed. The SheetId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Quick Suite console.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExperienceConfiguration_DashboardVisual_InitialDashboardVisualId_SheetId
-InitialDashboardVisualId_VisualId <String>
The ID of the visual that you want to embed. The VisualID can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon Quick Sight console.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExperienceConfiguration_DashboardVisual_InitialDashboardVisualId_VisualId
-QSearchBar_InitialTopicId <String>
The ID of the legacy Q topic that you want to use as the starting topic in the Q search bar. To locate the topic ID of the topic that you want to use, open the Quick Sight console, navigate to the Topics pane, and choose thre topic that you want to use. The TopicID is located in the URL of the topic that opens. When you select an initial topic, you can specify whether or not readers are allowed to select other topics from the list of available topics.If you don't specify an initial topic or if you specify a new reader experience topic, a list of all shared legacy topics is shown in the Q bar.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExperienceConfiguration_QSearchBar_InitialTopicId
-QuickSightConsole_InitialPath <String>
The initial URL path for the Amazon Quick Sight console. InitialPath is required.The entry point URL is constrained to the following paths:
  • /start
  • /start/analyses
  • /start/dashboards
  • /start/favorites
  • /dashboards/DashboardId. DashboardId is the actual ID key from the Amazon Quick Sight console URL of the dashboard.
  • /analyses/AnalysisId. AnalysisId is the actual ID key from the Amazon Quick Sight console URL of the analysis.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExperienceConfiguration_QuickSightConsole_InitialPath
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'EmbedUrl'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.GenerateEmbedUrlForRegisteredUserWithIdentityResponse). Specifying the name of a property of type Amazon.QuickSight.Model.GenerateEmbedUrlForRegisteredUserWithIdentityResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SessionLifetimeInMinute <Int64>
The validity of the session in minutes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSessionLifetimeInMinutes

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

System.String or Amazon.QuickSight.Model.GenerateEmbedUrlForRegisteredUserWithIdentityResponse
This cmdlet returns a System.String object. The service call response (type Amazon.QuickSight.Model.GenerateEmbedUrlForRegisteredUserWithIdentityResponse) can be returned by specifying '-Select *'.
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z