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

Description

Synopsis

Documentation

data RecommendationJobInputConfig Source #

The input configuration of the recommendation job.

See: newRecommendationJobInputConfig smart constructor.

Constructors

RecommendationJobInputConfig'

Fields

containerConfig :: Maybe RecommendationJobContainerConfig
Specifies mandatory fields for running an Inference Recommender job. The fields specified in ContainerConfig override the corresponding fields in the model package.
endpointConfigurations :: Maybe (NonEmpty EndpointInputConfiguration)
Specifies the endpoint configuration to use for a job.
endpoints :: Maybe [EndpointInfo]
Existing customer endpoints on which to run an Inference Recommender job.
jobDurationInSeconds :: Maybe Natural
Specifies the maximum duration of the job, in seconds.>
resourceLimit :: Maybe RecommendationJobResourceLimit
Defines the resource limit of the job.
trafficPattern :: Maybe TrafficPattern
Specifies the traffic pattern of the job.
volumeKmsKeyId :: 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 data on the storage volume attached to the ML compute instance that hosts the endpoint. This key will be passed to SageMaker Hosting for endpoint creation.
The SageMaker execution role must have kms:CreateGrant permission in order to encrypt data on the storage volume of the endpoints created for inference recommendation. The inference recommendation job will fail asynchronously during endpoint configuration creation if the role passed does not have kms:CreateGrant 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.
vpcConfig :: Maybe RecommendationJobVpcConfig
Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.
modelPackageVersionArn :: Text
The Amazon Resource Name (ARN) of a versioned model package.

Instances

Instances details

