AthenaDatasetDefinition - Amazon SageMaker

AthenaDatasetDefinition

Configuration for Athena Dataset Definition input.

Contents

Catalog

The name of the data catalog used in Athena query execution.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes

Database

The name of the database used in the Athena query execution.

Type: String

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

Pattern: .*

Required: Yes

OutputFormat

The data storage format for Athena query results.

Type: String

Valid Values: PARQUET | ORC | AVRO | JSON | TEXTFILE

Required: Yes

OutputS3Uri

The location in Amazon S3 where Athena query results are stored.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: ^(https|s3)://([^/]+)/?(.*)$

Required: Yes

QueryString

The SQL query statements, to be executed.

Type: String

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

Pattern: [\s\S]+

Required: Yes

KmsKeyId

The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data generated from an Athena query execution.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: ^[a-zA-Z0-9:/_-]*$

Required: No

OutputCompression

The compression used for Athena query results.

Type: String

Valid Values: GZIP | SNAPPY | ZLIB

Required: No

WorkGroup

The name of the workgroup in which the Athena query is being started.

Type: String

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

Pattern: [a-zA-Z0-9._-]+

Required: No

See Also

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