Class: Aws::QuickSight::Types::GenerateEmbedUrlForAnonymousUserRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::QuickSight::Types::GenerateEmbedUrlForAnonymousUserRequest
- Defined in:
- gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb
Overview
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
-
#authorized_resource_arns ⇒ Array<String>
The Amazon Resource Names for the Amazon QuickSight resources that the user is authorized to access during the lifetime of the session.
-
#aws_account_id ⇒ String
The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
-
#experience_configuration ⇒ Types::AnonymousUserEmbeddingExperienceConfiguration
The configuration of the experience you are embedding.
-
#namespace ⇒ String
The Amazon QuickSight namespace that the anonymous user virtually belongs to.
-
#session_lifetime_in_minutes ⇒ Integer
How many minutes the session is valid.
-
#session_tags ⇒ Array<Types::SessionTag>
The session tags used for row-level security.
Instance Attribute Details
#authorized_resource_arns ⇒ Array<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.
7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7140 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_id ⇒ String
The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7140 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_configuration ⇒ Types::AnonymousUserEmbeddingExperienceConfiguration
The configuration of the experience you are embedding.
7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7140 class GenerateEmbedUrlForAnonymousUserRequest < Struct.new( :aws_account_id, :session_lifetime_in_minutes, :namespace, :session_tags, :authorized_resource_arns, :experience_configuration) SENSITIVE = [] include Aws::Structure end |
#namespace ⇒ String
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
.
7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7140 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_minutes ⇒ Integer
How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.
7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7140 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_tags ⇒ Array<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.
7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 7140 class GenerateEmbedUrlForAnonymousUserRequest < Struct.new( :aws_account_id, :session_lifetime_in_minutes, :namespace, :session_tags, :authorized_resource_arns, :experience_configuration) SENSITIVE = [] include Aws::Structure end |