Class: Aws::SageMaker::Types::AthenaDatasetDefinition

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

Note:

When making an API call, you may pass AthenaDatasetDefinition data as a hash:

{
  catalog: "AthenaCatalog", # required
  database: "AthenaDatabase", # required
  query_string: "AthenaQueryString", # required
  work_group: "AthenaWorkGroup",
  output_s3_uri: "S3Uri", # required
  kms_key_id: "KmsKeyId",
  output_format: "PARQUET", # required, accepts PARQUET, ORC, AVRO, JSON, TEXTFILE
  output_compression: "GZIP", # accepts GZIP, SNAPPY, ZLIB
}

Configuration for Athena Dataset Definition input.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#catalogString

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

Returns:

  • (String)


1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 1971

class AthenaDatasetDefinition < Struct.new(
  :catalog,
  :database,
  :query_string,
  :work_group,
  :output_s3_uri,
  :kms_key_id,
  :output_format,
  :output_compression)
  SENSITIVE = []
  include Aws::Structure
end

#databaseString

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

Returns:

  • (String)


1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 1971

class AthenaDatasetDefinition < Struct.new(
  :catalog,
  :database,
  :query_string,
  :work_group,
  :output_s3_uri,
  :kms_key_id,
  :output_format,
  :output_compression)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_idString

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

Returns:

  • (String)


1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 1971

class AthenaDatasetDefinition < Struct.new(
  :catalog,
  :database,
  :query_string,
  :work_group,
  :output_s3_uri,
  :kms_key_id,
  :output_format,
  :output_compression)
  SENSITIVE = []
  include Aws::Structure
end

#output_compressionString

The compression used for Athena query results.

Returns:

  • (String)


1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 1971

class AthenaDatasetDefinition < Struct.new(
  :catalog,
  :database,
  :query_string,
  :work_group,
  :output_s3_uri,
  :kms_key_id,
  :output_format,
  :output_compression)
  SENSITIVE = []
  include Aws::Structure
end

#output_formatString

The data storage format for Athena query results.

Returns:

  • (String)


1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 1971

class AthenaDatasetDefinition < Struct.new(
  :catalog,
  :database,
  :query_string,
  :work_group,
  :output_s3_uri,
  :kms_key_id,
  :output_format,
  :output_compression)
  SENSITIVE = []
  include Aws::Structure
end

#output_s3_uriString

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

Returns:

  • (String)


1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 1971

class AthenaDatasetDefinition < Struct.new(
  :catalog,
  :database,
  :query_string,
  :work_group,
  :output_s3_uri,
  :kms_key_id,
  :output_format,
  :output_compression)
  SENSITIVE = []
  include Aws::Structure
end

#query_stringString

The SQL query statements, to be executed.

Returns:

  • (String)


1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 1971

class AthenaDatasetDefinition < Struct.new(
  :catalog,
  :database,
  :query_string,
  :work_group,
  :output_s3_uri,
  :kms_key_id,
  :output_format,
  :output_compression)
  SENSITIVE = []
  include Aws::Structure
end

#work_groupString

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

Returns:

  • (String)


1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 1971

class AthenaDatasetDefinition < Struct.new(
  :catalog,
  :database,
  :query_string,
  :work_group,
  :output_s3_uri,
  :kms_key_id,
  :output_format,
  :output_compression)
  SENSITIVE = []
  include Aws::Structure
end