Skip to content

BatchDataCaptureConfig

Source code in docs_src/capo_sagemaker/types/batch_data_capture_config.py
class BatchDataCaptureConfig(TypedDict, closed=True):
    destination_s3_uri: NotRequired["capo_sagemaker.types.s3_uri.S3Uri"]
    """<p>The Amazon S3 location being used to capture the data.</p>"""
    kms_key_id: NotRequired["capo_sagemaker.types.kms_key_id.KmsKeyId"]
    """<p>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 batch transform job.</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>"""
    generate_inference_id: NotRequired["capo_sagemaker.types.boolean.Boolean"]
    """<p>Flag that indicates whether to append inference id to the output.</p>"""

destination_s3_uri instance-attribute

destination_s3_uri: NotRequired[S3Uri]

The Amazon S3 location being used to capture the data.

generate_inference_id instance-attribute

generate_inference_id: NotRequired[Boolean]

Flag that indicates whether to append inference id to the output.

kms_key_id instance-attribute

kms_key_id: NotRequired[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 batch transform job.

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