AWS.Tools.QuickSight.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.QuickSight</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.QS.AddQSResourceTagCmdlet"> <summary> Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource. <para> 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 <c>TagResource</c> 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. </para><para> You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data set, data source, dashboard, template, topic, and user. </para><para> Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for the following: </para><ul><li><para> Tags are used to track costs for users in Amazon QuickSight. You can't tag other resources that Amazon QuickSight costs are based on, such as storage capacoty (SPICE), session usage, alert consumption, or reporting units. </para></li><li><para> Amazon QuickSight doesn't currently support the tag editor for Resource Groups. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.AddQSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource that you want to tag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.AddQSResourceTagCmdlet.Tag"> <summary> <para> <para>Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.AddQSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.TagResourceResponse). Specifying the name of a property of type Amazon.QuickSight.Model.TagResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.AddQSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.AddQSResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.FindQSGroupCmdlet"> <summary> Use the <c>SearchGroups</c> operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.FindQSGroupCmdlet.AwsAccountId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.FindQSGroupCmdlet.Filter"> <summary> <para> <para>The structure for the search filters that you want to apply to your search.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.FindQSGroupCmdlet.Namespace"> <summary> <para> <para>The namespace that you want to search.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.FindQSGroupCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return from this request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.FindQSGroupCmdlet.NextToken"> <summary> <para> <para>A pagination token that can be used in a subsequent request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.FindQSGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GroupList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.SearchGroupsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.SearchGroupsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.FindQSGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.FindQSGroupCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSAccountCustomizationCmdlet"> <summary> 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 <c>Resolved</c> flag included. <para> To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved. </para><ul><li><para><c>Amazon Web Services account</c> - 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. </para></li><li><para><c>Amazon Web Services Region</c> - 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. </para><para> 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: </para><ul><li><para> Use <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-options.html">command line options</a>. </para></li><li><para> Use <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html">named profiles</a>. </para></li><li><para> Run <c>aws configure</c> to change your default Amazon Web Services Region. Use Enter to key the same settings for your keys. For more information, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html">Configuring the CLI</a>. </para></li></ul></li><li><para><c>Namespace</c> - 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. </para></li><li><para><c>Applied customizations</c> - 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 <c>CreateAccountCustomization</c> command in each Amazon Web Services Region where you want to apply the same customizations. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAccountCustomizationCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the Amazon Web Services account that you want to describe Amazon QuickSight customizations for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAccountCustomizationCmdlet.Namespace"> <summary> <para> <para>The Amazon QuickSight namespace that you want to describe Amazon QuickSight customizations for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAccountCustomizationCmdlet.Resolved"> <summary> <para> <para>The <c>Resolved</c> 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 <c>no-resolved</c>, to reveal customizations that are configured at different levels. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAccountCustomizationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeAccountCustomizationResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeAccountCustomizationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAccountCustomizationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSAccountSettingCmdlet"> <summary> Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAccountSettingCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the Amazon Web Services account that contains the settings that you want to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAccountSettingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AccountSettings'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeAccountSettingsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeAccountSettingsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAccountSettingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSAccountSubscriptionCmdlet"> <summary> Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's subscription. A successful API call returns an <c>AccountInfo</c> object that includes an account's name, subscription status, authentication type, edition, and notification email address. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAccountSubscriptionCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID associated with your Amazon QuickSight account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAccountSubscriptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AccountInfo'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeAccountSubscriptionResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeAccountSubscriptionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAccountSubscriptionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSAnalysisCmdlet"> <summary> Provides a summary of the metadata for an analysis. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAnalysisCmdlet.AnalysisId"> <summary> <para> <para>The ID of the analysis that you're describing. The ID is part of the URL of the analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAnalysisCmdlet.AwsAccountId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAnalysisCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Analysis'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeAnalysisResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeAnalysisResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAnalysisCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AnalysisId parameter. The -PassThru parameter is deprecated, use -Select '^AnalysisId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSAnalysisDefinitionCmdlet"> <summary> Provides a detailed description of the definition of an analysis. <note><para> 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 <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeAnalysis.html"><c>DescribeAnalysis</c></a> instead. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAnalysisDefinitionCmdlet.AnalysisId"> <summary> <para> <para>The ID of the analysis that you're describing. The ID is part of the URL of the analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAnalysisDefinitionCmdlet.AwsAccountId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAnalysisDefinitionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeAnalysisDefinitionResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeAnalysisDefinitionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAnalysisDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AnalysisId parameter. The -PassThru parameter is deprecated, use -Select '^AnalysisId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSAnalysisListCmdlet"> <summary> Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAnalysisListCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the analyses.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAnalysisListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAnalysisListCmdlet.NextToken"> <summary> <para> <para>A pagination token that can be used in a subsequent request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAnalysisListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AnalysisSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.ListAnalysesResponse). Specifying the name of a property of type Amazon.QuickSight.Model.ListAnalysesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAnalysisListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAnalysisListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSAnalysisPermissionCmdlet"> <summary> Provides the read and write permissions for an analysis. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAnalysisPermissionCmdlet.AnalysisId"> <summary> <para> <para>The ID of the analysis whose permissions you're describing. The ID is part of the analysis URL.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAnalysisPermissionCmdlet.AwsAccountId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAnalysisPermissionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeAnalysisPermissionsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeAnalysisPermissionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAnalysisPermissionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AnalysisId parameter. The -PassThru parameter is deprecated, use -Select '^AnalysisId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSAssetBundleExportJobCmdlet"> <summary> Describes an existing export job. <para> Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to download the exported assets' data from. Download URLs are valid for five minutes after they are generated. You can call the <c>DescribeAssetBundleExportJob</c> API for a new download URL as needed. </para><para> Job descriptions are available for 14 days after the job starts. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAssetBundleExportJobCmdlet.AssetBundleExportJobId"> <summary> <para> <para>The ID of the job that you want described. The job ID is set when you start a new job with a <c>StartAssetBundleExportJob</c> API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAssetBundleExportJobCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account the export job is executed in. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAssetBundleExportJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeAssetBundleExportJobResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeAssetBundleExportJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAssetBundleExportJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssetBundleExportJobId parameter. The -PassThru parameter is deprecated, use -Select '^AssetBundleExportJobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSAssetBundleExportJobListCmdlet"> <summary> Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, <c>ListAssetBundleExportJobs</c> only returns the most recent job that uses the repeated job ID.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAssetBundleExportJobListCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that the export jobs were executed in. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAssetBundleExportJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned per request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAssetBundleExportJobListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results, or null if there are no more results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAssetBundleExportJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AssetBundleExportJobSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.ListAssetBundleExportJobsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.ListAssetBundleExportJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAssetBundleExportJobListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAssetBundleExportJobListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSAssetBundleImportJobCmdlet"> <summary> Describes an existing import job. <para> Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAssetBundleImportJobCmdlet.AssetBundleImportJobId"> <summary> <para> <para>The ID of the job. The job ID is set when you start a new job with a <c>StartAssetBundleImportJob</c> API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAssetBundleImportJobCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account the import job was executed in. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAssetBundleImportJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeAssetBundleImportJobResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeAssetBundleImportJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAssetBundleImportJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssetBundleImportJobId parameter. The -PassThru parameter is deprecated, use -Select '^AssetBundleImportJobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSAssetBundleImportJobListCmdlet"> <summary> Lists all asset bundle import jobs that have taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, <c>ListAssetBundleImportJobs</c> only returns the most recent job that uses the repeated job ID.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAssetBundleImportJobListCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that the import jobs were executed in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAssetBundleImportJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned per request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAssetBundleImportJobListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results, or null if there are no more results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAssetBundleImportJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AssetBundleImportJobSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.ListAssetBundleImportJobsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.ListAssetBundleImportJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAssetBundleImportJobListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSAssetBundleImportJobListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardCmdlet"> <summary> Provides a summary for a dashboard. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardCmdlet.AliasName"> <summary> <para> <para>The alias name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the dashboard that you're describing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardCmdlet.DashboardId"> <summary> <para> <para>The ID for the dashboard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardCmdlet.VersionNumber"> <summary> <para> <para>The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Dashboard'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeDashboardResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeDashboardResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DashboardId parameter. The -PassThru parameter is deprecated, use -Select '^DashboardId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardDefinitionCmdlet"> <summary> Provides a detailed description of the definition of a dashboard. <note><para> 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 <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeDashboard.html"><c>DescribeDashboard</c></a> instead. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardDefinitionCmdlet.AliasName"> <summary> <para> <para>The alias name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardDefinitionCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the dashboard that you're describing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardDefinitionCmdlet.DashboardId"> <summary> <para> <para>The ID for the dashboard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardDefinitionCmdlet.VersionNumber"> <summary> <para> <para>The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardDefinitionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeDashboardDefinitionResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeDashboardDefinitionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DashboardId parameter. The -PassThru parameter is deprecated, use -Select '^DashboardId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardEmbedUrlCmdlet"> <summary> 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. <para> Currently, you can use <c>GetDashboardEmbedURL</c> only from the server, not from the user's browser. The following rules apply to the generated URL: </para><ul><li><para> They must be used together. </para></li><li><para> They can be used one time only. </para></li><li><para> They are valid for 5 minutes after you run this command. </para></li><li><para> You are charged only when the URL is used or there is interaction with Amazon QuickSight. </para></li><li><para> The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional <c>SessionLifetimeInMinutes</c> parameter to customize session duration. </para></li></ul><para> For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics-deprecated.html">Embedding Analytics Using GetDashboardEmbedUrl</a> in the <i>Amazon QuickSight User Guide</i>. </para><para> For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the <a href="https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html">Amazon QuickSight Developer Portal</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardEmbedUrlCmdlet.AdditionalDashboardId"> <summary> <para> <para>A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the <c>IdentityType</c> parameter must be set to <c>ANONYMOUS</c> because other identity types authenticate as Amazon QuickSight or IAM users. For example, if you set "<c>--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS</c>", the session can access all three dashboards.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardEmbedUrlCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the Amazon Web Services account that contains the dashboard that you're embedding.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardEmbedUrlCmdlet.DashboardId"> <summary> <para> <para>The ID for the dashboard, also added to the Identity and Access Management (IAM) policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardEmbedUrlCmdlet.IdentityType"> <summary> <para> <para>The authentication method that the user uses to sign in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardEmbedUrlCmdlet.Namespace"> <summary> <para> <para>The Amazon QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set <c>Namespace = default</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardEmbedUrlCmdlet.ResetDisabled"> <summary> <para> <para>Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardEmbedUrlCmdlet.SessionLifetimeInMinute"> <summary> <para> <para>How many minutes the session is valid. The session lifetime must be 15-600 minutes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardEmbedUrlCmdlet.StatePersistenceEnabled"> <summary> <para> <para>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 <c>TRUE</c>, 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 <c>FALSE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardEmbedUrlCmdlet.UndoRedoDisabled"> <summary> <para> <para>Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardEmbedUrlCmdlet.UserArn"> <summary> <para> <para>The Amazon QuickSight user's Amazon Resource Name (ARN), for use with <c>QUICKSIGHT</c> identity type. You can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following:</para><ul><li><para>Active Directory (AD) users or group members</para></li><li><para>Invited nonfederated users</para></li><li><para>IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation.</para></li></ul><para>Omit this parameter for users in the third group – IAM users and IAM role-based sessions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardEmbedUrlCmdlet.Select"> <summary> 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.GetDashboardEmbedUrlResponse). Specifying the name of a property of type Amazon.QuickSight.Model.GetDashboardEmbedUrlResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardEmbedUrlCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DashboardId parameter. The -PassThru parameter is deprecated, use -Select '^DashboardId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardListCmdlet"> <summary> Lists dashboards in an Amazon Web Services account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardListCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the dashboards that you're listing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned per request.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results, or null if there are no more results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DashboardSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.ListDashboardsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.ListDashboardsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardPermissionCmdlet"> <summary> Describes read and write permissions for a dashboard. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardPermissionCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the dashboard that you're describing permissions for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardPermissionCmdlet.DashboardId"> <summary> <para> <para>The ID for the dashboard, also added to the IAM policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardPermissionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeDashboardPermissionsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeDashboardPermissionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardPermissionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DashboardId parameter. The -PassThru parameter is deprecated, use -Select '^DashboardId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardSnapshotJobCmdlet"> <summary> Describes an existing snapshot job. <para> Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see <c>JobStatus</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardSnapshotJobCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardSnapshotJobCmdlet.DashboardId"> <summary> <para> <para>The ID of the dashboard that you have started a snapshot job for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardSnapshotJobCmdlet.SnapshotJobId"> <summary> <para> <para>The ID of the job to be described. The job ID is set when you start a new job with a <c>StartDashboardSnapshotJob</c> API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardSnapshotJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeDashboardSnapshotJobResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeDashboardSnapshotJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardSnapshotJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardSnapshotJobResultCmdlet"> <summary> Describes the result of an existing snapshot job that has finished running. <para> A finished snapshot job will return a <c>COMPLETED</c> or <c>FAILED</c> status when you poll the job with a <c>DescribeDashboardSnapshotJob</c> API call. </para><para> If the job has not finished running, this operation returns a message that says <c>Dashboard Snapshot Job with id <SnapshotjobId> has not reached a terminal state.</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardSnapshotJobResultCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardSnapshotJobResultCmdlet.DashboardId"> <summary> <para> <para>The ID of the dashboard that you have started a snapshot job for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardSnapshotJobResultCmdlet.SnapshotJobId"> <summary> <para> <para>The ID of the job to be described. The job ID is set when you start a new job with a <c>StartDashboardSnapshotJob</c> API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardSnapshotJobResultCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeDashboardSnapshotJobResultResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeDashboardSnapshotJobResultResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardSnapshotJobResultCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardVersionListCmdlet"> <summary> Lists all the versions of the dashboards in the Amazon QuickSight subscription.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardVersionListCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the dashboard that you're listing versions for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardVersionListCmdlet.DashboardId"> <summary> <para> <para>The ID for the dashboard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardVersionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned per request.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardVersionListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results, or null if there are no more results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardVersionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DashboardVersionSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.ListDashboardVersionsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.ListDashboardVersionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardVersionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DashboardId parameter. The -PassThru parameter is deprecated, use -Select '^DashboardId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardVersionListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSDataSetCmdlet"> <summary> Describes a dataset. This operation doesn't support datasets that include uploaded files as a source. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDataSetCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDataSetCmdlet.DataSetId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDataSetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DataSet'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeDataSetResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeDataSetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDataSetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DataSetId parameter. The -PassThru parameter is deprecated, use -Select '^DataSetId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSDataSetListCmdlet"> <summary> Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region. <para> The permissions resource is <c>arn:aws:quicksight:region:aws-account-id:dataset/*</c>. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDataSetListCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDataSetListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned per request.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDataSetListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results, or null if there are no more results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDataSetListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DataSetSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.ListDataSetsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.ListDataSetsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDataSetListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDataSetListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSDataSetPermissionCmdlet"> <summary> Describes the permissions on a dataset. <para> The permissions resource is <c>arn:aws:quicksight:region:aws-account-id:dataset/data-set-id</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDataSetPermissionCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDataSetPermissionCmdlet.DataSetId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDataSetPermissionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeDataSetPermissionsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeDataSetPermissionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDataSetPermissionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DataSetId parameter. The -PassThru parameter is deprecated, use -Select '^DataSetId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSDataSetRefreshPropertyCmdlet"> <summary> Describes the refresh properties of a dataset. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDataSetRefreshPropertyCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDataSetRefreshPropertyCmdlet.DataSetId"> <summary> <para> <para>The ID of the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDataSetRefreshPropertyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DataSetRefreshProperties'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeDataSetRefreshPropertiesResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeDataSetRefreshPropertiesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDataSetRefreshPropertyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DataSetId parameter. The -PassThru parameter is deprecated, use -Select '^DataSetId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSDataSourceCmdlet"> <summary> Describes a data source. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDataSourceCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDataSourceCmdlet.DataSourceId"> <summary> <para> <para>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDataSourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DataSource'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeDataSourceResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeDataSourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDataSourceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DataSourceId parameter. The -PassThru parameter is deprecated, use -Select '^DataSourceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSDataSourceListCmdlet"> <summary> Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDataSourceListCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDataSourceListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned per request.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDataSourceListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results, or null if there are no more results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDataSourceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DataSources'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.ListDataSourcesResponse). Specifying the name of a property of type Amazon.QuickSight.Model.ListDataSourcesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDataSourceListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDataSourceListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSDataSourcePermissionCmdlet"> <summary> Describes the resource permissions for a data source. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDataSourcePermissionCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDataSourcePermissionCmdlet.DataSourceId"> <summary> <para> <para>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDataSourcePermissionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeDataSourcePermissionsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeDataSourcePermissionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDataSourcePermissionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DataSourceId parameter. The -PassThru parameter is deprecated, use -Select '^DataSourceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSFolderCmdlet"> <summary> Describes a folder. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFolderCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the Amazon Web Services account that contains the folder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFolderCmdlet.FolderId"> <summary> <para> <para>The ID of the folder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFolderCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Folder'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeFolderResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeFolderResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFolderCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FolderId parameter. The -PassThru parameter is deprecated, use -Select '^FolderId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSFolderListCmdlet"> <summary> Lists all folders in an account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFolderListCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the Amazon Web Services account that contains the folder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFolderListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned per request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFolderListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results, or null if there are no more results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFolderListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FolderSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.ListFoldersResponse). Specifying the name of a property of type Amazon.QuickSight.Model.ListFoldersResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFolderListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFolderListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSFolderMemberListCmdlet"> <summary> List all assets (<c>DASHBOARD</c>, <c>ANALYSIS</c>, and <c>DATASET</c>) in a folder.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFolderMemberListCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the Amazon Web Services account that contains the folder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFolderMemberListCmdlet.FolderId"> <summary> <para> <para>The ID of the folder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFolderMemberListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned per request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFolderMemberListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results, or null if there are no more results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFolderMemberListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FolderMemberList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.ListFolderMembersResponse). Specifying the name of a property of type Amazon.QuickSight.Model.ListFolderMembersResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFolderMemberListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FolderId parameter. The -PassThru parameter is deprecated, use -Select '^FolderId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFolderMemberListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSFolderPermissionCmdlet"> <summary> Describes permissions for a folder.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFolderPermissionCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the Amazon Web Services account that contains the folder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFolderPermissionCmdlet.FolderId"> <summary> <para> <para>The ID of the folder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFolderPermissionCmdlet.Namespace"> <summary> <para> <para>The namespace of the folder whose permissions you want described.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFolderPermissionCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned per request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFolderPermissionCmdlet.NextToken"> <summary> <para> <para>A pagination token for the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFolderPermissionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeFolderPermissionsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeFolderPermissionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFolderPermissionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FolderId parameter. The -PassThru parameter is deprecated, use -Select '^FolderId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFolderPermissionCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSFolderResolvedPermissionCmdlet"> <summary> Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFolderResolvedPermissionCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the Amazon Web Services account that contains the folder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFolderResolvedPermissionCmdlet.FolderId"> <summary> <para> <para>The ID of the folder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFolderResolvedPermissionCmdlet.Namespace"> <summary> <para> <para>The namespace of the folder whose permissions you want described.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFolderResolvedPermissionCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned per request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFolderResolvedPermissionCmdlet.NextToken"> <summary> <para> <para>A pagination token for the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFolderResolvedPermissionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeFolderResolvedPermissionsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeFolderResolvedPermissionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFolderResolvedPermissionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FolderId parameter. The -PassThru parameter is deprecated, use -Select '^FolderId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFolderResolvedPermissionCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSFoldersForResourceListCmdlet"> <summary> List all folders that a resource is a member of.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFoldersForResourceListCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the Amazon Web Services account that contains the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFoldersForResourceListCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) the resource whose folders you need to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFoldersForResourceListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned per request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFoldersForResourceListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results, or null if there are no more results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFoldersForResourceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Folders'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.ListFoldersForResourceResponse). Specifying the name of a property of type Amazon.QuickSight.Model.ListFoldersForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFoldersForResourceListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSFoldersForResourceListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSGroupCmdlet"> <summary> Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSGroupCmdlet.AwsAccountId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSGroupCmdlet.GroupName"> <summary> <para> <para>The name of the group that you want to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSGroupCmdlet.Namespace"> <summary> <para> <para>The namespace of the group that you want described.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Group'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeGroupResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GroupName parameter. The -PassThru parameter is deprecated, use -Select '^GroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSGroupListCmdlet"> <summary> Lists all user groups in Amazon QuickSight.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSGroupListCmdlet.AwsAccountId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSGroupListCmdlet.Namespace"> <summary> <para> <para>The namespace that you want a list of groups from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSGroupListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSGroupListCmdlet.NextToken"> <summary> <para> <para>A pagination token that can be used in a subsequent request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSGroupListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GroupList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.ListGroupsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.ListGroupsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSGroupListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSGroupListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSGroupMembershipCmdlet"> <summary> Use the <c>DescribeGroupMembership</c> 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 <c>GroupMember</c> object is returned. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSGroupMembershipCmdlet.AwsAccountId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSGroupMembershipCmdlet.GroupName"> <summary> <para> <para>The name of the group that you want to search.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSGroupMembershipCmdlet.MemberName"> <summary> <para> <para>The user name of the user that you want to search for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSGroupMembershipCmdlet.Namespace"> <summary> <para> <para>The namespace that includes the group you are searching within.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSGroupMembershipCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GroupMember'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeGroupMembershipResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeGroupMembershipResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSGroupMembershipCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSGroupMembershipListCmdlet"> <summary> Lists member users in a group.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSGroupMembershipListCmdlet.AwsAccountId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSGroupMembershipListCmdlet.GroupName"> <summary> <para> <para>The name of the group that you want to see a membership list of.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSGroupMembershipListCmdlet.Namespace"> <summary> <para> <para>The namespace of the group that you want a list of users from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSGroupMembershipListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return from this request.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSGroupMembershipListCmdlet.NextToken"> <summary> <para> <para>A pagination token that can be used in a subsequent request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSGroupMembershipListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GroupMemberList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.ListGroupMembershipsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.ListGroupMembershipsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSGroupMembershipListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GroupName parameter. The -PassThru parameter is deprecated, use -Select '^GroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSGroupMembershipListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSIAMPolicyAssignmentCmdlet"> <summary> Describes an existing IAM policy assignment, as specified by the assignment name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIAMPolicyAssignmentCmdlet.AssignmentName"> <summary> <para> <para>The name of the assignment, also called a rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIAMPolicyAssignmentCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the assignment that you want to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIAMPolicyAssignmentCmdlet.Namespace"> <summary> <para> <para>The namespace that contains the assignment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIAMPolicyAssignmentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'IAMPolicyAssignment'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeIAMPolicyAssignmentResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeIAMPolicyAssignmentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIAMPolicyAssignmentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssignmentName parameter. The -PassThru parameter is deprecated, use -Select '^AssignmentName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSIAMPolicyAssignmentListCmdlet"> <summary> Lists the IAM policy assignments in the current Amazon QuickSight account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIAMPolicyAssignmentListCmdlet.AssignmentStatus"> <summary> <para> <para>The status of the assignments.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIAMPolicyAssignmentListCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains these IAM policy assignments.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIAMPolicyAssignmentListCmdlet.Namespace"> <summary> <para> <para>The namespace for the assignments.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIAMPolicyAssignmentListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned per request.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIAMPolicyAssignmentListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results, or null if there are no more results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIAMPolicyAssignmentListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'IAMPolicyAssignments'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.ListIAMPolicyAssignmentsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.ListIAMPolicyAssignmentsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIAMPolicyAssignmentListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Namespace parameter. The -PassThru parameter is deprecated, use -Select '^Namespace' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIAMPolicyAssignmentListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSIAMPolicyAssignmentsForUserListCmdlet"> <summary> Lists all of the IAM policy assignments, including the Amazon Resource Names (ARNs), for the IAM policies assigned to the specified user and group, or groups that the user belongs to.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIAMPolicyAssignmentsForUserListCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the assignments.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIAMPolicyAssignmentsForUserListCmdlet.Namespace"> <summary> <para> <para>The namespace of the assignment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIAMPolicyAssignmentsForUserListCmdlet.UserName"> <summary> <para> <para>The name of the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIAMPolicyAssignmentsForUserListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned per request.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIAMPolicyAssignmentsForUserListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results, or null if there are no more results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIAMPolicyAssignmentsForUserListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ActiveAssignments'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.ListIAMPolicyAssignmentsForUserResponse). Specifying the name of a property of type Amazon.QuickSight.Model.ListIAMPolicyAssignmentsForUserResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIAMPolicyAssignmentsForUserListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UserName parameter. The -PassThru parameter is deprecated, use -Select '^UserName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIAMPolicyAssignmentsForUserListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSIdentityPropagationConfigListCmdlet"> <summary> Lists all services and authorized targets that the Amazon QuickSight IAM Identity Center application can access. <para> This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIdentityPropagationConfigListCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contain the identity propagation configurations of.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIdentityPropagationConfigListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIdentityPropagationConfigListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results, or null if there are no more results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIdentityPropagationConfigListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Services'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.ListIdentityPropagationConfigsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.ListIdentityPropagationConfigsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIdentityPropagationConfigListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIdentityPropagationConfigListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSIngestionCmdlet"> <summary> Describes a SPICE ingestion. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIngestionCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIngestionCmdlet.DataSetId"> <summary> <para> <para>The ID of the dataset used in the ingestion.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIngestionCmdlet.IngestionId"> <summary> <para> <para>An ID for the ingestion.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIngestionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Ingestion'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeIngestionResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeIngestionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIngestionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IngestionId parameter. The -PassThru parameter is deprecated, use -Select '^IngestionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSIngestionListCmdlet"> <summary> Lists the history of SPICE ingestions for a dataset.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIngestionListCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIngestionListCmdlet.DataSetId"> <summary> <para> <para>The ID of the dataset used in the ingestion.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIngestionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned per request.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIngestionListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results, or null if there are no more results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIngestionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Ingestions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.ListIngestionsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.ListIngestionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIngestionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DataSetId parameter. The -PassThru parameter is deprecated, use -Select '^DataSetId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIngestionListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSIpRestrictionCmdlet"> <summary> Provides a summary and status of IP rules. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIpRestrictionCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the IP rules.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIpRestrictionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeIpRestrictionResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeIpRestrictionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSIpRestrictionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSKeyRegistrationCmdlet"> <summary> Describes all customer managed key registrations in a Amazon QuickSight account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSKeyRegistrationCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the customer managed key registration that you want to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSKeyRegistrationCmdlet.DefaultKeyOnly"> <summary> <para> <para>Determines whether the request returns the default key only.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSKeyRegistrationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeKeyRegistrationResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeKeyRegistrationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSKeyRegistrationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSNamespaceCmdlet"> <summary> Describes the current namespace. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSNamespaceCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the Amazon Web Services account that contains the Amazon QuickSight namespace that you want to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSNamespaceCmdlet.Namespace"> <summary> <para> <para>The namespace that you want to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSNamespaceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Namespace'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeNamespaceResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeNamespaceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSNamespaceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Namespace parameter. The -PassThru parameter is deprecated, use -Select '^Namespace' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSNamespaceListCmdlet"> <summary> Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSNamespaceListCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the Amazon Web Services account that contains the Amazon QuickSight namespaces that you want to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSNamespaceListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSNamespaceListCmdlet.NextToken"> <summary> <para> <para>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 <c>ListNameSpaces</c> API call if there is more data that can be returned. To receive the data, make another <c>ListNamespaces</c> 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 <c>ListNamespaces</c> API call with an expired token, you will receive a <c>HTTP 400 InvalidNextTokenException</c> error.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSNamespaceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Namespaces'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.ListNamespacesResponse). Specifying the name of a property of type Amazon.QuickSight.Model.ListNamespacesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSNamespaceListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSNamespaceListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSQPersonalizationConfigurationCmdlet"> <summary> Describes a personalization configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSQPersonalizationConfigurationCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the personalization configuration that the user wants described.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSQPersonalizationConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PersonalizationMode'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeQPersonalizationConfigurationResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeQPersonalizationConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSQPersonalizationConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSRefreshScheduleCmdlet"> <summary> Provides a summary of a refresh schedule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSRefreshScheduleCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSRefreshScheduleCmdlet.DataSetId"> <summary> <para> <para>The ID of the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSRefreshScheduleCmdlet.ScheduleId"> <summary> <para> <para>The ID of the refresh schedule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSRefreshScheduleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeRefreshScheduleResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeRefreshScheduleResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSRefreshScheduleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ScheduleId parameter. The -PassThru parameter is deprecated, use -Select '^ScheduleId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSRefreshScheduleListCmdlet"> <summary> Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSRefreshScheduleListCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSRefreshScheduleListCmdlet.DataSetId"> <summary> <para> <para>The ID of the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSRefreshScheduleListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RefreshSchedules'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.ListRefreshSchedulesResponse). Specifying the name of a property of type Amazon.QuickSight.Model.ListRefreshSchedulesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSRefreshScheduleListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DataSetId parameter. The -PassThru parameter is deprecated, use -Select '^DataSetId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSResourceTagCmdlet"> <summary> Lists the tags assigned to a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource that you want a list of tags for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.QuickSight.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSRoleCustomPermissionCmdlet"> <summary> Describes all custom permissions that are mapped to a role. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSRoleCustomPermissionCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSRoleCustomPermissionCmdlet.Namespace"> <summary> <para> <para>The namespace that contains the role.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSRoleCustomPermissionCmdlet.Role"> <summary> <para> <para>The name of the role whose permissions you want described.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSRoleCustomPermissionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CustomPermissionsName'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeRoleCustomPermissionResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeRoleCustomPermissionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSRoleMembershipListCmdlet"> <summary> Lists all groups that are associated with a role.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSRoleMembershipListCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSRoleMembershipListCmdlet.Namespace"> <summary> <para> <para>The namespace that includes the role.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSRoleMembershipListCmdlet.Role"> <summary> <para> <para>The name of the role.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSRoleMembershipListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSRoleMembershipListCmdlet.NextToken"> <summary> <para> <para>A pagination token that can be used in a subsequent request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSRoleMembershipListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MembersList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.ListRoleMembershipsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.ListRoleMembershipsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSRoleMembershipListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSSessionEmbedUrlCmdlet"> <summary> Generates a session URL and authorization code that you can use to embed the Amazon Amazon QuickSight console in your web server code. Use <c>GetSessionEmbedUrl</c> 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 <c><a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html">UpdateUser</a></c> API operation. Use <c><a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RegisterUser.html">RegisterUser</a></c> API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the <i>Amazon QuickSight User Guide</i>: <ul><li><para><a href="https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html">Embedding Analytics</a></para></li><li><para><a href="https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html">Customizing Access to the Amazon QuickSight Console</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSSessionEmbedUrlCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSSessionEmbedUrlCmdlet.EntryPoint"> <summary> <para> <para>The URL you use to access the embedded session. The entry point URL is constrained to the following paths:</para><ul><li><para><c>/start</c></para></li><li><para><c>/start/analyses</c></para></li><li><para><c>/start/dashboards</c></para></li><li><para><c>/start/favorites</c></para></li><li><para><c>/dashboards/<i>DashboardId</i></c> - where <c>DashboardId</c> is the actual ID key from the Amazon QuickSight console URL of the dashboard</para></li><li><para><c>/analyses/<i>AnalysisId</i></c> - where <c>AnalysisId</c> is the actual ID key from the Amazon QuickSight console URL of the analysis</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSSessionEmbedUrlCmdlet.SessionLifetimeInMinute"> <summary> <para> <para>How many minutes the session is valid. The session lifetime must be 15-600 minutes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSSessionEmbedUrlCmdlet.UserArn"> <summary> <para> <para>The Amazon QuickSight user's Amazon Resource Name (ARN), for use with <c>QUICKSIGHT</c> 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:</para><ol><li><para>Active Directory (AD) users or group members</para></li><li><para>Invited nonfederated users</para></li><li><para>IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation</para></li></ol><para>Omit this parameter for users in the third group, IAM users and IAM role-based sessions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSSessionEmbedUrlCmdlet.Select"> <summary> 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.GetSessionEmbedUrlResponse). Specifying the name of a property of type Amazon.QuickSight.Model.GetSessionEmbedUrlResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSSessionEmbedUrlCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateCmdlet"> <summary> Describes a template's metadata. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateCmdlet.AliasName"> <summary> <para> <para>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 <c>$LATEST</c> in the <c>AliasName</c> parameter. The keyword <c>$PUBLISHED</c> doesn't apply to templates.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the template that you're describing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateCmdlet.TemplateId"> <summary> <para> <para>The ID for the template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateCmdlet.VersionNumber"> <summary> <para> <para>(Optional) The number for the version to describe. If a <c>VersionNumber</c> parameter value isn't provided, the latest version of the template is described.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Template'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeTemplateResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeTemplateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TemplateId parameter. The -PassThru parameter is deprecated, use -Select '^TemplateId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateAliasCmdlet"> <summary> Describes the template alias for a template. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateAliasCmdlet.AliasName"> <summary> <para> <para>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 <c>$LATEST</c> in the <c>AliasName</c> parameter. The keyword <c>$PUBLISHED</c> doesn't apply to templates.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateAliasCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the template alias that you're describing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateAliasCmdlet.TemplateId"> <summary> <para> <para>The ID for the template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateAliasCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TemplateAlias'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeTemplateAliasResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeTemplateAliasResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateAliasCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AliasName parameter. The -PassThru parameter is deprecated, use -Select '^AliasName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateAliasListCmdlet"> <summary> Lists all the aliases of a template.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateAliasListCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the template aliases that you're listing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateAliasListCmdlet.TemplateId"> <summary> <para> <para>The ID for the template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateAliasListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned per request.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateAliasListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results, or null if there are no more results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateAliasListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TemplateAliasList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.ListTemplateAliasesResponse). Specifying the name of a property of type Amazon.QuickSight.Model.ListTemplateAliasesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateAliasListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TemplateId parameter. The -PassThru parameter is deprecated, use -Select '^TemplateId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateAliasListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateDefinitionCmdlet"> <summary> Provides a detailed description of the definition of a template. <note><para> 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 <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeTemplate.html"><c>DescribeTemplate</c></a> instead. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateDefinitionCmdlet.AliasName"> <summary> <para> <para>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 <c>$LATEST</c> in the <c>AliasName</c> parameter. The keyword <c>$PUBLISHED</c> doesn't apply to templates.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateDefinitionCmdlet.AwsAccountId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateDefinitionCmdlet.TemplateId"> <summary> <para> <para>The ID of the template that you're describing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateDefinitionCmdlet.VersionNumber"> <summary> <para> <para>The version number of the template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateDefinitionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeTemplateDefinitionResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeTemplateDefinitionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TemplateId parameter. The -PassThru parameter is deprecated, use -Select '^TemplateId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateListCmdlet"> <summary> Lists all the templates in the current Amazon QuickSight account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateListCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the templates that you're listing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned per request.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results, or null if there are no more results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TemplateSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.ListTemplatesResponse). Specifying the name of a property of type Amazon.QuickSight.Model.ListTemplatesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSTemplatePermissionCmdlet"> <summary> Describes read and write permissions on a template. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplatePermissionCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the template that you're describing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplatePermissionCmdlet.TemplateId"> <summary> <para> <para>The ID for the template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplatePermissionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeTemplatePermissionsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeTemplatePermissionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplatePermissionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TemplateId parameter. The -PassThru parameter is deprecated, use -Select '^TemplateId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateVersionListCmdlet"> <summary> Lists all the versions of the templates in the current Amazon QuickSight account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateVersionListCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the templates that you're listing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateVersionListCmdlet.TemplateId"> <summary> <para> <para>The ID for the template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateVersionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned per request.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateVersionListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results, or null if there are no more results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateVersionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TemplateVersionSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.ListTemplateVersionsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.ListTemplateVersionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateVersionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TemplateId parameter. The -PassThru parameter is deprecated, use -Select '^TemplateId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTemplateVersionListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSThemeCmdlet"> <summary> Describes a theme. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemeCmdlet.AliasName"> <summary> <para> <para>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 <c>$LATEST</c> in the <c>AliasName</c> parameter. The keyword <c>$PUBLISHED</c> doesn't apply to themes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemeCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the theme that you're describing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemeCmdlet.ThemeId"> <summary> <para> <para>The ID for the theme.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemeCmdlet.VersionNumber"> <summary> <para> <para>The version number for the version to describe. If a <c>VersionNumber</c> parameter value isn't provided, the latest version of the theme is described.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Theme'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeThemeResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeThemeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ThemeId parameter. The -PassThru parameter is deprecated, use -Select '^ThemeId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSThemeAliasCmdlet"> <summary> Describes the alias for a theme. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemeAliasCmdlet.AliasName"> <summary> <para> <para>The name of the theme alias that you want to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemeAliasCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the theme alias that you're describing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemeAliasCmdlet.ThemeId"> <summary> <para> <para>The ID for the theme.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemeAliasCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ThemeAlias'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeThemeAliasResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeThemeAliasResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemeAliasCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ThemeId parameter. The -PassThru parameter is deprecated, use -Select '^ThemeId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSThemeAliasListCmdlet"> <summary> Lists all the aliases of a theme.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemeAliasListCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the theme aliases that you're listing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemeAliasListCmdlet.ThemeId"> <summary> <para> <para>The ID for the theme.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemeAliasListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned per request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemeAliasListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results, or null if there are no more results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemeAliasListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ThemeAliasList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.ListThemeAliasesResponse). Specifying the name of a property of type Amazon.QuickSight.Model.ListThemeAliasesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemeAliasListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ThemeId parameter. The -PassThru parameter is deprecated, use -Select '^ThemeId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemeAliasListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSThemeListCmdlet"> <summary> Lists all the themes in the current Amazon Web Services account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemeListCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the themes that you're listing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemeListCmdlet.Type"> <summary> <para> <para>The type of themes that you want to list. Valid options include the following:</para><ul><li><para><c>ALL (default)</c>- Display all existing themes.</para></li><li><para><c>CUSTOM</c> - Display only the themes created by people using Amazon QuickSight.</para></li><li><para><c>QUICKSIGHT</c> - Display only the starting themes defined by Amazon QuickSight.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemeListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned per request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemeListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results, or null if there are no more results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemeListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ThemeSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.ListThemesResponse). Specifying the name of a property of type Amazon.QuickSight.Model.ListThemesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemeListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemeListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSThemePermissionCmdlet"> <summary> Describes the read and write permissions for a theme. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemePermissionCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the theme that you're describing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemePermissionCmdlet.ThemeId"> <summary> <para> <para>The ID for the theme that you want to describe permissions for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemePermissionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeThemePermissionsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeThemePermissionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemePermissionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ThemeId parameter. The -PassThru parameter is deprecated, use -Select '^ThemeId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSThemeVersionListCmdlet"> <summary> Lists all the versions of the themes in the current Amazon Web Services account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemeVersionListCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the themes that you're listing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemeVersionListCmdlet.ThemeId"> <summary> <para> <para>The ID for the theme.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemeVersionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned per request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemeVersionListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results, or null if there are no more results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemeVersionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ThemeVersionSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.ListThemeVersionsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.ListThemeVersionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemeVersionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ThemeId parameter. The -PassThru parameter is deprecated, use -Select '^ThemeId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSThemeVersionListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSTopicCmdlet"> <summary> Describes a topic. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTopicCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTopicCmdlet.TopicId"> <summary> <para> <para>The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTopicCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeTopicResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeTopicResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTopicCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TopicId parameter. The -PassThru parameter is deprecated, use -Select '^TopicId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSTopicListCmdlet"> <summary> Lists all of the topics within an account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTopicListCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the topics that you want to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTopicListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned per request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTopicListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results, or null if there are no more results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTopicListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TopicsSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.ListTopicsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.ListTopicsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTopicListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTopicListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSTopicPermissionCmdlet"> <summary> Describes the permissions of a topic. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTopicPermissionCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the topic that you want described.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTopicPermissionCmdlet.TopicId"> <summary> <para> <para>The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTopicPermissionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeTopicPermissionsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeTopicPermissionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTopicPermissionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TopicId parameter. The -PassThru parameter is deprecated, use -Select '^TopicId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSTopicRefreshCmdlet"> <summary> Describes the status of a topic refresh. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTopicRefreshCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the topic whose refresh you want to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTopicRefreshCmdlet.RefreshId"> <summary> <para> <para>The ID of the refresh, which is performed when the topic is created or updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTopicRefreshCmdlet.TopicId"> <summary> <para> <para>The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTopicRefreshCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RefreshDetails'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeTopicRefreshResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeTopicRefreshResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTopicRefreshCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TopicId parameter. The -PassThru parameter is deprecated, use -Select '^TopicId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSTopicRefreshScheduleCmdlet"> <summary> Deletes a topic refresh schedule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTopicRefreshScheduleCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTopicRefreshScheduleCmdlet.DatasetId"> <summary> <para> <para>The ID of the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTopicRefreshScheduleCmdlet.TopicId"> <summary> <para> <para>The ID of the topic that contains the refresh schedule that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTopicRefreshScheduleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeTopicRefreshScheduleResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeTopicRefreshScheduleResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTopicRefreshScheduleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TopicId parameter. The -PassThru parameter is deprecated, use -Select '^TopicId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSTopicRefreshScheduleListCmdlet"> <summary> Lists all of the refresh schedules for a topic. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTopicRefreshScheduleListCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the topic whose refresh schedule you want described.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTopicRefreshScheduleListCmdlet.TopicId"> <summary> <para> <para>The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTopicRefreshScheduleListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.ListTopicRefreshSchedulesResponse). Specifying the name of a property of type Amazon.QuickSight.Model.ListTopicRefreshSchedulesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTopicRefreshScheduleListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TopicId parameter. The -PassThru parameter is deprecated, use -Select '^TopicId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSTopicReviewedAnswerListCmdlet"> <summary> Lists all reviewed answers for a Q Topic. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTopicReviewedAnswerListCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that containd the reviewed answers that you want listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTopicReviewedAnswerListCmdlet.TopicId"> <summary> <para> <para>The ID for the topic that contains the reviewed answer that you want to list. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTopicReviewedAnswerListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.ListTopicReviewedAnswersResponse). Specifying the name of a property of type Amazon.QuickSight.Model.ListTopicReviewedAnswersResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSTopicReviewedAnswerListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TopicId parameter. The -PassThru parameter is deprecated, use -Select '^TopicId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSUserCmdlet"> <summary> Returns information about a user, given the user name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSUserCmdlet.AwsAccountId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSUserCmdlet.Namespace"> <summary> <para> <para>The namespace. Currently, you should set this to <c>default</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSUserCmdlet.UserName"> <summary> <para> <para>The name of the user that you want to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSUserCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'User'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeUserResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeUserResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSUserCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UserName parameter. The -PassThru parameter is deprecated, use -Select '^UserName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSUserGroupListCmdlet"> <summary> Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSUserGroupListCmdlet.AwsAccountId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSUserGroupListCmdlet.Namespace"> <summary> <para> <para>The namespace. Currently, you should set this to <c>default</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSUserGroupListCmdlet.UserName"> <summary> <para> <para>The Amazon QuickSight user name that you want to list group memberships for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSUserGroupListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return from this request.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSUserGroupListCmdlet.NextToken"> <summary> <para> <para>A pagination token that can be used in a subsequent request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSUserGroupListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GroupList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.ListUserGroupsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.ListUserGroupsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSUserGroupListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UserName parameter. The -PassThru parameter is deprecated, use -Select '^UserName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSUserGroupListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSUserListCmdlet"> <summary> Returns a list of all of the Amazon QuickSight users belonging to this account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSUserListCmdlet.AwsAccountId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSUserListCmdlet.Namespace"> <summary> <para> <para>The namespace. Currently, you should set this to <c>default</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSUserListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return from this request.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSUserListCmdlet.NextToken"> <summary> <para> <para>A pagination token that can be used in a subsequent request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSUserListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'UserList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.ListUsersResponse). Specifying the name of a property of type Amazon.QuickSight.Model.ListUsersResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSUserListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSUserListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSVPCConnectionCmdlet"> <summary> Describes a VPC connection. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSVPCConnectionCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID of the account that contains the VPC connection that you want described.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSVPCConnectionCmdlet.VPCConnectionId"> <summary> <para> <para>The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSVPCConnectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'VPCConnection'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DescribeVPCConnectionResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DescribeVPCConnectionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSVPCConnectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the VPCConnectionId parameter. The -PassThru parameter is deprecated, use -Select '^VPCConnectionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSVPCConnectionListCmdlet"> <summary> Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSVPCConnectionListCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID of the account that contains the VPC connections that you want to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSVPCConnectionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned per request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSVPCConnectionListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results, or null if there are no more results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSVPCConnectionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'VPCConnectionSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.ListVPCConnectionsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.ListVPCConnectionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSVPCConnectionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSVPCConnectionListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.NewQSAccountCustomizationCmdlet"> <summary> Creates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, you can add a custom default theme by using the <c>CreateAccountCustomization</c> or <c>UpdateAccountCustomization</c> API operation. To further customize Amazon QuickSight by removing Amazon QuickSight sample assets and videos for all new users, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/customizing-quicksight.html">Customizing Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide.</i><para> 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 <c>DescribeAccountCustomization</c> API operation. </para><para> Before you use the <c>CreateAccountCustomization</c> 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 <c><a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeThemePermissions.html">DescribeThemePermissions</a></c> API operation. To share the theme, grant permissions by using the <c><a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateThemePermissions.html">UpdateThemePermissions</a></c> API operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAccountCustomizationCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAccountCustomizationCmdlet.AccountCustomization_DefaultEmailCustomizationTemplate"> <summary> <para> <para>The default email customization template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAccountCustomizationCmdlet.AccountCustomization_DefaultTheme"> <summary> <para> <para>The default theme for this Amazon QuickSight subscription.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAccountCustomizationCmdlet.Namespace"> <summary> <para> <para>The Amazon QuickSight namespace that you want to add customizations to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAccountCustomizationCmdlet.Tag"> <summary> <para> <para>A list of the tags that you want to attach to this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAccountCustomizationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.CreateAccountCustomizationResponse). Specifying the name of a property of type Amazon.QuickSight.Model.CreateAccountCustomizationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAccountCustomizationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAccountCustomizationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.NewQSAccountSubscriptionCmdlet"> <summary> Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q. <para> The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK. </para><para> 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 <a href="https://docs.aws.amazon.com/quicksight/latest/user/setting-up-aws-sign-up.html">Sign up for Amazon Web Services</a> in the <i>Amazon QuickSight User Guide</i>. The person who signs up for Amazon QuickSight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/iam-policy-examples.html">IAM Policy Examples for Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide</i>. </para><para> If your IAM policy includes both the <c>Subscribe</c> and <c>CreateAccountSubscription</c> actions, make sure that both actions are set to <c>Allow</c>. If either action is set to <c>Deny</c>, the <c>Deny</c> action prevails and your API call fails. </para><para> 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 <a href="https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html#security-create-iam-role">Passing IAM roles to Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide</i>. </para><para> 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 <a href="https://docs.aws.amazon.com/quicksight/latest/user/scoping-policies-defaults.html">Setting default resource access to Amazon Web Services services</a> in the <i>Amazon QuickSight User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAccountSubscriptionCmdlet.AccountName"> <summary> <para> <para>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 <c>AccountName</c> value after the Amazon QuickSight account is created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAccountSubscriptionCmdlet.ActiveDirectoryName"> <summary> <para> <para>The name of your Active Directory. This field is required if <c>ACTIVE_DIRECTORY</c> is the selected authentication method of the new Amazon QuickSight account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAccountSubscriptionCmdlet.AdminGroup"> <summary> <para> <para>The admin group associated with your Active Directory or IAM Identity Center account. Either this field or the <c>AdminProGroup</c> field is required if <c>ACTIVE_DIRECTORY</c> or <c>IAM_IDENTITY_CENTER</c> is the selected authentication method of the new Amazon QuickSight account.</para><para>For more information about using IAM Identity Center in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html">Using IAM Identity Center with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAccountSubscriptionCmdlet.AdminProGroup"> <summary> <para> <para>The admin pro group associated with your Active Directory or IAM Identity Center account. Either this field or the <c>AdminGroup</c> field is required if <c>ACTIVE_DIRECTORY</c> or <c>IAM_IDENTITY_CENTER</c> is the selected authentication method of the new Amazon QuickSight account.</para><para>For more information about using IAM Identity Center in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html">Using IAM Identity Center with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAccountSubscriptionCmdlet.AuthenticationMethod"> <summary> <para> <para>The method that you want to use to authenticate your Amazon QuickSight account.</para><para>If you choose <c>ACTIVE_DIRECTORY</c>, provide an <c>ActiveDirectoryName</c> and an <c>AdminGroup</c> associated with your Active Directory.</para><para>If you choose <c>IAM_IDENTITY_CENTER</c>, provide an <c>AdminGroup</c> associated with your IAM Identity Center account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAccountSubscriptionCmdlet.AuthorGroup"> <summary> <para> <para>The author group associated with your Active Directory or IAM Identity Center account.</para><para>For more information about using IAM Identity Center in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html">Using IAM Identity Center with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAccountSubscriptionCmdlet.AuthorProGroup"> <summary> <para> <para>The author pro group associated with your Active Directory or IAM Identity Center account.</para><para>For more information about using IAM Identity Center in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html">Using IAM Identity Center with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAccountSubscriptionCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID of the account that you're using to create your Amazon QuickSight account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAccountSubscriptionCmdlet.ContactNumber"> <summary> <para> <para>A 10-digit phone number for the author of the Amazon QuickSight account to use for future communications. This field is required if <c>ENTERPPRISE_AND_Q</c> is the selected edition of the new Amazon QuickSight account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAccountSubscriptionCmdlet.DirectoryId"> <summary> <para> <para>The ID of the Active Directory that is associated with your Amazon QuickSight account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAccountSubscriptionCmdlet.Edition"> <summary> <para> <para>The edition of Amazon QuickSight that you want your account to have. Currently, you can choose from <c>ENTERPRISE</c> or <c>ENTERPRISE_AND_Q</c>.</para><para>If you choose <c>ENTERPRISE_AND_Q</c>, the following parameters are required:</para><ul><li><para><c>FirstName</c></para></li><li><para><c>LastName</c></para></li><li><para><c>EmailAddress</c></para></li><li><para><c>ContactNumber</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAccountSubscriptionCmdlet.EmailAddress"> <summary> <para> <para>The email address of the author of the Amazon QuickSight account to use for future communications. This field is required if <c>ENTERPPRISE_AND_Q</c> is the selected edition of the new Amazon QuickSight account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAccountSubscriptionCmdlet.FirstName"> <summary> <para> <para>The first name of the author of the Amazon QuickSight account to use for future communications. This field is required if <c>ENTERPPRISE_AND_Q</c> is the selected edition of the new Amazon QuickSight account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAccountSubscriptionCmdlet.IAMIdentityCenterInstanceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the IAM Identity Center instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAccountSubscriptionCmdlet.LastName"> <summary> <para> <para>The last name of the author of the Amazon QuickSight account to use for future communications. This field is required if <c>ENTERPPRISE_AND_Q</c> is the selected edition of the new Amazon QuickSight account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAccountSubscriptionCmdlet.NotificationEmail"> <summary> <para> <para>The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAccountSubscriptionCmdlet.ReaderGroup"> <summary> <para> <para>The reader group associated with your Active Directory or IAM Identity Center account.</para><para>For more information about using IAM Identity Center in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html">Using IAM Identity Center with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAccountSubscriptionCmdlet.ReaderProGroup"> <summary> <para> <para>The reader pro group associated with your Active Directory or IAM Identity Center account.</para><para>For more information about using IAM Identity Center in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html">Using IAM Identity Center with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAccountSubscriptionCmdlet.Realm"> <summary> <para> <para>The realm of the Active Directory that is associated with your Amazon QuickSight account. This field is required if <c>ACTIVE_DIRECTORY</c> is the selected authentication method of the new Amazon QuickSight account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAccountSubscriptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.CreateAccountSubscriptionResponse). Specifying the name of a property of type Amazon.QuickSight.Model.CreateAccountSubscriptionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAccountSubscriptionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAccountSubscriptionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet"> <summary> Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an <c>AnalysisDefinition</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.AnalysisId"> <summary> <para> <para>The ID for the analysis that you're creating. This ID displays in the URL of the analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.SourceTemplate_Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the source template of an analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account where you are creating an analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.PaperMargin_Bottom"> <summary> <para> <para>Define the bottom spacing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.Definition_CalculatedField"> <summary> <para> <para>An array of calculated field definitions for the analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.Definition_ColumnConfiguration"> <summary> <para> <para> An array of analysis-level column configurations. Column configurations can be used to set default formatting for a column to be used throughout an analysis. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.Definition_DataSetIdentifierDeclaration"> <summary> <para> <para>An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of dataset ARNs throughout analysis sub-structures.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.SourceTemplate_DataSetReference"> <summary> <para> <para>The dataset references of the source template of an analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.Parameters_DateTimeParameter"> <summary> <para> <para>The parameters that have a data type of date-time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.Parameters_DecimalParameter"> <summary> <para> <para>The parameters that have a data type of decimal.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.Definition_FilterGroup"> <summary> <para> <para>Filter definitions for an analysis.</para><para>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/adding-a-filter.html">Filtering Data in Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.FolderArn"> <summary> <para> <para>When you create the analysis, Amazon QuickSight adds the analysis to these folders.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.Parameters_IntegerParameter"> <summary> <para> <para>The parameters that have a data type of integer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.PaperMargin_Left"> <summary> <para> <para>Define the left spacing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.ValidationStrategy_Mode"> <summary> <para> <para>The mode of validation for the asset to be created or updated. When you set this value to <c>STRICT</c>, strict validation for every error is enforced. When you set this value to <c>LENIENT</c>, validation is skipped for specific UI errors.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.Name"> <summary> <para> <para>A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon QuickSight console. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.Definition_AnalysisDefaults_DefaultNewSheetConfiguration_InteractiveLayoutConfiguration_FreeForm_CanvasSizeOptions_ScreenCanvasSizeOptions_OptimizedViewPortWidth"> <summary> <para> <para>The width that the view port will be optimized for when the layout renders.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.Definition_AnalysisDefaults_DefaultNewSheetConfiguration_InteractiveLayoutConfiguration_Grid_CanvasSizeOptions_ScreenCanvasSizeOptions_OptimizedViewPortWidth"> <summary> <para> <para>The width that the view port will be optimized for when the layout renders.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.PaperCanvasSizeOptions_PaperOrientation"> <summary> <para> <para>The paper orientation that is used to define canvas dimensions. Choose one of the following options:</para><ul><li><para>PORTRAIT</para></li><li><para>LANDSCAPE</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.PaperCanvasSizeOptions_PaperSize"> <summary> <para> <para>The paper size that is used to define canvas dimensions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.Definition_ParameterDeclaration"> <summary> <para> <para>An array of parameter declarations for an analysis.</para><para>Parameters are named variables that can transfer a value for use by an action or an object.</para><para>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html">Parameters in Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.Permission"> <summary> <para> <para>A structure that describes the principals and the resource-level permissions on an analysis. You can use the <c>Permissions</c> 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). </para><para>To specify no permissions, omit <c>Permissions</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.QueryExecutionOptions_QueryExecutionMode"> <summary> <para> <para>A structure that describes the query execution mode.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.ScreenCanvasSizeOptions_ResizeOption"> <summary> <para> <para>This value determines the layout behavior when the viewport is resized.</para><ul><li><para><c>FIXED</c>: A fixed width will be used when optimizing the layout. In the Amazon QuickSight console, this option is called <c>Classic</c>.</para></li><li><para><c>RESPONSIVE</c>: The width of the canvas will be responsive and optimized to the view port. In the Amazon QuickSight console, this option is called <c>Tiled</c>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.PaperMargin_Right"> <summary> <para> <para>Define the right spacing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.DefaultNewSheetConfiguration_SheetContentType"> <summary> <para> <para>The option that determines the sheet content type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.Definition_Sheet"> <summary> <para> <para>An array of sheet definitions for an analysis. Each <c>SheetDefinition</c> provides detailed information about a sheet within this analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.Parameters_StringParameter"> <summary> <para> <para>The parameters that have a data type of string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.Tag"> <summary> <para> <para>Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.ThemeArn"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.Options_Timezone"> <summary> <para> <para>Determines the timezone for the analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.PaperMargin_Top"> <summary> <para> <para>Define the top spacing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.Options_WeekStart"> <summary> <para> <para>Determines the week start day for an analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.CreateAnalysisResponse). Specifying the name of a property of type Amazon.QuickSight.Model.CreateAnalysisResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AnalysisId parameter. The -PassThru parameter is deprecated, use -Select '^AnalysisId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSAnalysisCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet"> <summary> Creates a dashboard from either a template or directly with a <c>DashboardDefinition</c>. To first create a template, see the <c><a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a></c> API operation. <para> 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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.SourceTemplate_Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.AdHocFilteringOption_AvailabilityStatus"> <summary> <para> <para>Availability status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.DataPointDrillUpDownOption_AvailabilityStatus"> <summary> <para> <para>The status of the drill down options of data points.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.DataPointMenuLabelOption_AvailabilityStatus"> <summary> <para> <para>The status of the data point menu options.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.DataPointTooltipOption_AvailabilityStatus"> <summary> <para> <para>The status of the data point tool tip options.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.ExportToCSVOption_AvailabilityStatus"> <summary> <para> <para>Availability status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.ExportWithHiddenFieldsOption_AvailabilityStatus"> <summary> <para> <para>The status of the export with hidden fields options.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.SheetLayoutElementMaximizationOption_AvailabilityStatus"> <summary> <para> <para>The status of the sheet layout maximization options of a dashbaord.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.VisualAxisSortOption_AvailabilityStatus"> <summary> <para> <para>The availaiblity status of a visual's axis sort options.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.VisualMenuOption_AvailabilityStatus"> <summary> <para> <para>The availaiblity status of a visual's menu options.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.ExportHiddenFieldsOption_AvailabilityStatus"> <summary> <para> <para>The status of the export hidden fields options of a dashbaord.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account where you want to create the dashboard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.PaperMargin_Bottom"> <summary> <para> <para>Define the bottom spacing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.Definition_CalculatedField"> <summary> <para> <para>An array of calculated field definitions for the dashboard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.Definition_ColumnConfiguration"> <summary> <para> <para>An array of dashboard-level column configurations. Column configurations are used to set the default formatting for a column that is used throughout a dashboard. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.DashboardId"> <summary> <para> <para>The ID for the dashboard, also added to the IAM policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.Definition_DataSetIdentifierDeclaration"> <summary> <para> <para>An array of dataset identifier declarations. With this mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard's sub-structures.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.SourceTemplate_DataSetReference"> <summary> <para> <para>Dataset references.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.Parameters_DateTimeParameter"> <summary> <para> <para>The parameters that have a data type of date-time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.Parameters_DecimalParameter"> <summary> <para> <para>The parameters that have a data type of decimal.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.Definition_FilterGroup"> <summary> <para> <para>The filter definitions for a dashboard.</para><para>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/adding-a-filter.html">Filtering Data in Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.FolderArn"> <summary> <para> <para>When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.Parameters_IntegerParameter"> <summary> <para> <para>The parameters that have a data type of integer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.PaperMargin_Left"> <summary> <para> <para>Define the left spacing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.LinkEntity"> <summary> <para> <para>A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.ValidationStrategy_Mode"> <summary> <para> <para>The mode of validation for the asset to be created or updated. When you set this value to <c>STRICT</c>, strict validation for every error is enforced. When you set this value to <c>LENIENT</c>, validation is skipped for specific UI errors.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.Name"> <summary> <para> <para>The display name of the dashboard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.Definition_AnalysisDefaults_DefaultNewSheetConfiguration_InteractiveLayoutConfiguration_FreeForm_CanvasSizeOptions_ScreenCanvasSizeOptions_OptimizedViewPortWidth"> <summary> <para> <para>The width that the view port will be optimized for when the layout renders.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.Definition_AnalysisDefaults_DefaultNewSheetConfiguration_InteractiveLayoutConfiguration_Grid_CanvasSizeOptions_ScreenCanvasSizeOptions_OptimizedViewPortWidth"> <summary> <para> <para>The width that the view port will be optimized for when the layout renders.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.PaperCanvasSizeOptions_PaperOrientation"> <summary> <para> <para>The paper orientation that is used to define canvas dimensions. Choose one of the following options:</para><ul><li><para>PORTRAIT</para></li><li><para>LANDSCAPE</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.PaperCanvasSizeOptions_PaperSize"> <summary> <para> <para>The paper size that is used to define canvas dimensions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.Definition_ParameterDeclaration"> <summary> <para> <para>The parameter declarations for a dashboard. Parameters are named variables that can transfer a value for use by an action or an object.</para><para>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html">Parameters in Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.LinkSharingConfiguration_Permission"> <summary> <para> <para>A structure that contains the permissions of a shareable link.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.Permission"> <summary> <para> <para>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. </para><para>To specify no permissions, omit the permissions list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.ScreenCanvasSizeOptions_ResizeOption"> <summary> <para> <para>This value determines the layout behavior when the viewport is resized.</para><ul><li><para><c>FIXED</c>: A fixed width will be used when optimizing the layout. In the Amazon QuickSight console, this option is called <c>Classic</c>.</para></li><li><para><c>RESPONSIVE</c>: The width of the canvas will be responsive and optimized to the view port. In the Amazon QuickSight console, this option is called <c>Tiled</c>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.PaperMargin_Right"> <summary> <para> <para>Define the right spacing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.DefaultNewSheetConfiguration_SheetContentType"> <summary> <para> <para>The option that determines the sheet content type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.Definition_Sheet"> <summary> <para> <para>An array of sheet definitions for a dashboard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.Parameters_StringParameter"> <summary> <para> <para>The parameters that have a data type of string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.Tag"> <summary> <para> <para>Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.ThemeArn"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.Options_Timezone"> <summary> <para> <para>Determines the timezone for the analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.PaperMargin_Top"> <summary> <para> <para>Define the top spacing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.VersionDescription"> <summary> <para> <para>A description for the first version of the dashboard being created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.SheetControlsOption_VisibilityState"> <summary> <para> <para>Visibility state.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.Options_WeekStart"> <summary> <para> <para>Determines the week start day for an analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.CreateDashboardResponse). Specifying the name of a property of type Amazon.QuickSight.Model.CreateDashboardResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DashboardId parameter. The -PassThru parameter is deprecated, use -Select '^DashboardId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDashboardCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.NewQSDataSetCmdlet"> <summary> Creates a dataset. This operation doesn't support datasets that include uploaded files as a source. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSetCmdlet.RowLevelPermissionDataSet_Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSetCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSetCmdlet.ColumnGroup"> <summary> <para> <para>Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSetCmdlet.ColumnLevelPermissionRule"> <summary> <para> <para>A set of one or more definitions of a <c><a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html">ColumnLevelPermissionRule</a></c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSetCmdlet.DataSetId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSetCmdlet.DatasetParameter"> <summary> <para> <para>The parameter declarations of the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSetCmdlet.DataSetUsageConfiguration_DisableUseAsDirectQuerySource"> <summary> <para> <para>An option that controls whether a child dataset of a direct query can use this dataset as a source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSetCmdlet.DataSetUsageConfiguration_DisableUseAsImportedSource"> <summary> <para> <para>An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSetCmdlet.FieldFolder"> <summary> <para> <para>The folder that contains fields and nested subfolders for your dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSetCmdlet.FolderArn"> <summary> <para> <para>When you create the dataset, Amazon QuickSight adds the dataset to these folders.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSetCmdlet.RowLevelPermissionDataSet_FormatVersion"> <summary> <para> <para>The user or group rules associated with the dataset that contains permissions for RLS.</para><para>By default, <c>FormatVersion</c> is <c>VERSION_1</c>. When <c>FormatVersion</c> is <c>VERSION_1</c>, <c>UserName</c> and <c>GroupName</c> are required. When <c>FormatVersion</c> is <c>VERSION_2</c>, <c>UserARN</c> and <c>GroupARN</c> are required, and <c>Namespace</c> must not exist.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSetCmdlet.ImportMode"> <summary> <para> <para>Indicates whether you want to import the data into SPICE.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSetCmdlet.LogicalTableMap"> <summary> <para> <para>Configures the combination and transformation of the data from the physical tables.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSetCmdlet.Name"> <summary> <para> <para>The display name for the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSetCmdlet.RowLevelPermissionDataSet_Namespace"> <summary> <para> <para>The namespace associated with the dataset that contains permissions for RLS.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSetCmdlet.RowLevelPermissionDataSet_PermissionPolicy"> <summary> <para> <para>The type of permissions to use when interpreting the permissions for RLS. <c>DENY_ACCESS</c> is included for backward compatibility only.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSetCmdlet.Permission"> <summary> <para> <para>A list of resource permissions on the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSetCmdlet.PhysicalTableMap"> <summary> <para> <para>Declares the physical tables that are available in the underlying data sources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSetCmdlet.RowLevelPermissionDataSet_Status"> <summary> <para> <para>The status of the row-level security permission dataset. If enabled, the status is <c>ENABLED</c>. If disabled, the status is <c>DISABLED</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSetCmdlet.RowLevelPermissionTagConfiguration_Status"> <summary> <para> <para>The status of row-level security tags. If enabled, the status is <c>ENABLED</c>. If disabled, the status is <c>DISABLED</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSetCmdlet.RowLevelPermissionTagConfiguration_TagRuleConfiguration"> <summary> <para> <para>A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSetCmdlet.RowLevelPermissionTagConfiguration_TagRule"> <summary> <para> <para>A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSetCmdlet.Tag"> <summary> <para> <para>Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.CreateDataSetResponse). Specifying the name of a property of type Amazon.QuickSight.Model.CreateDataSetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DataSetId parameter. The -PassThru parameter is deprecated, use -Select '^DataSetId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet"> <summary> Creates a data source. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.CredentialPair_AlternateDataSourceParameter"> <summary> <para> <para>A set of alternate data source parameters that you want to share for these credentials. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the <c>DataSourceParameters</c> structure that's in the request with the structures in the <c>AlternateDataSourceParameters</c> allow list. If the structures are an exact match, the request is allowed to use the new data source with the existing credentials. If the <c>AlternateDataSourceParameters</c> list is null, the <c>DataSourceParameters</c> originally used with these <c>Credentials</c> is automatically allowed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.SnowflakeParameters_AuthenticationType"> <summary> <para> <para>The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.StarburstParameters_AuthenticationType"> <summary> <para> <para>The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.IAMParameters_AutoCreateDatabaseUser"> <summary> <para> <para>Automatically creates a database user. If your database doesn't have a <c>DatabaseUser</c>, set this parameter to <c>True</c>. If there is no <c>DatabaseUser</c>, Amazon QuickSight can't connect to your cluster. The <c>RoleArn</c> that you use for this operation must grant access to <c>redshift:CreateClusterUser</c> to successfully create the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.ManifestFileLocation_Bucket"> <summary> <para> <para>Amazon S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.PrestoParameters_Catalog"> <summary> <para> <para>Catalog.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.StarburstParameters_Catalog"> <summary> <para> <para>The catalog name for the Starburst data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.TrinoParameters_Catalog"> <summary> <para> <para>The catalog name for the Trino data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.RedshiftParameters_ClusterId"> <summary> <para> <para>Cluster ID. This field can be blank if the <c>Host</c> and <c>Port</c> are provided.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.Credentials_CopySourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use. When <c>CopySourceArn</c> is not null, the credential pair from the data source in the ARN is used as the credentials for the <c>DataSourceCredentials</c> structure.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.AuroraParameters_Database"> <summary> <para> <para>Database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.AuroraPostgreSqlParameters_Database"> <summary> <para> <para>The Amazon Aurora PostgreSQL database to connect to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.MariaDbParameters_Database"> <summary> <para> <para>Database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.MySqlParameters_Database"> <summary> <para> <para>Database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.OracleParameters_Database"> <summary> <para> <para>The database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.PostgreSqlParameters_Database"> <summary> <para> <para>Database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.RdsParameters_Database"> <summary> <para> <para>Database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.RedshiftParameters_Database"> <summary> <para> <para>Database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.SnowflakeParameters_Database"> <summary> <para> <para>Database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.SqlServerParameters_Database"> <summary> <para> <para>Database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.TeradataParameters_Database"> <summary> <para> <para>Database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.SnowflakeParameters_DatabaseAccessControlRole"> <summary> <para> <para>The database access control role.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.StarburstParameters_DatabaseAccessControlRole"> <summary> <para> <para>The database access control role.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.IAMParameters_DatabaseGroup"> <summary> <para> <para>A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the <c>DatabaseUser</c>. If you choose to include this parameter, the <c>RoleArn</c> must grant access to <c>redshift:JoinGroup</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.IAMParameters_DatabaseUser"> <summary> <para> <para>The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of <c>AutoCreateDatabaseUser</c> to <c>True</c> to create a new user with PUBLIC permissions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.AwsIotAnalyticsParameters_DataSetName"> <summary> <para> <para>Dataset name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.BigQueryParameters_DataSetRegion"> <summary> <para> <para>The storage location where you create a Google BigQuery data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.DataSourceId"> <summary> <para> <para>An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.SslProperties_DisableSsl"> <summary> <para> <para>A Boolean option to control whether SSL should be disabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.AmazonElasticsearchParameters_Domain"> <summary> <para> <para>The OpenSearch domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.AmazonOpenSearchParameters_Domain"> <summary> <para> <para>The OpenSearch domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.IdentityCenterConfiguration_EnableIdentityPropagation"> <summary> <para> <para>A Boolean option that controls whether Trusted Identity Propagation should be used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.FolderArn"> <summary> <para> <para>When you create the data source, Amazon QuickSight adds the data source to these folders.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.AuroraParameters_Host"> <summary> <para> <para>Host.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.AuroraPostgreSqlParameters_Host"> <summary> <para> <para>The Amazon Aurora PostgreSQL-Compatible host to connect to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.DatabricksParameters_Host"> <summary> <para> <para>The host name of the Databricks data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.ExasolParameters_Host"> <summary> <para> <para>The hostname or IP address of the Exasol data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.MariaDbParameters_Host"> <summary> <para> <para>Host.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.MySqlParameters_Host"> <summary> <para> <para>Host.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.OracleParameters_Host"> <summary> <para> <para>An Oracle host.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.PostgreSqlParameters_Host"> <summary> <para> <para>Host.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.PrestoParameters_Host"> <summary> <para> <para>Host.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.RedshiftParameters_Host"> <summary> <para> <para>Host. This field can be blank if <c>ClusterId</c> is provided.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.SnowflakeParameters_Host"> <summary> <para> <para>Host.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.SparkParameters_Host"> <summary> <para> <para>Host.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.SqlServerParameters_Host"> <summary> <para> <para>Host.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.StarburstParameters_Host"> <summary> <para> <para>The host name of the Starburst data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.TeradataParameters_Host"> <summary> <para> <para>Host.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.TrinoParameters_Host"> <summary> <para> <para>The host name of the Trino data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.DataSourceParameters_SnowflakeParameters_OAuthParameters_IdentityProviderResourceUri"> <summary> <para> <para>The resource uri of the identity provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.DataSourceParameters_StarburstParameters_OAuthParameters_IdentityProviderResourceUri"> <summary> <para> <para>The resource uri of the identity provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.RdsParameters_InstanceId"> <summary> <para> <para>Instance ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.ManifestFileLocation_Key"> <summary> <para> <para>Amazon S3 key that identifies an object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.TwitterParameters_MaxRow"> <summary> <para> <para>Maximum number of rows to query Twitter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.Name"> <summary> <para> <para>A display name for the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.DataSourceParameters_SnowflakeParameters_OAuthParameters_OAuthScope"> <summary> <para> <para>The OAuth scope.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.DataSourceParameters_StarburstParameters_OAuthParameters_OAuthScope"> <summary> <para> <para>The OAuth scope.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.CredentialPair_Password"> <summary> <para> <para>Password.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.Permission"> <summary> <para> <para>A list of resource permissions on the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.AuroraParameters_Port"> <summary> <para> <para>Port.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.AuroraPostgreSqlParameters_Port"> <summary> <para> <para>The port that Amazon Aurora PostgreSQL is listening on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.DatabricksParameters_Port"> <summary> <para> <para>The port for the Databricks data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.ExasolParameters_Port"> <summary> <para> <para>The port for the Exasol data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.MariaDbParameters_Port"> <summary> <para> <para>Port.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.MySqlParameters_Port"> <summary> <para> <para>Port.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.OracleParameters_Port"> <summary> <para> <para>The port.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.PostgreSqlParameters_Port"> <summary> <para> <para>Port.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.PrestoParameters_Port"> <summary> <para> <para>Port.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.RedshiftParameters_Port"> <summary> <para> <para>Port. This field can be blank if the <c>ClusterId</c> is provided.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.SparkParameters_Port"> <summary> <para> <para>Port.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.SqlServerParameters_Port"> <summary> <para> <para>Port.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.StarburstParameters_Port"> <summary> <para> <para>The port for the Starburst data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.TeradataParameters_Port"> <summary> <para> <para>Port.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.TrinoParameters_Port"> <summary> <para> <para>The port for the Trino data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.StarburstParameters_ProductType"> <summary> <para> <para>The product type for the Starburst data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.BigQueryParameters_ProjectId"> <summary> <para> <para>The Google Cloud Platform project ID where your datasource was created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.TwitterParameters_Query"> <summary> <para> <para>Twitter query string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.AthenaParameters_RoleArn"> <summary> <para> <para>Use the <c>RoleArn</c> structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use <c>RoleArn</c> to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.IAMParameters_RoleArn"> <summary> <para> <para>Use the <c>RoleArn</c> structure to allow Amazon QuickSight to call <c>redshift:GetClusterCredentials</c> on your cluster. The calling principal must have <c>iam:PassRole</c> access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.S3Parameters_RoleArn"> <summary> <para> <para>Use the <c>RoleArn</c> structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use <c>RoleArn</c> to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.Credentials_SecretArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.JiraParameters_SiteBaseUrl"> <summary> <para> <para>The base URL of the Jira site.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.ServiceNowParameters_SiteBaseUrl"> <summary> <para> <para>URL of the base site.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.DatabricksParameters_SqlEndpointPath"> <summary> <para> <para>The HTTP path of the Databricks data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.Tag"> <summary> <para> <para>Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.DataSourceParameters_SnowflakeParameters_OAuthParameters_TokenProviderUrl"> <summary> <para> <para>The token endpoint URL of the identity provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.DataSourceParameters_StarburstParameters_OAuthParameters_TokenProviderUrl"> <summary> <para> <para>The token endpoint URL of the identity provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.Type"> <summary> <para> <para>The type of the data source. To return a list of all data sources, use <c>ListDataSources</c>.</para><para>Use <c>AMAZON_ELASTICSEARCH</c> for Amazon OpenSearch Service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.CredentialPair_Username"> <summary> <para> <para>User name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.DataSourceParameters_SnowflakeParameters_OAuthParameters_IdentityProviderVpcConnectionProperties_VpcConnectionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the VPC connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.DataSourceParameters_StarburstParameters_OAuthParameters_IdentityProviderVpcConnectionProperties_VpcConnectionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the VPC connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.VpcConnectionProperties_VpcConnectionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the VPC connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.SnowflakeParameters_Warehouse"> <summary> <para> <para>Warehouse.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.AthenaParameters_WorkGroup"> <summary> <para> <para>The workgroup that Amazon Athena uses.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.CreateDataSourceResponse). Specifying the name of a property of type Amazon.QuickSight.Model.CreateDataSourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DataSourceId parameter. The -PassThru parameter is deprecated, use -Select '^DataSourceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSDataSourceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForAnonymousUserCmdlet"> <summary> 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. <para> The following rules apply to the generated URL: </para><ul><li><para> 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. </para></li><li><para> The URL validity period should not be confused with the actual session lifetime that can be customized using the <c><a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForAnonymousUser.html#QS-GenerateEmbedUrlForAnonymousUser-request-SessionLifetimeInMinutes">SessionLifetimeInMinutes</a></c> parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours. </para></li><li><para> You are charged only when the URL is used or there is interaction with Amazon QuickSight. </para></li></ul><para> For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html">Embedded Analytics</a> in the <i>Amazon QuickSight User Guide</i>. </para><para> For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the <a href="https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html">Amazon QuickSight Developer Portal</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForAnonymousUserCmdlet.AllowedDomain"> <summary> <para> <para>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.</para><para>To include all subdomains under a specific domain to the allow list, use <c>*</c>. For example, <c>https://*.sapp.amazon.com</c> includes all subdomains under <c>https://sapp.amazon.com</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForAnonymousUserCmdlet.AuthorizedResourceArn"> <summary> <para> <para>The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user is authorized to access during the lifetime of the session.</para><para>If you choose <c>Dashboard</c> embedding experience, pass the list of dashboard ARNs in the account that you want the user to be able to view.</para><para>If you want to make changes to the theme of your embedded content, pass a list of theme ARNs that the anonymous users need access to.</para><para>Currently, you can pass up to 25 theme ARNs in each API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForAnonymousUserCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the Amazon Web Services account that contains the dashboard that you're embedding.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForAnonymousUserCmdlet.InitialDashboardVisualId_DashboardId"> <summary> <para> <para>The ID of the dashboard that has the visual that you want to embed. The <c>DashboardId</c> can be found in the <c>IDs for developers</c> section of the <c>Embed visual</c> pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the <c>DashboardId</c> with a <c>ListDashboards</c> API operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForAnonymousUserCmdlet.Dashboard_DisabledFeature"> <summary> <para> <para>A list of all disabled features of a specified anonymous dashboard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForAnonymousUserCmdlet.SharedView_Enabled"> <summary> <para> <para>The shared view settings of an embedded dashboard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForAnonymousUserCmdlet.Dashboard_EnabledFeature"> <summary> <para> <para>A list of all enabled features of a specified anonymous dashboard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForAnonymousUserCmdlet.Dashboard_InitialDashboardId"> <summary> <para> <para>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 QuickSight renders this dashboard.</para><para>The Amazon Resource Name (ARN) of this dashboard must be included in the <c>AuthorizedResourceArns</c> parameter. Otherwise, the request will fail with <c>InvalidParameterValueException</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForAnonymousUserCmdlet.GenerativeQnA_InitialTopicId"> <summary> <para> <para>The Amazon QuickSight Q topic ID of the new reader experience topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Generative Q&A experience with this new reader experience topic pre selected.</para><para>The Amazon Resource Name (ARN) of this Q new reader experience topic must be included in the <c>AuthorizedResourceArns</c> parameter. Otherwise, the request fails with an <c>InvalidParameterValueException</c> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForAnonymousUserCmdlet.QSearchBar_InitialTopicId"> <summary> <para> <para>The Amazon QuickSight Q topic ID of the legacy topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Q search bar with this legacy topic pre-selected.</para><para>The Amazon Resource Name (ARN) of this Q legacy topic must be included in the <c>AuthorizedResourceArns</c> parameter. Otherwise, the request fails with an <c>InvalidParameterValueException</c> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForAnonymousUserCmdlet.Namespace"> <summary> <para> <para>The Amazon QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon QuickSight custom namespace, set this to <c>default</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForAnonymousUserCmdlet.SessionLifetimeInMinute"> <summary> <para> <para>How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForAnonymousUserCmdlet.SessionTag"> <summary> <para> <para>The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the <c>DataSet$RowLevelPermissionTagConfiguration</c> parameter so that session tags can be used to provide row-level security.</para><para>These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-rls-tags.html">Using Row-Level Security (RLS) with Tags</a>in the <i>Amazon QuickSight User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForAnonymousUserCmdlet.InitialDashboardVisualId_SheetId"> <summary> <para> <para>The ID of the sheet that the has visual that you want to embed. The <c>SheetId</c> can be found in the <c>IDs for developers</c> section of the <c>Embed visual</c> pane of the visual's on-visual menu of the Amazon QuickSight console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForAnonymousUserCmdlet.InitialDashboardVisualId_VisualId"> <summary> <para> <para>The ID of the visual that you want to embed. The <c>VisualID</c> can be found in the <c>IDs for developers</c> section of the <c>Embed visual</c> pane of the visual's on-visual menu of the Amazon QuickSight console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForAnonymousUserCmdlet.Select"> <summary> 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.GenerateEmbedUrlForAnonymousUserResponse). Specifying the name of a property of type Amazon.QuickSight.Model.GenerateEmbedUrlForAnonymousUserResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForAnonymousUserCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForAnonymousUserCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForRegisteredUserCmdlet"> <summary> 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. <para> The following rules apply to the generated URL: </para><ul><li><para> 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. </para></li><li><para> The URL validity period should not be confused with the actual session lifetime that can be customized using the <c><a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForRegisteredUser.html#QS-GenerateEmbedUrlForRegisteredUser-request-SessionLifetimeInMinutes">SessionLifetimeInMinutes</a></c> parameter. </para><para> The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours. </para></li><li><para> You are charged only when the URL is used or there is interaction with Amazon QuickSight. </para></li></ul><para> For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html">Embedded Analytics</a> in the <i>Amazon QuickSight User Guide</i>. </para><para> For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the <a href="https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html">Amazon QuickSight Developer Portal</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForRegisteredUserCmdlet.AllowedDomain"> <summary> <para> <para>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.</para><para>To include all subdomains under a specific domain to the allow list, use <c>*</c>. For example, <c>https://*.sapp.amazon.com</c> includes all subdomains under <c>https://sapp.amazon.com</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForRegisteredUserCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the Amazon Web Services account that contains the dashboard that you're embedding.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForRegisteredUserCmdlet.InitialDashboardVisualId_DashboardId"> <summary> <para> <para>The ID of the dashboard that has the visual that you want to embed. The <c>DashboardId</c> can be found in the <c>IDs for developers</c> section of the <c>Embed visual</c> pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the <c>DashboardId</c> with a <c>ListDashboards</c> API operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForRegisteredUserCmdlet.ExperienceConfiguration_Dashboard_FeatureConfigurations_Bookmarks_Enabled"> <summary> <para> <para>A Boolean value that determines whether a user can bookmark an embedded dashboard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForRegisteredUserCmdlet.ExperienceConfiguration_Dashboard_FeatureConfigurations_SharedView_Enabled"> <summary> <para> <para>The shared view settings of an embedded dashboard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForRegisteredUserCmdlet.ExperienceConfiguration_Dashboard_FeatureConfigurations_StatePersistence_Enabled"> <summary> <para> <para>Determines if a Amazon QuickSight dashboard's state persistence settings are turned on or off.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForRegisteredUserCmdlet.ExperienceConfiguration_QuickSightConsole_FeatureConfigurations_SharedView_Enabled"> <summary> <para> <para>The shared view settings of an embedded dashboard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForRegisteredUserCmdlet.ExperienceConfiguration_QuickSightConsole_FeatureConfigurations_StatePersistence_Enabled"> <summary> <para> <para>Determines if a Amazon QuickSight dashboard's state persistence settings are turned on or off.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForRegisteredUserCmdlet.Dashboard_InitialDashboardId"> <summary> <para> <para>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 QuickSight renders this dashboard if the user has permissions to view it.</para><para>If the user does not have permission to view this dashboard, they see a permissions error message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForRegisteredUserCmdlet.QuickSightConsole_InitialPath"> <summary> <para> <para>The initial URL path for the Amazon QuickSight console. <c>InitialPath</c> is required.</para><para>The entry point URL is constrained to the following paths:</para><ul><li><para><c>/start</c></para></li><li><para><c>/start/analyses</c></para></li><li><para><c>/start/dashboards</c></para></li><li><para><c>/start/favorites</c></para></li><li><para><c>/dashboards/DashboardId</c>. <i>DashboardId</i> is the actual ID key from the Amazon QuickSight console URL of the dashboard.</para></li><li><para><c>/analyses/AnalysisId</c>. <i>AnalysisId</i> is the actual ID key from the Amazon QuickSight console URL of the analysis.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForRegisteredUserCmdlet.GenerativeQnA_InitialTopicId"> <summary> <para> <para>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 Amazon QuickSight application and opening a topic. The ID is in the URL for the topic that you open.</para><para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForRegisteredUserCmdlet.QSearchBar_InitialTopicId"> <summary> <para> <para>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 <a href="https://quicksight.aws.amazon.com/">Amazon QuickSight console</a>, navigate to the <b>Topics</b> pane, and choose thre topic that you want to use. The <c>TopicID</c> 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.</para><para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForRegisteredUserCmdlet.SessionLifetimeInMinute"> <summary> <para> <para>How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForRegisteredUserCmdlet.InitialDashboardVisualId_SheetId"> <summary> <para> <para>The ID of the sheet that the has visual that you want to embed. The <c>SheetId</c> can be found in the <c>IDs for developers</c> section of the <c>Embed visual</c> pane of the visual's on-visual menu of the Amazon QuickSight console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForRegisteredUserCmdlet.UserArn"> <summary> <para> <para>The Amazon Resource Name for the registered user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForRegisteredUserCmdlet.InitialDashboardVisualId_VisualId"> <summary> <para> <para>The ID of the visual that you want to embed. The <c>VisualID</c> can be found in the <c>IDs for developers</c> section of the <c>Embed visual</c> pane of the visual's on-visual menu of the Amazon QuickSight console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForRegisteredUserCmdlet.Select"> <summary> 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.GenerateEmbedUrlForRegisteredUserResponse). Specifying the name of a property of type Amazon.QuickSight.Model.GenerateEmbedUrlForRegisteredUserResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForRegisteredUserCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSEmbedUrlForRegisteredUserCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.NewQSFolderCmdlet"> <summary> Creates an empty shared folder. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSFolderCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the Amazon Web Services account where you want to create the folder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSFolderCmdlet.FolderId"> <summary> <para> <para>The ID of the folder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSFolderCmdlet.FolderType"> <summary> <para> <para>The type of folder. By default, <c>folderType</c> is <c>SHARED</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSFolderCmdlet.Name"> <summary> <para> <para>The name of the folder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSFolderCmdlet.ParentFolderArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the parent folder.</para><para><c>ParentFolderArn</c> can be null. An empty <c>parentFolderArn</c> creates a root-level folder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSFolderCmdlet.Permission"> <summary> <para> <para>A structure that describes the principals and the resource-level permissions of a folder.</para><para>To specify no permissions, omit <c>Permissions</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSFolderCmdlet.SharingModel"> <summary> <para> <para>An optional parameter that determines the sharing scope of the folder. The default value for this parameter is <c>ACCOUNT</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSFolderCmdlet.Tag"> <summary> <para> <para>Tags for the folder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSFolderCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.CreateFolderResponse). Specifying the name of a property of type Amazon.QuickSight.Model.CreateFolderResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSFolderCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FolderId parameter. The -PassThru parameter is deprecated, use -Select '^FolderId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSFolderCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.NewQSFolderMembershipCmdlet"> <summary> Adds an asset, such as a dashboard, analysis, or dataset into a folder. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSFolderMembershipCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the Amazon Web Services account that contains the folder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSFolderMembershipCmdlet.FolderId"> <summary> <para> <para>The ID of the folder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSFolderMembershipCmdlet.MemberId"> <summary> <para> <para>The ID of the asset that you want to add to the folder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSFolderMembershipCmdlet.MemberType"> <summary> <para> <para>The member type of the asset that you want to add to a folder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSFolderMembershipCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FolderMember'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.CreateFolderMembershipResponse). Specifying the name of a property of type Amazon.QuickSight.Model.CreateFolderMembershipResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSFolderMembershipCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FolderId parameter. The -PassThru parameter is deprecated, use -Select '^FolderId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSFolderMembershipCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.NewQSGroupCmdlet"> <summary> Use the <c>CreateGroup</c> operation to create a group in Amazon QuickSight. You can create up to 10,000 groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact Amazon Web Services Support. <para> The permissions resource is <c>arn:aws:quicksight:<your-region>:<i><relevant-aws-account-id></i>:group/default/<i><group-name></i></c>. </para><para> The response is a group object. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSGroupCmdlet.AwsAccountId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSGroupCmdlet.Description"> <summary> <para> <para>A description for the group that you want to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSGroupCmdlet.GroupName"> <summary> <para> <para>A name for the group that you want to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSGroupCmdlet.Namespace"> <summary> <para> <para>The namespace that you want the group to be a part of.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Group'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.CreateGroupResponse). Specifying the name of a property of type Amazon.QuickSight.Model.CreateGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GroupName parameter. The -PassThru parameter is deprecated, use -Select '^GroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.NewQSGroupMembershipCmdlet"> <summary> Adds an Amazon QuickSight user to an Amazon QuickSight group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSGroupMembershipCmdlet.AwsAccountId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSGroupMembershipCmdlet.GroupName"> <summary> <para> <para>The name of the group that you want to add the user to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSGroupMembershipCmdlet.MemberName"> <summary> <para> <para>The name of the user that you want to add to the group membership.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSGroupMembershipCmdlet.Namespace"> <summary> <para> <para>The namespace that you want the user to be a part of.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSGroupMembershipCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'GroupMember'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.CreateGroupMembershipResponse). Specifying the name of a property of type Amazon.QuickSight.Model.CreateGroupMembershipResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSGroupMembershipCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MemberName parameter. The -PassThru parameter is deprecated, use -Select '^MemberName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSGroupMembershipCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.NewQSIAMPolicyAssignmentCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSIAMPolicyAssignmentCmdlet.AssignmentName"> <summary> <para> <para>The name of the assignment, also called a rule. The name must be unique within the Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSIAMPolicyAssignmentCmdlet.AssignmentStatus"> <summary> <para> <para>The status of the assignment. Possible values are as follows:</para><ul><li><para><c>ENABLED</c> - Anything specified in this assignment is used when creating the data source.</para></li><li><para><c>DISABLED</c> - This assignment isn't used when creating the data source.</para></li><li><para><c>DRAFT</c> - This assignment is an unfinished draft and isn't used when creating the data source.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSIAMPolicyAssignmentCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account where you want to assign an IAM policy to Amazon QuickSight users or groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSIAMPolicyAssignmentCmdlet.Identity"> <summary> <para> <para>The Amazon QuickSight users, groups, or both that you want to assign the policy to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSIAMPolicyAssignmentCmdlet.Namespace"> <summary> <para> <para>The namespace that contains the assignment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSIAMPolicyAssignmentCmdlet.PolicyArn"> <summary> <para> <para>The ARN for the IAM policy to apply to the Amazon QuickSight users and groups specified in this assignment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSIAMPolicyAssignmentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.CreateIAMPolicyAssignmentResponse). Specifying the name of a property of type Amazon.QuickSight.Model.CreateIAMPolicyAssignmentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSIAMPolicyAssignmentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssignmentName parameter. The -PassThru parameter is deprecated, use -Select '^AssignmentName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSIAMPolicyAssignmentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.NewQSIngestionCmdlet"> <summary> 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. <para> Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see <a href="http://aws.amazon.com/premiumsupport/knowledge-center/iam-ec2-resource-tags/">How do I create an IAM policy to control access to Amazon EC2 resources using tags?</a> in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSIngestionCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSIngestionCmdlet.DataSetId"> <summary> <para> <para>The ID of the dataset used in the ingestion.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSIngestionCmdlet.IngestionId"> <summary> <para> <para>An ID for the ingestion.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSIngestionCmdlet.IngestionType"> <summary> <para> <para>The type of ingestion that you want to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSIngestionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.CreateIngestionResponse). Specifying the name of a property of type Amazon.QuickSight.Model.CreateIngestionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSIngestionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IngestionId parameter. The -PassThru parameter is deprecated, use -Select '^IngestionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSIngestionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.NewQSNamespaceCmdlet"> <summary> (Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight. <para> 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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSNamespaceCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the Amazon Web Services account that you want to create the Amazon QuickSight namespace in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSNamespaceCmdlet.IdentityStore"> <summary> <para> <para>Specifies the type of your user identity directory. Currently, this supports users with an identity type of <c>QUICKSIGHT</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSNamespaceCmdlet.Namespace"> <summary> <para> <para>The name that you want to use to describe the new namespace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSNamespaceCmdlet.Tag"> <summary> <para> <para>The tags that you want to associate with the namespace that you're creating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSNamespaceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.CreateNamespaceResponse). Specifying the name of a property of type Amazon.QuickSight.Model.CreateNamespaceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSNamespaceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Namespace parameter. The -PassThru parameter is deprecated, use -Select '^Namespace' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSNamespaceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.NewQSRefreshScheduleCmdlet"> <summary> Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSRefreshScheduleCmdlet.Schedule_Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the refresh schedule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSRefreshScheduleCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSRefreshScheduleCmdlet.DataSetId"> <summary> <para> <para>The ID of the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSRefreshScheduleCmdlet.RefreshOnDay_DayOfMonth"> <summary> <para> <para>The day of the month that you want to schedule refresh on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSRefreshScheduleCmdlet.RefreshOnDay_DayOfWeek"> <summary> <para> <para>The day of the week that you want to schedule a refresh on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSRefreshScheduleCmdlet.ScheduleFrequency_Interval"> <summary> <para> <para>The interval between scheduled refreshes. Valid values are as follows:</para><ul><li><para><c>MINUTE15</c>: The dataset refreshes every 15 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.</para></li><li><para><c>MINUTE30</c>:The dataset refreshes every 30 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.</para></li><li><para><c>HOURLY</c>: The dataset refreshes every hour. This interval can only be used for one schedule per dataset.</para></li><li><para><c>DAILY</c>: The dataset refreshes every day.</para></li><li><para><c>WEEKLY</c>: The dataset refreshes every week.</para></li><li><para><c>MONTHLY</c>: The dataset refreshes every month.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSRefreshScheduleCmdlet.Schedule_RefreshType"> <summary> <para> <para>The type of refresh that a datset undergoes. Valid values are as follows:</para><ul><li><para><c>FULL_REFRESH</c>: A complete refresh of a dataset.</para></li><li><para><c>INCREMENTAL_REFRESH</c>: A partial refresh of some rows of a dataset, based on the time window specified.</para></li></ul><para>For more information on full and incremental refreshes, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/refreshing-imported-data.html">Refreshing SPICE data</a> in the <i>Amazon QuickSight User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSRefreshScheduleCmdlet.Schedule_ScheduleId"> <summary> <para> <para>An identifier for the refresh schedule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSRefreshScheduleCmdlet.Schedule_StartAfterDateTime"> <summary> <para> <para>Time after which the refresh schedule can be started, expressed in <c>YYYY-MM-DDTHH:MM:SS</c> format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSRefreshScheduleCmdlet.ScheduleFrequency_TimeOfTheDay"> <summary> <para> <para>The time of day that you want the datset to refresh. This value is expressed in HH:MM format. This field is not required for schedules that refresh hourly.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSRefreshScheduleCmdlet.ScheduleFrequency_Timezone"> <summary> <para> <para>The timezone that you want the refresh schedule to use. The timezone ID must match a corresponding ID found on <c>java.util.time.getAvailableIDs()</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSRefreshScheduleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.CreateRefreshScheduleResponse). Specifying the name of a property of type Amazon.QuickSight.Model.CreateRefreshScheduleResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSRefreshScheduleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Schedule_ScheduleId parameter. The -PassThru parameter is deprecated, use -Select '^Schedule_ScheduleId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSRefreshScheduleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.NewQSRoleMembershipCmdlet"> <summary> Use <c>CreateRoleMembership</c> to add an existing Amazon QuickSight group to an existing role. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSRoleMembershipCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSRoleMembershipCmdlet.MemberName"> <summary> <para> <para>The name of the group that you want to add to the role.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSRoleMembershipCmdlet.Namespace"> <summary> <para> <para>The namespace that the role belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSRoleMembershipCmdlet.Role"> <summary> <para> <para>The role that you want to add a group to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSRoleMembershipCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.CreateRoleMembershipResponse). Specifying the name of a property of type Amazon.QuickSight.Model.CreateRoleMembershipResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSRoleMembershipCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateCmdlet"> <summary> Creates a template either from a <c>TemplateDefinition</c> or from an existing Amazon QuickSight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses. <para> A <i>template</i> 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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateCmdlet.SourceAnalysis_Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateCmdlet.SourceTemplate_Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateCmdlet.AwsAccountId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateCmdlet.PaperMargin_Bottom"> <summary> <para> <para>Define the bottom spacing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateCmdlet.Definition_CalculatedField"> <summary> <para> <para>An array of calculated field definitions for the template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateCmdlet.Definition_ColumnConfiguration"> <summary> <para> <para> An array of template-level column configurations. Column configurations are used to set default formatting for a column that's used throughout a template. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateCmdlet.Definition_DataSetConfiguration"> <summary> <para> <para>An array of dataset configurations. These configurations define the required columns for each dataset used within a template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateCmdlet.SourceAnalysis_DataSetReference"> <summary> <para> <para>A structure containing information about the dataset references used as placeholders in the template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateCmdlet.Definition_FilterGroup"> <summary> <para> <para>Filter definitions for a template.</para><para>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/filtering-visual-data.html">Filtering Data</a> in the <i>Amazon QuickSight User Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateCmdlet.PaperMargin_Left"> <summary> <para> <para>Define the left spacing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateCmdlet.ValidationStrategy_Mode"> <summary> <para> <para>The mode of validation for the asset to be created or updated. When you set this value to <c>STRICT</c>, strict validation for every error is enforced. When you set this value to <c>LENIENT</c>, validation is skipped for specific UI errors.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateCmdlet.Name"> <summary> <para> <para>A display name for the template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateCmdlet.Definition_AnalysisDefaults_DefaultNewSheetConfiguration_InteractiveLayoutConfiguration_FreeForm_CanvasSizeOptions_ScreenCanvasSizeOptions_OptimizedViewPortWidth"> <summary> <para> <para>The width that the view port will be optimized for when the layout renders.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateCmdlet.Definition_AnalysisDefaults_DefaultNewSheetConfiguration_InteractiveLayoutConfiguration_Grid_CanvasSizeOptions_ScreenCanvasSizeOptions_OptimizedViewPortWidth"> <summary> <para> <para>The width that the view port will be optimized for when the layout renders.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateCmdlet.PaperCanvasSizeOptions_PaperOrientation"> <summary> <para> <para>The paper orientation that is used to define canvas dimensions. Choose one of the following options:</para><ul><li><para>PORTRAIT</para></li><li><para>LANDSCAPE</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateCmdlet.PaperCanvasSizeOptions_PaperSize"> <summary> <para> <para>The paper size that is used to define canvas dimensions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateCmdlet.Definition_ParameterDeclaration"> <summary> <para> <para>An array of parameter declarations for a template.</para><para><i>Parameters</i> are named variables that can transfer a value for use by an action or an object.</para><para>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html">Parameters in Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateCmdlet.Permission"> <summary> <para> <para>A list of resource permissions to be set on the template. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateCmdlet.QueryExecutionOptions_QueryExecutionMode"> <summary> <para> <para>A structure that describes the query execution mode.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateCmdlet.ScreenCanvasSizeOptions_ResizeOption"> <summary> <para> <para>This value determines the layout behavior when the viewport is resized.</para><ul><li><para><c>FIXED</c>: A fixed width will be used when optimizing the layout. In the Amazon QuickSight console, this option is called <c>Classic</c>.</para></li><li><para><c>RESPONSIVE</c>: The width of the canvas will be responsive and optimized to the view port. In the Amazon QuickSight console, this option is called <c>Tiled</c>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateCmdlet.PaperMargin_Right"> <summary> <para> <para>Define the right spacing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateCmdlet.DefaultNewSheetConfiguration_SheetContentType"> <summary> <para> <para>The option that determines the sheet content type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateCmdlet.Definition_Sheet"> <summary> <para> <para>An array of sheet definitions for a template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateCmdlet.Tag"> <summary> <para> <para>Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateCmdlet.TemplateId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateCmdlet.Options_Timezone"> <summary> <para> <para>Determines the timezone for the analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateCmdlet.PaperMargin_Top"> <summary> <para> <para>Define the top spacing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateCmdlet.VersionDescription"> <summary> <para> <para>A description of the current template version being created. This API operation creates the first version of the template. Every time <c>UpdateTemplate</c> is called, a new version is created. Each version of the template maintains a description of the version in the <c>VersionDescription</c> field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateCmdlet.Options_WeekStart"> <summary> <para> <para>Determines the week start day for an analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.CreateTemplateResponse). Specifying the name of a property of type Amazon.QuickSight.Model.CreateTemplateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TemplateId parameter. The -PassThru parameter is deprecated, use -Select '^TemplateId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateAliasCmdlet"> <summary> Creates a template alias for a template. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateAliasCmdlet.AliasName"> <summary> <para> <para>The name that you want to give to the template alias that you're creating. Don't start the alias name with the <c>$</c> character. Alias names that start with <c>$</c> are reserved by Amazon QuickSight. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateAliasCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the template that you creating an alias for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateAliasCmdlet.TemplateId"> <summary> <para> <para>An ID for the template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateAliasCmdlet.TemplateVersionNumber"> <summary> <para> <para>The version number of the template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateAliasCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TemplateAlias'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.CreateTemplateAliasResponse). Specifying the name of a property of type Amazon.QuickSight.Model.CreateTemplateAliasResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateAliasCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AliasName parameter. The -PassThru parameter is deprecated, use -Select '^AliasName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTemplateAliasCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.NewQSThemeCmdlet"> <summary> Creates a theme. <para> A <i>theme</i> is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html">Using Themes in Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeCmdlet.UIColorPalette_Accent"> <summary> <para> <para>This color is that applies to selected states and buttons.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeCmdlet.UIColorPalette_AccentForeground"> <summary> <para> <para>The foreground color that applies to any text or other elements that appear over the accent color.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account where you want to store the new theme. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeCmdlet.BaseThemeId"> <summary> <para> <para>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 <c>ListThemes</c> or choose <b>Themes</b> from within an analysis. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeCmdlet.DataColorPalette_Color"> <summary> <para> <para>The hexadecimal codes for the colors.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeCmdlet.UIColorPalette_Danger"> <summary> <para> <para>The color that applies to error messages.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeCmdlet.UIColorPalette_DangerForeground"> <summary> <para> <para>The foreground color that applies to any text or other elements that appear over the error color.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeCmdlet.UIColorPalette_Dimension"> <summary> <para> <para>The color that applies to the names of fields that are identified as dimensions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeCmdlet.UIColorPalette_DimensionForeground"> <summary> <para> <para>The foreground color that applies to any text or other elements that appear over the dimension color.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeCmdlet.DataColorPalette_EmptyFillColor"> <summary> <para> <para>The hexadecimal code of a color that applies to charts where a lack of data is highlighted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeCmdlet.Typography_FontFamily"> <summary> <para> <para>Determines the list of font families.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeCmdlet.UIColorPalette_Measure"> <summary> <para> <para>The color that applies to the names of fields that are identified as measures.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeCmdlet.UIColorPalette_MeasureForeground"> <summary> <para> <para>The foreground color that applies to any text or other elements that appear over the measure color.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeCmdlet.DataColorPalette_MinMaxGradient"> <summary> <para> <para>The minimum and maximum hexadecimal codes that describe a color gradient. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeCmdlet.Name"> <summary> <para> <para>A display name for the theme.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeCmdlet.Permission"> <summary> <para> <para>A valid grouping of resource permissions to apply to the new theme. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeCmdlet.UIColorPalette_PrimaryBackground"> <summary> <para> <para>The background color that applies to visuals and other high emphasis UI.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeCmdlet.UIColorPalette_PrimaryForeground"> <summary> <para> <para>The color of text and other foreground elements that appear over the primary background regions, such as grid lines, borders, table banding, icons, and so on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeCmdlet.UIColorPalette_SecondaryBackground"> <summary> <para> <para>The background color that applies to the sheet background and sheet controls.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeCmdlet.UIColorPalette_SecondaryForeground"> <summary> <para> <para>The foreground color that applies to any sheet title, sheet control text, or UI that appears over the secondary background.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeCmdlet.Border_Show"> <summary> <para> <para>The option to enable display of borders for visuals.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeCmdlet.Gutter_Show"> <summary> <para> <para>This Boolean value controls whether to display a gutter space between sheet tiles. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeCmdlet.Margin_Show"> <summary> <para> <para>This Boolean value controls whether to display sheet margins.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeCmdlet.UIColorPalette_Success"> <summary> <para> <para>The color that applies to success messages, for example the check mark for a successful download.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeCmdlet.UIColorPalette_SuccessForeground"> <summary> <para> <para>The foreground color that applies to any text or other elements that appear over the success color.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeCmdlet.Tag"> <summary> <para> <para>A map of the key-value pairs for the resource tag or tags that you want to add to the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeCmdlet.ThemeId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeCmdlet.VersionDescription"> <summary> <para> <para>A description of the first version of the theme that you're creating. Every time <c>UpdateTheme</c> is called, a new version is created. Each version of the theme has a description of the version in the <c>VersionDescription</c> field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeCmdlet.UIColorPalette_Warning"> <summary> <para> <para>This color that applies to warning and informational messages.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeCmdlet.UIColorPalette_WarningForeground"> <summary> <para> <para>The foreground color that applies to any text or other elements that appear over the warning color.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.CreateThemeResponse). Specifying the name of a property of type Amazon.QuickSight.Model.CreateThemeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ThemeId parameter. The -PassThru parameter is deprecated, use -Select '^ThemeId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.NewQSThemeAliasCmdlet"> <summary> Creates a theme alias for a theme. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeAliasCmdlet.AliasName"> <summary> <para> <para>The name that you want to give to the theme alias that you are creating. The alias name can't begin with a <c>$</c>. Alias names that start with <c>$</c> are reserved by Amazon QuickSight. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeAliasCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the theme for the new theme alias.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeAliasCmdlet.ThemeId"> <summary> <para> <para>An ID for the theme alias.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeAliasCmdlet.ThemeVersionNumber"> <summary> <para> <para>The version number of the theme.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeAliasCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ThemeAlias'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.CreateThemeAliasResponse). Specifying the name of a property of type Amazon.QuickSight.Model.CreateThemeAliasResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeAliasCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ThemeId parameter. The -PassThru parameter is deprecated, use -Select '^ThemeId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSThemeAliasCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.NewQSTopicCmdlet"> <summary> Creates a new Q topic. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTopicCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that you want to create a topic in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTopicCmdlet.Topic_DataSet"> <summary> <para> <para>The data sets that the topic is associated with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTopicCmdlet.Topic_Description"> <summary> <para> <para>The description of the topic.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTopicCmdlet.Topic_Name"> <summary> <para> <para>The name of the topic.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTopicCmdlet.ConfigOptions_QBusinessInsightsEnabled"> <summary> <para> <para>Enables Amazon Q Business Insights for a <c>Topic</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTopicCmdlet.Tag"> <summary> <para> <para>Contains a map of the key-value pairs for the resource tag or tags that are assigned to the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTopicCmdlet.TopicId"> <summary> <para> <para>The ID for the topic that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTopicCmdlet.Topic_UserExperienceVersion"> <summary> <para> <para>The user experience version of a topic.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTopicCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.CreateTopicResponse). Specifying the name of a property of type Amazon.QuickSight.Model.CreateTopicResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTopicCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TopicId parameter. The -PassThru parameter is deprecated, use -Select '^TopicId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTopicCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.NewQSTopicRefreshScheduleCmdlet"> <summary> Creates a topic refresh schedule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTopicRefreshScheduleCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the topic you're creating a refresh schedule for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTopicRefreshScheduleCmdlet.RefreshSchedule_BasedOnSpiceSchedule"> <summary> <para> <para>A Boolean value that controls whether to schedule runs at the same schedule that is specified in SPICE dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTopicRefreshScheduleCmdlet.DatasetArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTopicRefreshScheduleCmdlet.DatasetName"> <summary> <para> <para>The name of the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTopicRefreshScheduleCmdlet.RefreshSchedule_IsEnabled"> <summary> <para> <para>A Boolean value that controls whether to schedule is enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTopicRefreshScheduleCmdlet.RefreshSchedule_RepeatAt"> <summary> <para> <para>The time of day when the refresh should run, for example, Monday-Sunday.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTopicRefreshScheduleCmdlet.RefreshSchedule_StartingAt"> <summary> <para> <para>The starting date and time for the refresh schedule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTopicRefreshScheduleCmdlet.RefreshSchedule_Timezone"> <summary> <para> <para>The timezone that you want the refresh schedule to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTopicRefreshScheduleCmdlet.TopicId"> <summary> <para> <para>The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTopicRefreshScheduleCmdlet.RefreshSchedule_TopicScheduleType"> <summary> <para> <para>The type of refresh schedule. Valid values for this structure are <c>HOURLY</c>, <c>DAILY</c>, <c>WEEKLY</c>, and <c>MONTHLY</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTopicRefreshScheduleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.CreateTopicRefreshScheduleResponse). Specifying the name of a property of type Amazon.QuickSight.Model.CreateTopicRefreshScheduleResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTopicRefreshScheduleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TopicId parameter. The -PassThru parameter is deprecated, use -Select '^TopicId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSTopicRefreshScheduleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.NewQSVPCConnectionCmdlet"> <summary> Creates a new VPC connection. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSVPCConnectionCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID of the account where you want to create a new VPC connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSVPCConnectionCmdlet.DnsResolver"> <summary> <para> <para>A list of IP addresses of DNS resolver endpoints for the VPC connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSVPCConnectionCmdlet.Name"> <summary> <para> <para>The display name for the VPC connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSVPCConnectionCmdlet.RoleArn"> <summary> <para> <para>The IAM role to associate with the VPC connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSVPCConnectionCmdlet.SecurityGroupId"> <summary> <para> <para>A list of security group IDs for the VPC connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSVPCConnectionCmdlet.SubnetId"> <summary> <para> <para>A list of subnet IDs for the VPC connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSVPCConnectionCmdlet.Tag"> <summary> <para> <para>A map of the key-value pairs for the resource tag or tags assigned to the VPC connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSVPCConnectionCmdlet.VPCConnectionId"> <summary> <para> <para>The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSVPCConnectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.CreateVPCConnectionResponse). Specifying the name of a property of type Amazon.QuickSight.Model.CreateVPCConnectionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSVPCConnectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the VPCConnectionId parameter. The -PassThru parameter is deprecated, use -Select '^VPCConnectionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSVPCConnectionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.RegisterQSUserCmdlet"> <summary> Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Amazon QuickSight API, Amazon QuickSight generates a registration URL. The user accesses this registration URL to create their account. Amazon QuickSight doesn't send a registration email to users who are registered from the Amazon QuickSight API. If you want new users to receive a registration email, then add those users in the Amazon QuickSight console. For more information on registering a new user in the Amazon QuickSight console, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/managing-users.html#inviting-users"> Inviting users to access Amazon QuickSight</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RegisterQSUserCmdlet.AwsAccountId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RegisterQSUserCmdlet.CustomFederationProviderUrl"> <summary> <para> <para>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 <c>ExternalLoginFederationProviderType</c> parameter is set to <c>CUSTOM_OIDC</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RegisterQSUserCmdlet.CustomPermissionsName"> <summary> <para> <para>(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:</para><ul><li><para>Create and update data sources</para></li><li><para>Create and update datasets</para></li><li><para>Create and update email reports</para></li><li><para>Subscribe to email reports</para></li></ul><para>To add custom permissions to an existing user, use <c><a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html">UpdateUser</a></c> instead.</para><para>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 <c>RegisterUser</c> API operation to assign the named set of permissions to a Amazon QuickSight user. </para><para>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, admin pro, author pro, reader pro).</para><para>This feature is available only to Amazon QuickSight Enterprise edition subscriptions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RegisterQSUserCmdlet.Email"> <summary> <para> <para>The email address of the user that you want to register.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RegisterQSUserCmdlet.ExternalLoginFederationProviderType"> <summary> <para> <para>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.</para><ul><li><para><c>COGNITO</c>: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the <c>COGNITO</c> provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.</para></li><li><para><c>CUSTOM_OIDC</c>: Custom OpenID Connect (OIDC) provider. When choosing <c>CUSTOM_OIDC</c> type, use the <c>CustomFederationProviderUrl</c> parameter to provide the custom OIDC provider URL.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RegisterQSUserCmdlet.ExternalLoginId"> <summary> <para> <para>The identity ID for a user in the external login provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RegisterQSUserCmdlet.IamArn"> <summary> <para> <para>The ARN of the IAM user or role that you are registering with Amazon QuickSight. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RegisterQSUserCmdlet.IdentityType"> <summary> <para> <para>The identity type that your Amazon QuickSight account uses to manage the identity of users.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RegisterQSUserCmdlet.Namespace"> <summary> <para> <para>The namespace. Currently, you should set this to <c>default</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RegisterQSUserCmdlet.SessionName"> <summary> <para> <para>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 <a href="https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html"><c>assume-role</c></a> in the <i>CLI Reference.</i></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RegisterQSUserCmdlet.Tag"> <summary> <para> <para>The tags to associate with the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RegisterQSUserCmdlet.UserName"> <summary> <para> <para>The Amazon QuickSight user name that you want to create for the user you are registering.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RegisterQSUserCmdlet.UserRole"> <summary> <para> <para>The Amazon QuickSight role for the user. The user role can be one of the following:</para><ul><li><para><c>READER</c>: A user who has read-only access to dashboards.</para></li><li><para><c>AUTHOR</c>: A user who can create data sources, datasets, analyses, and dashboards.</para></li><li><para><c>ADMIN</c>: A user who is an author, who can also manage Amazon QuickSight settings.</para></li><li><para><c>READER_PRO</c>: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards.</para></li><li><para><c>AUTHOR_PRO</c>: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.</para></li><li><para><c>ADMIN_PRO</c>: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.</para></li><li><para><c>RESTRICTED_READER</c>: This role isn't currently available for use.</para></li><li><para><c>RESTRICTED_AUTHOR</c>: This role isn't currently available for use.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RegisterQSUserCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.RegisterUserResponse). Specifying the name of a property of type Amazon.QuickSight.Model.RegisterUserResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RegisterQSUserCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Email parameter. The -PassThru parameter is deprecated, use -Select '^Email' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RegisterQSUserCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.RemoveQSAccountCustomizationCmdlet"> <summary> Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSAccountCustomizationCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the Amazon Web Services account that you want to delete Amazon QuickSight customizations from in this Amazon Web Services Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSAccountCustomizationCmdlet.Namespace"> <summary> <para> <para>The Amazon QuickSight namespace that you're deleting the customizations from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSAccountCustomizationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DeleteAccountCustomizationResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DeleteAccountCustomizationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSAccountCustomizationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSAccountCustomizationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.RemoveQSAccountSubscriptionCmdlet"> <summary> Use the <c>DeleteAccountSubscription</c> 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 <c>True</c>. To change this setting and delete your account, call the <c>UpdateAccountSettings</c> API and set the value of the <c>TerminationProtectionEnabled</c> parameter to <c>False</c>, then make another call to the <c>DeleteAccountSubscription</c> API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSAccountSubscriptionCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID of the account that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSAccountSubscriptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DeleteAccountSubscriptionResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DeleteAccountSubscriptionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSAccountSubscriptionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSAccountSubscriptionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.RemoveQSAnalysisCmdlet"> <summary> 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 <c>DeletionTime</c> 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. <para> At any time before recovery window ends, you can use the <c>RestoreAnalysis</c> API operation to remove the <c>DeletionTime</c> 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. </para><para> 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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSAnalysisCmdlet.AnalysisId"> <summary> <para> <para>The ID of the analysis that you're deleting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSAnalysisCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account where you want to delete an analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSAnalysisCmdlet.ForceDeleteWithoutRecovery"> <summary> <para> <para>This option defaults to the value <c>NoForceDeleteWithoutRecovery</c>. To immediately delete the analysis, add the <c>ForceDeleteWithoutRecovery</c> option. You can't restore an analysis after it's deleted. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSAnalysisCmdlet.RecoveryWindowInDay"> <summary> <para> <para>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 <c>ForceDeleteWithoutRecovery</c> option in the same API call. The default value is 30.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSAnalysisCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DeleteAnalysisResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DeleteAnalysisResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSAnalysisCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AnalysisId parameter. The -PassThru parameter is deprecated, use -Select '^AnalysisId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSAnalysisCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.RemoveQSDashboardCmdlet"> <summary> Deletes a dashboard. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSDashboardCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the dashboard that you're deleting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSDashboardCmdlet.DashboardId"> <summary> <para> <para>The ID for the dashboard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSDashboardCmdlet.VersionNumber"> <summary> <para> <para>The version number of the dashboard. If the version number property is provided, only the specified version of the dashboard is deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSDashboardCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DeleteDashboardResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DeleteDashboardResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSDashboardCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DashboardId parameter. The -PassThru parameter is deprecated, use -Select '^DashboardId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSDashboardCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.RemoveQSDataSetCmdlet"> <summary> Deletes a dataset. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSDataSetCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSDataSetCmdlet.DataSetId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSDataSetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DeleteDataSetResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DeleteDataSetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSDataSetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DataSetId parameter. The -PassThru parameter is deprecated, use -Select '^DataSetId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSDataSetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.RemoveQSDataSetRefreshPropertyCmdlet"> <summary> Deletes the dataset refresh properties of the dataset. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSDataSetRefreshPropertyCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSDataSetRefreshPropertyCmdlet.DataSetId"> <summary> <para> <para>The ID of the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSDataSetRefreshPropertyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DeleteDataSetRefreshPropertiesResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DeleteDataSetRefreshPropertiesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSDataSetRefreshPropertyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DataSetId parameter. The -PassThru parameter is deprecated, use -Select '^DataSetId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSDataSetRefreshPropertyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.RemoveQSDataSourceCmdlet"> <summary> Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSDataSourceCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSDataSourceCmdlet.DataSourceId"> <summary> <para> <para>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSDataSourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DeleteDataSourceResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DeleteDataSourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSDataSourceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DataSourceId parameter. The -PassThru parameter is deprecated, use -Select '^DataSourceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSDataSourceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.RemoveQSFolderCmdlet"> <summary> Deletes an empty folder. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSFolderCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the Amazon Web Services account that contains the folder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSFolderCmdlet.FolderId"> <summary> <para> <para>The ID of the folder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSFolderCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DeleteFolderResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DeleteFolderResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSFolderCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FolderId parameter. The -PassThru parameter is deprecated, use -Select '^FolderId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSFolderCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.RemoveQSFolderMembershipCmdlet"> <summary> Removes an asset, such as a dashboard, analysis, or dataset, from a folder. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSFolderMembershipCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the Amazon Web Services account that contains the folder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSFolderMembershipCmdlet.FolderId"> <summary> <para> <para>The Folder ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSFolderMembershipCmdlet.MemberId"> <summary> <para> <para>The ID of the asset that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSFolderMembershipCmdlet.MemberType"> <summary> <para> <para>The member type of the asset that you want to delete from a folder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSFolderMembershipCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DeleteFolderMembershipResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DeleteFolderMembershipResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSFolderMembershipCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FolderId parameter. The -PassThru parameter is deprecated, use -Select '^FolderId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSFolderMembershipCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.RemoveQSGroupCmdlet"> <summary> Removes a user group from Amazon QuickSight. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSGroupCmdlet.AwsAccountId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSGroupCmdlet.GroupName"> <summary> <para> <para>The name of the group that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSGroupCmdlet.Namespace"> <summary> <para> <para>The namespace of the group that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DeleteGroupResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DeleteGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GroupName parameter. The -PassThru parameter is deprecated, use -Select '^GroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.RemoveQSGroupMembershipCmdlet"> <summary> Removes a user from a group so that the user is no longer a member of the group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSGroupMembershipCmdlet.AwsAccountId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSGroupMembershipCmdlet.GroupName"> <summary> <para> <para>The name of the group that you want to delete the user from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSGroupMembershipCmdlet.MemberName"> <summary> <para> <para>The name of the user that you want to delete from the group membership.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSGroupMembershipCmdlet.Namespace"> <summary> <para> <para>The namespace of the group that you want to remove a user from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSGroupMembershipCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DeleteGroupMembershipResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DeleteGroupMembershipResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSGroupMembershipCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MemberName parameter. The -PassThru parameter is deprecated, use -Select '^MemberName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSGroupMembershipCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.RemoveQSIAMPolicyAssignmentCmdlet"> <summary> Deletes an existing IAM policy assignment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSIAMPolicyAssignmentCmdlet.AssignmentName"> <summary> <para> <para>The name of the assignment. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSIAMPolicyAssignmentCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID where you want to delete the IAM policy assignment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSIAMPolicyAssignmentCmdlet.Namespace"> <summary> <para> <para>The namespace that contains the assignment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSIAMPolicyAssignmentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AssignmentName'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DeleteIAMPolicyAssignmentResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DeleteIAMPolicyAssignmentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSIAMPolicyAssignmentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssignmentName parameter. The -PassThru parameter is deprecated, use -Select '^AssignmentName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSIAMPolicyAssignmentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.RemoveQSIdentityPropagationConfigCmdlet"> <summary> Deletes all access scopes and authorized targets that are associated with a service from the Amazon QuickSight IAM Identity Center application. <para> This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSIdentityPropagationConfigCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that you want to delete an identity propagation configuration from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSIdentityPropagationConfigCmdlet.Service"> <summary> <para> <para>The name of the Amazon Web Services service that you want to delete the associated access scopes and authorized targets from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSIdentityPropagationConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DeleteIdentityPropagationConfigResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DeleteIdentityPropagationConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSIdentityPropagationConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSIdentityPropagationConfigCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.RemoveQSNamespaceCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSNamespaceCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the Amazon Web Services account that you want to delete the Amazon QuickSight namespace from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSNamespaceCmdlet.Namespace"> <summary> <para> <para>The namespace that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSNamespaceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DeleteNamespaceResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DeleteNamespaceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSNamespaceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Namespace parameter. The -PassThru parameter is deprecated, use -Select '^Namespace' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSNamespaceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.RemoveQSRefreshScheduleCmdlet"> <summary> Deletes a refresh schedule from a dataset. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSRefreshScheduleCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSRefreshScheduleCmdlet.DataSetId"> <summary> <para> <para>The ID of the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSRefreshScheduleCmdlet.ScheduleId"> <summary> <para> <para>The ID of the refresh schedule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSRefreshScheduleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DeleteRefreshScheduleResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DeleteRefreshScheduleResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSRefreshScheduleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ScheduleId parameter. The -PassThru parameter is deprecated, use -Select '^ScheduleId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSRefreshScheduleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.RemoveQSResourceTagCmdlet"> <summary> Removes a tag or tags from a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource that you want to untag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSResourceTagCmdlet.TagKey"> <summary> <para> <para>The keys of the key-value pairs for the resource tag or tags assigned to the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UntagResourceResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UntagResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.RemoveQSRoleCustomPermissionCmdlet"> <summary> Removes custom permissions from the role. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSRoleCustomPermissionCmdlet.AwsAccountId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSRoleCustomPermissionCmdlet.Namespace"> <summary> <para> <para>The namespace that includes the role.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSRoleCustomPermissionCmdlet.Role"> <summary> <para> <para>The role that you want to remove permissions from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSRoleCustomPermissionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DeleteRoleCustomPermissionResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DeleteRoleCustomPermissionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSRoleCustomPermissionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.RemoveQSRoleMembershipCmdlet"> <summary> Removes a group from a role. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSRoleMembershipCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSRoleMembershipCmdlet.MemberName"> <summary> <para> <para>The name of the group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSRoleMembershipCmdlet.Namespace"> <summary> <para> <para>The namespace that contains the role.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSRoleMembershipCmdlet.Role"> <summary> <para> <para>The role that you want to remove permissions from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSRoleMembershipCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DeleteRoleMembershipResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DeleteRoleMembershipResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSRoleMembershipCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.RemoveQSTemplateCmdlet"> <summary> Deletes a template. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSTemplateCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the template that you're deleting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSTemplateCmdlet.TemplateId"> <summary> <para> <para>An ID for the template you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSTemplateCmdlet.VersionNumber"> <summary> <para> <para>Specifies the version of the template that you want to delete. If you don't provide a version number, <c>DeleteTemplate</c> deletes all versions of the template. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DeleteTemplateResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DeleteTemplateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSTemplateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TemplateId parameter. The -PassThru parameter is deprecated, use -Select '^TemplateId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSTemplateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.RemoveQSTemplateAliasCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSTemplateAliasCmdlet.AliasName"> <summary> <para> <para>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 <c>$LATEST</c> in the <c>AliasName</c> parameter. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSTemplateAliasCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the item to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSTemplateAliasCmdlet.TemplateId"> <summary> <para> <para>The ID for the template that the specified alias is for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSTemplateAliasCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DeleteTemplateAliasResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DeleteTemplateAliasResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSTemplateAliasCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AliasName parameter. The -PassThru parameter is deprecated, use -Select '^AliasName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSTemplateAliasCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.RemoveQSThemeCmdlet"> <summary> Deletes a theme. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSThemeCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the theme that you're deleting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSThemeCmdlet.ThemeId"> <summary> <para> <para>An ID for the theme that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSThemeCmdlet.VersionNumber"> <summary> <para> <para>The version of the theme that you want to delete. </para><para><b>Note:</b> If you don't provide a version number, you're using this call to <c>DeleteTheme</c> to delete all versions of the theme.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSThemeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DeleteThemeResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DeleteThemeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSThemeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ThemeId parameter. The -PassThru parameter is deprecated, use -Select '^ThemeId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSThemeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.RemoveQSThemeAliasCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSThemeAliasCmdlet.AliasName"> <summary> <para> <para>The unique name for the theme alias to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSThemeAliasCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the theme alias to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSThemeAliasCmdlet.ThemeId"> <summary> <para> <para>The ID for the theme that the specified alias is for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSThemeAliasCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DeleteThemeAliasResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DeleteThemeAliasResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSThemeAliasCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ThemeId parameter. The -PassThru parameter is deprecated, use -Select '^ThemeId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSThemeAliasCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.RemoveQSTopicCmdlet"> <summary> Deletes a topic. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSTopicCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the topic that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSTopicCmdlet.TopicId"> <summary> <para> <para>The ID of the topic that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSTopicCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DeleteTopicResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DeleteTopicResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSTopicCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TopicId parameter. The -PassThru parameter is deprecated, use -Select '^TopicId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSTopicCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.RemoveQSTopicRefreshScheduleCmdlet"> <summary> Deletes a topic refresh schedule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSTopicRefreshScheduleCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSTopicRefreshScheduleCmdlet.DatasetId"> <summary> <para> <para>The ID of the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSTopicRefreshScheduleCmdlet.TopicId"> <summary> <para> <para>The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSTopicRefreshScheduleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DeleteTopicRefreshScheduleResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DeleteTopicRefreshScheduleResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSTopicRefreshScheduleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TopicId parameter. The -PassThru parameter is deprecated, use -Select '^TopicId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSTopicRefreshScheduleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.RemoveQSUserCmdlet"> <summary> Deletes the Amazon QuickSight user that is associated with the identity of the IAM user or role that's making the call. The IAM user isn't deleted as a result of this call. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSUserCmdlet.AwsAccountId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSUserCmdlet.Namespace"> <summary> <para> <para>The namespace. Currently, you should set this to <c>default</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSUserCmdlet.UserName"> <summary> <para> <para>The name of the user that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSUserCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DeleteUserResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DeleteUserResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSUserCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UserName parameter. The -PassThru parameter is deprecated, use -Select '^UserName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSUserCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.RemoveQSUserByPrincipalIdCmdlet"> <summary> Deletes a user identified by its principal ID. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSUserByPrincipalIdCmdlet.AwsAccountId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSUserByPrincipalIdCmdlet.Namespace"> <summary> <para> <para>The namespace. Currently, you should set this to <c>default</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSUserByPrincipalIdCmdlet.PrincipalId"> <summary> <para> <para>The principal ID of the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSUserByPrincipalIdCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DeleteUserByPrincipalIdResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DeleteUserByPrincipalIdResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSUserByPrincipalIdCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PrincipalId parameter. The -PassThru parameter is deprecated, use -Select '^PrincipalId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSUserByPrincipalIdCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.RemoveQSVPCConnectionCmdlet"> <summary> Deletes a VPC connection. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSVPCConnectionCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID of the account where you want to delete a VPC connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSVPCConnectionCmdlet.VPCConnectionId"> <summary> <para> <para>The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSVPCConnectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.DeleteVPCConnectionResponse). Specifying the name of a property of type Amazon.QuickSight.Model.DeleteVPCConnectionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSVPCConnectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the VPCConnectionId parameter. The -PassThru parameter is deprecated, use -Select '^VPCConnectionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSVPCConnectionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.RestoreQSAnalysisCmdlet"> <summary> Restores an analysis. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RestoreQSAnalysisCmdlet.AnalysisId"> <summary> <para> <para>The ID of the analysis that you're restoring.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RestoreQSAnalysisCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RestoreQSAnalysisCmdlet.RestoreToFolder"> <summary> <para> <para>A boolean value that determines if the analysis will be restored to folders that it previously resided in. A <c>True</c> value restores analysis back to all folders that it previously resided in. A <c>False</c> value restores the analysis but does not restore the analysis back to all previously resided folders. Restoring a restricted analysis requires this parameter to be set to <c>True</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RestoreQSAnalysisCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.RestoreAnalysisResponse). Specifying the name of a property of type Amazon.QuickSight.Model.RestoreAnalysisResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RestoreQSAnalysisCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AnalysisId parameter. The -PassThru parameter is deprecated, use -Select '^AnalysisId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RestoreQSAnalysisCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.SearchQSAnalysisCmdlet"> <summary> Searches for analyses that belong to the user specified in the filter. <note><para> This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. </para></note><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSAnalysisCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the analyses that you're searching for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSAnalysisCmdlet.Filter"> <summary> <para> <para>The structure for the search filters that you want to apply to your search. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSAnalysisCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSAnalysisCmdlet.NextToken"> <summary> <para> <para>A pagination token that can be used in a subsequent request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSAnalysisCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AnalysisSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.SearchAnalysesResponse). Specifying the name of a property of type Amazon.QuickSight.Model.SearchAnalysesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSAnalysisCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSAnalysisCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSAnalysisCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.SearchQSDashboardCmdlet"> <summary> Searches for dashboards that belong to a user. <note><para> This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. </para></note><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSDashboardCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the user whose dashboards you're searching for. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSDashboardCmdlet.Filter"> <summary> <para> <para>The filters to apply to the search. Currently, you can search only by user name, for example, <c>"Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSDashboardCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned per request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSDashboardCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results, or null if there are no more results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSDashboardCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DashboardSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.SearchDashboardsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.SearchDashboardsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSDashboardCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSDashboardCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSDashboardCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.SearchQSDataSetCmdlet"> <summary> Use the <c>SearchDataSets</c> operation to search for datasets that belong to an account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSDataSetCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSDataSetCmdlet.Filter"> <summary> <para> <para>The filters to apply to the search.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSDataSetCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned per request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSDataSetCmdlet.NextToken"> <summary> <para> <para>A pagination token that can be used in a subsequent request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSDataSetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DataSetSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.SearchDataSetsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.SearchDataSetsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSDataSetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSDataSetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSDataSetCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.SearchQSDataSourceCmdlet"> <summary> Use the <c>SearchDataSources</c> operation to search for data sources that belong to an account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSDataSourceCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSDataSourceCmdlet.Filter"> <summary> <para> <para>The filters to apply to the search.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSDataSourceCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned per request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSDataSourceCmdlet.NextToken"> <summary> <para> <para>A pagination token that can be used in a subsequent request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSDataSourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DataSourceSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.SearchDataSourcesResponse). Specifying the name of a property of type Amazon.QuickSight.Model.SearchDataSourcesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSDataSourceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSDataSourceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSDataSourceCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.SearchQSFolderCmdlet"> <summary> Searches the subfolders in a folder.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSFolderCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the Amazon Web Services account that contains the folder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSFolderCmdlet.Filter"> <summary> <para> <para>The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example, <c>"Filters": [ { "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" } ]</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSFolderCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be returned per request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSFolderCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results, or null if there are no more results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSFolderCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FolderSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.SearchFoldersResponse). Specifying the name of a property of type Amazon.QuickSight.Model.SearchFoldersResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSFolderCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSFolderCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SearchQSFolderCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.SetQSBatchCreateTopicReviewedAnswerCmdlet"> <summary> Creates new reviewed answers for a Q Topic. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SetQSBatchCreateTopicReviewedAnswerCmdlet.Answer"> <summary> <para> <para>The definition of the Answers to be created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SetQSBatchCreateTopicReviewedAnswerCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that you want to create a reviewed answer in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SetQSBatchCreateTopicReviewedAnswerCmdlet.TopicId"> <summary> <para> <para>The ID for the topic reviewed answer that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SetQSBatchCreateTopicReviewedAnswerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.BatchCreateTopicReviewedAnswerResponse). Specifying the name of a property of type Amazon.QuickSight.Model.BatchCreateTopicReviewedAnswerResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SetQSBatchCreateTopicReviewedAnswerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TopicId parameter. The -PassThru parameter is deprecated, use -Select '^TopicId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.SetQSBatchDeleteTopicReviewedAnswerCmdlet"> <summary> Deletes reviewed answers for Q Topic. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SetQSBatchDeleteTopicReviewedAnswerCmdlet.AnswerId"> <summary> <para> <para>The Answer IDs of the Answers to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SetQSBatchDeleteTopicReviewedAnswerCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that you want to delete a reviewed answers in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SetQSBatchDeleteTopicReviewedAnswerCmdlet.TopicId"> <summary> <para> <para>The ID for the topic reviewed answer that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SetQSBatchDeleteTopicReviewedAnswerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.BatchDeleteTopicReviewedAnswerResponse). Specifying the name of a property of type Amazon.QuickSight.Model.BatchDeleteTopicReviewedAnswerResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.SetQSBatchDeleteTopicReviewedAnswerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TopicId parameter. The -PassThru parameter is deprecated, use -Select '^TopicId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleExportJobCmdlet"> <summary> Starts an Asset Bundle export job. <para> An Asset Bundle export job exports specified Amazon QuickSight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a <c>DescribeAssetBundleExportJob</c> API call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a <c>DescribeAssetBundleExportJob</c> API call. Each Amazon QuickSight account can run up to 5 export jobs concurrently. </para><para> The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleExportJobCmdlet.CloudFormationOverridePropertyConfiguration_Analyses"> <summary> <para> <para>An optional list of structures that control how <c>Analysis</c> resources are parameterized in the returned CloudFormation template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleExportJobCmdlet.AssetBundleExportJobId"> <summary> <para> <para>The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleExportJobCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account to export assets from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleExportJobCmdlet.CloudFormationOverridePropertyConfiguration_Dashboard"> <summary> <para> <para>An optional list of structures that control how <c>Dashboard</c> resources are parameterized in the returned CloudFormation template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleExportJobCmdlet.CloudFormationOverridePropertyConfiguration_DataSet"> <summary> <para> <para>An optional list of structures that control how <c>DataSet</c> resources are parameterized in the returned CloudFormation template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleExportJobCmdlet.CloudFormationOverridePropertyConfiguration_DataSource"> <summary> <para> <para>An optional list of structures that control how <c>DataSource</c> resources are parameterized in the returned CloudFormation template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleExportJobCmdlet.ExportFormat"> <summary> <para> <para>The export data format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleExportJobCmdlet.CloudFormationOverridePropertyConfiguration_Folder"> <summary> <para> <para>An optional list of structures that controls how <c>Folder</c> resources are parameterized in the returned CloudFormation template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleExportJobCmdlet.IncludeAllDependency"> <summary> <para> <para>A Boolean that determines whether all dependencies of each resource ARN are recursively exported with the job. For example, say you provided a Dashboard ARN to the <c>ResourceArns</c> parameter. If you set <c>IncludeAllDependencies</c> to <c>TRUE</c>, any theme, dataset, and data source resource that is a dependency of the dashboard is also exported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleExportJobCmdlet.IncludeFolderMember"> <summary> <para> <para>A setting that indicates whether you want to include folder assets. You can also use this setting to recusrsively include all subfolders of an exported folder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleExportJobCmdlet.IncludeFolderMembership"> <summary> <para> <para>A Boolean that determines if the exported asset carries over information about the folders that the asset is a member of. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleExportJobCmdlet.IncludePermission"> <summary> <para> <para>A Boolean that determines whether all permissions for each resource ARN are exported with the job. If you set <c>IncludePermissions</c> to <c>TRUE</c>, any permissions associated with each resource are exported. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleExportJobCmdlet.IncludeTag"> <summary> <para> <para> A Boolean that determines whether all tags for each resource ARN are exported with the job. If you set <c>IncludeTags</c> to <c>TRUE</c>, any tags associated with each resource are exported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleExportJobCmdlet.ResourceIdOverrideConfiguration_PrefixForAllResource"> <summary> <para> <para>An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleExportJobCmdlet.CloudFormationOverridePropertyConfiguration_RefreshSchedule"> <summary> <para> <para>An optional list of structures that control how <c>RefreshSchedule</c> resources are parameterized in the returned CloudFormation template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleExportJobCmdlet.ResourceArn"> <summary> <para> <para>An array of resource ARNs to export. The following resources are supported.</para><ul><li><para><c>Analysis</c></para></li><li><para><c>Dashboard</c></para></li><li><para><c>DataSet</c></para></li><li><para><c>DataSource</c></para></li><li><para><c>RefreshSchedule</c></para></li><li><para><c>Theme</c></para></li><li><para><c>VPCConnection</c></para></li></ul><para>The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleExportJobCmdlet.ValidationStrategy_StrictModeForAllResource"> <summary> <para> <para>A Boolean value that indicates whether to export resources under strict or lenient mode.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleExportJobCmdlet.CloudFormationOverridePropertyConfiguration_Theme"> <summary> <para> <para>An optional list of structures that control how <c>Theme</c> resources are parameterized in the returned CloudFormation template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleExportJobCmdlet.CloudFormationOverridePropertyConfiguration_VPCConnection"> <summary> <para> <para>An optional list of structures that control how <c>VPCConnection</c> resources are parameterized in the returned CloudFormation template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleExportJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.StartAssetBundleExportJobResponse). Specifying the name of a property of type Amazon.QuickSight.Model.StartAssetBundleExportJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleExportJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssetBundleExportJobId parameter. The -PassThru parameter is deprecated, use -Select '^AssetBundleExportJobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleExportJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleImportJobCmdlet"> <summary> Starts an Asset Bundle import job. <para> An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight account can run up to 5 import jobs concurrently. </para><para> The API caller must have the necessary <c>"create"</c>, <c>"describe"</c>, and <c>"update"</c> permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleImportJobCmdlet.OverrideParameters_Analyses"> <summary> <para> <para>A list of overrides for any <c>Analysis</c> resources that are present in the asset bundle that is imported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleImportJobCmdlet.OverridePermissions_Analyses"> <summary> <para> <para>A list of permissions overrides for any <c>Analysis</c> resources that are present in the asset bundle that is imported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleImportJobCmdlet.OverrideTags_Analyses"> <summary> <para> <para>A list of tag overrides for any <c>Analysis</c> resources that are present in the asset bundle that is imported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleImportJobCmdlet.AssetBundleImportJobId"> <summary> <para> <para>The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleImportJobCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account to import assets into. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleImportJobCmdlet.AssetBundleImportSource_Body"> <summary> <para> <para>The bytes of the base64 encoded asset bundle import zip file. This file can't exceed 20 MB.</para><para>If you are calling the API operations from the Amazon Web Services SDK for Java, JavaScript, Python, or PHP, the SDK encodes base64 automatically to allow the direct setting of the zip file's bytes. If you are using an SDK for a different language or receiving related errors, try to base64 encode your data.</para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleImportJobCmdlet.OverrideParameters_Dashboard"> <summary> <para> <para>A list of overrides for any <c>Dashboard</c> resources that are present in the asset bundle that is imported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleImportJobCmdlet.OverridePermissions_Dashboard"> <summary> <para> <para>A list of permissions overrides for any <c>Dashboard</c> resources that are present in the asset bundle that is imported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleImportJobCmdlet.OverrideTags_Dashboard"> <summary> <para> <para>A list of tag overrides for any <c>Dashboard</c> resources that are present in the asset bundle that is imported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleImportJobCmdlet.OverrideParameters_DataSet"> <summary> <para> <para>A list of overrides for any <c>DataSet</c> resources that are present in the asset bundle that is imported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleImportJobCmdlet.OverridePermissions_DataSet"> <summary> <para> <para>A list of permissions overrides for any <c>DataSet</c> resources that are present in the asset bundle that is imported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleImportJobCmdlet.OverrideTags_DataSet"> <summary> <para> <para>A list of tag overrides for any <c>DataSet</c> resources that are present in the asset bundle that is imported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleImportJobCmdlet.OverrideParameters_DataSource"> <summary> <para> <para> A list of overrides for any <c>DataSource</c> resources that are present in the asset bundle that is imported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleImportJobCmdlet.OverridePermissions_DataSource"> <summary> <para> <para>A list of permissions overrides for any <c>DataSource</c> resources that are present in the asset bundle that is imported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleImportJobCmdlet.OverrideTags_DataSource"> <summary> <para> <para>A list of tag overrides for any <c>DataSource</c> resources that are present in the asset bundle that is imported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleImportJobCmdlet.FailureAction"> <summary> <para> <para>The failure action for the import job.</para><para>If you choose <c>ROLLBACK</c>, failed import jobs will attempt to undo any asset changes caused by the failed job.</para><para>If you choose <c>DO_NOTHING</c>, failed import jobs will not attempt to roll back any asset changes caused by the failed job, possibly keeping the Amazon QuickSight account in an inconsistent state.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleImportJobCmdlet.OverrideParameters_Folder"> <summary> <para> <para>A list of overrides for any <c>Folder</c> resources that are present in the asset bundle that is imported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleImportJobCmdlet.OverridePermissions_Folder"> <summary> <para> <para>A list of permissions for the folders that you want to apply overrides to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleImportJobCmdlet.OverrideTags_Folder"> <summary> <para> <para>A list of tag overrides for any <c>Folder</c> resources that are present in the asset bundle that is imported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleImportJobCmdlet.ResourceIdOverrideConfiguration_PrefixForAllResource"> <summary> <para> <para>An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleImportJobCmdlet.OverrideParameters_RefreshSchedule"> <summary> <para> <para>A list of overrides for any <c>RefreshSchedule</c> resources that are present in the asset bundle that is imported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleImportJobCmdlet.AssetBundleImportSource_S3Uri"> <summary> <para> <para>The Amazon S3 URI for an asset bundle import file that exists in an Amazon S3 bucket that the caller has read access to. The file must be a zip format file and can't exceed 20 MB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleImportJobCmdlet.OverrideValidationStrategy_StrictModeForAllResource"> <summary> <para> <para>A Boolean value that indicates whether to import all analyses and dashboards under strict or lenient mode.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleImportJobCmdlet.OverrideParameters_Theme"> <summary> <para> <para>A list of overrides for any <c>Theme</c> resources that are present in the asset bundle that is imported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleImportJobCmdlet.OverridePermissions_Theme"> <summary> <para> <para>A list of permissions overrides for any <c>Theme</c> resources that are present in the asset bundle that is imported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleImportJobCmdlet.OverrideTags_Theme"> <summary> <para> <para>A list of tag overrides for any <c>Theme</c> resources that are present in the asset bundle that is imported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleImportJobCmdlet.OverrideParameters_VPCConnection"> <summary> <para> <para>A list of overrides for any <c>VPCConnection</c> resources that are present in the asset bundle that is imported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleImportJobCmdlet.OverrideTags_VPCConnection"> <summary> <para> <para>A list of tag overrides for any <c>VPCConnection</c> resources that are present in the asset bundle that is imported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleImportJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.StartAssetBundleImportJobResponse). Specifying the name of a property of type Amazon.QuickSight.Model.StartAssetBundleImportJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleImportJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssetBundleImportJobId parameter. The -PassThru parameter is deprecated, use -Select '^AssetBundleImportJobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSAssetBundleImportJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.StartQSDashboardSnapshotJobCmdlet"> <summary> Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call. <ul><li><para> 1 Paginated PDF </para></li><li><para> 1 Excel workbook that includes up to 5 table or pivot table visuals </para></li><li><para> 5 CSVs from table or pivot table visuals </para></li></ul><para> The status of a submitted job can be polled with the <c>DescribeDashboardSnapshotJob</c> API. When you call the <c>DescribeDashboardSnapshotJob</c> API, check the <c>JobStatus</c> field in the response. Once the job reaches a <c>COMPLETED</c> or <c>FAILED</c> status, use the <c>DescribeDashboardSnapshotJobResult</c> API to obtain the URLs for the generated files. If the job fails, the <c>DescribeDashboardSnapshotJobResult</c> API returns detailed information about the error that occurred. </para><para><b>StartDashboardSnapshotJob API throttling</b></para><para> Amazon QuickSight utilizes API throttling to create a more consistent user experience within a time span for customers when they call the <c>StartDashboardSnapshotJob</c>. By default, 12 jobs can run simlutaneously in one Amazon Web Services account and users can submit up 10 API requests per second before an account is throttled. If an overwhelming number of API requests are made by the same user in a short period of time, Amazon QuickSight throttles the API calls to maintin an optimal experience and reliability for all Amazon QuickSight users. </para><para><b>Common throttling scenarios</b></para><para> The following list provides information about the most commin throttling scenarios that can occur. </para><ul><li><para><b>A large number of <c>SnapshotExport</c> API jobs are running simultaneously on an Amazon Web Services account.</b> When a new <c>StartDashboardSnapshotJob</c> is created and there are already 12 jobs with the <c>RUNNING</c> status, the new job request fails and returns a <c>LimitExceededException</c> error. Wait for a current job to comlpete before you resubmit the new job. </para></li><li><para><b>A large number of API requests are submitted on an Amazon Web Services account.</b> When a user makes more than 10 API calls to the Amazon QuickSight API in one second, a <c>ThrottlingException</c> is returned. </para></li></ul><para> If your use case requires a higher throttling limit, contact your account admin or <a href="http://aws.amazon.com/contact-us/">Amazon Web ServicesSupport</a> to explore options to tailor a more optimal expereince for your account. </para><para><b>Best practices to handle throttling</b></para><para> If your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for the total processing time of your projected load that stays within the throttling limits of the Amazon QuickSight APIs. For example, if your projected traffic is 100 snapshot jobs before 12:00 PM per day, start 12 jobs in parallel and measure the amount of time it takes to proccess all 12 jobs. Once you obtain the result, multiply the duration by 9, for example <c>(12 minutes * 9 = 108 minutes)</c>. Use the new result to determine the latest time at which the jobs need to be started to meet your target deadline. </para><para> The time that it takes to process a job can be impacted by the following factors: </para><ul><li><para> The dataset type (Direct Query or SPICE). </para></li><li><para> The size of the dataset. </para></li><li><para> The complexity of the calculated fields that are used in the dashboard. </para></li><li><para> The number of visuals that are on a sheet. </para></li><li><para> The types of visuals that are on the sheet. </para></li><li><para> The number of formats and snapshots that are requested in the job configuration. </para></li><li><para> The size of the generated snapshots. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSDashboardSnapshotJobCmdlet.UserConfiguration_AnonymousUser"> <summary> <para> <para>An array of records that describe the anonymous users that the dashboard snapshot is generated for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSDashboardSnapshotJobCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSDashboardSnapshotJobCmdlet.DashboardId"> <summary> <para> <para>The ID of the dashboard that you want to start a snapshot job for. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSDashboardSnapshotJobCmdlet.Parameters_DateTimeParameter"> <summary> <para> <para>The parameters that have a data type of date-time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSDashboardSnapshotJobCmdlet.Parameters_DecimalParameter"> <summary> <para> <para>The parameters that have a data type of decimal.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSDashboardSnapshotJobCmdlet.SnapshotConfiguration_FileGroup"> <summary> <para> <para>A list of <c>SnapshotJobResultFileGroup</c> objects that contain information about the snapshot that is generated. This list can hold a maximum of 6 <c>FileGroup</c> configurations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSDashboardSnapshotJobCmdlet.Parameters_IntegerParameter"> <summary> <para> <para>The parameters that have a data type of integer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSDashboardSnapshotJobCmdlet.DestinationConfiguration_S3Destination"> <summary> <para> <para> A list of <c>SnapshotS3DestinationConfiguration</c> objects that contain Amazon S3 destination configurations. This structure can hold a maximum of 1 <c>S3DestinationConfiguration</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSDashboardSnapshotJobCmdlet.SnapshotJobId"> <summary> <para> <para>An ID for the dashboard snapshot job. This ID is unique to the dashboard while the job is running. This ID can be used to poll the status of a job with a <c>DescribeDashboardSnapshotJob</c> while the job runs. You can reuse this ID for another job 24 hours after the current job is completed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSDashboardSnapshotJobCmdlet.Parameters_StringParameter"> <summary> <para> <para>The parameters that have a data type of string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSDashboardSnapshotJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.StartDashboardSnapshotJobResponse). Specifying the name of a property of type Amazon.QuickSight.Model.StartDashboardSnapshotJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSDashboardSnapshotJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SnapshotJobId parameter. The -PassThru parameter is deprecated, use -Select '^SnapshotJobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSDashboardSnapshotJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.StartQSDashboardSnapshotJobScheduleCmdlet"> <summary> Starts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email. <para> Only one job can run simultaneously in a given schedule. Repeated requests are skipped with a <c>202</c> HTTP status code. </para><para> For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sending-reports.html">Scheduling and sending Amazon QuickSight reports by email</a> and <a href="https://docs.aws.amazon.com/quicksight/latest/user/email-reports-from-dashboard.html">Configuring email report settings for a Amazon QuickSight dashboard</a> in the <i>Amazon QuickSight User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSDashboardSnapshotJobScheduleCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSDashboardSnapshotJobScheduleCmdlet.DashboardId"> <summary> <para> <para>The ID of the dashboard that you want to start a snapshot job schedule for. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSDashboardSnapshotJobScheduleCmdlet.ScheduleId"> <summary> <para> <para>The ID of the schedule that you want to start a snapshot job schedule for. The schedule ID can be found in the Amazon QuickSight console in the <b>Schedules</b> pane of the dashboard that the schedule is configured for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSDashboardSnapshotJobScheduleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.StartDashboardSnapshotJobScheduleResponse). Specifying the name of a property of type Amazon.QuickSight.Model.StartDashboardSnapshotJobScheduleResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSDashboardSnapshotJobScheduleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ScheduleId parameter. The -PassThru parameter is deprecated, use -Select '^ScheduleId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StartQSDashboardSnapshotJobScheduleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.StopQSIngestionCmdlet"> <summary> Cancels an ongoing ingestion of data into SPICE. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StopQSIngestionCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StopQSIngestionCmdlet.DataSetId"> <summary> <para> <para>The ID of the dataset used in the ingestion.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StopQSIngestionCmdlet.IngestionId"> <summary> <para> <para>An ID for the ingestion.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StopQSIngestionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.CancelIngestionResponse). Specifying the name of a property of type Amazon.QuickSight.Model.CancelIngestionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StopQSIngestionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IngestionId parameter. The -PassThru parameter is deprecated, use -Select '^IngestionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.StopQSIngestionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.UpdateQSAccountCustomizationCmdlet"> <summary> Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme. <para> 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 <c>DescribeAccountCustomization</c> API operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAccountCustomizationCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAccountCustomizationCmdlet.AccountCustomization_DefaultEmailCustomizationTemplate"> <summary> <para> <para>The default email customization template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAccountCustomizationCmdlet.AccountCustomization_DefaultTheme"> <summary> <para> <para>The default theme for this Amazon QuickSight subscription.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAccountCustomizationCmdlet.Namespace"> <summary> <para> <para>The namespace that you want to update Amazon QuickSight customizations for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAccountCustomizationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UpdateAccountCustomizationResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateAccountCustomizationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAccountCustomizationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAccountCustomizationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.UpdateQSAccountSettingCmdlet"> <summary> Updates the Amazon QuickSight settings in your Amazon Web Services account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAccountSettingCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the Amazon Web Services account that contains the Amazon QuickSight settings that you want to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAccountSettingCmdlet.DefaultNamespace"> <summary> <para> <para>The default namespace for this Amazon Web Services account. Currently, the default is <c>default</c>. IAM users that register for the first time with Amazon QuickSight provide an email address that becomes associated with the default namespace. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAccountSettingCmdlet.NotificationEmail"> <summary> <para> <para>The email address that you want Amazon QuickSight to send notifications to regarding your Amazon Web Services account or Amazon QuickSight subscription.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAccountSettingCmdlet.TerminationProtectionEnabled"> <summary> <para> <para>A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A <c>True</c> value doesn't allow the account to be deleted and results in an error message if a user tries to make a <c>DeleteAccountSubscription</c> request. A <c>False</c> value will allow the account to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAccountSettingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UpdateAccountSettingsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateAccountSettingsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAccountSettingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAccountSettingCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisCmdlet"> <summary> Updates an analysis in Amazon QuickSight </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisCmdlet.AnalysisId"> <summary> <para> <para>The ID for the analysis that you're updating. This ID displays in the URL of the analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisCmdlet.SourceTemplate_Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the source template of an analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the analysis that you're updating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisCmdlet.PaperMargin_Bottom"> <summary> <para> <para>Define the bottom spacing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisCmdlet.Definition_CalculatedField"> <summary> <para> <para>An array of calculated field definitions for the analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisCmdlet.Definition_ColumnConfiguration"> <summary> <para> <para> An array of analysis-level column configurations. Column configurations can be used to set default formatting for a column to be used throughout an analysis. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisCmdlet.Definition_DataSetIdentifierDeclaration"> <summary> <para> <para>An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of dataset ARNs throughout analysis sub-structures.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisCmdlet.SourceTemplate_DataSetReference"> <summary> <para> <para>The dataset references of the source template of an analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisCmdlet.Parameters_DateTimeParameter"> <summary> <para> <para>The parameters that have a data type of date-time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisCmdlet.Parameters_DecimalParameter"> <summary> <para> <para>The parameters that have a data type of decimal.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisCmdlet.Definition_FilterGroup"> <summary> <para> <para>Filter definitions for an analysis.</para><para>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/adding-a-filter.html">Filtering Data in Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisCmdlet.Parameters_IntegerParameter"> <summary> <para> <para>The parameters that have a data type of integer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisCmdlet.PaperMargin_Left"> <summary> <para> <para>Define the left spacing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisCmdlet.ValidationStrategy_Mode"> <summary> <para> <para>The mode of validation for the asset to be created or updated. When you set this value to <c>STRICT</c>, strict validation for every error is enforced. When you set this value to <c>LENIENT</c>, validation is skipped for specific UI errors.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisCmdlet.Name"> <summary> <para> <para>A descriptive name for the analysis that you're updating. This name displays for the analysis in the Amazon QuickSight console.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisCmdlet.Definition_AnalysisDefaults_DefaultNewSheetConfiguration_InteractiveLayoutConfiguration_FreeForm_CanvasSizeOptions_ScreenCanvasSizeOptions_OptimizedViewPortWidth"> <summary> <para> <para>The width that the view port will be optimized for when the layout renders.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisCmdlet.Definition_AnalysisDefaults_DefaultNewSheetConfiguration_InteractiveLayoutConfiguration_Grid_CanvasSizeOptions_ScreenCanvasSizeOptions_OptimizedViewPortWidth"> <summary> <para> <para>The width that the view port will be optimized for when the layout renders.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisCmdlet.PaperCanvasSizeOptions_PaperOrientation"> <summary> <para> <para>The paper orientation that is used to define canvas dimensions. Choose one of the following options:</para><ul><li><para>PORTRAIT</para></li><li><para>LANDSCAPE</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisCmdlet.PaperCanvasSizeOptions_PaperSize"> <summary> <para> <para>The paper size that is used to define canvas dimensions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisCmdlet.Definition_ParameterDeclaration"> <summary> <para> <para>An array of parameter declarations for an analysis.</para><para>Parameters are named variables that can transfer a value for use by an action or an object.</para><para>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html">Parameters in Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisCmdlet.QueryExecutionOptions_QueryExecutionMode"> <summary> <para> <para>A structure that describes the query execution mode.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisCmdlet.ScreenCanvasSizeOptions_ResizeOption"> <summary> <para> <para>This value determines the layout behavior when the viewport is resized.</para><ul><li><para><c>FIXED</c>: A fixed width will be used when optimizing the layout. In the Amazon QuickSight console, this option is called <c>Classic</c>.</para></li><li><para><c>RESPONSIVE</c>: The width of the canvas will be responsive and optimized to the view port. In the Amazon QuickSight console, this option is called <c>Tiled</c>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisCmdlet.PaperMargin_Right"> <summary> <para> <para>Define the right spacing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisCmdlet.DefaultNewSheetConfiguration_SheetContentType"> <summary> <para> <para>The option that determines the sheet content type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisCmdlet.Definition_Sheet"> <summary> <para> <para>An array of sheet definitions for an analysis. Each <c>SheetDefinition</c> provides detailed information about a sheet within this analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisCmdlet.Parameters_StringParameter"> <summary> <para> <para>The parameters that have a data type of string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisCmdlet.ThemeArn"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisCmdlet.Options_Timezone"> <summary> <para> <para>Determines the timezone for the analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisCmdlet.PaperMargin_Top"> <summary> <para> <para>Define the top spacing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisCmdlet.Options_WeekStart"> <summary> <para> <para>Determines the week start day for an analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UpdateAnalysisResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateAnalysisResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AnalysisId parameter. The -PassThru parameter is deprecated, use -Select '^AnalysisId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisPermissionCmdlet"> <summary> Updates the read and write permissions for an analysis. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisPermissionCmdlet.AnalysisId"> <summary> <para> <para>The ID of the analysis whose permissions you're updating. The ID is part of the analysis URL.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisPermissionCmdlet.AwsAccountId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisPermissionCmdlet.GrantPermission"> <summary> <para> <para>A structure that describes the permissions to add and the principal to add them to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisPermissionCmdlet.RevokePermission"> <summary> <para> <para>A structure that describes the permissions to remove and the principal to remove them from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisPermissionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UpdateAnalysisPermissionsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateAnalysisPermissionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisPermissionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AnalysisId parameter. The -PassThru parameter is deprecated, use -Select '^AnalysisId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSAnalysisPermissionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet"> <summary> Updates a dashboard in an Amazon Web Services account. <note><para> 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 <c><a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateDashboardPublishedVersion.html">UpdateDashboardPublishedVersion</a></c> API operation. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.SourceTemplate_Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.AdHocFilteringOption_AvailabilityStatus"> <summary> <para> <para>Availability status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.DataPointDrillUpDownOption_AvailabilityStatus"> <summary> <para> <para>The status of the drill down options of data points.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.DataPointMenuLabelOption_AvailabilityStatus"> <summary> <para> <para>The status of the data point menu options.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.DataPointTooltipOption_AvailabilityStatus"> <summary> <para> <para>The status of the data point tool tip options.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.ExportToCSVOption_AvailabilityStatus"> <summary> <para> <para>Availability status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.ExportWithHiddenFieldsOption_AvailabilityStatus"> <summary> <para> <para>The status of the export with hidden fields options.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.SheetLayoutElementMaximizationOption_AvailabilityStatus"> <summary> <para> <para>The status of the sheet layout maximization options of a dashbaord.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.VisualAxisSortOption_AvailabilityStatus"> <summary> <para> <para>The availaiblity status of a visual's axis sort options.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.VisualMenuOption_AvailabilityStatus"> <summary> <para> <para>The availaiblity status of a visual's menu options.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.ExportHiddenFieldsOption_AvailabilityStatus"> <summary> <para> <para>The status of the export hidden fields options of a dashbaord.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the dashboard that you're updating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.PaperMargin_Bottom"> <summary> <para> <para>Define the bottom spacing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.Definition_CalculatedField"> <summary> <para> <para>An array of calculated field definitions for the dashboard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.Definition_ColumnConfiguration"> <summary> <para> <para>An array of dashboard-level column configurations. Column configurations are used to set the default formatting for a column that is used throughout a dashboard. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.DashboardId"> <summary> <para> <para>The ID for the dashboard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.Definition_DataSetIdentifierDeclaration"> <summary> <para> <para>An array of dataset identifier declarations. With this mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard's sub-structures.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.SourceTemplate_DataSetReference"> <summary> <para> <para>Dataset references.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.Parameters_DateTimeParameter"> <summary> <para> <para>The parameters that have a data type of date-time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.Parameters_DecimalParameter"> <summary> <para> <para>The parameters that have a data type of decimal.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.Definition_FilterGroup"> <summary> <para> <para>The filter definitions for a dashboard.</para><para>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/adding-a-filter.html">Filtering Data in Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.Parameters_IntegerParameter"> <summary> <para> <para>The parameters that have a data type of integer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.PaperMargin_Left"> <summary> <para> <para>Define the left spacing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.ValidationStrategy_Mode"> <summary> <para> <para>The mode of validation for the asset to be created or updated. When you set this value to <c>STRICT</c>, strict validation for every error is enforced. When you set this value to <c>LENIENT</c>, validation is skipped for specific UI errors.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.Name"> <summary> <para> <para>The display name of the dashboard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.Definition_AnalysisDefaults_DefaultNewSheetConfiguration_InteractiveLayoutConfiguration_FreeForm_CanvasSizeOptions_ScreenCanvasSizeOptions_OptimizedViewPortWidth"> <summary> <para> <para>The width that the view port will be optimized for when the layout renders.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.Definition_AnalysisDefaults_DefaultNewSheetConfiguration_InteractiveLayoutConfiguration_Grid_CanvasSizeOptions_ScreenCanvasSizeOptions_OptimizedViewPortWidth"> <summary> <para> <para>The width that the view port will be optimized for when the layout renders.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.PaperCanvasSizeOptions_PaperOrientation"> <summary> <para> <para>The paper orientation that is used to define canvas dimensions. Choose one of the following options:</para><ul><li><para>PORTRAIT</para></li><li><para>LANDSCAPE</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.PaperCanvasSizeOptions_PaperSize"> <summary> <para> <para>The paper size that is used to define canvas dimensions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.Definition_ParameterDeclaration"> <summary> <para> <para>The parameter declarations for a dashboard. Parameters are named variables that can transfer a value for use by an action or an object.</para><para>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html">Parameters in Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.ScreenCanvasSizeOptions_ResizeOption"> <summary> <para> <para>This value determines the layout behavior when the viewport is resized.</para><ul><li><para><c>FIXED</c>: A fixed width will be used when optimizing the layout. In the Amazon QuickSight console, this option is called <c>Classic</c>.</para></li><li><para><c>RESPONSIVE</c>: The width of the canvas will be responsive and optimized to the view port. In the Amazon QuickSight console, this option is called <c>Tiled</c>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.PaperMargin_Right"> <summary> <para> <para>Define the right spacing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.DefaultNewSheetConfiguration_SheetContentType"> <summary> <para> <para>The option that determines the sheet content type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.Definition_Sheet"> <summary> <para> <para>An array of sheet definitions for a dashboard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.Parameters_StringParameter"> <summary> <para> <para>The parameters that have a data type of string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.ThemeArn"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.Options_Timezone"> <summary> <para> <para>Determines the timezone for the analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.PaperMargin_Top"> <summary> <para> <para>Define the top spacing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.VersionDescription"> <summary> <para> <para>A description for the first version of the dashboard being created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.SheetControlsOption_VisibilityState"> <summary> <para> <para>Visibility state.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.Options_WeekStart"> <summary> <para> <para>Determines the week start day for an analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UpdateDashboardResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateDashboardResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardLinkCmdlet"> <summary> Updates the linked analyses on a dashboard. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardLinkCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the dashboard whose links you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardLinkCmdlet.DashboardId"> <summary> <para> <para>The ID for the dashboard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardLinkCmdlet.LinkEntity"> <summary> <para> <para> list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardLinkCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UpdateDashboardLinksResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateDashboardLinksResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardLinkCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardLinkCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardPermissionCmdlet"> <summary> Updates read and write permissions on a dashboard. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardPermissionCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the dashboard whose permissions you're updating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardPermissionCmdlet.DashboardId"> <summary> <para> <para>The ID for the dashboard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardPermissionCmdlet.GrantLinkPermission"> <summary> <para> <para>Grants link permissions to all users in a defined namespace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardPermissionCmdlet.GrantPermission"> <summary> <para> <para>The permissions that you want to grant on this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardPermissionCmdlet.RevokeLinkPermission"> <summary> <para> <para>Revokes link permissions from all users in a defined namespace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardPermissionCmdlet.RevokePermission"> <summary> <para> <para>The permissions that you want to revoke from this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardPermissionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UpdateDashboardPermissionsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateDashboardPermissionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardPermissionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardPermissionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardPublishedVersionCmdlet"> <summary> Updates the published version of a dashboard. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardPublishedVersionCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the dashboard that you're updating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardPublishedVersionCmdlet.DashboardId"> <summary> <para> <para>The ID for the dashboard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardPublishedVersionCmdlet.VersionNumber"> <summary> <para> <para>The version number of the dashboard.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardPublishedVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UpdateDashboardPublishedVersionResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateDashboardPublishedVersionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardPublishedVersionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDashboardPublishedVersionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSetCmdlet"> <summary> Updates a dataset. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSetCmdlet.RowLevelPermissionDataSet_Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSetCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSetCmdlet.ColumnGroup"> <summary> <para> <para>Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSetCmdlet.ColumnLevelPermissionRule"> <summary> <para> <para>A set of one or more definitions of a <c><a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html">ColumnLevelPermissionRule</a></c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSetCmdlet.DataSetId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSetCmdlet.DatasetParameter"> <summary> <para> <para>The parameter declarations of the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSetCmdlet.DataSetUsageConfiguration_DisableUseAsDirectQuerySource"> <summary> <para> <para>An option that controls whether a child dataset of a direct query can use this dataset as a source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSetCmdlet.DataSetUsageConfiguration_DisableUseAsImportedSource"> <summary> <para> <para>An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSetCmdlet.FieldFolder"> <summary> <para> <para>The folder that contains fields and nested subfolders for your dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSetCmdlet.RowLevelPermissionDataSet_FormatVersion"> <summary> <para> <para>The user or group rules associated with the dataset that contains permissions for RLS.</para><para>By default, <c>FormatVersion</c> is <c>VERSION_1</c>. When <c>FormatVersion</c> is <c>VERSION_1</c>, <c>UserName</c> and <c>GroupName</c> are required. When <c>FormatVersion</c> is <c>VERSION_2</c>, <c>UserARN</c> and <c>GroupARN</c> are required, and <c>Namespace</c> must not exist.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSetCmdlet.ImportMode"> <summary> <para> <para>Indicates whether you want to import the data into SPICE.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSetCmdlet.LogicalTableMap"> <summary> <para> <para>Configures the combination and transformation of the data from the physical tables.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSetCmdlet.Name"> <summary> <para> <para>The display name for the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSetCmdlet.RowLevelPermissionDataSet_Namespace"> <summary> <para> <para>The namespace associated with the dataset that contains permissions for RLS.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSetCmdlet.RowLevelPermissionDataSet_PermissionPolicy"> <summary> <para> <para>The type of permissions to use when interpreting the permissions for RLS. <c>DENY_ACCESS</c> is included for backward compatibility only.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSetCmdlet.PhysicalTableMap"> <summary> <para> <para>Declares the physical tables that are available in the underlying data sources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSetCmdlet.RowLevelPermissionDataSet_Status"> <summary> <para> <para>The status of the row-level security permission dataset. If enabled, the status is <c>ENABLED</c>. If disabled, the status is <c>DISABLED</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSetCmdlet.RowLevelPermissionTagConfiguration_Status"> <summary> <para> <para>The status of row-level security tags. If enabled, the status is <c>ENABLED</c>. If disabled, the status is <c>DISABLED</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSetCmdlet.RowLevelPermissionTagConfiguration_TagRuleConfiguration"> <summary> <para> <para>A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSetCmdlet.RowLevelPermissionTagConfiguration_TagRule"> <summary> <para> <para>A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UpdateDataSetResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateDataSetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DataSetId parameter. The -PassThru parameter is deprecated, use -Select '^DataSetId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSetPermissionCmdlet"> <summary> Updates the permissions on a dataset. <para> The permissions resource is <c>arn:aws:quicksight:region:aws-account-id:dataset/data-set-id</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSetPermissionCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSetPermissionCmdlet.DataSetId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSetPermissionCmdlet.GrantPermission"> <summary> <para> <para>The resource permissions that you want to grant to the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSetPermissionCmdlet.RevokePermission"> <summary> <para> <para>The resource permissions that you want to revoke from the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSetPermissionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UpdateDataSetPermissionsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateDataSetPermissionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSetPermissionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DataSetId parameter. The -PassThru parameter is deprecated, use -Select '^DataSetId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSetPermissionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet"> <summary> Updates a data source. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.CredentialPair_AlternateDataSourceParameter"> <summary> <para> <para>A set of alternate data source parameters that you want to share for these credentials. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the <c>DataSourceParameters</c> structure that's in the request with the structures in the <c>AlternateDataSourceParameters</c> allow list. If the structures are an exact match, the request is allowed to use the new data source with the existing credentials. If the <c>AlternateDataSourceParameters</c> list is null, the <c>DataSourceParameters</c> originally used with these <c>Credentials</c> is automatically allowed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.SnowflakeParameters_AuthenticationType"> <summary> <para> <para>The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.StarburstParameters_AuthenticationType"> <summary> <para> <para>The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.IAMParameters_AutoCreateDatabaseUser"> <summary> <para> <para>Automatically creates a database user. If your database doesn't have a <c>DatabaseUser</c>, set this parameter to <c>True</c>. If there is no <c>DatabaseUser</c>, Amazon QuickSight can't connect to your cluster. The <c>RoleArn</c> that you use for this operation must grant access to <c>redshift:CreateClusterUser</c> to successfully create the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.ManifestFileLocation_Bucket"> <summary> <para> <para>Amazon S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.PrestoParameters_Catalog"> <summary> <para> <para>Catalog.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.StarburstParameters_Catalog"> <summary> <para> <para>The catalog name for the Starburst data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.TrinoParameters_Catalog"> <summary> <para> <para>The catalog name for the Trino data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.RedshiftParameters_ClusterId"> <summary> <para> <para>Cluster ID. This field can be blank if the <c>Host</c> and <c>Port</c> are provided.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.Credentials_CopySourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use. When <c>CopySourceArn</c> is not null, the credential pair from the data source in the ARN is used as the credentials for the <c>DataSourceCredentials</c> structure.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.AuroraParameters_Database"> <summary> <para> <para>Database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.AuroraPostgreSqlParameters_Database"> <summary> <para> <para>The Amazon Aurora PostgreSQL database to connect to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.MariaDbParameters_Database"> <summary> <para> <para>Database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.MySqlParameters_Database"> <summary> <para> <para>Database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.OracleParameters_Database"> <summary> <para> <para>The database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.PostgreSqlParameters_Database"> <summary> <para> <para>Database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.RdsParameters_Database"> <summary> <para> <para>Database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.RedshiftParameters_Database"> <summary> <para> <para>Database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.SnowflakeParameters_Database"> <summary> <para> <para>Database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.SqlServerParameters_Database"> <summary> <para> <para>Database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.TeradataParameters_Database"> <summary> <para> <para>Database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.SnowflakeParameters_DatabaseAccessControlRole"> <summary> <para> <para>The database access control role.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.StarburstParameters_DatabaseAccessControlRole"> <summary> <para> <para>The database access control role.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.IAMParameters_DatabaseGroup"> <summary> <para> <para>A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the <c>DatabaseUser</c>. If you choose to include this parameter, the <c>RoleArn</c> must grant access to <c>redshift:JoinGroup</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.IAMParameters_DatabaseUser"> <summary> <para> <para>The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of <c>AutoCreateDatabaseUser</c> to <c>True</c> to create a new user with PUBLIC permissions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.AwsIotAnalyticsParameters_DataSetName"> <summary> <para> <para>Dataset name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.BigQueryParameters_DataSetRegion"> <summary> <para> <para>The storage location where you create a Google BigQuery data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.DataSourceId"> <summary> <para> <para>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.SslProperties_DisableSsl"> <summary> <para> <para>A Boolean option to control whether SSL should be disabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.AmazonElasticsearchParameters_Domain"> <summary> <para> <para>The OpenSearch domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.AmazonOpenSearchParameters_Domain"> <summary> <para> <para>The OpenSearch domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.IdentityCenterConfiguration_EnableIdentityPropagation"> <summary> <para> <para>A Boolean option that controls whether Trusted Identity Propagation should be used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.AuroraParameters_Host"> <summary> <para> <para>Host.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.AuroraPostgreSqlParameters_Host"> <summary> <para> <para>The Amazon Aurora PostgreSQL-Compatible host to connect to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.DatabricksParameters_Host"> <summary> <para> <para>The host name of the Databricks data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.ExasolParameters_Host"> <summary> <para> <para>The hostname or IP address of the Exasol data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.MariaDbParameters_Host"> <summary> <para> <para>Host.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.MySqlParameters_Host"> <summary> <para> <para>Host.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.OracleParameters_Host"> <summary> <para> <para>An Oracle host.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.PostgreSqlParameters_Host"> <summary> <para> <para>Host.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.PrestoParameters_Host"> <summary> <para> <para>Host.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.RedshiftParameters_Host"> <summary> <para> <para>Host. This field can be blank if <c>ClusterId</c> is provided.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.SnowflakeParameters_Host"> <summary> <para> <para>Host.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.SparkParameters_Host"> <summary> <para> <para>Host.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.SqlServerParameters_Host"> <summary> <para> <para>Host.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.StarburstParameters_Host"> <summary> <para> <para>The host name of the Starburst data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.TeradataParameters_Host"> <summary> <para> <para>Host.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.TrinoParameters_Host"> <summary> <para> <para>The host name of the Trino data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.DataSourceParameters_SnowflakeParameters_OAuthParameters_IdentityProviderResourceUri"> <summary> <para> <para>The resource uri of the identity provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.DataSourceParameters_StarburstParameters_OAuthParameters_IdentityProviderResourceUri"> <summary> <para> <para>The resource uri of the identity provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.RdsParameters_InstanceId"> <summary> <para> <para>Instance ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.ManifestFileLocation_Key"> <summary> <para> <para>Amazon S3 key that identifies an object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.TwitterParameters_MaxRow"> <summary> <para> <para>Maximum number of rows to query Twitter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.Name"> <summary> <para> <para>A display name for the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.DataSourceParameters_SnowflakeParameters_OAuthParameters_OAuthScope"> <summary> <para> <para>The OAuth scope.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.DataSourceParameters_StarburstParameters_OAuthParameters_OAuthScope"> <summary> <para> <para>The OAuth scope.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.CredentialPair_Password"> <summary> <para> <para>Password.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.AuroraParameters_Port"> <summary> <para> <para>Port.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.AuroraPostgreSqlParameters_Port"> <summary> <para> <para>The port that Amazon Aurora PostgreSQL is listening on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.DatabricksParameters_Port"> <summary> <para> <para>The port for the Databricks data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.ExasolParameters_Port"> <summary> <para> <para>The port for the Exasol data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.MariaDbParameters_Port"> <summary> <para> <para>Port.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.MySqlParameters_Port"> <summary> <para> <para>Port.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.OracleParameters_Port"> <summary> <para> <para>The port.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.PostgreSqlParameters_Port"> <summary> <para> <para>Port.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.PrestoParameters_Port"> <summary> <para> <para>Port.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.RedshiftParameters_Port"> <summary> <para> <para>Port. This field can be blank if the <c>ClusterId</c> is provided.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.SparkParameters_Port"> <summary> <para> <para>Port.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.SqlServerParameters_Port"> <summary> <para> <para>Port.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.StarburstParameters_Port"> <summary> <para> <para>The port for the Starburst data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.TeradataParameters_Port"> <summary> <para> <para>Port.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.TrinoParameters_Port"> <summary> <para> <para>The port for the Trino data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.StarburstParameters_ProductType"> <summary> <para> <para>The product type for the Starburst data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.BigQueryParameters_ProjectId"> <summary> <para> <para>The Google Cloud Platform project ID where your datasource was created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.TwitterParameters_Query"> <summary> <para> <para>Twitter query string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.AthenaParameters_RoleArn"> <summary> <para> <para>Use the <c>RoleArn</c> structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use <c>RoleArn</c> to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.IAMParameters_RoleArn"> <summary> <para> <para>Use the <c>RoleArn</c> structure to allow Amazon QuickSight to call <c>redshift:GetClusterCredentials</c> on your cluster. The calling principal must have <c>iam:PassRole</c> access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.S3Parameters_RoleArn"> <summary> <para> <para>Use the <c>RoleArn</c> structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use <c>RoleArn</c> to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.Credentials_SecretArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.JiraParameters_SiteBaseUrl"> <summary> <para> <para>The base URL of the Jira site.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.ServiceNowParameters_SiteBaseUrl"> <summary> <para> <para>URL of the base site.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.DatabricksParameters_SqlEndpointPath"> <summary> <para> <para>The HTTP path of the Databricks data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.DataSourceParameters_SnowflakeParameters_OAuthParameters_TokenProviderUrl"> <summary> <para> <para>The token endpoint URL of the identity provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.DataSourceParameters_StarburstParameters_OAuthParameters_TokenProviderUrl"> <summary> <para> <para>The token endpoint URL of the identity provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.CredentialPair_Username"> <summary> <para> <para>User name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.DataSourceParameters_SnowflakeParameters_OAuthParameters_IdentityProviderVpcConnectionProperties_VpcConnectionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the VPC connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.DataSourceParameters_StarburstParameters_OAuthParameters_IdentityProviderVpcConnectionProperties_VpcConnectionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the VPC connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.VpcConnectionProperties_VpcConnectionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the VPC connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.SnowflakeParameters_Warehouse"> <summary> <para> <para>Warehouse.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.AthenaParameters_WorkGroup"> <summary> <para> <para>The workgroup that Amazon Athena uses.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UpdateDataSourceResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateDataSourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DataSourceId parameter. The -PassThru parameter is deprecated, use -Select '^DataSourceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourcePermissionCmdlet"> <summary> Updates the permissions to a data source. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourcePermissionCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourcePermissionCmdlet.DataSourceId"> <summary> <para> <para>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourcePermissionCmdlet.GrantPermission"> <summary> <para> <para>A list of resource permissions that you want to grant on the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourcePermissionCmdlet.RevokePermission"> <summary> <para> <para>A list of resource permissions that you want to revoke on the data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourcePermissionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UpdateDataSourcePermissionsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateDataSourcePermissionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourcePermissionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DataSourceId parameter. The -PassThru parameter is deprecated, use -Select '^DataSourceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSDataSourcePermissionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.UpdateQSFolderCmdlet"> <summary> Updates the name of a folder. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSFolderCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the Amazon Web Services account that contains the folder to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSFolderCmdlet.FolderId"> <summary> <para> <para>The ID of the folder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSFolderCmdlet.Name"> <summary> <para> <para>The name of the folder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSFolderCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UpdateFolderResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateFolderResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSFolderCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FolderId parameter. The -PassThru parameter is deprecated, use -Select '^FolderId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSFolderCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.UpdateQSFolderPermissionCmdlet"> <summary> Updates permissions of a folder. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSFolderPermissionCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the Amazon Web Services account that contains the folder to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSFolderPermissionCmdlet.FolderId"> <summary> <para> <para>The ID of the folder.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSFolderPermissionCmdlet.GrantPermission"> <summary> <para> <para>The permissions that you want to grant on a resource. Namespace ARNs are not supported <c>Principal</c> values for folder permissions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSFolderPermissionCmdlet.RevokePermission"> <summary> <para> <para>The permissions that you want to revoke from a resource. Namespace ARNs are not supported <c>Principal</c> values for folder permissions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSFolderPermissionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UpdateFolderPermissionsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateFolderPermissionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSFolderPermissionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FolderId parameter. The -PassThru parameter is deprecated, use -Select '^FolderId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSFolderPermissionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.UpdateQSGroupCmdlet"> <summary> Changes a group description. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSGroupCmdlet.AwsAccountId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSGroupCmdlet.Description"> <summary> <para> <para>The description for the group that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSGroupCmdlet.GroupName"> <summary> <para> <para>The name of the group that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSGroupCmdlet.Namespace"> <summary> <para> <para>The namespace of the group that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Group'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UpdateGroupResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the GroupName parameter. The -PassThru parameter is deprecated, use -Select '^GroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.UpdateQSIAMPolicyAssignmentCmdlet"> <summary> 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 <c>Identities</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSIAMPolicyAssignmentCmdlet.AssignmentName"> <summary> <para> <para>The name of the assignment, also called a rule. The name must be unique within the Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSIAMPolicyAssignmentCmdlet.AssignmentStatus"> <summary> <para> <para>The status of the assignment. Possible values are as follows:</para><ul><li><para><c>ENABLED</c> - Anything specified in this assignment is used when creating the data source.</para></li><li><para><c>DISABLED</c> - This assignment isn't used when creating the data source.</para></li><li><para><c>DRAFT</c> - This assignment is an unfinished draft and isn't used when creating the data source.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSIAMPolicyAssignmentCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the IAM policy assignment. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSIAMPolicyAssignmentCmdlet.Identity"> <summary> <para> <para>The Amazon QuickSight users, groups, or both that you want to assign the policy to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSIAMPolicyAssignmentCmdlet.Namespace"> <summary> <para> <para>The namespace of the assignment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSIAMPolicyAssignmentCmdlet.PolicyArn"> <summary> <para> <para>The ARN for the IAM policy to apply to the Amazon QuickSight users and groups specified in this assignment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSIAMPolicyAssignmentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UpdateIAMPolicyAssignmentResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateIAMPolicyAssignmentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSIAMPolicyAssignmentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssignmentName parameter. The -PassThru parameter is deprecated, use -Select '^AssignmentName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSIAMPolicyAssignmentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.UpdateQSIdentityPropagationConfigCmdlet"> <summary> Adds or updates services and authorized targets to configure what the Amazon QuickSight IAM Identity Center application can access. <para> This operation is only supported for Amazon QuickSight accounts using IAM Identity Center </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSIdentityPropagationConfigCmdlet.AuthorizedTarget"> <summary> <para> <para>Specifies a list of application ARNs that represent the authorized targets for a service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSIdentityPropagationConfigCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the identity propagation configuration that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSIdentityPropagationConfigCmdlet.Service"> <summary> <para> <para>The name of the Amazon Web Services service that contains the authorized targets that you want to add or update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSIdentityPropagationConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UpdateIdentityPropagationConfigResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateIdentityPropagationConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSIdentityPropagationConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSIdentityPropagationConfigCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.UpdateQSIpRestrictionCmdlet"> <summary> Updates the content and status of IP rules. Traffic from a source is allowed when the source satisfies either the <c>IpRestrictionRule</c>, <c>VpcIdRestrictionRule</c>, or <c>VpcEndpointIdRestrictionRule</c>. To use this operation, you must provide the entire map of rules. You can use the <c>DescribeIpRestriction</c> operation to get the current rule map. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSIpRestrictionCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the IP rules.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSIpRestrictionCmdlet.Enabled"> <summary> <para> <para>A value that specifies whether IP rules are turned on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSIpRestrictionCmdlet.IpRestrictionRuleMap"> <summary> <para> <para>A map that describes the updated IP rules with CIDR ranges and descriptions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSIpRestrictionCmdlet.VpcEndpointIdRestrictionRuleMap"> <summary> <para> <para>A map of allowed VPC endpoint IDs and their corresponding rule descriptions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSIpRestrictionCmdlet.VpcIdRestrictionRuleMap"> <summary> <para> <para>A map of VPC IDs and their corresponding rules. When you configure this parameter, traffic from all VPC endpoints that are present in the specified VPC is allowed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSIpRestrictionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AwsAccountId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UpdateIpRestrictionResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateIpRestrictionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSIpRestrictionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSIpRestrictionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.UpdateQSKeyRegistrationCmdlet"> <summary> Updates a customer managed key in a Amazon QuickSight account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSKeyRegistrationCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the customer managed key registration that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSKeyRegistrationCmdlet.KeyRegistration"> <summary> <para> <para>A list of <c>RegisteredCustomerManagedKey</c> objects to be updated to the Amazon QuickSight account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSKeyRegistrationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UpdateKeyRegistrationResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateKeyRegistrationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSKeyRegistrationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSKeyRegistrationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.UpdateQSPublicSharingSettingCmdlet"> <summary> Use the <c>UpdatePublicSharingSettings</c> operation to turn on or turn off the public sharing settings of an Amazon QuickSight dashboard. <para> To use this operation, turn on session capacity pricing for your Amazon QuickSight account. </para><para> 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 <a href="https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html">Using Amazon QuickSight with IAM</a> in the <i>Amazon QuickSight User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSPublicSharingSettingCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID associated with your Amazon QuickSight subscription.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSPublicSharingSettingCmdlet.PublicSharingEnabled"> <summary> <para> <para>A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSPublicSharingSettingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UpdatePublicSharingSettingsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdatePublicSharingSettingsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSPublicSharingSettingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSPublicSharingSettingCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.UpdateQSQPersonalizationConfigurationCmdlet"> <summary> Updates a personalization configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSQPersonalizationConfigurationCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account account that contains the personalization configuration that the user wants to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSQPersonalizationConfigurationCmdlet.PersonalizationMode"> <summary> <para> <para>An option to allow Amazon QuickSight to customize data stories with user specific metadata, specifically location and job information, in your IAM Identity Center instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSQPersonalizationConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PersonalizationMode'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UpdateQPersonalizationConfigurationResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateQPersonalizationConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSQPersonalizationConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSQPersonalizationConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.UpdateQSRefreshScheduleCmdlet"> <summary> Updates a refresh schedule for a dataset. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSRefreshScheduleCmdlet.Schedule_Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the refresh schedule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSRefreshScheduleCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSRefreshScheduleCmdlet.DataSetId"> <summary> <para> <para>The ID of the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSRefreshScheduleCmdlet.RefreshOnDay_DayOfMonth"> <summary> <para> <para>The day of the month that you want to schedule refresh on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSRefreshScheduleCmdlet.RefreshOnDay_DayOfWeek"> <summary> <para> <para>The day of the week that you want to schedule a refresh on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSRefreshScheduleCmdlet.ScheduleFrequency_Interval"> <summary> <para> <para>The interval between scheduled refreshes. Valid values are as follows:</para><ul><li><para><c>MINUTE15</c>: The dataset refreshes every 15 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.</para></li><li><para><c>MINUTE30</c>:The dataset refreshes every 30 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.</para></li><li><para><c>HOURLY</c>: The dataset refreshes every hour. This interval can only be used for one schedule per dataset.</para></li><li><para><c>DAILY</c>: The dataset refreshes every day.</para></li><li><para><c>WEEKLY</c>: The dataset refreshes every week.</para></li><li><para><c>MONTHLY</c>: The dataset refreshes every month.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSRefreshScheduleCmdlet.Schedule_RefreshType"> <summary> <para> <para>The type of refresh that a datset undergoes. Valid values are as follows:</para><ul><li><para><c>FULL_REFRESH</c>: A complete refresh of a dataset.</para></li><li><para><c>INCREMENTAL_REFRESH</c>: A partial refresh of some rows of a dataset, based on the time window specified.</para></li></ul><para>For more information on full and incremental refreshes, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/refreshing-imported-data.html">Refreshing SPICE data</a> in the <i>Amazon QuickSight User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSRefreshScheduleCmdlet.Schedule_ScheduleId"> <summary> <para> <para>An identifier for the refresh schedule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSRefreshScheduleCmdlet.Schedule_StartAfterDateTime"> <summary> <para> <para>Time after which the refresh schedule can be started, expressed in <c>YYYY-MM-DDTHH:MM:SS</c> format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSRefreshScheduleCmdlet.ScheduleFrequency_TimeOfTheDay"> <summary> <para> <para>The time of day that you want the datset to refresh. This value is expressed in HH:MM format. This field is not required for schedules that refresh hourly.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSRefreshScheduleCmdlet.ScheduleFrequency_Timezone"> <summary> <para> <para>The timezone that you want the refresh schedule to use. The timezone ID must match a corresponding ID found on <c>java.util.time.getAvailableIDs()</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSRefreshScheduleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UpdateRefreshScheduleResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateRefreshScheduleResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSRefreshScheduleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Schedule_ScheduleId parameter. The -PassThru parameter is deprecated, use -Select '^Schedule_ScheduleId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSRefreshScheduleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.UpdateQSRoleCustomPermissionCmdlet"> <summary> Updates the custom permissions that are associated with a role. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSRoleCustomPermissionCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSRoleCustomPermissionCmdlet.CustomPermissionsName"> <summary> <para> <para>The name of the custom permission that you want to update the role with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSRoleCustomPermissionCmdlet.Namespace"> <summary> <para> <para>The namespace that contains the role that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSRoleCustomPermissionCmdlet.Role"> <summary> <para> <para>The name of role tht you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSRoleCustomPermissionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UpdateRoleCustomPermissionResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateRoleCustomPermissionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSRoleCustomPermissionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.UpdateQSSPICECapacityConfigurationCmdlet"> <summary> Updates the SPICE capacity configuration for a Amazon QuickSight account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSSPICECapacityConfigurationCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the SPICE configuration that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSSPICECapacityConfigurationCmdlet.PurchaseMode"> <summary> <para> <para>Determines how SPICE capacity can be purchased. The following options are available. </para><ul><li><para><c>MANUAL</c>: SPICE capacity can only be purchased manually.</para></li><li><para><c>AUTO_PURCHASE</c>: Extra SPICE capacity is automatically purchased on your behalf as needed. SPICE capacity can also be purchased manually with this option.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSSPICECapacityConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UpdateSPICECapacityConfigurationResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateSPICECapacityConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSSPICECapacityConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AwsAccountId parameter. The -PassThru parameter is deprecated, use -Select '^AwsAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSSPICECapacityConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateCmdlet"> <summary> Updates a template from an existing Amazon QuickSight analysis or another template. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateCmdlet.SourceAnalysis_Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateCmdlet.SourceTemplate_Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the template that you're updating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateCmdlet.PaperMargin_Bottom"> <summary> <para> <para>Define the bottom spacing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateCmdlet.Definition_CalculatedField"> <summary> <para> <para>An array of calculated field definitions for the template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateCmdlet.Definition_ColumnConfiguration"> <summary> <para> <para> An array of template-level column configurations. Column configurations are used to set default formatting for a column that's used throughout a template. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateCmdlet.Definition_DataSetConfiguration"> <summary> <para> <para>An array of dataset configurations. These configurations define the required columns for each dataset used within a template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateCmdlet.SourceAnalysis_DataSetReference"> <summary> <para> <para>A structure containing information about the dataset references used as placeholders in the template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateCmdlet.Definition_FilterGroup"> <summary> <para> <para>Filter definitions for a template.</para><para>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/filtering-visual-data.html">Filtering Data</a> in the <i>Amazon QuickSight User Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateCmdlet.PaperMargin_Left"> <summary> <para> <para>Define the left spacing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateCmdlet.ValidationStrategy_Mode"> <summary> <para> <para>The mode of validation for the asset to be created or updated. When you set this value to <c>STRICT</c>, strict validation for every error is enforced. When you set this value to <c>LENIENT</c>, validation is skipped for specific UI errors.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateCmdlet.Name"> <summary> <para> <para>The name for the template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateCmdlet.Definition_AnalysisDefaults_DefaultNewSheetConfiguration_InteractiveLayoutConfiguration_FreeForm_CanvasSizeOptions_ScreenCanvasSizeOptions_OptimizedViewPortWidth"> <summary> <para> <para>The width that the view port will be optimized for when the layout renders.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateCmdlet.Definition_AnalysisDefaults_DefaultNewSheetConfiguration_InteractiveLayoutConfiguration_Grid_CanvasSizeOptions_ScreenCanvasSizeOptions_OptimizedViewPortWidth"> <summary> <para> <para>The width that the view port will be optimized for when the layout renders.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateCmdlet.PaperCanvasSizeOptions_PaperOrientation"> <summary> <para> <para>The paper orientation that is used to define canvas dimensions. Choose one of the following options:</para><ul><li><para>PORTRAIT</para></li><li><para>LANDSCAPE</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateCmdlet.PaperCanvasSizeOptions_PaperSize"> <summary> <para> <para>The paper size that is used to define canvas dimensions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateCmdlet.Definition_ParameterDeclaration"> <summary> <para> <para>An array of parameter declarations for a template.</para><para><i>Parameters</i> are named variables that can transfer a value for use by an action or an object.</para><para>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html">Parameters in Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateCmdlet.QueryExecutionOptions_QueryExecutionMode"> <summary> <para> <para>A structure that describes the query execution mode.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateCmdlet.ScreenCanvasSizeOptions_ResizeOption"> <summary> <para> <para>This value determines the layout behavior when the viewport is resized.</para><ul><li><para><c>FIXED</c>: A fixed width will be used when optimizing the layout. In the Amazon QuickSight console, this option is called <c>Classic</c>.</para></li><li><para><c>RESPONSIVE</c>: The width of the canvas will be responsive and optimized to the view port. In the Amazon QuickSight console, this option is called <c>Tiled</c>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateCmdlet.PaperMargin_Right"> <summary> <para> <para>Define the right spacing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateCmdlet.DefaultNewSheetConfiguration_SheetContentType"> <summary> <para> <para>The option that determines the sheet content type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateCmdlet.Definition_Sheet"> <summary> <para> <para>An array of sheet definitions for a template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateCmdlet.TemplateId"> <summary> <para> <para>The ID for the template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateCmdlet.Options_Timezone"> <summary> <para> <para>Determines the timezone for the analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateCmdlet.PaperMargin_Top"> <summary> <para> <para>Define the top spacing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateCmdlet.VersionDescription"> <summary> <para> <para>A description of the current template version that is being updated. Every time you call <c>UpdateTemplate</c>, you create a new version of the template. Each version of the template maintains a description of the version in the <c>VersionDescription</c> field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateCmdlet.Options_WeekStart"> <summary> <para> <para>Determines the week start day for an analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UpdateTemplateResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateTemplateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TemplateId parameter. The -PassThru parameter is deprecated, use -Select '^TemplateId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateAliasCmdlet"> <summary> Updates the template alias of a template. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateAliasCmdlet.AliasName"> <summary> <para> <para>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 <c>$LATEST</c> in the <c>AliasName</c> parameter. The keyword <c>$PUBLISHED</c> doesn't apply to templates.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateAliasCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the template alias that you're updating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateAliasCmdlet.TemplateId"> <summary> <para> <para>The ID for the template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateAliasCmdlet.TemplateVersionNumber"> <summary> <para> <para>The version number of the template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateAliasCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TemplateAlias'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UpdateTemplateAliasResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateTemplateAliasResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateAliasCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AliasName parameter. The -PassThru parameter is deprecated, use -Select '^AliasName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplateAliasCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplatePermissionCmdlet"> <summary> Updates the resource permissions for a template. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplatePermissionCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplatePermissionCmdlet.GrantPermission"> <summary> <para> <para>A list of resource permissions to be granted on the template. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplatePermissionCmdlet.RevokePermission"> <summary> <para> <para>A list of resource permissions to be revoked from the template. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplatePermissionCmdlet.TemplateId"> <summary> <para> <para>The ID for the template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplatePermissionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UpdateTemplatePermissionsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateTemplatePermissionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplatePermissionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TemplateId parameter. The -PassThru parameter is deprecated, use -Select '^TemplateId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTemplatePermissionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeCmdlet"> <summary> Updates a theme. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeCmdlet.UIColorPalette_Accent"> <summary> <para> <para>This color is that applies to selected states and buttons.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeCmdlet.UIColorPalette_AccentForeground"> <summary> <para> <para>The foreground color that applies to any text or other elements that appear over the accent color.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the theme that you're updating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeCmdlet.BaseThemeId"> <summary> <para> <para>The theme ID, defined by Amazon QuickSight, that a custom theme inherits from. All themes initially inherit from a default Amazon QuickSight theme.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeCmdlet.DataColorPalette_Color"> <summary> <para> <para>The hexadecimal codes for the colors.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeCmdlet.UIColorPalette_Danger"> <summary> <para> <para>The color that applies to error messages.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeCmdlet.UIColorPalette_DangerForeground"> <summary> <para> <para>The foreground color that applies to any text or other elements that appear over the error color.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeCmdlet.UIColorPalette_Dimension"> <summary> <para> <para>The color that applies to the names of fields that are identified as dimensions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeCmdlet.UIColorPalette_DimensionForeground"> <summary> <para> <para>The foreground color that applies to any text or other elements that appear over the dimension color.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeCmdlet.DataColorPalette_EmptyFillColor"> <summary> <para> <para>The hexadecimal code of a color that applies to charts where a lack of data is highlighted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeCmdlet.Typography_FontFamily"> <summary> <para> <para>Determines the list of font families.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeCmdlet.UIColorPalette_Measure"> <summary> <para> <para>The color that applies to the names of fields that are identified as measures.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeCmdlet.UIColorPalette_MeasureForeground"> <summary> <para> <para>The foreground color that applies to any text or other elements that appear over the measure color.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeCmdlet.DataColorPalette_MinMaxGradient"> <summary> <para> <para>The minimum and maximum hexadecimal codes that describe a color gradient. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeCmdlet.Name"> <summary> <para> <para>The name for the theme.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeCmdlet.UIColorPalette_PrimaryBackground"> <summary> <para> <para>The background color that applies to visuals and other high emphasis UI.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeCmdlet.UIColorPalette_PrimaryForeground"> <summary> <para> <para>The color of text and other foreground elements that appear over the primary background regions, such as grid lines, borders, table banding, icons, and so on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeCmdlet.UIColorPalette_SecondaryBackground"> <summary> <para> <para>The background color that applies to the sheet background and sheet controls.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeCmdlet.UIColorPalette_SecondaryForeground"> <summary> <para> <para>The foreground color that applies to any sheet title, sheet control text, or UI that appears over the secondary background.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeCmdlet.Border_Show"> <summary> <para> <para>The option to enable display of borders for visuals.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeCmdlet.Gutter_Show"> <summary> <para> <para>This Boolean value controls whether to display a gutter space between sheet tiles. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeCmdlet.Margin_Show"> <summary> <para> <para>This Boolean value controls whether to display sheet margins.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeCmdlet.UIColorPalette_Success"> <summary> <para> <para>The color that applies to success messages, for example the check mark for a successful download.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeCmdlet.UIColorPalette_SuccessForeground"> <summary> <para> <para>The foreground color that applies to any text or other elements that appear over the success color.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeCmdlet.ThemeId"> <summary> <para> <para>The ID for the theme.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeCmdlet.VersionDescription"> <summary> <para> <para>A description of the theme version that you're updating Every time that you call <c>UpdateTheme</c>, you create a new version of the theme. Each version of the theme maintains a description of the version in <c>VersionDescription</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeCmdlet.UIColorPalette_Warning"> <summary> <para> <para>This color that applies to warning and informational messages.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeCmdlet.UIColorPalette_WarningForeground"> <summary> <para> <para>The foreground color that applies to any text or other elements that appear over the warning color.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UpdateThemeResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateThemeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ThemeId parameter. The -PassThru parameter is deprecated, use -Select '^ThemeId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeAliasCmdlet"> <summary> Updates an alias of a theme. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeAliasCmdlet.AliasName"> <summary> <para> <para>The name of the theme alias that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeAliasCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the theme alias that you're updating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeAliasCmdlet.ThemeId"> <summary> <para> <para>The ID for the theme.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeAliasCmdlet.ThemeVersionNumber"> <summary> <para> <para>The version number of the theme that the alias should reference.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeAliasCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ThemeAlias'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UpdateThemeAliasResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateThemeAliasResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeAliasCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ThemeId parameter. The -PassThru parameter is deprecated, use -Select '^ThemeId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemeAliasCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemePermissionCmdlet"> <summary> Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example <c>"quicksight:DescribeTheme"</c>. <para> Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions: </para><ul><li><para> User </para><ul><li><para><c>"quicksight:DescribeTheme"</c></para></li><li><para><c>"quicksight:DescribeThemeAlias"</c></para></li><li><para><c>"quicksight:ListThemeAliases"</c></para></li><li><para><c>"quicksight:ListThemeVersions"</c></para></li></ul></li><li><para> Owner </para><ul><li><para><c>"quicksight:DescribeTheme"</c></para></li><li><para><c>"quicksight:DescribeThemeAlias"</c></para></li><li><para><c>"quicksight:ListThemeAliases"</c></para></li><li><para><c>"quicksight:ListThemeVersions"</c></para></li><li><para><c>"quicksight:DeleteTheme"</c></para></li><li><para><c>"quicksight:UpdateTheme"</c></para></li><li><para><c>"quicksight:CreateThemeAlias"</c></para></li><li><para><c>"quicksight:DeleteThemeAlias"</c></para></li><li><para><c>"quicksight:UpdateThemeAlias"</c></para></li><li><para><c>"quicksight:UpdateThemePermissions"</c></para></li><li><para><c>"quicksight:DescribeThemePermissions"</c></para></li></ul></li><li><para> To specify no permissions, omit the permissions list. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemePermissionCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the theme.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemePermissionCmdlet.GrantPermission"> <summary> <para> <para>A list of resource permissions to be granted for the theme.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemePermissionCmdlet.RevokePermission"> <summary> <para> <para>A list of resource permissions to be revoked from the theme.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemePermissionCmdlet.ThemeId"> <summary> <para> <para>The ID for the theme.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemePermissionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UpdateThemePermissionsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateThemePermissionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemePermissionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ThemeId parameter. The -PassThru parameter is deprecated, use -Select '^ThemeId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSThemePermissionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.UpdateQSTopicCmdlet"> <summary> Updates a topic. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTopicCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the topic that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTopicCmdlet.Topic_DataSet"> <summary> <para> <para>The data sets that the topic is associated with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTopicCmdlet.Topic_Description"> <summary> <para> <para>The description of the topic.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTopicCmdlet.Topic_Name"> <summary> <para> <para>The name of the topic.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTopicCmdlet.ConfigOptions_QBusinessInsightsEnabled"> <summary> <para> <para>Enables Amazon Q Business Insights for a <c>Topic</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTopicCmdlet.TopicId"> <summary> <para> <para>The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTopicCmdlet.Topic_UserExperienceVersion"> <summary> <para> <para>The user experience version of a topic.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTopicCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UpdateTopicResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateTopicResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTopicCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TopicId parameter. The -PassThru parameter is deprecated, use -Select '^TopicId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTopicCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.UpdateQSTopicPermissionCmdlet"> <summary> Updates the permissions of a topic. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTopicPermissionCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the topic that you want to update the permissions for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTopicPermissionCmdlet.GrantPermission"> <summary> <para> <para>The resource permissions that you want to grant to the topic.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTopicPermissionCmdlet.RevokePermission"> <summary> <para> <para>The resource permissions that you want to revoke from the topic.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTopicPermissionCmdlet.TopicId"> <summary> <para> <para>The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTopicPermissionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UpdateTopicPermissionsResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateTopicPermissionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTopicPermissionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TopicId parameter. The -PassThru parameter is deprecated, use -Select '^TopicId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTopicPermissionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.UpdateQSTopicRefreshScheduleCmdlet"> <summary> Updates a topic refresh schedule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTopicRefreshScheduleCmdlet.AwsAccountId"> <summary> <para> <para>The ID of the Amazon Web Services account that contains the topic whose refresh schedule you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTopicRefreshScheduleCmdlet.RefreshSchedule_BasedOnSpiceSchedule"> <summary> <para> <para>A Boolean value that controls whether to schedule runs at the same schedule that is specified in SPICE dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTopicRefreshScheduleCmdlet.DatasetId"> <summary> <para> <para>The ID of the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTopicRefreshScheduleCmdlet.RefreshSchedule_IsEnabled"> <summary> <para> <para>A Boolean value that controls whether to schedule is enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTopicRefreshScheduleCmdlet.RefreshSchedule_RepeatAt"> <summary> <para> <para>The time of day when the refresh should run, for example, Monday-Sunday.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTopicRefreshScheduleCmdlet.RefreshSchedule_StartingAt"> <summary> <para> <para>The starting date and time for the refresh schedule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTopicRefreshScheduleCmdlet.RefreshSchedule_Timezone"> <summary> <para> <para>The timezone that you want the refresh schedule to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTopicRefreshScheduleCmdlet.TopicId"> <summary> <para> <para>The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTopicRefreshScheduleCmdlet.RefreshSchedule_TopicScheduleType"> <summary> <para> <para>The type of refresh schedule. Valid values for this structure are <c>HOURLY</c>, <c>DAILY</c>, <c>WEEKLY</c>, and <c>MONTHLY</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTopicRefreshScheduleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UpdateTopicRefreshScheduleResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateTopicRefreshScheduleResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTopicRefreshScheduleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TopicId parameter. The -PassThru parameter is deprecated, use -Select '^TopicId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSTopicRefreshScheduleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.UpdateQSUserCmdlet"> <summary> Updates an Amazon QuickSight user. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSUserCmdlet.AwsAccountId"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSUserCmdlet.CustomFederationProviderUrl"> <summary> <para> <para>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 <c>ExternalLoginFederationProviderType</c> parameter is set to <c>CUSTOM_OIDC</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSUserCmdlet.CustomPermissionsName"> <summary> <para> <para>(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:</para><ul><li><para>Create and update data sources</para></li><li><para>Create and update datasets</para></li><li><para>Create and update email reports</para></li><li><para>Subscribe to email reports</para></li></ul><para>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 <c>RegisterUser</c> API operation to assign the named set of permissions to a Amazon QuickSight user. </para><para>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).</para><para>This feature is available only to Amazon QuickSight Enterprise edition subscriptions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSUserCmdlet.Email"> <summary> <para> <para>The email address of the user that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSUserCmdlet.ExternalLoginFederationProviderType"> <summary> <para> <para>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.</para><ul><li><para><c>COGNITO</c>: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the <c>COGNITO</c> provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.</para></li><li><para><c>CUSTOM_OIDC</c>: Custom OpenID Connect (OIDC) provider. When choosing <c>CUSTOM_OIDC</c> type, use the <c>CustomFederationProviderUrl</c> parameter to provide the custom OIDC provider URL.</para></li><li><para><c>NONE</c>: This clears all the previously saved external login information for a user. Use the <c><a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeUser.html">DescribeUser</a></c> API operation to check the external login information.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSUserCmdlet.ExternalLoginId"> <summary> <para> <para>The identity ID for a user in the external login provider.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSUserCmdlet.Namespace"> <summary> <para> <para>The namespace. Currently, you should set this to <c>default</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSUserCmdlet.Role"> <summary> <para> <para>The Amazon QuickSight role of the user. The role can be one of the following default security cohorts:</para><ul><li><para><c>READER</c>: A user who has read-only access to dashboards.</para></li><li><para><c>AUTHOR</c>: A user who can create data sources, datasets, analyses, and dashboards.</para></li><li><para><c>ADMIN</c>: A user who is an author, who can also manage Amazon QuickSight settings.</para></li><li><para><c>READER_PRO</c>: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards.</para></li><li><para><c>AUTHOR_PRO</c>: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.</para></li><li><para><c>ADMIN_PRO</c>: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.</para></li></ul><para>The name of the Amazon QuickSight role is invisible to the user except for the console screens dealing with permissions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSUserCmdlet.UnapplyCustomPermission"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSUserCmdlet.UserName"> <summary> <para> <para>The Amazon QuickSight user name that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSUserCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'User'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UpdateUserResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateUserResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSUserCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UserName parameter. The -PassThru parameter is deprecated, use -Select '^UserName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSUserCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.UpdateQSVPCConnectionCmdlet"> <summary> Updates a VPC connection. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSVPCConnectionCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID of the account that contains the VPC connection that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSVPCConnectionCmdlet.DnsResolver"> <summary> <para> <para>A list of IP addresses of DNS resolver endpoints for the VPC connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSVPCConnectionCmdlet.Name"> <summary> <para> <para>The display name for the VPC connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSVPCConnectionCmdlet.RoleArn"> <summary> <para> <para>An IAM role associated with the VPC connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSVPCConnectionCmdlet.SecurityGroupId"> <summary> <para> <para>A list of security group IDs for the VPC connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSVPCConnectionCmdlet.SubnetId"> <summary> <para> <para>A list of subnet IDs for the VPC connection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSVPCConnectionCmdlet.VPCConnectionId"> <summary> <para> <para>The ID of the VPC connection that you're updating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSVPCConnectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.UpdateVPCConnectionResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateVPCConnectionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSVPCConnectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the VPCConnectionId parameter. The -PassThru parameter is deprecated, use -Select '^VPCConnectionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSVPCConnectionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.WriteQSDataSetRefreshPropertyCmdlet"> <summary> Creates or updates the dataset refresh properties for the dataset. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.WriteQSDataSetRefreshPropertyCmdlet.AwsAccountId"> <summary> <para> <para>The Amazon Web Services account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.WriteQSDataSetRefreshPropertyCmdlet.LookbackWindow_ColumnName"> <summary> <para> <para>The name of the lookback window column.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.WriteQSDataSetRefreshPropertyCmdlet.DataSetId"> <summary> <para> <para>The ID of the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.WriteQSDataSetRefreshPropertyCmdlet.LookbackWindow_Size"> <summary> <para> <para>The lookback window column size.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.WriteQSDataSetRefreshPropertyCmdlet.LookbackWindow_SizeUnit"> <summary> <para> <para>The size unit that is used for the lookback window column. Valid values for this structure are <c>HOUR</c>, <c>DAY</c>, and <c>WEEK</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.WriteQSDataSetRefreshPropertyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.PutDataSetRefreshPropertiesResponse). Specifying the name of a property of type Amazon.QuickSight.Model.PutDataSetRefreshPropertiesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.WriteQSDataSetRefreshPropertyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DataSetId parameter. The -PassThru parameter is deprecated, use -Select '^DataSetId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.WriteQSDataSetRefreshPropertyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |