Class: Aws::SageMaker::Types::ProcessingInput

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 ProcessingInput data as a hash:

{
  input_name: "String", # required
  app_managed: false,
  s3_input: {
    s3_uri: "S3Uri", # required
    local_path: "ProcessingLocalPath",
    s3_data_type: "ManifestFile", # required, accepts ManifestFile, S3Prefix
    s3_input_mode: "Pipe", # accepts Pipe, File
    s3_data_distribution_type: "FullyReplicated", # accepts FullyReplicated, ShardedByS3Key
    s3_compression_type: "None", # accepts None, Gzip
  },
  dataset_definition: {
    athena_dataset_definition: {
      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
    },
    redshift_dataset_definition: {
      cluster_id: "RedshiftClusterId", # required
      database: "RedshiftDatabase", # required
      db_user: "RedshiftUserName", # required
      query_string: "RedshiftQueryString", # required
      cluster_role_arn: "RoleArn", # required
      output_s3_uri: "S3Uri", # required
      kms_key_id: "KmsKeyId",
      output_format: "PARQUET", # required, accepts PARQUET, CSV
      output_compression: "None", # accepts None, GZIP, BZIP2, ZSTD, SNAPPY
    },
    local_path: "ProcessingLocalPath",
    data_distribution_type: "FullyReplicated", # accepts FullyReplicated, ShardedByS3Key
    input_mode: "Pipe", # accepts Pipe, File
  },
}

The inputs for a processing job. The processing input must specify exactly one of either S3Input or DatasetDefinition types.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#app_managed ⇒ Boolean

When True, input operations such as data download are managed natively by the processing job application. When False (default), input operations are managed by Amazon SageMaker.

Returns:

  • (Boolean) 


28429
28430
28431
28432
28433
28434
28435
28436
 
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 28429

class ProcessingInput < Struct.new(
  :input_name,
  :app_managed,
  :s3_input,
  :dataset_definition)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_definition ⇒ Types::DatasetDefinition

Configuration for a Dataset Definition input.

Returns:



28429
28430
28431
28432
28433
28434
28435
28436
 
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 28429

class ProcessingInput < Struct.new(
  :input_name,
  :app_managed,
  :s3_input,
  :dataset_definition)
  SENSITIVE = []
  include Aws::Structure
end

#input_name ⇒ String

The name for the processing job input.

Returns:

  • (String) 


28429
28430
28431
28432
28433
28434
28435
28436
 
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 28429

class ProcessingInput < Struct.new(
  :input_name,
  :app_managed,
  :s3_input,
  :dataset_definition)
  SENSITIVE = []
  include Aws::Structure
end

#s3_input ⇒ Types::ProcessingS3Input

Configuration for downloading input data from Amazon S3 into the processing container.

Returns:



28429
28430
28431
28432
28433
28434
28435
28436
 
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 28429

class ProcessingInput < Struct.new(
  :input_name,
  :app_managed,
  :s3_input,
  :dataset_definition)
  SENSITIVE = []
  include Aws::Structure
end