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 |
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.
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
The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.
- 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 GenerateEmbedUrlForRegisteredUser = GenerateEmbedUrlForRegisteredUser' {}
- newGenerateEmbedUrlForRegisteredUser :: Text -> Text -> RegisteredUserEmbeddingExperienceConfiguration -> GenerateEmbedUrlForRegisteredUser
- generateEmbedUrlForRegisteredUser_allowedDomains :: Lens' GenerateEmbedUrlForRegisteredUser (Maybe [Text])
- generateEmbedUrlForRegisteredUser_sessionLifetimeInMinutes :: Lens' GenerateEmbedUrlForRegisteredUser (Maybe Natural)
- generateEmbedUrlForRegisteredUser_awsAccountId :: Lens' GenerateEmbedUrlForRegisteredUser Text
- generateEmbedUrlForRegisteredUser_userArn :: Lens' GenerateEmbedUrlForRegisteredUser Text
- generateEmbedUrlForRegisteredUser_experienceConfiguration :: Lens' GenerateEmbedUrlForRegisteredUser RegisteredUserEmbeddingExperienceConfiguration
- data GenerateEmbedUrlForRegisteredUserResponse = GenerateEmbedUrlForRegisteredUserResponse' {}
- newGenerateEmbedUrlForRegisteredUserResponse :: Int -> Text -> Text -> GenerateEmbedUrlForRegisteredUserResponse
- generateEmbedUrlForRegisteredUserResponse_status :: Lens' GenerateEmbedUrlForRegisteredUserResponse Int
- generateEmbedUrlForRegisteredUserResponse_embedUrl :: Lens' GenerateEmbedUrlForRegisteredUserResponse Text
- generateEmbedUrlForRegisteredUserResponse_requestId :: Lens' GenerateEmbedUrlForRegisteredUserResponse Text
Creating a Request
data GenerateEmbedUrlForRegisteredUser Source #
See: newGenerateEmbedUrlForRegisteredUser
smart constructor.
GenerateEmbedUrlForRegisteredUser' | |
|
Instances
newGenerateEmbedUrlForRegisteredUser Source #
:: Text | |
-> Text | |
-> RegisteredUserEmbeddingExperienceConfiguration |
|
-> GenerateEmbedUrlForRegisteredUser |
Create a value of GenerateEmbedUrlForRegisteredUser
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:GenerateEmbedUrlForRegisteredUser'
, generateEmbedUrlForRegisteredUser_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:GenerateEmbedUrlForRegisteredUser'
, generateEmbedUrlForRegisteredUser_sessionLifetimeInMinutes
- How many minutes the session is valid. The session lifetime must be in
[15-600] minutes range.
GenerateEmbedUrlForRegisteredUser
, generateEmbedUrlForRegisteredUser_awsAccountId
- The ID for the Amazon Web Services account that contains the dashboard
that you're embedding.
$sel:userArn:GenerateEmbedUrlForRegisteredUser'
, generateEmbedUrlForRegisteredUser_userArn
- The Amazon Resource Name for the registered user.
$sel:experienceConfiguration:GenerateEmbedUrlForRegisteredUser'
, generateEmbedUrlForRegisteredUser_experienceConfiguration
- The experience you are embedding. For registered users, you can embed
Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon
QuickSight Q search bar, or the entire Amazon QuickSight console.
Request Lenses
generateEmbedUrlForRegisteredUser_allowedDomains :: Lens' GenerateEmbedUrlForRegisteredUser (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
.
generateEmbedUrlForRegisteredUser_sessionLifetimeInMinutes :: Lens' GenerateEmbedUrlForRegisteredUser (Maybe Natural) Source #
How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.
generateEmbedUrlForRegisteredUser_awsAccountId :: Lens' GenerateEmbedUrlForRegisteredUser Text Source #
The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
generateEmbedUrlForRegisteredUser_userArn :: Lens' GenerateEmbedUrlForRegisteredUser Text Source #
The Amazon Resource Name for the registered user.
generateEmbedUrlForRegisteredUser_experienceConfiguration :: Lens' GenerateEmbedUrlForRegisteredUser RegisteredUserEmbeddingExperienceConfiguration Source #
The experience you are embedding. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, or the entire Amazon QuickSight console.
Destructuring the Response
data GenerateEmbedUrlForRegisteredUserResponse Source #
See: newGenerateEmbedUrlForRegisteredUserResponse
smart constructor.
Instances
newGenerateEmbedUrlForRegisteredUserResponse Source #
Create a value of GenerateEmbedUrlForRegisteredUserResponse
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:
GenerateEmbedUrlForRegisteredUserResponse
, generateEmbedUrlForRegisteredUserResponse_status
- The HTTP status of the request.
$sel:embedUrl:GenerateEmbedUrlForRegisteredUserResponse'
, generateEmbedUrlForRegisteredUserResponse_embedUrl
- The embed URL for the Amazon QuickSight dashboard, visual, Q search bar,
or console.
$sel:requestId:GenerateEmbedUrlForRegisteredUserResponse'
, generateEmbedUrlForRegisteredUserResponse_requestId
- The Amazon Web Services request ID for this operation.
Response Lenses
generateEmbedUrlForRegisteredUserResponse_status :: Lens' GenerateEmbedUrlForRegisteredUserResponse Int Source #
The HTTP status of the request.
generateEmbedUrlForRegisteredUserResponse_embedUrl :: Lens' GenerateEmbedUrlForRegisteredUserResponse Text Source #
The embed URL for the Amazon QuickSight dashboard, visual, Q search bar, or console.
generateEmbedUrlForRegisteredUserResponse_requestId :: Lens' GenerateEmbedUrlForRegisteredUserResponse Text Source #
The Amazon Web Services request ID for this operation.