Skip to content

AthenaParameters

Source code in docs_src/capo_quicksight/types/athena_parameters.py 
13
14
15
16
17
18
19
20
21
22
23
class AthenaParameters(TypedDict, closed=True):
    work_group: NotRequired["capo_quicksight.types.work_group.WorkGroup"]
    """<p>The workgroup that Amazon Athena uses.</p>"""
    role_arn: NotRequired["capo_quicksight.types.role_arn.RoleArn"]
    """<p>Use the <code>RoleArn</code> structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use <code>RoleArn</code> to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.</p>"""
    consumer_account_role_arn: NotRequired["capo_quicksight.types.role_arn.RoleArn"]
    """<p>Use <code>ConsumerAccountRoleArn</code> to perform cross-account Athena access. This is an IAM role ARN in the same AWS account as the Athena resources you want to access. Provide this along with <code>RoleArn</code> to enable role-chaining, where Amazon Quick Sight first assumes the <code>RoleArn</code> and then assumes the <code>ConsumerAccountRoleArn</code> to access Athena resources.</p>"""
    identity_center_configuration: NotRequired[
        "capo_quicksight.types.identity_center_configuration.IdentityCenterConfiguration"
    ]
    """<p>An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.</p> <p>This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.</p>"""

consumer_account_role_arn instance-attribute 

consumer_account_role_arn: NotRequired[RoleArn]

Use ConsumerAccountRoleArn to perform cross-account Athena access. This is an IAM role ARN in the same AWS account as the Athena resources you want to access. Provide this along with RoleArn to enable role-chaining, where Amazon Quick Sight first assumes the RoleArn and then assumes the ConsumerAccountRoleArn to access Athena resources.

identity_center_configuration instance-attribute 

identity_center_configuration: NotRequired[IdentityCenterConfiguration]

An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.

This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.

role_arn instance-attribute 

role_arn: NotRequired[RoleArn]

Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.

work_group instance-attribute 

work_group: NotRequired[WorkGroup]

The workgroup that Amazon Athena uses.