| 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.CreateEndpointConfig
Description
Creates an endpoint configuration that SageMaker hosting services uses
to deploy models. In the configuration, you identify one or more models,
created using the CreateModel API, to deploy and the resources that
you want SageMaker to provision. Then you call the CreateEndpoint API.
Use this API if you want to use SageMaker hosting services to deploy models into production.
In the request, you define a ProductionVariant, for each model that
you want to deploy. Each ProductionVariant parameter also describes
the resources that you want SageMaker to provision. This includes the
number and type of ML compute instances to deploy.
If you are hosting multiple models, you also assign a VariantWeight to
specify how much traffic you want to allocate to each model. For
example, suppose that you want to host two models, A and B, and you
assign traffic weight 2 for model A and 1 for model B. SageMaker
distributes two-thirds of the traffic to Model A, and one-third to model
B.
When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.
Synopsis
- data CreateEndpointConfig = CreateEndpointConfig' {
- asyncInferenceConfig :: Maybe AsyncInferenceConfig
- dataCaptureConfig :: Maybe DataCaptureConfig
- explainerConfig :: Maybe ExplainerConfig
- kmsKeyId :: Maybe Text
- shadowProductionVariants :: Maybe (NonEmpty ProductionVariant)
- tags :: Maybe [Tag]
- endpointConfigName :: Text
- productionVariants :: NonEmpty ProductionVariant
- newCreateEndpointConfig :: Text -> NonEmpty ProductionVariant -> CreateEndpointConfig
- createEndpointConfig_asyncInferenceConfig :: Lens' CreateEndpointConfig (Maybe AsyncInferenceConfig)
- createEndpointConfig_dataCaptureConfig :: Lens' CreateEndpointConfig (Maybe DataCaptureConfig)
- createEndpointConfig_explainerConfig :: Lens' CreateEndpointConfig (Maybe ExplainerConfig)
- createEndpointConfig_kmsKeyId :: Lens' CreateEndpointConfig (Maybe Text)
- createEndpointConfig_shadowProductionVariants :: Lens' CreateEndpointConfig (Maybe (NonEmpty ProductionVariant))
- createEndpointConfig_tags :: Lens' CreateEndpointConfig (Maybe [Tag])
- createEndpointConfig_endpointConfigName :: Lens' CreateEndpointConfig Text
- createEndpointConfig_productionVariants :: Lens' CreateEndpointConfig (NonEmpty ProductionVariant)
- data CreateEndpointConfigResponse = CreateEndpointConfigResponse' {}
- newCreateEndpointConfigResponse :: Int -> Text -> CreateEndpointConfigResponse
- createEndpointConfigResponse_httpStatus :: Lens' CreateEndpointConfigResponse Int
- createEndpointConfigResponse_endpointConfigArn :: Lens' CreateEndpointConfigResponse Text
Creating a Request
data CreateEndpointConfig Source #
See: newCreateEndpointConfig smart constructor.
Constructors
| CreateEndpointConfig' | |
Fields
| |
Instances
newCreateEndpointConfig Source #
Arguments
| :: Text | |
| -> NonEmpty ProductionVariant | |
| -> CreateEndpointConfig |
Create a value of CreateEndpointConfig 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:asyncInferenceConfig:CreateEndpointConfig', createEndpointConfig_asyncInferenceConfig - Specifies configuration for how an endpoint performs asynchronous
inference. This is a required field in order for your Endpoint to be
invoked using
InvokeEndpointAsync.
CreateEndpointConfig, createEndpointConfig_dataCaptureConfig - Undocumented member.
$sel:explainerConfig:CreateEndpointConfig', createEndpointConfig_explainerConfig - A member of CreateEndpointConfig that enables explainers.
CreateEndpointConfig, createEndpointConfig_kmsKeyId - The Amazon Resource Name (ARN) of a Amazon Web Services Key Management
Service key that SageMaker uses to encrypt data on the storage volume
attached to the ML compute instance that hosts the endpoint.
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
The KMS key policy must grant permission to the IAM role that you
specify in your CreateEndpoint, UpdateEndpoint requests. For more
information, refer to the Amazon Web Services Key Management Service
section
Using Key Policies in Amazon Web Services KMS
Certain Nitro-based instances include local storage, dependent on the
instance type. Local storage volumes are encrypted using a hardware
module on the instance. You can't request a KmsKeyId when using an
instance type with local storage. If any of the models that you specify
in the ProductionVariants parameter use nitro-based instances with
local storage, do not specify a value for the KmsKeyId parameter. If
you specify a value for KmsKeyId when using any nitro-based instances
with local storage, the call to CreateEndpointConfig fails.
For a list of instance types that support local instance storage, see Instance Store Volumes.
For more information about local instance storage encryption, see SSD Instance Store Volumes.
CreateEndpointConfig, createEndpointConfig_shadowProductionVariants - An array of ProductionVariant objects, one for each model that you
want to host at this endpoint in shadow mode with production traffic
replicated from the model specified on ProductionVariants. If you use
this field, you can only specify one variant for ProductionVariants
and one variant for ShadowProductionVariants.
CreateEndpointConfig, createEndpointConfig_tags - An array of key-value pairs. You can use tags to categorize your Amazon
Web Services resources in different ways, for example, by purpose,
owner, or environment. For more information, see
Tagging Amazon Web Services Resources.
CreateEndpointConfig, createEndpointConfig_endpointConfigName - The name of the endpoint configuration. You specify this name in a
CreateEndpoint request.
CreateEndpointConfig, createEndpointConfig_productionVariants - An array of ProductionVariant objects, one for each model that you
want to host at this endpoint.
Request Lenses
createEndpointConfig_asyncInferenceConfig :: Lens' CreateEndpointConfig (Maybe AsyncInferenceConfig) Source #
Specifies configuration for how an endpoint performs asynchronous inference. This is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync.
createEndpointConfig_dataCaptureConfig :: Lens' CreateEndpointConfig (Maybe DataCaptureConfig) Source #
Undocumented member.
createEndpointConfig_explainerConfig :: Lens' CreateEndpointConfig (Maybe ExplainerConfig) Source #
A member of CreateEndpointConfig that enables explainers.
createEndpointConfig_kmsKeyId :: Lens' CreateEndpointConfig (Maybe Text) Source #
The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.
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
The KMS key policy must grant permission to the IAM role that you
specify in your CreateEndpoint, UpdateEndpoint requests. For more
information, refer to the Amazon Web Services Key Management Service
section
Using Key Policies in Amazon Web Services KMS
Certain Nitro-based instances include local storage, dependent on the
instance type. Local storage volumes are encrypted using a hardware
module on the instance. You can't request a KmsKeyId when using an
instance type with local storage. If any of the models that you specify
in the ProductionVariants parameter use nitro-based instances with
local storage, do not specify a value for the KmsKeyId parameter. If
you specify a value for KmsKeyId when using any nitro-based instances
with local storage, the call to CreateEndpointConfig fails.
For a list of instance types that support local instance storage, see Instance Store Volumes.
For more information about local instance storage encryption, see SSD Instance Store Volumes.
createEndpointConfig_shadowProductionVariants :: Lens' CreateEndpointConfig (Maybe (NonEmpty ProductionVariant)) Source #
An array of ProductionVariant objects, one for each model that you
want to host at this endpoint in shadow mode with production traffic
replicated from the model specified on ProductionVariants. If you use
this field, you can only specify one variant for ProductionVariants
and one variant for ShadowProductionVariants.
createEndpointConfig_tags :: Lens' CreateEndpointConfig (Maybe [Tag]) Source #
An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
createEndpointConfig_endpointConfigName :: Lens' CreateEndpointConfig Text Source #
The name of the endpoint configuration. You specify this name in a CreateEndpoint request.
createEndpointConfig_productionVariants :: Lens' CreateEndpointConfig (NonEmpty ProductionVariant) Source #
An array of ProductionVariant objects, one for each model that you
want to host at this endpoint.
Destructuring the Response
data CreateEndpointConfigResponse Source #
See: newCreateEndpointConfigResponse smart constructor.
Constructors
| CreateEndpointConfigResponse' | |
Fields
| |
Instances
newCreateEndpointConfigResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> CreateEndpointConfigResponse |
Create a value of CreateEndpointConfigResponse 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:httpStatus:CreateEndpointConfigResponse', createEndpointConfigResponse_httpStatus - The response's http status code.
CreateEndpointConfigResponse, createEndpointConfigResponse_endpointConfigArn - The Amazon Resource Name (ARN) of the endpoint configuration.
Response Lenses
createEndpointConfigResponse_httpStatus :: Lens' CreateEndpointConfigResponse Int Source #
The response's http status code.
createEndpointConfigResponse_endpointConfigArn :: Lens' CreateEndpointConfigResponse Text Source #
The Amazon Resource Name (ARN) of the endpoint configuration.