Package software.amazon.awssdk.services.neptunedata.model

Class StartMlModelTransformJobRequest

    • Method Detail

      • id

        public final String id()

        A unique identifier for the new job. The default is an autogenerated UUID.

        Returns:
        A unique identifier for the new job. The default is an autogenerated UUID.

      • dataProcessingJobId

        public final String dataProcessingJobId()

        The job ID of a completed data-processing job. You must include either dataProcessingJobId and a mlModelTrainingJobId, or a trainingJobName.

        Returns:
        The job ID of a completed data-processing job. You must include either dataProcessingJobId and a mlModelTrainingJobId, or a trainingJobName.

      • mlModelTrainingJobId

        public final String mlModelTrainingJobId()

        The job ID of a completed model-training job. You must include either dataProcessingJobId and a mlModelTrainingJobId, or a trainingJobName.

        Returns:
        The job ID of a completed model-training job. You must include either dataProcessingJobId and a mlModelTrainingJobId, or a trainingJobName.

      • trainingJobName

        public final String trainingJobName()

        The name of a completed SageMaker training job. You must include either dataProcessingJobId and a mlModelTrainingJobId, or a trainingJobName.

        Returns:
        The name of a completed SageMaker training job. You must include either dataProcessingJobId and a mlModelTrainingJobId, or a trainingJobName.

      • modelTransformOutputS3Location

        public final String modelTransformOutputS3Location()

        The location in Amazon S3 where the model artifacts are to be stored.

        Returns:
        The location in Amazon S3 where the model artifacts are to be stored.

      • sagemakerIamRoleArn

        public final String sagemakerIamRoleArn()

        The ARN of an IAM role for SageMaker execution. This must be listed in your DB cluster parameter group or an error will occur.

        Returns:
        The ARN of an IAM role for SageMaker execution. This must be listed in your DB cluster parameter group or an error will occur.

      • neptuneIamRoleArn

        public final String neptuneIamRoleArn()

        The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.

        Returns:
        The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.

      • customModelTransformParameters

        public final CustomModelTransformParameters customModelTransformParameters()

        Configuration information for a model transform using a custom model. The customModelTransformParameters object contains the following fields, which must have values compatible with the saved model parameters from the training job:

        Returns:
        Configuration information for a model transform using a custom model. The customModelTransformParameters object contains the following fields, which must have values compatible with the saved model parameters from the training job:

      • baseProcessingInstanceType

        public final String baseProcessingInstanceType()

        The type of ML instance used in preparing and managing training of ML models. This is an ML compute instance chosen based on memory requirements for processing the training data and model.

        Returns:
        The type of ML instance used in preparing and managing training of ML models. This is an ML compute instance chosen based on memory requirements for processing the training data and model.

      • baseProcessingInstanceVolumeSizeInGB

        public final Integer baseProcessingInstanceVolumeSizeInGB()

        The disk volume size of the training instance in gigabytes. The default is 0. Both input data and the output model are stored on disk, so the volume size must be large enough to hold both data sets. If not specified or 0, Neptune ML selects a disk volume size based on the recommendation generated in the data processing step.

        Returns:
        The disk volume size of the training instance in gigabytes. The default is 0. Both input data and the output model are stored on disk, so the volume size must be large enough to hold both data sets. If not specified or 0, Neptune ML selects a disk volume size based on the recommendation generated in the data processing step.

      • hasSubnets

        public final boolean hasSubnets()
        For responses, this returns true if the service returned a value for the Subnets property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • subnets

        public final List<String> subnets()

        The IDs of the subnets in the Neptune VPC. The default is None.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSubnets() method.

        Returns:
        The IDs of the subnets in the Neptune VPC. The default is None.

      • hasSecurityGroupIds

        public final boolean hasSecurityGroupIds()
        For responses, this returns true if the service returned a value for the SecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • securityGroupIds

        public final List<String> securityGroupIds()

        The VPC security group IDs. The default is None.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSecurityGroupIds() method.

        Returns:
        The VPC security group IDs. The default is None.

      • volumeEncryptionKMSKey

        public final String volumeEncryptionKMSKey()

        The Amazon Key Management Service (KMS) key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instances that run the training job. The default is None.

        Returns:
        The Amazon Key Management Service (KMS) key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instances that run the training job. The default is None.

      • s3OutputEncryptionKMSKey

        public final String s3OutputEncryptionKMSKey()

        The Amazon Key Management Service (KMS) key that SageMaker uses to encrypt the output of the processing job. The default is none.

        Returns:
        The Amazon Key Management Service (KMS) key that SageMaker uses to encrypt the output of the processing job. The default is none.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object