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

Class CreateCompilationJobRequest

    • Method Detail

      • compilationJobName

        public final String compilationJobName()

        A name for the model compilation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.

        Returns:
        A name for the model compilation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.

      • 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 compilation, 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 compilation, 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.

      • modelPackageVersionArn

        public final String modelPackageVersionArn()

        The Amazon Resource Name (ARN) of a versioned model package. Provide either a ModelPackageVersionArn or an InputConfig object in the request syntax. The presence of both objects in the CreateCompilationJob request will return an exception.

        Returns:
        The Amazon Resource Name (ARN) of a versioned model package. Provide either a ModelPackageVersionArn or an InputConfig object in the request syntax. The presence of both objects in the CreateCompilationJob request will return an exception.

      • inputConfig

        public final InputConfig inputConfig()

        Provides information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

        Returns:
        Provides information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

      • outputConfig

        public final OutputConfig outputConfig()

        Provides information about the output location for the compiled model and the target device the model runs on.

        Returns:
        Provides information about the output location for the compiled model and the target device the model runs on.

      • stoppingCondition

        public final StoppingCondition stoppingCondition()

        Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker AI ends the compilation job. Use this API to cap model training costs.

        Returns:
        Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker AI ends the compilation job. Use this API to cap model training costs.

      • 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()

        An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

        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:
        An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

      • 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