Skip to content

GetIdentityContextRequest

Source code in docs_src/capo_quicksight/types/get_identity_context_request.py 
18
19
20
21
22
23
24
25
26
27
28
class GetIdentityContextRequest(TypedDict, closed=True):
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId"
    """<p>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.</p>"""
    user_identifier: "capo_quicksight.types.user_identifier.UserIdentifier"
    """<p>The identifier for the user whose identity context you want to retrieve.</p>"""
    namespace: NotRequired["capo_quicksight.types.namespace.Namespace"]
    """<p>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.</p>"""
    session_expires_at: NotRequired["datetime.datetime"]
    """<p>The timestamp at which the session will expire.</p>"""
    context_region: NotRequired["capo_quicksight.types.region.Region"]
    """<p>The region in which the context is to be used. Use this parameter to obtain an identity context for cross-region use.</p> <p>The specified region must meet the following conditions:</p> <ul> <li> <p>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 <code>aws-cn</code> partition when calling from a region in the <code>aws</code> partition.</p> </li> <li> <p>It must be a valid Amazon QuickSight supported region.</p> </li> <li> <p>The calling customer account must be enabled in the specified context region.</p> </li> <li> <p>This parameter is not supported when calling from an opt-in region.</p> </li> </ul>"""

aws_account_id instance-attribute 

aws_account_id: AwsAccountId

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.

context_region instance-attribute 

context_region: NotRequired[Region]

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.

namespace instance-attribute 

namespace: NotRequired[Namespace]

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.

session_expires_at instance-attribute 

session_expires_at: NotRequired[datetime]

The timestamp at which the session will expire.

user_identifier instance-attribute 

user_identifier: UserIdentifier

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