View a markdown version of this page

AthenaParameters - Amazon Quick Sight

AthenaParameters

Parameters for Amazon Athena.

Contents

Note

In the following list, the required parameters are described first.

ConsumerAccountRoleArn

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.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: No

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.

Type: IdentityCenterConfiguration object

Required: No

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.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: No

WorkGroup

The workgroup that Amazon Athena uses.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: