quicksight_generate_embed_url_for_registered_user: Generates an embed URL that you can use to embed an Amazon...
In paws.analytics: 'Amazon Web Services' Analytics Services
View source: R/quicksight_operations.R
quicksight_generate_embed_url_for_registered_user R Documentation
Generates an embed URL that you can use to embed an Amazon QuickSight
experience in your website
Description
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.
See https://www.paws-r-sdk.com/docs/quicksight_generate_embed_url_for_registered_user/ for full documentation.
Usage
quicksight_generate_embed_url_for_registered_user(
AwsAccountId,
SessionLifetimeInMinutes = NULL,
UserArn,
ExperienceConfiguration,
AllowedDomains = NULL
)
Arguments
AwsAccountId
[required] The ID for the Amazon Web Services account that contains the dashboard
that you're embedding.
SessionLifetimeInMinutes
How many minutes the session is valid. The session lifetime must be in
[15-600] minutes range.
UserArn
[required] The Amazon Resource Name for the registered user.
ExperienceConfiguration
[required] 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.
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.
paws.analytics documentation built on Sept. 11, 2023, 5:06 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
View source: R/quicksight_operations.R
| quicksight_generate_embed_url_for_registered_user | R Documentation |
Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website
Description
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.
See https://www.paws-r-sdk.com/docs/quicksight_generate_embed_url_for_registered_user/ for full documentation.
Usage
quicksight_generate_embed_url_for_registered_user(
AwsAccountId,
SessionLifetimeInMinutes = NULL,
UserArn,
ExperienceConfiguration,
AllowedDomains = NULL
)
Arguments
AwsAccountId |
[required] The ID for the Amazon Web Services account that contains the dashboard that you're embedding. |
SessionLifetimeInMinutes |
How many minutes the session is valid. The session lifetime must be in [15-600] minutes range. |
UserArn |
[required] The Amazon Resource Name for the registered user. |
ExperienceConfiguration |
[required] 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. |
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
|
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.