[ aws . quicksight ]

get-session-embed-url

Description

Generates a session URL and authorization code that you can embed in your web server code.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-session-embed-url
--aws-account-id <value>
[--entry-point <value>]
[--session-lifetime-in-minutes <value>]
[--user-arn <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--aws-account-id (string)

The ID for the AWS account that contains the QuickSight session that you’re embedding.

--entry-point (string)

The entry point for the embedded session.

--session-lifetime-in-minutes (long)

How many minutes the session is valid. The session lifetime must be 15-600 minutes.

--user-arn (string)

The Amazon QuickSight user’s Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following:

• Active Directory (AD) users or group members

• Invited nonfederated users

• IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

EmbedUrl -> (string)

A single-use URL that you can put into your server-side web page to embed your QuickSight session. This URL is valid for 5 minutes. The API provides the URL with an auth_code value that enables one (and only one) sign-on to a user session that is valid for 10 hours.

Status -> (integer)

The HTTP status of the request.

RequestId -> (string)

The AWS request ID for this operation.