AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::QuickSight::Types::GetSessionEmbedUrlRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb

Overview

Note:

When making an API call, you may pass GetSessionEmbedUrlRequest data as a hash:

{
  aws_account_id: "AwsAccountId", # required
  entry_point: "EntryPoint",
  session_lifetime_in_minutes: 1,
  user_arn: "Arn",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aws_account_idString

The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.

Returns:

  • (String)


7337
7338
7339
7340
7341
7342
7343
7344
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7337

class GetSessionEmbedUrlRequest < Struct.new(
  :aws_account_id,
  :entry_point,
  :session_lifetime_in_minutes,
  :user_arn)
  SENSITIVE = []
  include Aws::Structure
end

#entry_pointString

The URL you use to access the embedded session. The entry point URL is constrained to the following paths:

  • /start

  • /start/analyses

  • /start/dashboards

  • /start/favorites

  • /dashboards/DashboardId - where DashboardId is the actual ID key from the Amazon QuickSight console URL of the dashboard

  • /analyses/AnalysisId - where AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis

Returns:

  • (String)


7337
7338
7339
7340
7341
7342
7343
7344
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7337

class GetSessionEmbedUrlRequest < Struct.new(
  :aws_account_id,
  :entry_point,
  :session_lifetime_in_minutes,
  :user_arn)
  SENSITIVE = []
  include Aws::Structure
end

#session_lifetime_in_minutesInteger

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

Returns:

  • (Integer)


7337
7338
7339
7340
7341
7342
7343
7344
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7337

class GetSessionEmbedUrlRequest < Struct.new(
  :aws_account_id,
  :entry_point,
  :session_lifetime_in_minutes,
  :user_arn)
  SENSITIVE = []
  include Aws::Structure
end

#user_arnString

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

  1. Active Directory (AD) users or group members

  2. Invited nonfederated users

  3. Identity and Access Management (IAM) users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation

Omit this parameter for users in the third group, IAM users and IAM role-based sessions.

Returns:

  • (String)


7337
7338
7339
7340
7341
7342
7343
7344
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7337

class GetSessionEmbedUrlRequest < Struct.new(
  :aws_account_id,
  :entry_point,
  :session_lifetime_in_minutes,
  :user_arn)
  SENSITIVE = []
  include Aws::Structure
end