com.amazonaws.services.sagemaker.model

Class CreateEndpointConfigRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sagemaker.model.CreateEndpointConfigRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateEndpointConfigRequest()

Method Summary

Modifier and Type	Method and Description
CreateEndpointConfigRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
AsyncInferenceConfig	getAsyncInferenceConfig() Specifies configuration for how an endpoint performs asynchronous inference.
DataCaptureConfig	getDataCaptureConfig()
String	getEndpointConfigName() The name of the endpoint configuration.
String	getKmsKeyId() The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.
List<ProductionVariant>	getProductionVariants() An list of ProductionVariant objects, one for each model that you want to host at this endpoint.
List<Tag>	getTags() An array of key-value pairs.
int	hashCode()
void	setAsyncInferenceConfig(AsyncInferenceConfig asyncInferenceConfig) Specifies configuration for how an endpoint performs asynchronous inference.
void	setDataCaptureConfig(DataCaptureConfig dataCaptureConfig)
void	setEndpointConfigName(String endpointConfigName) The name of the endpoint configuration.
void	setKmsKeyId(String kmsKeyId) The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.
void	setProductionVariants(Collection<ProductionVariant> productionVariants) An list of ProductionVariant objects, one for each model that you want to host at this endpoint.
void	setTags(Collection<Tag> tags) An array of key-value pairs.
String	toString() Returns a string representation of this object.
CreateEndpointConfigRequest	withAsyncInferenceConfig(AsyncInferenceConfig asyncInferenceConfig) Specifies configuration for how an endpoint performs asynchronous inference.
CreateEndpointConfigRequest	withDataCaptureConfig(DataCaptureConfig dataCaptureConfig)
CreateEndpointConfigRequest	withEndpointConfigName(String endpointConfigName) The name of the endpoint configuration.
CreateEndpointConfigRequest	withKmsKeyId(String kmsKeyId) The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.
CreateEndpointConfigRequest	withProductionVariants(Collection<ProductionVariant> productionVariants) An list of ProductionVariant objects, one for each model that you want to host at this endpoint.
CreateEndpointConfigRequest	withProductionVariants(ProductionVariant... productionVariants) An list of ProductionVariant objects, one for each model that you want to host at this endpoint.
CreateEndpointConfigRequest	withTags(Collection<Tag> tags) An array of key-value pairs.
CreateEndpointConfigRequest	withTags(Tag... tags) An array of key-value pairs.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateEndpointConfigRequest

public CreateEndpointConfigRequest()

Method Detail

setEndpointConfigName

public void setEndpointConfigName(String endpointConfigName)

The name of the endpoint configuration. You specify this name in a CreateEndpoint request.

Parameters:

endpointConfigName - The name of the endpoint configuration. You specify this name in a CreateEndpoint request.

getEndpointConfigName

public String getEndpointConfigName()

The name of the endpoint configuration. You specify this name in a CreateEndpoint request.

Returns:

The name of the endpoint configuration. You specify this name in a CreateEndpoint request.

withEndpointConfigName

public CreateEndpointConfigRequest withEndpointConfigName(String endpointConfigName)

The name of the endpoint configuration. You specify this name in a CreateEndpoint request.

Parameters:

endpointConfigName - The name of the endpoint configuration. You specify this name in a CreateEndpoint request.

Returns:

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

getProductionVariants

public List<ProductionVariant> getProductionVariants()

An list of ProductionVariant objects, one for each model that you want to host at this endpoint.

Returns:

An list of ProductionVariant objects, one for each model that you want to host at this endpoint.

setProductionVariants

public void setProductionVariants(Collection<ProductionVariant> productionVariants)

An list of ProductionVariant objects, one for each model that you want to host at this endpoint.

Parameters:

productionVariants - An list of ProductionVariant objects, one for each model that you want to host at this endpoint.

withProductionVariants

public CreateEndpointConfigRequest withProductionVariants(ProductionVariant... productionVariants)

An list of ProductionVariant objects, one for each model that you want to host at this endpoint.

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

Parameters:

productionVariants - An list of ProductionVariant objects, one for each model that you want to host at this endpoint.

Returns:

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

withProductionVariants

public CreateEndpointConfigRequest withProductionVariants(Collection<ProductionVariant> productionVariants)

An list of ProductionVariant objects, one for each model that you want to host at this endpoint.

Parameters:

productionVariants - An list of ProductionVariant objects, one for each model that you want to host at this endpoint.

Returns:

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

setDataCaptureConfig

public void setDataCaptureConfig(DataCaptureConfig dataCaptureConfig)

Parameters:

dataCaptureConfig -

getDataCaptureConfig

public DataCaptureConfig getDataCaptureConfig()

Returns:

withDataCaptureConfig

public CreateEndpointConfigRequest withDataCaptureConfig(DataCaptureConfig dataCaptureConfig)

Parameters:

dataCaptureConfig -

Returns:

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

getTags

public List<Tag> getTags()

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:

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.

setTags

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

withTags

public CreateEndpointConfigRequest withTags(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.

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

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.

withTags

public CreateEndpointConfigRequest withTags(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.

setKmsKeyId

public void setKmsKeyId(String kmsKeyId)

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

The KmsKeyId can be any of the following formats:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

• Alias name: alias/ExampleAlias

• Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint, UpdateEndpoint requests. For more information, refer to the Amazon Web Services Key Management Service section Using Key Policies in Amazon Web Services KMS

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a KmsKeyId when using an instance type with local storage. If any of the models that you specify in the ProductionVariants parameter use nitro-based instances with local storage, do not specify a value for the KmsKeyId parameter. If you specify a value for KmsKeyId when using any nitro-based instances with local storage, the call to CreateEndpointConfig fails.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

Parameters:

kmsKeyId - The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.

The KmsKeyId can be any of the following formats:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

• Alias name: alias/ExampleAlias

• Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint, UpdateEndpoint requests. For more information, refer to the Amazon Web Services Key Management Service section Using Key Policies in Amazon Web Services KMS

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a KmsKeyId when using an instance type with local storage. If any of the models that you specify in the ProductionVariants parameter use nitro-based instances with local storage, do not specify a value for the KmsKeyId parameter. If you specify a value for KmsKeyId when using any nitro-based instances with local storage, the call to CreateEndpointConfig fails.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

getKmsKeyId

public String getKmsKeyId()

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

The KmsKeyId can be any of the following formats:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

• Alias name: alias/ExampleAlias

• Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint, UpdateEndpoint requests. For more information, refer to the Amazon Web Services Key Management Service section Using Key Policies in Amazon Web Services KMS

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a KmsKeyId when using an instance type with local storage. If any of the models that you specify in the ProductionVariants parameter use nitro-based instances with local storage, do not specify a value for the KmsKeyId parameter. If you specify a value for KmsKeyId when using any nitro-based instances with local storage, the call to CreateEndpointConfig fails.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

Returns:

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

The KmsKeyId can be any of the following formats:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

• Alias name: alias/ExampleAlias

• Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint, UpdateEndpoint requests. For more information, refer to the Amazon Web Services Key Management Service section Using Key Policies in Amazon Web Services KMS

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a KmsKeyId when using an instance type with local storage. If any of the models that you specify in the ProductionVariants parameter use nitro-based instances with local storage, do not specify a value for the KmsKeyId parameter. If you specify a value for KmsKeyId when using any nitro-based instances with local storage, the call to CreateEndpointConfig fails.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

withKmsKeyId

public CreateEndpointConfigRequest withKmsKeyId(String kmsKeyId)

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

The KmsKeyId can be any of the following formats:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

• Alias name: alias/ExampleAlias

• Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint, UpdateEndpoint requests. For more information, refer to the Amazon Web Services Key Management Service section Using Key Policies in Amazon Web Services KMS

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a KmsKeyId when using an instance type with local storage. If any of the models that you specify in the ProductionVariants parameter use nitro-based instances with local storage, do not specify a value for the KmsKeyId parameter. If you specify a value for KmsKeyId when using any nitro-based instances with local storage, the call to CreateEndpointConfig fails.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

Parameters:

kmsKeyId - The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.

The KmsKeyId can be any of the following formats:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

• Alias name: alias/ExampleAlias

• Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint, UpdateEndpoint requests. For more information, refer to the Amazon Web Services Key Management Service section Using Key Policies in Amazon Web Services KMS

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a KmsKeyId when using an instance type with local storage. If any of the models that you specify in the ProductionVariants parameter use nitro-based instances with local storage, do not specify a value for the KmsKeyId parameter. If you specify a value for KmsKeyId when using any nitro-based instances with local storage, the call to CreateEndpointConfig fails.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

Returns:

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

setAsyncInferenceConfig

public void setAsyncInferenceConfig(AsyncInferenceConfig asyncInferenceConfig)

Specifies configuration for how an endpoint performs asynchronous inference. This is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync.

Parameters:

asyncInferenceConfig - Specifies configuration for how an endpoint performs asynchronous inference. This is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync.

getAsyncInferenceConfig

public AsyncInferenceConfig getAsyncInferenceConfig()

Specifies configuration for how an endpoint performs asynchronous inference. This is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync.

Returns:

Specifies configuration for how an endpoint performs asynchronous inference. This is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync.

withAsyncInferenceConfig

public CreateEndpointConfigRequest withAsyncInferenceConfig(AsyncInferenceConfig asyncInferenceConfig)

Specifies configuration for how an endpoint performs asynchronous inference. This is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync.

Parameters:

asyncInferenceConfig - Specifies configuration for how an endpoint performs asynchronous inference. This is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync.

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 CreateEndpointConfigRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()