| 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 |
Amazonka.QuickSight.GenerateEmbedUrlForAnonymousUser
Description
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.
The following rules apply to the generated URL:
- 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.
- The URL validity period should not be confused with the actual
session lifetime that can be customized using the
- You are charged only when the URL is used or there is interaction with Amazon QuickSight.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
Synopsis
- data GenerateEmbedUrlForAnonymousUser = GenerateEmbedUrlForAnonymousUser' {}
- newGenerateEmbedUrlForAnonymousUser :: Text -> Text -> AnonymousUserEmbeddingExperienceConfiguration -> GenerateEmbedUrlForAnonymousUser
- generateEmbedUrlForAnonymousUser_allowedDomains :: Lens' GenerateEmbedUrlForAnonymousUser (Maybe [Text])
- generateEmbedUrlForAnonymousUser_sessionLifetimeInMinutes :: Lens' GenerateEmbedUrlForAnonymousUser (Maybe Natural)
- generateEmbedUrlForAnonymousUser_sessionTags :: Lens' GenerateEmbedUrlForAnonymousUser (Maybe (NonEmpty SessionTag))
- generateEmbedUrlForAnonymousUser_awsAccountId :: Lens' GenerateEmbedUrlForAnonymousUser Text
- generateEmbedUrlForAnonymousUser_namespace :: Lens' GenerateEmbedUrlForAnonymousUser Text
- generateEmbedUrlForAnonymousUser_authorizedResourceArns :: Lens' GenerateEmbedUrlForAnonymousUser [Text]
- generateEmbedUrlForAnonymousUser_experienceConfiguration :: Lens' GenerateEmbedUrlForAnonymousUser AnonymousUserEmbeddingExperienceConfiguration
- data GenerateEmbedUrlForAnonymousUserResponse = GenerateEmbedUrlForAnonymousUserResponse' {}
- newGenerateEmbedUrlForAnonymousUserResponse :: Int -> Text -> Text -> Text -> GenerateEmbedUrlForAnonymousUserResponse
- generateEmbedUrlForAnonymousUserResponse_status :: Lens' GenerateEmbedUrlForAnonymousUserResponse Int
- generateEmbedUrlForAnonymousUserResponse_embedUrl :: Lens' GenerateEmbedUrlForAnonymousUserResponse Text
- generateEmbedUrlForAnonymousUserResponse_requestId :: Lens' GenerateEmbedUrlForAnonymousUserResponse Text
- generateEmbedUrlForAnonymousUserResponse_anonymousUserArn :: Lens' GenerateEmbedUrlForAnonymousUserResponse Text
Creating a Request
data GenerateEmbedUrlForAnonymousUser Source #
See: newGenerateEmbedUrlForAnonymousUser smart constructor.
Constructors
| GenerateEmbedUrlForAnonymousUser' | |
Fields
| |
Instances
newGenerateEmbedUrlForAnonymousUser Source #
Arguments
| :: Text | |
| -> Text | |
| -> AnonymousUserEmbeddingExperienceConfiguration |
|
| -> GenerateEmbedUrlForAnonymousUser |
Create a value of GenerateEmbedUrlForAnonymousUser 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:allowedDomains:GenerateEmbedUrlForAnonymousUser', generateEmbedUrlForAnonymousUser_allowedDomains - 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.
To include all subdomains under a specific domain to the allow list, use
*. For example, https://*.sapp.amazon.com includes all subdomains
under https://sapp.amazon.com.
$sel:sessionLifetimeInMinutes:GenerateEmbedUrlForAnonymousUser', generateEmbedUrlForAnonymousUser_sessionLifetimeInMinutes - How many minutes the session is valid. The session lifetime must be in
[15-600] minutes range.
$sel:sessionTags:GenerateEmbedUrlForAnonymousUser', generateEmbedUrlForAnonymousUser_sessionTags - The session tags used for row-level security. Before you use this
parameter, make sure that you have configured the relevant datasets
using the DataSet$RowLevelPermissionTagConfiguration parameter so that
session tags can be used to provide row-level security.
These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.
GenerateEmbedUrlForAnonymousUser, generateEmbedUrlForAnonymousUser_awsAccountId - The ID for the Amazon Web Services account that contains the dashboard
that you're embedding.
GenerateEmbedUrlForAnonymousUser, generateEmbedUrlForAnonymousUser_namespace - The Amazon QuickSight namespace that the anonymous user virtually
belongs to. If you are not using an Amazon QuickSight custom namespace,
set this to default.
$sel:authorizedResourceArns:GenerateEmbedUrlForAnonymousUser', generateEmbedUrlForAnonymousUser_authorizedResourceArns - The Amazon Resource Names (ARNs) for the Amazon QuickSight resources
that the user is authorized to access during the lifetime of the
session. If you choose Dashboard embedding experience, pass the list
of dashboard ARNs in the account that you want the user to be able to
view. Currently, you can pass up to 25 dashboard ARNs in each API call.
$sel:experienceConfiguration:GenerateEmbedUrlForAnonymousUser', generateEmbedUrlForAnonymousUser_experienceConfiguration - The configuration of the experience that you are embedding.
Request Lenses
generateEmbedUrlForAnonymousUser_allowedDomains :: Lens' GenerateEmbedUrlForAnonymousUser (Maybe [Text]) Source #
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.
To include all subdomains under a specific domain to the allow list, use
*. For example, https://*.sapp.amazon.com includes all subdomains
under https://sapp.amazon.com.
generateEmbedUrlForAnonymousUser_sessionLifetimeInMinutes :: Lens' GenerateEmbedUrlForAnonymousUser (Maybe Natural) Source #
How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.
generateEmbedUrlForAnonymousUser_sessionTags :: Lens' GenerateEmbedUrlForAnonymousUser (Maybe (NonEmpty SessionTag)) Source #
The session tags used for row-level security. Before you use this
parameter, make sure that you have configured the relevant datasets
using the DataSet$RowLevelPermissionTagConfiguration parameter so that
session tags can be used to provide row-level security.
These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.
generateEmbedUrlForAnonymousUser_awsAccountId :: Lens' GenerateEmbedUrlForAnonymousUser Text Source #
The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
generateEmbedUrlForAnonymousUser_namespace :: Lens' GenerateEmbedUrlForAnonymousUser Text Source #
The Amazon QuickSight namespace that the anonymous user virtually
belongs to. If you are not using an Amazon QuickSight custom namespace,
set this to default.
generateEmbedUrlForAnonymousUser_authorizedResourceArns :: Lens' GenerateEmbedUrlForAnonymousUser [Text] Source #
The Amazon Resource Names (ARNs) for the Amazon QuickSight resources
that the user is authorized to access during the lifetime of the
session. If you choose Dashboard embedding experience, pass the list
of dashboard ARNs in the account that you want the user to be able to
view. Currently, you can pass up to 25 dashboard ARNs in each API call.
generateEmbedUrlForAnonymousUser_experienceConfiguration :: Lens' GenerateEmbedUrlForAnonymousUser AnonymousUserEmbeddingExperienceConfiguration Source #
The configuration of the experience that you are embedding.
Destructuring the Response
data GenerateEmbedUrlForAnonymousUserResponse Source #
See: newGenerateEmbedUrlForAnonymousUserResponse smart constructor.
Constructors
| GenerateEmbedUrlForAnonymousUserResponse' | |
Instances
newGenerateEmbedUrlForAnonymousUserResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> Text |
|
| -> GenerateEmbedUrlForAnonymousUserResponse |
Create a value of GenerateEmbedUrlForAnonymousUserResponse 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:
GenerateEmbedUrlForAnonymousUserResponse, generateEmbedUrlForAnonymousUserResponse_status - The HTTP status of the request.
$sel:embedUrl:GenerateEmbedUrlForAnonymousUserResponse', generateEmbedUrlForAnonymousUserResponse_embedUrl - The embed URL for the dashboard.
$sel:requestId:GenerateEmbedUrlForAnonymousUserResponse', generateEmbedUrlForAnonymousUserResponse_requestId - The Amazon Web Services request ID for this operation.
$sel:anonymousUserArn:GenerateEmbedUrlForAnonymousUserResponse', generateEmbedUrlForAnonymousUserResponse_anonymousUserArn - The Amazon Resource Name (ARN) to use for the anonymous Amazon
QuickSight user.
Response Lenses
generateEmbedUrlForAnonymousUserResponse_status :: Lens' GenerateEmbedUrlForAnonymousUserResponse Int Source #
The HTTP status of the request.
generateEmbedUrlForAnonymousUserResponse_embedUrl :: Lens' GenerateEmbedUrlForAnonymousUserResponse Text Source #
The embed URL for the dashboard.
generateEmbedUrlForAnonymousUserResponse_requestId :: Lens' GenerateEmbedUrlForAnonymousUserResponse Text Source #
The Amazon Web Services request ID for this operation.
generateEmbedUrlForAnonymousUserResponse_anonymousUserArn :: Lens' GenerateEmbedUrlForAnonymousUserResponse Text Source #
The Amazon Resource Name (ARN) to use for the anonymous Amazon QuickSight user.