software.amazon.awssdk.services.sagemaker.model

Class DataCaptureConfig

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.DataCaptureConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DataCaptureConfig.Builder,DataCaptureConfig>

@Generated(value="software.amazon.awssdk:codegen")
public final class DataCaptureConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DataCaptureConfig.Builder,DataCaptureConfig>

Configuration to control how SageMaker captures inference data.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DataCaptureConfig.Builder

Method Summary

Modifier and Type	Method and Description
static DataCaptureConfig.Builder	builder()
CaptureContentTypeHeader	captureContentTypeHeader() Configuration specifying how to treat different headers.
List<CaptureOption>	captureOptions() Specifies data Model Monitor will capture.
String	destinationS3Uri() The Amazon S3 location used to capture the data.
Boolean	enableCapture() Whether data capture should be enabled or disabled (defaults to enabled).
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCaptureOptions() For responses, this returns true if the service returned a value for the CaptureOptions property.
int	hashCode()
Integer	initialSamplingPercentage() The percentage of requests SageMaker will capture.
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<SdkField<?>>	sdkFields()
static Class<? extends DataCaptureConfig.Builder>	serializableBuilderClass()
DataCaptureConfig.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

enableCapture

public final Boolean enableCapture()

Whether data capture should be enabled or disabled (defaults to enabled).

Returns:

Whether data capture should be enabled or disabled (defaults to enabled).

initialSamplingPercentage

public final Integer initialSamplingPercentage()

The percentage of requests SageMaker will capture. A lower value is recommended for Endpoints with high traffic.

Returns:

The percentage of requests SageMaker will capture. A lower value is recommended for Endpoints with high traffic.

destinationS3Uri

public final String destinationS3Uri()

The Amazon S3 location used to capture the data.

Returns:

The Amazon S3 location used to capture the data.

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

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

hasCaptureOptions

public final boolean hasCaptureOptions()

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

captureOptions

public final List<CaptureOption> captureOptions()

Specifies data Model Monitor will capture. You can configure whether to collect only input, only output, or both

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

Returns:

Specifies data Model Monitor will capture. You can configure whether to collect only input, only output, or both

captureContentTypeHeader

public final CaptureContentTypeHeader captureContentTypeHeader()

Configuration specifying how to treat different headers. If no headers are specified SageMaker will by default base64 encode when capturing the data.

Returns:

Configuration specifying how to treat different headers. If no headers are specified SageMaker will by default base64 encode when capturing the data.

toBuilder

public DataCaptureConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DataCaptureConfig.Builder,DataCaptureConfig>

builder

public static DataCaptureConfig.Builder builder()

serializableBuilderClass

public static Class<? extends DataCaptureConfig.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)

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo