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

Inherits:
Struct
  • Object
show all
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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#capture_content_type_headerTypes::CaptureContentTypeHeader

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



10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10457

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_optionsArray<Types::CaptureOption>

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

Returns:



10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10457

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_uriString

The Amazon S3 location used to capture the data.

Returns:

  • (String)


10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10457

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_captureBoolean

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

Returns:

  • (Boolean)


10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10457

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_percentageInteger

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

Returns:

  • (Integer)


10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10457

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_idString

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)


10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 10457

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