software.amazon.awssdk.services.sagemaker.model

Class CreateEndpointConfigRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sagemaker.model.SageMakerRequest

software.amazon.awssdk.services.sagemaker.model.CreateEndpointConfigRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateEndpointConfigRequest.Builder,CreateEndpointConfigRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateEndpointConfigRequest
extends SageMakerRequest
implements ToCopyableBuilder<CreateEndpointConfigRequest.Builder,CreateEndpointConfigRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateEndpointConfigRequest.Builder

Method Summary

Modifier and Type	Method and Description
AsyncInferenceConfig	asyncInferenceConfig() Specifies configuration for how an endpoint performs asynchronous inference.
static CreateEndpointConfigRequest.Builder	builder()
DataCaptureConfig	dataCaptureConfig() Returns the value of the DataCaptureConfig property for this object.
String	endpointConfigName() The name of the endpoint configuration.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ExplainerConfig	explainerConfig() A member of CreateEndpointConfig that enables explainers.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasProductionVariants() For responses, this returns true if the service returned a value for the ProductionVariants property.
boolean	hasShadowProductionVariants() For responses, this returns true if the service returned a value for the ShadowProductionVariants property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
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.
List<ProductionVariant>	productionVariants() An array of ProductionVariant objects, one for each model that you want to host at this endpoint.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateEndpointConfigRequest.Builder>	serializableBuilderClass()
List<ProductionVariant>	shadowProductionVariants() An array of ProductionVariant objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants.
List<Tag>	tags() An array of key-value pairs.
CreateEndpointConfigRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

endpointConfigName

public final String endpointConfigName()

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.

hasProductionVariants

public final boolean hasProductionVariants()

For responses, this returns true if the service returned a value for the ProductionVariants 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.

productionVariants

public final List<ProductionVariant> productionVariants()

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

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

Returns:

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

dataCaptureConfig

public final DataCaptureConfig dataCaptureConfig()

Returns the value of the DataCaptureConfig property for this object.

Returns:

The value of the DataCaptureConfig property for this object.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags 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.

tags

public final List<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.

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

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.

kmsKeyId

public final 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.

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.

asyncInferenceConfig

public final 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.

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.

explainerConfig

public final ExplainerConfig explainerConfig()

A member of CreateEndpointConfig that enables explainers.

Returns:

A member of CreateEndpointConfig that enables explainers.

hasShadowProductionVariants

public final boolean hasShadowProductionVariants()

For responses, this returns true if the service returned a value for the ShadowProductionVariants 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.

shadowProductionVariants

public final List<ProductionVariant> shadowProductionVariants()

An array of ProductionVariant objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants. If you use this field, you can only specify one variant for ProductionVariants and one variant for ShadowProductionVariants.

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

Returns:

An array of ProductionVariant objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants. If you use this field, you can only specify one variant for ProductionVariants and one variant for ShadowProductionVariants.

toBuilder

public CreateEndpointConfigRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateEndpointConfigRequest.Builder,CreateEndpointConfigRequest>

Specified by:

toBuilder in class SageMakerRequest

builder

public static CreateEndpointConfigRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo