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::GenerateEmbedUrlForAnonymousUserRequest

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 GenerateEmbedUrlForAnonymousUserRequest data as a hash:

{
  aws_account_id: "AwsAccountId", # required
  session_lifetime_in_minutes: 1,
  namespace: "Namespace", # required
  session_tags: [
    {
      key: "SessionTagKey", # required
      value: "SessionTagValue", # required
    },
  ],
  authorized_resource_arns: ["Arn"], # required
  experience_configuration: { # required
    dashboard: {
      initial_dashboard_id: "RestrictiveResourceId", # required
    },
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#authorized_resource_arnsArray<String>

The Amazon Resource Names for the Amazon QuickSight resources that the user is authorized to access during the lifetime of the session. If you choose Dashboard embedding experience, pass the list of dashboard ARNs in the account that you want the user to be able to view.

Returns:

  • (Array<String>)


7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7003

class GenerateEmbedUrlForAnonymousUserRequest < Struct.new(
  :aws_account_id,
  :session_lifetime_in_minutes,
  :namespace,
  :session_tags,
  :authorized_resource_arns,
  :experience_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#aws_account_idString

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

Returns:

  • (String)


7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7003

class GenerateEmbedUrlForAnonymousUserRequest < Struct.new(
  :aws_account_id,
  :session_lifetime_in_minutes,
  :namespace,
  :session_tags,
  :authorized_resource_arns,
  :experience_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#experience_configurationTypes::AnonymousUserEmbeddingExperienceConfiguration

The configuration of the experience you are embedding.



7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7003

class GenerateEmbedUrlForAnonymousUserRequest < Struct.new(
  :aws_account_id,
  :session_lifetime_in_minutes,
  :namespace,
  :session_tags,
  :authorized_resource_arns,
  :experience_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#namespaceString

The Amazon QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon QuickSight custom namespace, set this to default.

Returns:

  • (String)


7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7003

class GenerateEmbedUrlForAnonymousUserRequest < Struct.new(
  :aws_account_id,
  :session_lifetime_in_minutes,
  :namespace,
  :session_tags,
  :authorized_resource_arns,
  :experience_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#session_lifetime_in_minutesInteger

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

Returns:

  • (Integer)


7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7003

class GenerateEmbedUrlForAnonymousUserRequest < Struct.new(
  :aws_account_id,
  :session_lifetime_in_minutes,
  :namespace,
  :session_tags,
  :authorized_resource_arns,
  :experience_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#session_tagsArray<Types::SessionTag>

The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.

These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tags.

Returns:



7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7003

class GenerateEmbedUrlForAnonymousUserRequest < Struct.new(
  :aws_account_id,
  :session_lifetime_in_minutes,
  :namespace,
  :session_tags,
  :authorized_resource_arns,
  :experience_configuration)
  SENSITIVE = []
  include Aws::Structure
end