Class: Aws::SageMaker::Types::DataCaptureConfig

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::DataCaptureConfig

Defined in:

gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

Note:

When making an API call, you may pass DataCaptureConfig data as a hash:

{
  enable_capture: false,
  initial_sampling_percentage: 1, # required
  destination_s3_uri: "DestinationS3Uri", # required
  kms_key_id: "KmsKeyId",
  capture_options: [ # required
    {
      capture_mode: "Input", # required, accepts Input, Output
    },
  ],
  capture_content_type_header: {
    csv_content_types: ["CsvContentType"],
    json_content_types: ["JsonContentType"],
  },
}

Configuration to control how SageMaker captures inference data.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #capture_content_type_header ⇒ Types::CaptureContentTypeHeader

  Configuration specifying how to treat different headers.

• #capture_options ⇒ Array<Types::CaptureOption>

  Specifies data Model Monitor will capture.

• #destination_s3_uri ⇒ String

  The Amazon S3 location used to capture the data.

• #enable_capture ⇒ Boolean

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

• #initial_sampling_percentage ⇒ Integer

  The percentage of requests SageMaker will capture.

• #kms_key_id ⇒ String

  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.

Instance Attribute Details

#capture_content_type_header ⇒ Types::CaptureContentTypeHeader

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

Returns:

• (Types::CaptureContentTypeHeader)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10289

class DataCaptureConfig < Struct.new(
  :enable_capture,
  :initial_sampling_percentage,
  :destination_s3_uri,
  :kms_key_id,
  :capture_options,
  :capture_content_type_header)
  SENSITIVE = []
  include Aws::Structure
end

#capture_options ⇒ Array<Types::CaptureOption>

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

Returns:

• (Array<Types::CaptureOption>)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10289

class DataCaptureConfig < Struct.new(
  :enable_capture,
  :initial_sampling_percentage,
  :destination_s3_uri,
  :kms_key_id,
  :capture_options,
  :capture_content_type_header)
  SENSITIVE = []
  include Aws::Structure
end

#destination_s3_uri ⇒ String

The Amazon S3 location used to capture the data.

Returns:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10289

class DataCaptureConfig < Struct.new(
  :enable_capture,
  :initial_sampling_percentage,
  :destination_s3_uri,
  :kms_key_id,
  :capture_options,
  :capture_content_type_header)
  SENSITIVE = []
  include Aws::Structure
end

#enable_capture ⇒ Boolean

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10289

class DataCaptureConfig < Struct.new(
  :enable_capture,
  :initial_sampling_percentage,
  :destination_s3_uri,
  :kms_key_id,
  :capture_options,
  :capture_content_type_header)
  SENSITIVE = []
  include Aws::Structure
end

#initial_sampling_percentage ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10289

class DataCaptureConfig < Struct.new(
  :enable_capture,
  :initial_sampling_percentage,
  :destination_s3_uri,
  :kms_key_id,
  :capture_options,
  :capture_content_type_header)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

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:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10289

class DataCaptureConfig < Struct.new(
  :enable_capture,
  :initial_sampling_percentage,
  :destination_s3_uri,
  :kms_key_id,
  :capture_options,
  :capture_content_type_header)
  SENSITIVE = []
  include Aws::Structure
end