GetSessionEmbedUrlRequest

public struct GetSessionEmbedUrlRequest : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • The ID for the AWS account associated with your QuickSight subscription.

    Declaration

    Swift

    public let awsAccountId: String

  • 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 QuickSight console URL of the dashboard /analyses/AnalysisId - where AnalysisId is the actual ID key from the QuickSight console URL of the analysis

    Declaration

    Swift

    public let entryPoint: String?

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

    Declaration

    Swift

    public let sessionLifetimeInMinutes: Int64?

  • 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: 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 Omit this parameter for users in the third group – IAM users and IAM role-based sessions.

    Declaration

    Swift

    public let userArn: String?

  • Undocumented

    Declaration

    Swift

    public init(awsAccountId: String, entryPoint: String? = nil, sessionLifetimeInMinutes: Int64? = nil, userArn: String? = nil)

  • Declaration

    Swift

    public func validate(name: String) throws