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

Class CreateOptimizationJobRequest

    • Method Detail

      • optimizationJobName

        public final String optimizationJobName()

        A custom name for the new optimization job.

        Returns:
        A custom name for the new optimization job.

      • roleArn

        public final String roleArn()

        The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.

        During model optimization, Amazon SageMaker AI needs your permission to:

        • Read input data from an S3 bucket

        • Write model artifacts to an S3 bucket

        • Write logs to Amazon CloudWatch Logs

        • Publish metrics to Amazon CloudWatch

        You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker AI, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker AI Roles.

        Returns:
        The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.

        During model optimization, Amazon SageMaker AI needs your permission to:

        • Read input data from an S3 bucket

        • Write model artifacts to an S3 bucket

        • Write logs to Amazon CloudWatch Logs

        • Publish metrics to Amazon CloudWatch

        You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker AI, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker AI Roles.

      • modelSource

        public final OptimizationJobModelSource modelSource()

        The location of the source model to optimize with an optimization job.

        Returns:
        The location of the source model to optimize with an optimization job.

      • hasOptimizationEnvironment

        public final boolean hasOptimizationEnvironment()
        For responses, this returns true if the service returned a value for the OptimizationEnvironment 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.

      • optimizationEnvironment

        public final Map<String,​String> optimizationEnvironment()

        The environment variables to set in the model container.

        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 hasOptimizationEnvironment() method.

        Returns:
        The environment variables to set in the model container.

      • hasOptimizationConfigs

        public final boolean hasOptimizationConfigs()
        For responses, this returns true if the service returned a value for the OptimizationConfigs 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.

      • optimizationConfigs

        public final List<OptimizationConfig> optimizationConfigs()

        Settings for each of the optimization techniques that the job applies.

        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 hasOptimizationConfigs() method.

        Returns:
        Settings for each of the optimization techniques that the job applies.

      • outputConfig

        public final OptimizationJobOutputConfig outputConfig()

        Details for where to store the optimized model that you create with the optimization job.

        Returns:
        Details for where to store the optimized model that you create with the optimization job.

      • stoppingCondition

        public final StoppingCondition stoppingCondition()
        Returns the value of the StoppingCondition property for this object.
        Returns:
        The value of the StoppingCondition property for this object.

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags 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.

      • tags

        public final List<Tag> tags()

        A list of key-value pairs associated with the optimization job. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

        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 hasTags() method.

        Returns:
        A list of key-value pairs associated with the optimization job. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

      • vpcConfig

        public final OptimizationVpcConfig vpcConfig()

        A VPC in Amazon VPC that your optimized model has access to.

        Returns:
        A VPC in Amazon VPC that your optimized model has access to.

      • 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