Class: AWSCDK::Sagemaker::CfnDataQualityJobDefinition::BatchTransformInputProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
sagemaker/cfn_data_quality_job_definition.rb

Overview

Input object for the batch transform job.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data_captured_destination_s3_uri:, dataset_format:, local_path:, exclude_features_attribute: nil, s3_data_distribution_type: nil, s3_input_mode: nil) ⇒ BatchTransformInputProperty

Returns a new instance of BatchTransformInputProperty.

Parameters:

  • data_captured_destination_s3_uri (String) —

    The Amazon S3 location being used to capture the data.

  • dataset_format (AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnDataQualityJobDefinition::DatasetFormatProperty) —

    The dataset format for your batch transform job.

  • local_path (String) —

    Path to the filesystem where the batch transform data is available to the container.

  • exclude_features_attribute (String, nil) (defaults to: nil) —

    The attributes of the input data to exclude from the analysis.

  • s3_data_distribution_type (String, nil) (defaults to: nil) —

    Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key.

  • s3_input_mode (String, nil) (defaults to: nil) —

    Whether the Pipe or File is used as the input mode for transferring data for the monitoring job.



662
663
664
665
666
667
668
669
670
671
672
673
674
675
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 662

def initialize(data_captured_destination_s3_uri:, dataset_format:, local_path:, exclude_features_attribute: nil, s3_data_distribution_type: nil, s3_input_mode: nil)
  @data_captured_destination_s3_uri = data_captured_destination_s3_uri
  Jsii::Type.check_type(@data_captured_destination_s3_uri, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataCapturedDestinationS3Uri")
  @dataset_format = dataset_format.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnDataQualityJobDefinition::DatasetFormatProperty.new(**dataset_format.transform_keys(&:to_sym)) : dataset_format
  Jsii::Type.check_type(@dataset_format, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuRGF0YVF1YWxpdHlKb2JEZWZpbml0aW9uLkRhdGFzZXRGb3JtYXRQcm9wZXJ0eSJ9XX19")), "datasetFormat")
  @local_path = local_path
  Jsii::Type.check_type(@local_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "localPath")
  @exclude_features_attribute = exclude_features_attribute
  Jsii::Type.check_type(@exclude_features_attribute, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "excludeFeaturesAttribute") unless @exclude_features_attribute.nil?
  @s3_data_distribution_type = s3_data_distribution_type
  Jsii::Type.check_type(@s3_data_distribution_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3DataDistributionType") unless @s3_data_distribution_type.nil?
  @s3_input_mode = s3_input_mode
  Jsii::Type.check_type(@s3_input_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3InputMode") unless @s3_input_mode.nil?
end

Instance Attribute Details

#data_captured_destination_s3_uri ⇒ String (readonly)

The Amazon S3 location being used to capture the data.

Returns:

  • (String)

See Also:



681
682
683
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 681

def data_captured_destination_s3_uri
  @data_captured_destination_s3_uri
end

#dataset_format ⇒ AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnDataQualityJobDefinition::DatasetFormatProperty (readonly)

The dataset format for your batch transform job.

Returns:

See Also:



686
687
688
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 686

def dataset_format
  @dataset_format
end

#exclude_features_attribute ⇒ String? (readonly)

The attributes of the input data to exclude from the analysis.

Returns:

  • (String, nil)

See Also:



696
697
698
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 696

def exclude_features_attribute
  @exclude_features_attribute
end

#local_path ⇒ String (readonly)

Path to the filesystem where the batch transform data is available to the container.

Returns:

  • (String)

See Also:



691
692
693
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 691

def local_path
  @local_path
end

#s3_data_distribution_type ⇒ String? (readonly)

Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key.

Defaults to FullyReplicated

Returns:

  • (String, nil)

See Also:



703
704
705
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 703

def s3_data_distribution_type
  @s3_data_distribution_type
end

#s3_input_mode ⇒ String? (readonly)

Whether the Pipe or File is used as the input mode for transferring data for the monitoring job.

Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File .

Returns:

  • (String, nil)

See Also:



710
711
712
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 710

def s3_input_mode
  @s3_input_mode
end

Class Method Details

.jsii_properties ⇒ Object 



712
713
714
715
716
717
718
719
720
721
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 712

def self.jsii_properties
  {
    :data_captured_destination_s3_uri => "dataCapturedDestinationS3Uri",
    :dataset_format => "datasetFormat",
    :local_path => "localPath",
    :exclude_features_attribute => "excludeFeaturesAttribute",
    :s3_data_distribution_type => "s3DataDistributionType",
    :s3_input_mode => "s3InputMode",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



723
724
725
726
727
728
729
730
731
732
733
734
 
# File 'sagemaker/cfn_data_quality_job_definition.rb', line 723

def to_jsii
  result = {}
  result.merge!({
    "dataCapturedDestinationS3Uri" => @data_captured_destination_s3_uri,
    "datasetFormat" => @dataset_format,
    "localPath" => @local_path,
    "excludeFeaturesAttribute" => @exclude_features_attribute,
    "s3DataDistributionType" => @s3_data_distribution_type,
    "s3InputMode" => @s3_input_mode,
  })
  result.compact
end