Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SageMaker.Types.DataCaptureConfig

Description

Documentation

data DataCaptureConfig Source #

Configuration to control how SageMaker captures inference data.

See: newDataCaptureConfig smart constructor.

Constructors

DataCaptureConfig'

Fields

captureContentTypeHeader :: Maybe CaptureContentTypeHeader
Configuration specifying how to treat different headers. If no headers are specified SageMaker will by default base64 encode when capturing the data.
enableCapture :: Maybe Bool
Whether data capture should be enabled or disabled (defaults to enabled).
kmsKeyId :: Maybe Text
The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker 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
initialSamplingPercentage :: Natural
The percentage of requests SageMaker will capture. A lower value is recommended for Endpoints with high traffic.
destinationS3Uri :: Text
The Amazon S3 location used to capture the data.
captureOptions :: NonEmpty CaptureOption
Specifies data Model Monitor will capture. You can configure whether to collect only input, only output, or both

Instances

Instances details

FromJSON DataCaptureConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.DataCaptureConfig Methods parseJSON :: Value -> Parser DataCaptureConfig # parseJSONList :: Value -> Parser [DataCaptureConfig] #
ToJSON DataCaptureConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.DataCaptureConfig Methods toJSON :: DataCaptureConfig -> Value # toEncoding :: DataCaptureConfig -> Encoding # toJSONList :: [DataCaptureConfig] -> Value # toEncodingList :: [DataCaptureConfig] -> Encoding #
Generic DataCaptureConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.DataCaptureConfig Associated Types type Rep DataCaptureConfig :: Type -> Type # Methods from :: DataCaptureConfig -> Rep DataCaptureConfig x # to :: Rep DataCaptureConfig x -> DataCaptureConfig #
Read DataCaptureConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.DataCaptureConfig Methods readsPrec :: Int -> ReadS DataCaptureConfig # readList :: ReadS [DataCaptureConfig] # readPrec :: ReadPrec DataCaptureConfig # readListPrec :: ReadPrec [DataCaptureConfig] #
Show DataCaptureConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.DataCaptureConfig Methods showsPrec :: Int -> DataCaptureConfig -> ShowS # show :: DataCaptureConfig -> String # showList :: [DataCaptureConfig] -> ShowS #
NFData DataCaptureConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.DataCaptureConfig Methods rnf :: DataCaptureConfig -> () #
Eq DataCaptureConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.DataCaptureConfig Methods (==) :: DataCaptureConfig -> DataCaptureConfig -> Bool # (/=) :: DataCaptureConfig -> DataCaptureConfig -> Bool #
Hashable DataCaptureConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.DataCaptureConfig Methods hashWithSalt :: Int -> DataCaptureConfig -> Int # hash :: DataCaptureConfig -> Int #
type Rep DataCaptureConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.DataCaptureConfig type Rep DataCaptureConfig = D1 ('MetaData "DataCaptureConfig" "Amazonka.SageMaker.Types.DataCaptureConfig" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "DataCaptureConfig'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "captureContentTypeHeader") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CaptureContentTypeHeader)) :: (S1 ('MetaSel ('Just "enableCapture") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "initialSamplingPercentage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :: (S1 ('MetaSel ('Just "destinationS3Uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "captureOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty CaptureOption))))))

newDataCaptureConfig Source #

Arguments

:: Natural	`$sel:initialSamplingPercentage:DataCaptureConfig'`
-> Text	`$sel:destinationS3Uri:DataCaptureConfig'`
-> NonEmpty CaptureOption	`$sel:captureOptions:DataCaptureConfig'`
-> DataCaptureConfig

Create a value of DataCaptureConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:captureContentTypeHeader:DataCaptureConfig', dataCaptureConfig_captureContentTypeHeader - Configuration specifying how to treat different headers. If no headers are specified SageMaker will by default base64 encode when capturing the data.

$sel:enableCapture:DataCaptureConfig', dataCaptureConfig_enableCapture - Whether data capture should be enabled or disabled (defaults to enabled).

$sel:kmsKeyId:DataCaptureConfig', dataCaptureConfig_kmsKeyId - The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker 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

$sel:initialSamplingPercentage:DataCaptureConfig', dataCaptureConfig_initialSamplingPercentage - The percentage of requests SageMaker will capture. A lower value is recommended for Endpoints with high traffic.

$sel:destinationS3Uri:DataCaptureConfig', dataCaptureConfig_destinationS3Uri - The Amazon S3 location used to capture the data.

$sel:captureOptions:DataCaptureConfig', dataCaptureConfig_captureOptions - Specifies data Model Monitor will capture. You can configure whether to collect only input, only output, or both

dataCaptureConfig_captureContentTypeHeader :: Lens' DataCaptureConfig (Maybe CaptureContentTypeHeader) Source #

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

dataCaptureConfig_enableCapture :: Lens' DataCaptureConfig (Maybe Bool) Source #

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

dataCaptureConfig_kmsKeyId :: Lens' DataCaptureConfig (Maybe Text) Source #

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker 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

dataCaptureConfig_initialSamplingPercentage :: Lens' DataCaptureConfig Natural Source #

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

dataCaptureConfig_destinationS3Uri :: Lens' DataCaptureConfig Text Source #

The Amazon S3 location used to capture the data.

dataCaptureConfig_captureOptions :: Lens' DataCaptureConfig (NonEmpty CaptureOption) Source #

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