FromJSON RecommendationJobInputConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.RecommendationJobInputConfig Methods parseJSON :: Value -> Parser RecommendationJobInputConfig # parseJSONList :: Value -> Parser [RecommendationJobInputConfig] #
ToJSON RecommendationJobInputConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.RecommendationJobInputConfig Methods toJSON :: RecommendationJobInputConfig -> Value # toEncoding :: RecommendationJobInputConfig -> Encoding # toJSONList :: [RecommendationJobInputConfig] -> Value # toEncodingList :: [RecommendationJobInputConfig] -> Encoding #
Generic RecommendationJobInputConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.RecommendationJobInputConfig Associated Types type Rep RecommendationJobInputConfig :: Type -> Type # Methods from :: RecommendationJobInputConfig -> Rep RecommendationJobInputConfig x # to :: Rep RecommendationJobInputConfig x -> RecommendationJobInputConfig #
Read RecommendationJobInputConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.RecommendationJobInputConfig Methods readsPrec :: Int -> ReadS RecommendationJobInputConfig # readList :: ReadS [RecommendationJobInputConfig] # readPrec :: ReadPrec RecommendationJobInputConfig # readListPrec :: ReadPrec [RecommendationJobInputConfig] #
Show RecommendationJobInputConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.RecommendationJobInputConfig Methods showsPrec :: Int -> RecommendationJobInputConfig -> ShowS # show :: RecommendationJobInputConfig -> String # showList :: [RecommendationJobInputConfig] -> ShowS #
NFData RecommendationJobInputConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.RecommendationJobInputConfig Methods rnf :: RecommendationJobInputConfig -> () #
Eq RecommendationJobInputConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.RecommendationJobInputConfig Methods (==) :: RecommendationJobInputConfig -> RecommendationJobInputConfig -> Bool # (/=) :: RecommendationJobInputConfig -> RecommendationJobInputConfig -> Bool #
Hashable RecommendationJobInputConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.RecommendationJobInputConfig Methods hashWithSalt :: Int -> RecommendationJobInputConfig -> Int # hash :: RecommendationJobInputConfig -> Int #
type Rep RecommendationJobInputConfig Source #
Instance details Defined in Amazonka.SageMaker.Types.RecommendationJobInputConfig type Rep RecommendationJobInputConfig = D1 ('MetaData "RecommendationJobInputConfig" "Amazonka.SageMaker.Types.RecommendationJobInputConfig" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "RecommendationJobInputConfig'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "containerConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RecommendationJobContainerConfig)) :: S1 ('MetaSel ('Just "endpointConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty EndpointInputConfiguration)))) :: (S1 ('MetaSel ('Just "endpoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EndpointInfo])) :: S1 ('MetaSel ('Just "jobDurationInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :: ((S1 ('MetaSel ('Just "resourceLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RecommendationJobResourceLimit)) :: S1 ('MetaSel ('Just "trafficPattern") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TrafficPattern))) :: (S1 ('MetaSel ('Just "volumeKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RecommendationJobVpcConfig)) :: S1 ('MetaSel ('Just "modelPackageVersionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newRecommendationJobInputConfig Source #

Arguments

:: Text	`$sel:modelPackageVersionArn:RecommendationJobInputConfig'`
-> RecommendationJobInputConfig

Create a value of RecommendationJobInputConfig 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:containerConfig:RecommendationJobInputConfig', recommendationJobInputConfig_containerConfig - Specifies mandatory fields for running an Inference Recommender job. The fields specified in ContainerConfig override the corresponding fields in the model package.

$sel:endpointConfigurations:RecommendationJobInputConfig', recommendationJobInputConfig_endpointConfigurations - Specifies the endpoint configuration to use for a job.

$sel:endpoints:RecommendationJobInputConfig', recommendationJobInputConfig_endpoints - Existing customer endpoints on which to run an Inference Recommender job.

$sel:jobDurationInSeconds:RecommendationJobInputConfig', recommendationJobInputConfig_jobDurationInSeconds - Specifies the maximum duration of the job, in seconds.>

$sel:resourceLimit:RecommendationJobInputConfig', recommendationJobInputConfig_resourceLimit - Defines the resource limit of the job.

$sel:trafficPattern:RecommendationJobInputConfig', recommendationJobInputConfig_trafficPattern - Specifies the traffic pattern of the job.

$sel:volumeKmsKeyId:RecommendationJobInputConfig', recommendationJobInputConfig_volumeKmsKeyId - The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. This key will be passed to SageMaker Hosting for endpoint creation.

The SageMaker execution role must have kms:CreateGrant permission in order to encrypt data on the storage volume of the endpoints created for inference recommendation. The inference recommendation job will fail asynchronously during endpoint configuration creation if the role passed does not have kms:CreateGrant 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.

$sel:vpcConfig:RecommendationJobInputConfig', recommendationJobInputConfig_vpcConfig - Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.

$sel:modelPackageVersionArn:RecommendationJobInputConfig', recommendationJobInputConfig_modelPackageVersionArn - The Amazon Resource Name (ARN) of a versioned model package.

recommendationJobInputConfig_containerConfig :: Lens' RecommendationJobInputConfig (Maybe RecommendationJobContainerConfig) Source #

Specifies mandatory fields for running an Inference Recommender job. The fields specified in ContainerConfig override the corresponding fields in the model package.

recommendationJobInputConfig_endpointConfigurations :: Lens' RecommendationJobInputConfig (Maybe (NonEmpty EndpointInputConfiguration)) Source #

Specifies the endpoint configuration to use for a job.

recommendationJobInputConfig_endpoints :: Lens' RecommendationJobInputConfig (Maybe [EndpointInfo]) Source #

Existing customer endpoints on which to run an Inference Recommender job.

recommendationJobInputConfig_jobDurationInSeconds :: Lens' RecommendationJobInputConfig (Maybe Natural) Source #

Specifies the maximum duration of the job, in seconds.>

recommendationJobInputConfig_resourceLimit :: Lens' RecommendationJobInputConfig (Maybe RecommendationJobResourceLimit) Source #

Defines the resource limit of the job.

recommendationJobInputConfig_trafficPattern :: Lens' RecommendationJobInputConfig (Maybe TrafficPattern) Source #

Specifies the traffic pattern of the job.

recommendationJobInputConfig_volumeKmsKeyId :: Lens' RecommendationJobInputConfig (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 data on the storage volume attached to the ML compute instance that hosts the endpoint. This key will be passed to SageMaker Hosting for endpoint creation.

The SageMaker execution role must have kms:CreateGrant permission in order to encrypt data on the storage volume of the endpoints created for inference recommendation. The inference recommendation job will fail asynchronously during endpoint configuration creation if the role passed does not have kms:CreateGrant 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.

recommendationJobInputConfig_vpcConfig :: Lens' RecommendationJobInputConfig (Maybe RecommendationJobVpcConfig) Source #

Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.

recommendationJobInputConfig_modelPackageVersionArn :: Lens' RecommendationJobInputConfig Text Source #

The Amazon Resource Name (ARN) of a versioned model package.