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

Class RecommendationJobInputConfig

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.RecommendationJobInputConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RecommendationJobInputConfig.Builder,RecommendationJobInputConfig>
@Generated("software.amazon.awssdk:codegen") public final class RecommendationJobInputConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RecommendationJobInputConfig.Builder,RecommendationJobInputConfig>

The input configuration of the recommendation job.

See Also:

  • Method Details

    • modelPackageVersionArn

      public final String modelPackageVersionArn()

      The Amazon Resource Name (ARN) of a versioned model package.

      Returns:
      The Amazon Resource Name (ARN) of a versioned model package.

    • jobDurationInSeconds

      public final Integer jobDurationInSeconds()

      Specifies the maximum duration of the job, in seconds. The maximum value is 18,000 seconds.

      Returns:
      Specifies the maximum duration of the job, in seconds. The maximum value is 18,000 seconds.

    • trafficPattern

      public final TrafficPattern trafficPattern()

      Specifies the traffic pattern of the job.

      Returns:
      Specifies the traffic pattern of the job.

    • resourceLimit

      public final RecommendationJobResourceLimit resourceLimit()

      Defines the resource limit of the job.

      Returns:
      Defines the resource limit of the job.

    • hasEndpointConfigurations

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

    • endpointConfigurations

      public final List<EndpointInputConfiguration> endpointConfigurations()

      Specifies the endpoint configuration to use for a job.

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

      Returns:
      Specifies the endpoint configuration to use for a job.

    • volumeKmsKeyId

      public final String volumeKmsKeyId()

      The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. This key will be passed to SageMaker Hosting for endpoint creation.

      The SageMaker execution role must have kms:CreateGrant permission in order to encrypt data on the storage volume of the endpoints created for inference recommendation. The inference recommendation job will fail asynchronously during endpoint configuration creation if the role passed does not have kms:CreateGrant permission.

      The KmsKeyId can be any of the following formats:

      • // KMS Key ID

        "1234abcd-12ab-34cd-56ef-1234567890ab"

      • // Amazon Resource Name (ARN) of a KMS Key

        "arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"

      • // KMS Key Alias

        "alias/ExampleAlias"

      • // Amazon Resource Name (ARN) of a KMS Key Alias

        "arn:aws:kms:<region>:<account>:alias/<ExampleAlias>"

      For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

      Returns:
      The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. This key will be passed to SageMaker Hosting for endpoint creation.

      The SageMaker execution role must have kms:CreateGrant permission in order to encrypt data on the storage volume of the endpoints created for inference recommendation. The inference recommendation job will fail asynchronously during endpoint configuration creation if the role passed does not have kms:CreateGrant permission.

      The KmsKeyId can be any of the following formats:

      • // KMS Key ID

        "1234abcd-12ab-34cd-56ef-1234567890ab"

      • // Amazon Resource Name (ARN) of a KMS Key

        "arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"

      • // KMS Key Alias

        "alias/ExampleAlias"

      • // Amazon Resource Name (ARN) of a KMS Key Alias

        "arn:aws:kms:<region>:<account>:alias/<ExampleAlias>"

      For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

    • containerConfig

      public final RecommendationJobContainerConfig containerConfig()

      Specifies mandatory fields for running an Inference Recommender job. The fields specified in ContainerConfig override the corresponding fields in the model package.

      Returns:
      Specifies mandatory fields for running an Inference Recommender job. The fields specified in ContainerConfig override the corresponding fields in the model package.

    • hasEndpoints

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

    • endpoints

      public final List<EndpointInfo> endpoints()

      Existing customer endpoints on which to run an Inference Recommender job.

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

      Returns:
      Existing customer endpoints on which to run an Inference Recommender job.

    • vpcConfig

      public final RecommendationJobVpcConfig vpcConfig()

      Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.

      Returns:
      Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.

    • modelName

      public final String modelName()

      The name of the created model.

      Returns:
      The name of the created model.

    • toBuilder

      public RecommendationJobInputConfig.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<RecommendationJobInputConfig.Builder,RecommendationJobInputConfig>
      Returns:
      a builder for type T

    • builder

      public static RecommendationJobInputConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RecommendationJobInputConfig.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.