AWS cli documentation change
Summary
Updated documentation to use 'Amazon Quick Sight' product name consistently instead of 'QuickSight' and updated CLI version reference
Security assessment
Changes are primarily branding updates (product name standardization) and version number updates. No new security controls, vulnerabilities, or security-related procedures were added/modified. Existing security context about IAM Identity Center sessions and permissions remains unchanged.
Diff
diff --git a/cli/latest/reference/quicksight/generate-embed-url-for-registered-user-with-identity.md b/cli/latest/reference/quicksight/generate-embed-url-for-registered-user-with-identity.md index 0dba6218b..2892110cb 100644 --- a//cli/latest/reference/quicksight/generate-embed-url-for-registered-user-with-identity.md +++ b//cli/latest/reference/quicksight/generate-embed-url-for-registered-user-with-identity.md @@ -15 +15 @@ - * [AWS CLI 2.31.10 Command Reference](../../index.html) » + * [AWS CLI 2.31.13 Command Reference](../../index.html) » @@ -59 +59 @@ First time using the AWS CLI? See the [User Guide](https://docs.aws.amazon.com/c -Generates an embed URL that you can use to embed an QuickSight experience in your website. This action can be used for any type of user that is registered in an QuickSight account that uses IAM Identity Center for authentication. This API requires [identity-enhanced IAM Role sessions](https://docs.aws.amazon.com/singlesignon/latest/userguide/trustedidentitypropagation-overview.html#types-identity-enhanced-iam-role-sessions) for the authenticated user that the API call is being made for. +Generates an embed URL that you can use to embed an Amazon Quick Sight experience in your website. This action can be used for any type of user that is registered in an Amazon Quick Sight account that uses IAM Identity Center for authentication. This API requires [identity-enhanced IAM Role sessions](https://docs.aws.amazon.com/singlesignon/latest/userguide/trustedidentitypropagation-overview.html#types-identity-enhanced-iam-role-sessions) for the authenticated user that the API call is being made for. @@ -61 +61 @@ Generates an embed URL that you can use to embed an QuickSight experience in you -This API uses [trusted identity propagation](https://docs.aws.amazon.com/singlesignon/latest/userguide/trustedidentitypropagation.html) to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have [trusted Identity Propagation enabled for QuickSight](https://docs.aws.amazon.com/singlesignon/latest/userguide/trustedidentitypropagation-using-customermanagedapps-specify-trusted-apps.html) with the scope value set to `quicksight:read` . Before you use this action, make sure that you have configured the relevant QuickSight resource and permissions. +This API uses [trusted identity propagation](https://docs.aws.amazon.com/singlesignon/latest/userguide/trustedidentitypropagation.html) to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have [trusted Identity Propagation enabled for Amazon Quick Sight](https://docs.aws.amazon.com/singlesignon/latest/userguide/trustedidentitypropagation-using-customermanagedapps-specify-trusted-apps.html) with the scope value set to `quicksight:read` . Before you use this action, make sure that you have configured the relevant Amazon Quick Sight resource and permissions. @@ -122 +122 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/quicks -> The type of experience you want to embed. For registered users, you can embed QuickSight dashboards or the QuickSight console. +> The type of experience you want to embed. For registered users, you can embed QuickSight dashboards or the Amazon Quick Sight console. @@ -134 +134 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/quicks ->>> 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, QuickSight renders this dashboard if the user has permissions to view it. +>>> The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon Quick Sight renders this dashboard if the user has permissions to view it. @@ -148 +148 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/quicks ->>> The feature configurations of an embbedded QuickSight dashboard. +>>> The feature configurations of an embbedded Amazon Quick Sight dashboard. @@ -168 +168 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/quicks ->>>> The bookmarks configuration for an embedded dashboard in QuickSight. +>>>> The bookmarks configuration for an embedded dashboard in Amazon Quick Sight. @@ -176 +176 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/quicks ->>>> The Amazon Q configurations of an embedded QuickSight dashboard. +>>>> The Amazon Q configurations of an embedded Amazon Quick Sight dashboard. @@ -212 +212 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/quicks ->> The configuration details for providing each QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see [Customizing Access to the QuickSight Console](https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html) in the _Amazon QuickSight User Guide_ . +>> The configuration details for providing each Amazon Quick Sight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see [Customizing Access to the Amazon Quick Sight Console](https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html) in the _Amazon QuickSight User Guide_ . @@ -214 +214 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/quicks ->> Use `` [GenerateEmbedUrlForRegisteredUser](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForRegisteredUser.html) `` where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who accesses an embedded QuickSight console needs to belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the `` [UpdateUser](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html) `` API operation. Use the `` [RegisterUser](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RegisterUser.html) `` API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the _Amazon QuickSight User Guide_ : +>> Use `` [GenerateEmbedUrlForRegisteredUser](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForRegisteredUser.html) `` where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who accesses an embedded Amazon Quick Sight console needs to belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the `` [UpdateUser](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html) `` API operation. Use the `` [RegisterUser](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RegisterUser.html) `` API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the _Amazon QuickSight User Guide_ : @@ -216 +216 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/quicks ->> * [Embedding the Full Functionality of the QuickSight Console for Authenticated Users](https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics-full-console-for-authenticated-users.html) +>> * [Embedding the Full Functionality of the Amazon Quick Sight Console for Authenticated Users](https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics-full-console-for-authenticated-users.html) @@ -225 +225 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/quicks ->>> The initial URL path for the QuickSight console. `InitialPath` is required. +>>> The initial URL path for the Amazon Quick Sight console. `InitialPath` is required. @@ -233,2 +233,2 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/quicks ->>> * `/dashboards/DashboardId` . _DashboardId_ is the actual ID key from the QuickSight console URL of the dashboard. ->>> * `/analyses/AnalysisId` . _AnalysisId_ is the actual ID key from the QuickSight console URL of the analysis. +>>> * `/dashboards/DashboardId` . _DashboardId_ is the actual ID key from the Amazon Quick Sight console URL of the dashboard. +>>> * `/analyses/AnalysisId` . _AnalysisId_ is the actual ID key from the Amazon Quick Sight console URL of the analysis. @@ -247 +247 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/quicks ->>> The embedding configuration of an embedded QuickSight console. +>>> The embedding configuration of an embedded Amazon Quick Sight console. @@ -251 +251 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/quicks ->>>> The state persistence configurations of an embedded QuickSight console. +>>>> The state persistence configurations of an embedded Amazon Quick Sight console. @@ -267 +267 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/quicks ->>>> The Amazon Q configurations of an embedded QuickSight console. +>>>> The Amazon Q configurations of an embedded Amazon Quick Sight console. @@ -329 +329 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/quicks ->> For more information about embedding the Q search bar, see [Embedding Overview](https://docs.aws.amazon.com/quicksight/latest/user/embedding-overview.html) in the _QuickSight User Guide_ . +>> For more information about embedding the Q search bar, see [Embedding Overview](https://docs.aws.amazon.com/quicksight/latest/user/embedding-overview.html) in the _Amazon Quick Sight User Guide_ . @@ -347 +347 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/quicks ->> The type of embedding experience. In this case, QuickSight visuals. +>> The type of embedding experience. In this case, Amazon Quick Sight visuals. @@ -351 +351 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/quicks ->>> The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When the URL in response is accessed, QuickSight renders this visual. +>>> The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When the URL in response is accessed, Amazon Quick Sight renders this visual. @@ -381 +381 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/quicks ->>>> The ID of the visual that you want to embed. The `VisualID` can be found in the `IDs for developers` section of the `Embed visual` pane of the visual’s on-visual menu of the QuickSight console. +>>>> The ID of the visual that you want to embed. The `VisualID` can be found in the `IDs for developers` section of the `Embed visual` pane of the visual’s on-visual menu of the Amazon Quick Sight console. @@ -395 +395 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/quicks ->> For more information about embedding the Generative Q&A experience, see [Embedding Overview](https://docs.aws.amazon.com/quicksight/latest/user/embedding-overview.html) in the _QuickSight User Guide_ . +>> For more information about embedding the Generative Q&A experience, see [Embedding Overview](https://docs.aws.amazon.com/quicksight/latest/user/embedding-overview.html) in the _Amazon Quick Sight User Guide_ . @@ -626 +626 @@ RequestId -> (string) - * [AWS CLI 2.31.10 Command Reference](../../index.html) » + * [AWS CLI 2.31.13 Command Reference](../../index.html) »