Interface UpdateModelPackageRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdateModelPackageRequest.Builder,UpdateModelPackageRequest>, SageMakerRequest.Builder, SdkBuilder<UpdateModelPackageRequest.Builder,UpdateModelPackageRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateModelPackageRequest
@Mutable @NotThreadSafe public static interface UpdateModelPackageRequest.Builder extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<UpdateModelPackageRequest.Builder,UpdateModelPackageRequest>

  • Method Details

    • modelPackageArn

      UpdateModelPackageRequest.Builder modelPackageArn(String modelPackageArn)

      The Amazon Resource Name (ARN) of the model package.

      Parameters:
      modelPackageArn - The Amazon Resource Name (ARN) of the model package.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modelApprovalStatus

      UpdateModelPackageRequest.Builder modelApprovalStatus(String modelApprovalStatus)

      The approval status of the model.

      Parameters:
      modelApprovalStatus - The approval status of the model.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • modelApprovalStatus

      UpdateModelPackageRequest.Builder modelApprovalStatus(ModelApprovalStatus modelApprovalStatus)

      The approval status of the model.

      Parameters:
      modelApprovalStatus - The approval status of the model.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • approvalDescription

      UpdateModelPackageRequest.Builder approvalDescription(String approvalDescription)

      A description for the approval status of the model.

      Parameters:
      approvalDescription - A description for the approval status of the model.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customerMetadataProperties

      UpdateModelPackageRequest.Builder customerMetadataProperties(Map<String,String> customerMetadataProperties)

      The metadata properties associated with the model package versions.

      Parameters:
      customerMetadataProperties - The metadata properties associated with the model package versions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customerMetadataPropertiesToRemove

      UpdateModelPackageRequest.Builder customerMetadataPropertiesToRemove(Collection<String> customerMetadataPropertiesToRemove)

      The metadata properties associated with the model package versions to remove.

      Parameters:
      customerMetadataPropertiesToRemove - The metadata properties associated with the model package versions to remove.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customerMetadataPropertiesToRemove

      UpdateModelPackageRequest.Builder customerMetadataPropertiesToRemove(String... customerMetadataPropertiesToRemove)

      The metadata properties associated with the model package versions to remove.

      Parameters:
      customerMetadataPropertiesToRemove - The metadata properties associated with the model package versions to remove.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalInferenceSpecificationsToAdd

      UpdateModelPackageRequest.Builder additionalInferenceSpecificationsToAdd(Collection<AdditionalInferenceSpecificationDefinition> additionalInferenceSpecificationsToAdd)

      An array of additional Inference Specification objects to be added to the existing array additional Inference Specification. Total number of additional Inference Specifications can not exceed 15. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

      Parameters:
      additionalInferenceSpecificationsToAdd - An array of additional Inference Specification objects to be added to the existing array additional Inference Specification. Total number of additional Inference Specifications can not exceed 15. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalInferenceSpecificationsToAdd

      UpdateModelPackageRequest.Builder additionalInferenceSpecificationsToAdd(AdditionalInferenceSpecificationDefinition... additionalInferenceSpecificationsToAdd)

      An array of additional Inference Specification objects to be added to the existing array additional Inference Specification. Total number of additional Inference Specifications can not exceed 15. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

      Parameters:
      additionalInferenceSpecificationsToAdd - An array of additional Inference Specification objects to be added to the existing array additional Inference Specification. Total number of additional Inference Specifications can not exceed 15. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalInferenceSpecificationsToAdd

      UpdateModelPackageRequest.Builder additionalInferenceSpecificationsToAdd(Consumer<AdditionalInferenceSpecificationDefinition.Builder>... additionalInferenceSpecificationsToAdd)

      An array of additional Inference Specification objects to be added to the existing array additional Inference Specification. Total number of additional Inference Specifications can not exceed 15. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

      This is a convenience method that creates an instance of the AdditionalInferenceSpecificationDefinition.Builder avoiding the need to create one manually via AdditionalInferenceSpecificationDefinition.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to additionalInferenceSpecificationsToAdd(List<AdditionalInferenceSpecificationDefinition>).

      Parameters:
      additionalInferenceSpecificationsToAdd - a consumer that will call methods on AdditionalInferenceSpecificationDefinition.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • inferenceSpecification

      UpdateModelPackageRequest.Builder inferenceSpecification(InferenceSpecification inferenceSpecification)

      Specifies details about inference jobs that you can run with models based on this model package, including the following information:

      • The Amazon ECR paths of containers that contain the inference code and model artifacts.

      • The instance types that the model package supports for transform jobs and real-time endpoints used for inference.

      • The input and output content formats that the model package supports for inference.

      Parameters:
      inferenceSpecification - Specifies details about inference jobs that you can run with models based on this model package, including the following information:

      • The Amazon ECR paths of containers that contain the inference code and model artifacts.

      • The instance types that the model package supports for transform jobs and real-time endpoints used for inference.

      • The input and output content formats that the model package supports for inference.

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

    • inferenceSpecification

      default UpdateModelPackageRequest.Builder inferenceSpecification(Consumer<InferenceSpecification.Builder> inferenceSpecification)

      Specifies details about inference jobs that you can run with models based on this model package, including the following information:

      • The Amazon ECR paths of containers that contain the inference code and model artifacts.

      • The instance types that the model package supports for transform jobs and real-time endpoints used for inference.

      • The input and output content formats that the model package supports for inference.

      This is a convenience method that creates an instance of the InferenceSpecification.Builder avoiding the need to create one manually via InferenceSpecification.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inferenceSpecification(InferenceSpecification).

      Parameters:
      inferenceSpecification - a consumer that will call methods on InferenceSpecification.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sourceUri

      UpdateModelPackageRequest.Builder sourceUri(String sourceUri)

      The URI of the source for the model package.

      Parameters:
      sourceUri - The URI of the source for the model package.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modelCard

      UpdateModelPackageRequest.Builder modelCard(ModelPackageModelCard modelCard)

      The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.

      Parameters:
      modelCard - The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modelCard

      default UpdateModelPackageRequest.Builder modelCard(Consumer<ModelPackageModelCard.Builder> modelCard)

      The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.

      This is a convenience method that creates an instance of the ModelPackageModelCard.Builder avoiding the need to create one manually via ModelPackageModelCard.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to modelCard(ModelPackageModelCard).

      Parameters:
      modelCard - a consumer that will call methods on ModelPackageModelCard.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • modelLifeCycle

      UpdateModelPackageRequest.Builder modelLifeCycle(ModelLifeCycle modelLifeCycle)

      A structure describing the current state of the model in its life cycle.

      Parameters:
      modelLifeCycle - A structure describing the current state of the model in its life cycle.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modelLifeCycle

      default UpdateModelPackageRequest.Builder modelLifeCycle(Consumer<ModelLifeCycle.Builder> modelLifeCycle)

      A structure describing the current state of the model in its life cycle.

      This is a convenience method that creates an instance of the ModelLifeCycle.Builder avoiding the need to create one manually via ModelLifeCycle.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to modelLifeCycle(ModelLifeCycle).

      Parameters:
      modelLifeCycle - a consumer that will call methods on ModelLifeCycle.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientToken

      UpdateModelPackageRequest.Builder clientToken(String clientToken)

      A unique token that guarantees that the call to this API is idempotent.

      Parameters:
      clientToken - A unique token that guarantees that the call to this API is idempotent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      UpdateModelPackageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateModelPackageRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.