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 |
Synopsis
- data RecommendationJobInputConfig = RecommendationJobInputConfig' {
- containerConfig :: Maybe RecommendationJobContainerConfig
- endpointConfigurations :: Maybe (NonEmpty EndpointInputConfiguration)
- endpoints :: Maybe [EndpointInfo]
- jobDurationInSeconds :: Maybe Natural
- resourceLimit :: Maybe RecommendationJobResourceLimit
- trafficPattern :: Maybe TrafficPattern
- volumeKmsKeyId :: Maybe Text
- vpcConfig :: Maybe RecommendationJobVpcConfig
- modelPackageVersionArn :: Text
- newRecommendationJobInputConfig :: Text -> RecommendationJobInputConfig
- recommendationJobInputConfig_containerConfig :: Lens' RecommendationJobInputConfig (Maybe RecommendationJobContainerConfig)
- recommendationJobInputConfig_endpointConfigurations :: Lens' RecommendationJobInputConfig (Maybe (NonEmpty EndpointInputConfiguration))
- recommendationJobInputConfig_endpoints :: Lens' RecommendationJobInputConfig (Maybe [EndpointInfo])
- recommendationJobInputConfig_jobDurationInSeconds :: Lens' RecommendationJobInputConfig (Maybe Natural)
- recommendationJobInputConfig_resourceLimit :: Lens' RecommendationJobInputConfig (Maybe RecommendationJobResourceLimit)
- recommendationJobInputConfig_trafficPattern :: Lens' RecommendationJobInputConfig (Maybe TrafficPattern)
- recommendationJobInputConfig_volumeKmsKeyId :: Lens' RecommendationJobInputConfig (Maybe Text)
- recommendationJobInputConfig_vpcConfig :: Lens' RecommendationJobInputConfig (Maybe RecommendationJobVpcConfig)
- recommendationJobInputConfig_modelPackageVersionArn :: Lens' RecommendationJobInputConfig Text
Documentation
data RecommendationJobInputConfig Source #
The input configuration of the recommendation job.
See: newRecommendationJobInputConfig
smart constructor.
RecommendationJobInputConfig' | |
|
Instances
newRecommendationJobInputConfig Source #
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.