amazonka-sagemaker-2.0: Amazon SageMaker Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SageMaker.Types.RecommendationJobOutputConfig

Description

 
Synopsis

Documentation

data RecommendationJobOutputConfig Source #

Provides information about the output configuration for the compiled model.

See: newRecommendationJobOutputConfig smart constructor.

Constructors

RecommendationJobOutputConfig' 

Fields

  • compiledOutputConfig :: Maybe RecommendationJobCompiledOutputConfig

    Provides information about the output configuration for the compiled model.

  • kmsKeyId :: Maybe Text

    The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt your output artifacts with Amazon S3 server-side encryption. The SageMaker execution role must have kms:GenerateDataKey permission.

    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:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"
    • // KMS Key Alias

      "alias/ExampleAlias"
    • // Amazon Resource Name (ARN) of a KMS Key Alias

      "arn:aws:kms:<region>:<account>:alias/<ExampleAlias>"

    For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

Instances

Instances details
ToJSON RecommendationJobOutputConfig Source # 
Instance details

Defined in Amazonka.SageMaker.Types.RecommendationJobOutputConfig

Generic RecommendationJobOutputConfig Source # 
Instance details

Defined in Amazonka.SageMaker.Types.RecommendationJobOutputConfig

Associated Types

type Rep RecommendationJobOutputConfig :: Type -> Type #

Read RecommendationJobOutputConfig Source # 
Instance details

Defined in Amazonka.SageMaker.Types.RecommendationJobOutputConfig

Show RecommendationJobOutputConfig Source # 
Instance details

Defined in Amazonka.SageMaker.Types.RecommendationJobOutputConfig

NFData RecommendationJobOutputConfig Source # 
Instance details

Defined in Amazonka.SageMaker.Types.RecommendationJobOutputConfig

Eq RecommendationJobOutputConfig Source # 
Instance details

Defined in Amazonka.SageMaker.Types.RecommendationJobOutputConfig

Hashable RecommendationJobOutputConfig Source # 
Instance details

Defined in Amazonka.SageMaker.Types.RecommendationJobOutputConfig

type Rep RecommendationJobOutputConfig Source # 
Instance details

Defined in Amazonka.SageMaker.Types.RecommendationJobOutputConfig

type Rep RecommendationJobOutputConfig = D1 ('MetaData "RecommendationJobOutputConfig" "Amazonka.SageMaker.Types.RecommendationJobOutputConfig" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "RecommendationJobOutputConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "compiledOutputConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RecommendationJobCompiledOutputConfig)) :*: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newRecommendationJobOutputConfig :: RecommendationJobOutputConfig Source #

Create a value of RecommendationJobOutputConfig 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:compiledOutputConfig:RecommendationJobOutputConfig', recommendationJobOutputConfig_compiledOutputConfig - Provides information about the output configuration for the compiled model.

$sel:kmsKeyId:RecommendationJobOutputConfig', recommendationJobOutputConfig_kmsKeyId - The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt your output artifacts with Amazon S3 server-side encryption. The SageMaker execution role must have kms:GenerateDataKey permission.

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:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"
  • // KMS Key Alias

    "alias/ExampleAlias"
  • // Amazon Resource Name (ARN) of a KMS Key Alias

    "arn:aws:kms:<region>:<account>:alias/<ExampleAlias>"

For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

recommendationJobOutputConfig_kmsKeyId :: Lens' RecommendationJobOutputConfig (Maybe Text) Source #

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt your output artifacts with Amazon S3 server-side encryption. The SageMaker execution role must have kms:GenerateDataKey permission.

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:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"
  • // KMS Key Alias

    "alias/ExampleAlias"
  • // Amazon Resource Name (ARN) of a KMS Key Alias

    "arn:aws:kms:<region>:<account>:alias/<ExampleAlias>"

For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.