amazonka-quicksight-2.0: Amazon QuickSight SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.QuickSight.GenerateEmbedUrlForRegisteredUser

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.

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 SessionLifetimeInMinutes parameter.

    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

Creating a Request

data GenerateEmbedUrlForRegisteredUser Source #

See: newGenerateEmbedUrlForRegisteredUser smart constructor.

Constructors

GenerateEmbedUrlForRegisteredUser' 

Fields

  • allowedDomains :: Maybe [Text]

    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.

  • sessionLifetimeInMinutes :: Maybe Natural

    How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

  • awsAccountId :: Text

    The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

  • userArn :: Text

    The Amazon Resource Name for the registered user.

  • experienceConfiguration :: RegisteredUserEmbeddingExperienceConfiguration

    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.

Instances

Instances details
ToJSON GenerateEmbedUrlForRegisteredUser Source # 
Instance details

Defined in Amazonka.QuickSight.GenerateEmbedUrlForRegisteredUser

ToHeaders GenerateEmbedUrlForRegisteredUser Source # 
Instance details

Defined in Amazonka.QuickSight.GenerateEmbedUrlForRegisteredUser

ToPath GenerateEmbedUrlForRegisteredUser Source # 
Instance details

Defined in Amazonka.QuickSight.GenerateEmbedUrlForRegisteredUser

ToQuery GenerateEmbedUrlForRegisteredUser Source # 
Instance details

Defined in Amazonka.QuickSight.GenerateEmbedUrlForRegisteredUser

AWSRequest GenerateEmbedUrlForRegisteredUser Source # 
Instance details

Defined in Amazonka.QuickSight.GenerateEmbedUrlForRegisteredUser

Generic GenerateEmbedUrlForRegisteredUser Source # 
Instance details

Defined in Amazonka.QuickSight.GenerateEmbedUrlForRegisteredUser

Associated Types

type Rep GenerateEmbedUrlForRegisteredUser :: Type -> Type #

Read GenerateEmbedUrlForRegisteredUser Source # 
Instance details

Defined in Amazonka.QuickSight.GenerateEmbedUrlForRegisteredUser

Show GenerateEmbedUrlForRegisteredUser Source # 
Instance details

Defined in Amazonka.QuickSight.GenerateEmbedUrlForRegisteredUser

NFData GenerateEmbedUrlForRegisteredUser Source # 
Instance details

Defined in Amazonka.QuickSight.GenerateEmbedUrlForRegisteredUser

Eq GenerateEmbedUrlForRegisteredUser Source # 
Instance details

Defined in Amazonka.QuickSight.GenerateEmbedUrlForRegisteredUser

Hashable GenerateEmbedUrlForRegisteredUser Source # 
Instance details

Defined in Amazonka.QuickSight.GenerateEmbedUrlForRegisteredUser

type AWSResponse GenerateEmbedUrlForRegisteredUser Source # 
Instance details

Defined in Amazonka.QuickSight.GenerateEmbedUrlForRegisteredUser

type Rep GenerateEmbedUrlForRegisteredUser Source # 
Instance details

Defined in Amazonka.QuickSight.GenerateEmbedUrlForRegisteredUser

type Rep GenerateEmbedUrlForRegisteredUser = D1 ('MetaData "GenerateEmbedUrlForRegisteredUser" "Amazonka.QuickSight.GenerateEmbedUrlForRegisteredUser" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "GenerateEmbedUrlForRegisteredUser'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "allowedDomains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "sessionLifetimeInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "awsAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "userArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "experienceConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RegisteredUserEmbeddingExperienceConfiguration)))))

newGenerateEmbedUrlForRegisteredUser Source #

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_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 #

Constructors

GenerateEmbedUrlForRegisteredUserResponse' 

Fields

  • status :: Int

    The HTTP status of the request.

  • embedUrl :: Sensitive Text

    The embed URL for the Amazon QuickSight dashboard, visual, Q search bar, or console.

  • requestId :: Text

    The Amazon Web Services request ID for this operation.

Instances

Instances details
Generic GenerateEmbedUrlForRegisteredUserResponse Source # 
Instance details

Defined in Amazonka.QuickSight.GenerateEmbedUrlForRegisteredUser

Show GenerateEmbedUrlForRegisteredUserResponse Source # 
Instance details

Defined in Amazonka.QuickSight.GenerateEmbedUrlForRegisteredUser

NFData GenerateEmbedUrlForRegisteredUserResponse Source # 
Instance details

Defined in Amazonka.QuickSight.GenerateEmbedUrlForRegisteredUser

Eq GenerateEmbedUrlForRegisteredUserResponse Source # 
Instance details

Defined in Amazonka.QuickSight.GenerateEmbedUrlForRegisteredUser

type Rep GenerateEmbedUrlForRegisteredUserResponse Source # 
Instance details

Defined in Amazonka.QuickSight.GenerateEmbedUrlForRegisteredUser

type Rep GenerateEmbedUrlForRegisteredUserResponse = D1 ('MetaData "GenerateEmbedUrlForRegisteredUserResponse" "Amazonka.QuickSight.GenerateEmbedUrlForRegisteredUser" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "GenerateEmbedUrlForRegisteredUserResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "embedUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

Response Lenses

generateEmbedUrlForRegisteredUserResponse_embedUrl :: Lens' GenerateEmbedUrlForRegisteredUserResponse Text Source #

The embed URL for the Amazon QuickSight dashboard, visual, Q search bar, or console.