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.OutputDataConfig

Description

Synopsis

data OutputDataConfig = OutputDataConfig' {
- kmsKeyId :: Maybe Text
- s3OutputPath :: Text
}
newOutputDataConfig :: Text -> OutputDataConfig
outputDataConfig_kmsKeyId :: Lens' OutputDataConfig (Maybe Text)
outputDataConfig_s3OutputPath :: Lens' OutputDataConfig Text

Documentation

data OutputDataConfig Source #

Provides information about how to store model training results (model artifacts).

See: newOutputDataConfig smart constructor.

Constructors

OutputDataConfig'

Fields

kmsKeyId :: Maybe Text
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:
- // KMS Key ID
```
"1234abcd-12ab-34cd-56ef-1234567890ab"
```
- // Amazon Resource Name (ARN) of a KMS Key
```
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
```
- // KMS Key Alias
```
"alias/ExampleAlias"
```
- // Amazon Resource Name (ARN) of a KMS Key Alias
```
"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
```
If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, SageMaker uses the default KMS key for Amazon S3 for your role's account. SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.
The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob, CreateTransformJob, or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.
s3OutputPath :: Text
Identifies the S3 path where you want SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

Instances

Instances details

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

newOutputDataConfig Source #

Arguments

:: Text	`$sel:s3OutputPath:OutputDataConfig'`
-> OutputDataConfig

Create a value of OutputDataConfig 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:kmsKeyId:OutputDataConfig', outputDataConfig_kmsKeyId - The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

// KMS Key ID
```
"1234abcd-12ab-34cd-56ef-1234567890ab"
```

// Amazon Resource Name (ARN) of a KMS Key

"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

// KMS Key Alias
```
"alias/ExampleAlias"
```

// Amazon Resource Name (ARN) of a KMS Key Alias

"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, SageMaker uses the default KMS key for Amazon S3 for your role's account. SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob, CreateTransformJob, or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

$sel:s3OutputPath:OutputDataConfig', outputDataConfig_s3OutputPath - Identifies the S3 path where you want SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

outputDataConfig_kmsKeyId :: Lens' OutputDataConfig (Maybe Text) Source #

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

// KMS Key ID
```
"1234abcd-12ab-34cd-56ef-1234567890ab"
```

// Amazon Resource Name (ARN) of a KMS Key

"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

// KMS Key Alias
```
"alias/ExampleAlias"
```

// Amazon Resource Name (ARN) of a KMS Key Alias

"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, SageMaker uses the default KMS key for Amazon S3 for your role's account. SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob, CreateTransformJob, or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

outputDataConfig_s3OutputPath :: Lens' OutputDataConfig Text Source #

Identifies the S3 path where you want SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.