com.amazonaws.services.sagemaker.model

Class RecommendationJobInputConfig

java.lang.Object

com.amazonaws.services.sagemaker.model.RecommendationJobInputConfig

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RecommendationJobInputConfig
extends Object
implements Serializable, Cloneable, StructuredPojo

The input configuration of the recommendation job.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
RecommendationJobInputConfig()

Method Summary

Modifier and Type	Method and Description
RecommendationJobInputConfig	clone()
boolean	equals(Object obj)
List<EndpointInputConfiguration>	getEndpointConfigurations() Specifies the endpoint configuration to use for a job.
Integer	getJobDurationInSeconds() Specifies the maximum duration of the job, in seconds.>
String	getModelPackageVersionArn() The Amazon Resource Name (ARN) of a versioned model package.
RecommendationJobResourceLimit	getResourceLimit() Defines the resource limit of the job.
TrafficPattern	getTrafficPattern() Specifies the traffic pattern of the job.
String	getVolumeKmsKeyId() 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.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setEndpointConfigurations(Collection<EndpointInputConfiguration> endpointConfigurations) Specifies the endpoint configuration to use for a job.
void	setJobDurationInSeconds(Integer jobDurationInSeconds) Specifies the maximum duration of the job, in seconds.>
void	setModelPackageVersionArn(String modelPackageVersionArn) The Amazon Resource Name (ARN) of a versioned model package.
void	setResourceLimit(RecommendationJobResourceLimit resourceLimit) Defines the resource limit of the job.
void	setTrafficPattern(TrafficPattern trafficPattern) Specifies the traffic pattern of the job.
void	setVolumeKmsKeyId(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.
String	toString() Returns a string representation of this object.
RecommendationJobInputConfig	withEndpointConfigurations(Collection<EndpointInputConfiguration> endpointConfigurations) Specifies the endpoint configuration to use for a job.
RecommendationJobInputConfig	withEndpointConfigurations(EndpointInputConfiguration... endpointConfigurations) Specifies the endpoint configuration to use for a job.
RecommendationJobInputConfig	withJobDurationInSeconds(Integer jobDurationInSeconds) Specifies the maximum duration of the job, in seconds.>
RecommendationJobInputConfig	withModelPackageVersionArn(String modelPackageVersionArn) The Amazon Resource Name (ARN) of a versioned model package.
RecommendationJobInputConfig	withResourceLimit(RecommendationJobResourceLimit resourceLimit) Defines the resource limit of the job.
RecommendationJobInputConfig	withTrafficPattern(TrafficPattern trafficPattern) Specifies the traffic pattern of the job.
RecommendationJobInputConfig	withVolumeKmsKeyId(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.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RecommendationJobInputConfig

public RecommendationJobInputConfig()

Method Detail

setModelPackageVersionArn

public void setModelPackageVersionArn(String modelPackageVersionArn)

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

Parameters:

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

getModelPackageVersionArn

public String getModelPackageVersionArn()

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

Returns:

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

withModelPackageVersionArn

public RecommendationJobInputConfig withModelPackageVersionArn(String modelPackageVersionArn)

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

Parameters:

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

Returns:

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

setJobDurationInSeconds

public void setJobDurationInSeconds(Integer jobDurationInSeconds)

Specifies the maximum duration of the job, in seconds.>

Parameters:

jobDurationInSeconds - Specifies the maximum duration of the job, in seconds.>

getJobDurationInSeconds

public Integer getJobDurationInSeconds()

Specifies the maximum duration of the job, in seconds.>

Returns:

Specifies the maximum duration of the job, in seconds.>

withJobDurationInSeconds

public RecommendationJobInputConfig withJobDurationInSeconds(Integer jobDurationInSeconds)

Specifies the maximum duration of the job, in seconds.>

Parameters:

jobDurationInSeconds - Specifies the maximum duration of the job, in seconds.>

Returns:

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

setTrafficPattern

public void setTrafficPattern(TrafficPattern trafficPattern)

Specifies the traffic pattern of the job.

Parameters:

trafficPattern - Specifies the traffic pattern of the job.

getTrafficPattern

public TrafficPattern getTrafficPattern()

Specifies the traffic pattern of the job.

Returns:

Specifies the traffic pattern of the job.

withTrafficPattern

public RecommendationJobInputConfig withTrafficPattern(TrafficPattern trafficPattern)

Specifies the traffic pattern of the job.

Parameters:

trafficPattern - Specifies the traffic pattern of the job.

Returns:

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

setResourceLimit

public void setResourceLimit(RecommendationJobResourceLimit resourceLimit)

Defines the resource limit of the job.

Parameters:

resourceLimit - Defines the resource limit of the job.

getResourceLimit

public RecommendationJobResourceLimit getResourceLimit()

Defines the resource limit of the job.

Returns:

Defines the resource limit of the job.

withResourceLimit

public RecommendationJobInputConfig withResourceLimit(RecommendationJobResourceLimit resourceLimit)

Defines the resource limit of the job.

Parameters:

resourceLimit - Defines the resource limit of the job.

Returns:

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

getEndpointConfigurations

public List<EndpointInputConfiguration> getEndpointConfigurations()

Specifies the endpoint configuration to use for a job.

Returns:

Specifies the endpoint configuration to use for a job.

setEndpointConfigurations

public void setEndpointConfigurations(Collection<EndpointInputConfiguration> endpointConfigurations)

Specifies the endpoint configuration to use for a job.

Parameters:

endpointConfigurations - Specifies the endpoint configuration to use for a job.

withEndpointConfigurations

public RecommendationJobInputConfig withEndpointConfigurations(EndpointInputConfiguration... endpointConfigurations)

Specifies the endpoint configuration to use for a job.

NOTE: This method appends the values to the existing list (if any). Use setEndpointConfigurations(java.util.Collection) or withEndpointConfigurations(java.util.Collection) if you want to override the existing values.

Parameters:

endpointConfigurations - Specifies the endpoint configuration to use for a job.

Returns:

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

withEndpointConfigurations

public RecommendationJobInputConfig withEndpointConfigurations(Collection<EndpointInputConfiguration> endpointConfigurations)

Specifies the endpoint configuration to use for a job.

Parameters:

endpointConfigurations - Specifies the endpoint configuration to use for a job.

Returns:

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

setVolumeKmsKeyId

public void setVolumeKmsKeyId(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.

Parameters:

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.

getVolumeKmsKeyId

public String getVolumeKmsKeyId()

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.

withVolumeKmsKeyId

public RecommendationJobInputConfig withVolumeKmsKeyId(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.

Parameters:

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:

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

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public RecommendationJobInputConfig clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.