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

Interface CreateCompilationJobRequest.Builder

    • Method Detail

      • compilationJobName

        CreateCompilationJobRequest.Builder compilationJobName​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • roleArn

        CreateCompilationJobRequest.Builder roleArn​(String roleArn)

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

        During model compilation, Amazon SageMaker 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, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker Roles.

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

        During model compilation, Amazon SageMaker 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, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker Roles.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • modelPackageVersionArn

        CreateCompilationJobRequest.Builder modelPackageVersionArn​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • inputConfig

        CreateCompilationJobRequest.Builder inputConfig​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • outputConfig

        CreateCompilationJobRequest.Builder outputConfig​(OutputConfig outputConfig)

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

        Parameters:
        outputConfig - Provides information about the output location for the compiled model and the target device the model runs on.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • stoppingCondition

        CreateCompilationJobRequest.Builder stoppingCondition​(StoppingCondition stoppingCondition)

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

        Parameters:
        stoppingCondition - Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateCompilationJobRequest.Builder tags​(Collection<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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateCompilationJobRequest.Builder tags​(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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.