AthenaDatasetDefinition: DatasetDefinition for Athena.

In DyfanJones/sagemaker-r-common: R6sagemaker lower level api calls

DatasetDefinition for Athena.

Description

With this input, SQL queries will be executed using Athena to generate datasets to S3.

Super class

sagemaker.core::ApiObject -> AthenaDatasetDefinition

Methods

Public methods

• AthenaDatasetDefinition$new()

• AthenaDatasetDefinition$clone()

Inherited methods

• sagemaker.core::ApiObject$format()
• sagemaker.core::ApiObject$from_paws()
• sagemaker.core::ApiObject$to_paws()

---

Method new()

Initialize AthenaDatasetDefinition.

Usage

AthenaDatasetDefinition$new(
  catalog = NULL,
  database = NULL,
  query_string = NULL,
  output_s3_uri = NULL,
  work_group = NULL,
  kms_key_id = NULL,
  output_format = NULL,
  output_compression = NULL
)

Arguments

catalog

(str, default=None): The name of the data catalog used in Athena query execution.

database

(str, default=None): The name of the database used in the Athena query execution.

query_string

(str, default=None): The SQL query statements, to be executed.

output_s3_uri

(str, default=None): The location in Amazon S3 where Athena query results are stored.

work_group

(str, default=None): The name of the workgroup in which the Athena query is being started.

kms_key_id

(str, default=None): The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data generated from an Athena query execution.

output_format

(str, default=None): The data storage format for Athena query results. Valid options are "PARQUET", "ORC", "AVRO", "JSON", "TEXTFILE"

output_compression

(str, default=None): The compression used for Athena query results. Valid options are "GZIP", "SNAPPY", "ZLIB"

---

Method clone()

The objects of this class are cloneable with this method.

Usage

AthenaDatasetDefinition$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

DyfanJones/sagemaker-r-common documentation built on June 14, 2022, 10:31 p.m.