Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data RegisteredUserDashboardVisualEmbeddingConfiguration = RegisteredUserDashboardVisualEmbeddingConfiguration' {}
- newRegisteredUserDashboardVisualEmbeddingConfiguration :: DashboardVisualId -> RegisteredUserDashboardVisualEmbeddingConfiguration
- registeredUserDashboardVisualEmbeddingConfiguration_initialDashboardVisualId :: Lens' RegisteredUserDashboardVisualEmbeddingConfiguration DashboardVisualId
Documentation
data RegisteredUserDashboardVisualEmbeddingConfiguration Source #
The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.
See: newRegisteredUserDashboardVisualEmbeddingConfiguration
smart constructor.
RegisteredUserDashboardVisualEmbeddingConfiguration' | |
|
Instances
newRegisteredUserDashboardVisualEmbeddingConfiguration Source #
:: DashboardVisualId |
|
-> RegisteredUserDashboardVisualEmbeddingConfiguration |
Create a value of RegisteredUserDashboardVisualEmbeddingConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:initialDashboardVisualId:RegisteredUserDashboardVisualEmbeddingConfiguration'
, registeredUserDashboardVisualEmbeddingConfiguration_initialDashboardVisualId
- 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
QuickSight renders this visual.
The Amazon Resource Name (ARN) of the dashboard that the visual belongs
to must be included in the AuthorizedResourceArns
parameter.
Otherwise, the request will fail with InvalidParameterValueException
.
registeredUserDashboardVisualEmbeddingConfiguration_initialDashboardVisualId :: Lens' RegisteredUserDashboardVisualEmbeddingConfiguration DashboardVisualId Source #
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 QuickSight renders this visual.
The Amazon Resource Name (ARN) of the dashboard that the visual belongs
to must be included in the AuthorizedResourceArns
parameter.
Otherwise, the request will fail with InvalidParameterValueException
.