Skip to content

DataCaptureConfig

Source code in docs_src/capo_sagemaker/types/data_capture_config.py
class DataCaptureConfig(TypedDict, closed=True):
    enable_capture: NotRequired["capo_sagemaker.types.enable_capture.EnableCapture"]
    """<p>Whether data capture should be enabled or disabled (defaults to enabled).</p>"""
    initial_sampling_percentage: NotRequired[
        "capo_sagemaker.types.sampling_percentage.SamplingPercentage"
    ]
    """<p>The percentage of requests SageMaker AI will capture. A lower value is recommended for Endpoints with high traffic.</p>"""
    destination_s3_uri: NotRequired[
        "capo_sagemaker.types.destination_s3_uri.DestinationS3Uri"
    ]
    """<p>The Amazon S3 location used to capture the data.</p>"""
    kms_key_id: NotRequired["capo_sagemaker.types.kms_key_id.KmsKeyId"]
    """<p>The Amazon Resource Name (ARN) of an Key Management Service key that SageMaker AI uses to encrypt the captured data at rest using Amazon S3 server-side encryption.</p> <p>The KmsKeyId can be any of the following formats: </p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li> <p>Alias name ARN: <code>arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias</code> </p> </li> </ul>"""
    capture_options: NotRequired[
        "capo_sagemaker.types.capture_option_list.CaptureOptionList"
    ]
    """<p>Specifies data Model Monitor will capture. You can configure whether to collect only input, only output, or both</p>"""
    capture_content_type_header: NotRequired[
        "capo_sagemaker.types.capture_content_type_header.CaptureContentTypeHeader"
    ]
    """<p>Configuration specifying how to treat different headers. If no headers are specified SageMaker AI will by default base64 encode when capturing the data.</p>"""

capture_content_type_header instance-attribute

capture_content_type_header: NotRequired[CaptureContentTypeHeader]

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

capture_options instance-attribute

capture_options: NotRequired[CaptureOptionList]

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

destination_s3_uri instance-attribute

destination_s3_uri: NotRequired[DestinationS3Uri]

The Amazon S3 location used to capture the data.

enable_capture instance-attribute

enable_capture: NotRequired[EnableCapture]

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

initial_sampling_percentage instance-attribute

initial_sampling_percentage: NotRequired[SamplingPercentage]

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

kms_key_id instance-attribute

kms_key_id: NotRequired[KmsKeyId]

The Amazon Resource Name (ARN) of an Key Management Service key that SageMaker AI uses to encrypt the captured data at rest using Amazon S3 server-side encryption.

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