AWS.Tools.QuickSight.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.QuickSight</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardEmbedUrlCmdlet"> <summary> Generates a server-side embeddable URL and authorization code. Before this can work properly, first you need to configure the dashboards and user permissions. For more information, see <a href="https://docs.aws.amazon.com/en_us/quicksight/latest/user/embedding.html"> Embedding Amazon QuickSight Dashboards</a>. <para> Currently, you can use <code>GetDashboardEmbedURL</code> only from the server, not from the user’s browser. </para><para><b>CLI Sample:</b></para><para> Assume the role with permissions enabled for actions: <code>quickSight:RegisterUser</code> and <code>quicksight:GetDashboardEmbedURL</code>. You can use assume-role, assume-role-with-web-identity, or assume-role-with-saml. </para><para><code>aws sts assume-role --role-arn "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role" --role-session-name embeddingsession</code></para><para> If the user does not exist in QuickSight, register the user: </para><para><code>aws quicksight register-user --aws-account-id 111122223333 --namespace default --identity-type IAM --iam-arn "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role" --user-role READER --session-name "embeddingsession" --email user123@example.com --region us-east-1</code></para><para> Get the URL for the embedded dashboard </para><para><code>aws quicksight get-dashboard-embed-url --aws-account-id 111122223333 --dashboard-id 1a1ac2b2-3fc3-4b44-5e5d-c6db6778df89 --identity-type IAM</code></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardEmbedUrlCmdlet.AwsAccountId"> <summary> <para> <para>AWS account ID that contains the dashboard you are 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 IAM policy</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardEmbedUrlCmdlet.IdentityType"> <summary> <para> <para>The authentication method the user uses to sign in (IAM only).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardEmbedUrlCmdlet.ResetDisabled"> <summary> <para> <para>Remove the reset button on embedded dashboard. The default is FALSE, which allows 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 between 15 and 600 minutes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSDashboardEmbedUrlCmdlet.UndoRedoDisabled"> <summary> <para> <para>Remove the undo/redo button on 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 ARN, for use with <code>QUICKSIGHT</code> identity type. You can use this for any of the following:</para><ul><li><para>Amazon QuickSight users in your account (readers, authors, or admins)</para></li><li><para>AD users</para></li><li><para>Invited non-federated users</para></li><li><para>Federated IAM users</para></li><li><para>Federated IAM role-based sessions</para></li></ul> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSGroupCmdlet"> <summary> Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN). <para> The permissions resource is <code>arn:aws:quicksight:us-east-1:<i><relevant-aws-account-id></i>:group/default/<i><group-name></i></code>. </para><para> The response is the group object. </para><para><b>CLI Sample:</b></para><para><code>aws quicksight describe-group -\-aws-account-id=11112222333 -\-namespace=default -\-group-name=Sales </code></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSGroupCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the AWS account that the group is in. Currently, you use the ID for the AWS 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. Currently, you should set this to <code>default</code>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSGroupListCmdlet"> <summary> Lists all user groups in Amazon QuickSight. <para> The permissions resource is <code>arn:aws:quicksight:us-east-1:<i><aws-account-id></i>:group/default/*</code>. </para><para> The response is a list of group objects. </para><para><b>CLI Sample:</b></para><para><code>aws quicksight list-groups -\-aws-account-id=111122223333 -\-namespace=default </code></para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSGroupListCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the AWS account that the group is in. Currently, you use the ID for the AWS 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. Currently, you should set this to <code>default</code>.</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> </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/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSGroupMembershipListCmdlet"> <summary> Lists member users in a group. <para> The permissions resource is <code>arn:aws:quicksight:us-east-1:<i><aws-account-id></i>:group/default/<i><group-name></i></code>. </para><para> The response is a list of group member objects. </para><para><b>CLI Sample:</b></para><para><code>aws quicksight list-group-memberships -\-aws-account-id=111122223333 -\-namespace=default </code></para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSGroupMembershipListCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the AWS account that the group is in. Currently, you use the ID for the AWS 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. Currently, you should set this to <code>default</code>.</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> </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/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.GetQSUserCmdlet"> <summary> Returns information about a user, given the user name. <para> The permission resource is <code>arn:aws:quicksight:us-east-1:<i><aws-account-id></i>:user/default/<i><user-name></i></code>. </para><para> The response is a user object that contains the user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address. </para><para><b>CLI Sample:</b></para><para><code>aws quicksight describe-user --aws-account-id=111122223333 --namespace=default --user-name=Pat </code></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSUserCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the AWS account that the user is in. Currently, you use the ID for the AWS 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 <code>default</code>.</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="T:Amazon.PowerShell.Cmdlets.QS.GetQSUserGroupListCmdlet"> <summary> Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of. <para> The permission resource is <code>arn:aws:quicksight:us-east-1:<i><aws-account-id></i>:user/default/<i><user-name></i></code>. </para><para> The response is a one or more group objects. </para><para><b>CLI Sample:</b></para><para><code>aws quicksight list-user-groups -\-user-name=Pat -\-aws-account-id=111122223333 -\-namespace=default -\-region=us-east-1 </code></para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSUserGroupListCmdlet.AwsAccountId"> <summary> <para> <para>The AWS Account ID that the user is in. Currently, you use the ID for the AWS 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 <code>default</code>.</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> </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/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </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. <para> The permission resource is <code>arn:aws:quicksight:us-east-1:<i><aws-account-id></i>:user/default/<i>*</i></code>. </para><para> The response is a list of user objects, containing each user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address. </para><para><b>CLI Sample:</b></para><para><code>aws quicksight list-users --aws-account-id=111122223333 --namespace=default </code></para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.GetQSUserListCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the AWS account that the user is in. Currently, you use the ID for the AWS 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 <code>default</code>.</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> </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/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.QS.NewQSGroupCmdlet"> <summary> Creates an Amazon QuickSight group. <para> The permissions resource is <code>arn:aws:quicksight:us-east-1:<i><relevant-aws-account-id></i>:group/default/<i><group-name></i></code>. </para><para> The response is a group object. </para><para><b>CLI Sample:</b></para><para><code>aws quicksight create-group --aws-account-id=111122223333 --namespace=default --group-name="Sales-Management" --description="Sales Management - Forecasting" </code></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSGroupCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the AWS account that the group is in. Currently, you use the ID for the AWS 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. Currently, you should set this to <code>default</code>.</para> </para> </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. <para> The permissions resource is <code>arn:aws:quicksight:us-east-1:<i><aws-account-id></i>:group/default/<i><group-name></i></code>. </para><para> The condition resource is the user name. </para><para> The condition key is <code>quicksight:UserName</code>. </para><para> The response is the group member object. </para><para><b>CLI Sample:</b></para><para><code>aws quicksight create-group-membership --aws-account-id=111122223333 --namespace=default --group-name=Sales --member-name=Pat </code></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.NewQSGroupMembershipCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the AWS account that the group is in. Currently, you use the ID for the AWS 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. Currently, you should set this to <code>default</code>.</para> </para> </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.RegisterQSUserCmdlet"> <summary> Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request. <para> The permission resource is <code>arn:aws:quicksight:us-east-1:<i><aws-account-id></i>:user/default/<i><user-name></i></code>. </para><para> The condition resource is the Amazon Resource Name (ARN) for the IAM user or role, and the session name. </para><para> The condition keys are <code>quicksight:IamArn</code> and <code>quicksight:SessionName</code>. </para><para><b>CLI Sample:</b></para><para><code>aws quicksight register-user -\-aws-account-id=111122223333 -\-namespace=default -\-email=pat@example.com -\-identity-type=IAM -\-user-role=AUTHOR -\-iam-arn=arn:aws:iam::111122223333:user/Pat </code></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RegisterQSUserCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.</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.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>Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:</para><ul><li><para><code>IAM</code>: A user whose identity maps to an existing IAM user or role. </para></li><li><para><code>QUICKSIGHT</code>: A user whose identity is owned and managed internally by Amazon QuickSight. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RegisterQSUserCmdlet.Namespace"> <summary> <para> <para>The namespace. Currently, you should set this to <code>default</code>.</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"><code>assume-role</code></a> in the <i>AWS CLI Reference.</i></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 of the user. The user role can be one of the following:</para><ul><li><para><code>READER</code>: A user who has read-only access to dashboards.</para></li><li><para><code>AUTHOR</code>: A user who can create data sources, data sets, analyses, and dashboards.</para></li><li><para><code>ADMIN</code>: A user who is an author, who can also manage Amazon QuickSight settings.</para></li></ul> </para> </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.RemoveQSGroupCmdlet"> <summary> Removes a user group from Amazon QuickSight. <para> The permissions resource is <code>arn:aws:quicksight:us-east-1:<i><aws-account-id></i>:group/default/<i><group-name></i></code>. </para><para><b>CLI Sample:</b></para><para><code>aws quicksight delete-group -\-aws-account-id=111122223333 -\-namespace=default -\-group-name=Sales-Management </code></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSGroupCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the AWS account that the group is in. Currently, you use the ID for the AWS 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. Currently, you should set this to <code>default</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSGroupCmdlet.PassThru"> <summary> Returns the value passed to the GroupName parameter. By default, this cmdlet does not generate any output. </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. <para> The permissions resource is <code>arn:aws:quicksight:us-east-1:<i><aws-account-id></i>:group/default/<i><group-name></i></code>. </para><para> The condition resource is the user name. </para><para> The condition key is <code>quicksight:UserName</code>. </para><para><b>CLI Sample:</b></para><para><code>aws quicksight delete-group-membership --aws-account-id=111122223333 --namespace=default --group-name=Sales-Management --member-name=Charlie </code></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSGroupMembershipCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the AWS account that the group is in. Currently, you use the ID for the AWS 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. Currently, you should set this to <code>default</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSGroupMembershipCmdlet.PassThru"> <summary> Returns the value passed to the MemberName parameter. By default, this cmdlet does not generate any output. </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.RemoveQSUserCmdlet"> <summary> Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call. <para> The permission resource is <code>arn:aws:quicksight:us-east-1:<i><aws-account-id></i>:user/default/<i><user-name> </i></code>. </para><para><b>CLI Sample:</b></para><para><code>aws quicksight delete-user --aws-account-id=111122223333 --namespace=default --user-name=Pat </code></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSUserCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the AWS account that the user is in. Currently, you use the ID for the AWS 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 <code>default</code>.</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.PassThru"> <summary> Returns the value passed to the UserName parameter. By default, this cmdlet does not generate any output. </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. <para> The permission resource is <code>arn:aws:quicksight:us-east-1:<i><aws-account-id></i>:user/default/<i><user-name> </i></code>. </para><para><b>CLI Sample:</b></para><para><code>aws quicksight delete-user-by-principal-id --aws-account-id=111122223333 --namespace=default --principal-id=ABCDEFJA26JLI7EUUOEHS </code></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.RemoveQSUserByPrincipalIdCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the AWS account that the user is in. Currently, you use the ID for the AWS 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 <code>default</code>.</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.PassThru"> <summary> Returns the value passed to the PrincipalId parameter. By default, this cmdlet does not generate any output. </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.UpdateQSGroupCmdlet"> <summary> Changes a group description. <para> The permissions resource is <code>arn:aws:quicksight:us-east-1:<i><aws-account-id></i>:group/default/<i><group-name></i></code>. </para><para> The response is a group object. </para><para><b>CLI Sample:</b></para><para><code>aws quicksight update-group --aws-account-id=111122223333 --namespace=default --group-name=Sales --description="Sales BI Dashboards" </code></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSGroupCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the AWS account that the group is in. Currently, you use the ID for the AWS 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. Currently, you should set this to <code>default</code>.</para> </para> </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.UpdateQSUserCmdlet"> <summary> Updates an Amazon QuickSight user. <para> The permission resource is <code>arn:aws:quicksight:us-east-1:<i><aws-account-id></i>:user/default/<i><user-name></i></code>. </para><para> The response is a user object that contains the user's Amazon QuickSight user name, email address, active or inactive status in Amazon QuickSight, Amazon QuickSight role, and Amazon Resource Name (ARN). </para><para><b>CLI Sample:</b></para><para><code>aws quicksight update-user --user-name=Pat --role=ADMIN --email=new_address@amazon.com --aws-account-id=111122223333 --namespace=default --region=us-east-1 </code></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSUserCmdlet.AwsAccountId"> <summary> <para> <para>The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.</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.Namespace"> <summary> <para> <para>The namespace. Currently, you should set this to <code>default</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.QS.UpdateQSUserCmdlet.Role"> <summary> <para> <para>The Amazon QuickSight role of the user. The user role can be one of the following:</para><ul><li><para><code>READER</code>: A user who has read-only access to dashboards.</para></li><li><para><code>AUTHOR</code>: A user who can create data sources, data sets, analyses, and dashboards.</para></li><li><para><code>ADMIN</code>: A user who is an author, who can also manage Amazon QuickSight settings.</para></li></ul> </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.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> |