Class: Aws::QuickSight::Types::S3KnowledgeBaseParameters

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

Overview

The parameters that are required to connect to an S3 knowledge base data source.

Prerequisites: Amazon S3 bucket access

Before you call CreateKnowledgeBase for an Amazon S3 knowledge base, an administrator must grant Amazon QuickSight access to the source S3 bucket. If access has not been granted for the bucket, knowledge base creation fails.

To grant access, an administrator adds the bucket in the Amazon QuickSight admin console, under Permissions, Amazon Web Services resources, Amazon S3, Select S3 buckets. This authorizes the Amazon QuickSight service role to read the bucket. The bucket can be in the same Amazon Web Services account or, when the bucket owner has authorized your account, in a different account.

The service role requires at least the following permissions on the bucket:

  • s3:GetObject

  • s3:ListBucket

  • s3:GetBucketLocation

  • s3:GetObjectVersion

  • s3:ListBucketVersions

For the full procedure, including cross-account buckets and KMS-encrypted buckets, see the Amazon S3 knowledge base administrator setup guide.

To grant access for a specific S3 knowledge base data source without granting account-wide S3 access, provide a custom IAM role on the data source by using RoleArn.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucket_url ⇒ String

The URL of the S3 bucket that contains the knowledge base data.

Returns:

  • (String) 


39079
39080
39081
39082
39083
39084
39085
 
# File 'lib/aws-sdk-quicksight/types.rb', line 39079

class S3KnowledgeBaseParameters < Struct.new(
  :role_arn,
  :bucket_url,
  :metadata_files_location)
  SENSITIVE = []
  include Aws::Structure
end

#metadata_files_location ⇒ String

The Amazon S3 location (prefix) of per-document metadata files. Each metadata file describes a single source document and its indexable attributes, such as title, category, and version. This is not the global ACL configuration file. To apply a single global ACL file to the entire knowledge base, use the access control configuration instead.

Returns:

  • (String) 


39079
39080
39081
39082
39083
39084
39085
 
# File 'lib/aws-sdk-quicksight/types.rb', line 39079

class S3KnowledgeBaseParameters < Struct.new(
  :role_arn,
  :bucket_url,
  :metadata_files_location)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

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

Returns:

  • (String) 


39079
39080
39081
39082
39083
39084
39085
 
# File 'lib/aws-sdk-quicksight/types.rb', line 39079

class S3KnowledgeBaseParameters < Struct.new(
  :role_arn,
  :bucket_url,
  :metadata_files_location)
  SENSITIVE = []
  include Aws::Structure
end