Class: Aws::QuickSight::Types::GetIdentityContextRequest

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

Overview

///////////////////////// /////////////////////////

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aws_account_id ⇒ String

The ID for the Amazon Web Services account that the user whose identity context you want to retrieve is in. Currently, you use the ID for the Amazon Web Services account that contains your Quick Sight account.

Returns:

  • (String) 


24351
24352
24353
24354
24355
24356
24357
24358
24359
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 24351

class GetIdentityContextRequest < Struct.new(
  :aws_account_id,
  :user_identifier,
  :namespace,
  :session_expires_at,
  :context_region)
  SENSITIVE = []
  include Aws::Structure
end

#context_region ⇒ String

The region in which the context is to be used. Use this parameter to obtain an identity context for cross-region use.

The specified region must meet the following conditions:

  • The region must be in the same Amazon Web Services partition as the region you are calling from. Cross-partition requests are not supported. For example, you cannot specify a region in the aws-cn partition when calling from a region in the aws partition.

  • It must be a valid Amazon QuickSight supported region.

  • The calling customer account must be enabled in the specified context region.

  • This parameter is not supported when calling from an opt-in region.

Returns:

  • (String) 


24351
24352
24353
24354
24355
24356
24357
24358
24359
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 24351

class GetIdentityContextRequest < Struct.new(
  :aws_account_id,
  :user_identifier,
  :namespace,
  :session_expires_at,
  :context_region)
  SENSITIVE = []
  include Aws::Structure
end

#namespace ⇒ String

The namespace of the user that you want to get identity context for. This parameter is required when the UserIdentifier is specified using Email or UserName.

Returns:

  • (String) 


24351
24352
24353
24354
24355
24356
24357
24358
24359
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 24351

class GetIdentityContextRequest < Struct.new(
  :aws_account_id,
  :user_identifier,
  :namespace,
  :session_expires_at,
  :context_region)
  SENSITIVE = []
  include Aws::Structure
end

#session_expires_at ⇒ Time

The timestamp at which the session will expire.

Returns:

  • (Time) 


24351
24352
24353
24354
24355
24356
24357
24358
24359
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 24351

class GetIdentityContextRequest < Struct.new(
  :aws_account_id,
  :user_identifier,
  :namespace,
  :session_expires_at,
  :context_region)
  SENSITIVE = []
  include Aws::Structure
end

#user_identifier ⇒ Types::UserIdentifier

The identifier for the user whose identity context you want to retrieve.

Returns:



24351
24352
24353
24354
24355
24356
24357
24358
24359
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 24351

class GetIdentityContextRequest < Struct.new(
  :aws_account_id,
  :user_identifier,
  :namespace,
  :session_expires_at,
  :context_region)
  SENSITIVE = []
  include Aws::Structure
end