Package software.amazon.awssdk.services.sagemaker.model

Interface ProcessingS3Input.Builder

    • Method Detail

      • s3Uri

        ProcessingS3Input.Builder s3Uri​(String s3Uri)

        The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.

        Parameters:
        s3Uri - The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • localPath

        ProcessingS3Input.Builder localPath​(String localPath)

        The local path in your container where you want Amazon SageMaker to write input data to. LocalPath is an absolute path to the input data and must begin with /opt/ml/processing/. LocalPath is a required parameter when AppManaged is False (default).

        Parameters:
        localPath - The local path in your container where you want Amazon SageMaker to write input data to. LocalPath is an absolute path to the input data and must begin with /opt/ml/processing/. LocalPath is a required parameter when AppManaged is False (default).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • s3DataType

        ProcessingS3Input.Builder s3DataType​(String s3DataType)

        Whether you use an S3Prefix or a ManifestFile for the data type. If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing job. If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for the processing job.

        Parameters:
        s3DataType - Whether you use an S3Prefix or a ManifestFile for the data type. If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing job. If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for the processing job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ProcessingS3DataType, ProcessingS3DataType

      • s3DataType

        ProcessingS3Input.Builder s3DataType​(ProcessingS3DataType s3DataType)

        Whether you use an S3Prefix or a ManifestFile for the data type. If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing job. If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for the processing job.

        Parameters:
        s3DataType - Whether you use an S3Prefix or a ManifestFile for the data type. If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing job. If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for the processing job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ProcessingS3DataType, ProcessingS3DataType

      • s3InputMode

        ProcessingS3Input.Builder s3InputMode​(String s3InputMode)

        Whether to use File or Pipe input mode. In File mode, Amazon SageMaker copies the data from the input source onto the local ML storage volume before starting your processing container. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your processing container into named pipes without using the ML storage volume.

        Parameters:
        s3InputMode - Whether to use File or Pipe input mode. In File mode, Amazon SageMaker copies the data from the input source onto the local ML storage volume before starting your processing container. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your processing container into named pipes without using the ML storage volume.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ProcessingS3InputMode, ProcessingS3InputMode

      • s3InputMode

        ProcessingS3Input.Builder s3InputMode​(ProcessingS3InputMode s3InputMode)

        Whether to use File or Pipe input mode. In File mode, Amazon SageMaker copies the data from the input source onto the local ML storage volume before starting your processing container. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your processing container into named pipes without using the ML storage volume.

        Parameters:
        s3InputMode - Whether to use File or Pipe input mode. In File mode, Amazon SageMaker copies the data from the input source onto the local ML storage volume before starting your processing container. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your processing container into named pipes without using the ML storage volume.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ProcessingS3InputMode, ProcessingS3InputMode

      • s3DataDistributionType

        ProcessingS3Input.Builder s3DataDistributionType​(String s3DataDistributionType)

        Whether to distribute the data from Amazon S3 to all processing instances with FullyReplicated, or whether the data from Amazon S3 is shared by Amazon S3 key, downloading one shard of data to each processing instance.

        Parameters:
        s3DataDistributionType - Whether to distribute the data from Amazon S3 to all processing instances with FullyReplicated, or whether the data from Amazon S3 is shared by Amazon S3 key, downloading one shard of data to each processing instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ProcessingS3DataDistributionType, ProcessingS3DataDistributionType

      • s3DataDistributionType

        ProcessingS3Input.Builder s3DataDistributionType​(ProcessingS3DataDistributionType s3DataDistributionType)

        Whether to distribute the data from Amazon S3 to all processing instances with FullyReplicated, or whether the data from Amazon S3 is shared by Amazon S3 key, downloading one shard of data to each processing instance.

        Parameters:
        s3DataDistributionType - Whether to distribute the data from Amazon S3 to all processing instances with FullyReplicated, or whether the data from Amazon S3 is shared by Amazon S3 key, downloading one shard of data to each processing instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ProcessingS3DataDistributionType, ProcessingS3DataDistributionType

      • s3CompressionType

        ProcessingS3Input.Builder s3CompressionType​(String s3CompressionType)

        Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container. Gzip can only be used when Pipe mode is specified as the S3InputMode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your container without using the EBS volume.

        Parameters:
        s3CompressionType - Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container. Gzip can only be used when Pipe mode is specified as the S3InputMode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your container without using the EBS volume.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ProcessingS3CompressionType, ProcessingS3CompressionType

      • s3CompressionType

        ProcessingS3Input.Builder s3CompressionType​(ProcessingS3CompressionType s3CompressionType)

        Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container. Gzip can only be used when Pipe mode is specified as the S3InputMode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your container without using the EBS volume.

        Parameters:
        s3CompressionType - Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container. Gzip can only be used when Pipe mode is specified as the S3InputMode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your container without using the EBS volume.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ProcessingS3CompressionType, ProcessingS3CompressionType