| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.SageMaker.UpdateEndpoint
Description
Deploys the new EndpointConfig specified in the request, switches to
using newly created endpoint, and then deletes resources provisioned for
the endpoint using the previous EndpointConfig (there is no
availability loss).
When Amazon SageMaker receives the request, it sets the endpoint status
to Updating. After updating the endpoint, it sets the status to
InService. To check the status of an endpoint, use the
DescribeEndpoint API.
You must not delete an EndpointConfig in use by an endpoint that is
live or while the UpdateEndpoint or CreateEndpoint operations are
being performed on the endpoint. To update an endpoint, you must create
a new EndpointConfig.
If you delete the EndpointConfig of an endpoint that is active or
being created or updated you may lose visibility into the instance type
the endpoint is using. The endpoint must be deleted in order to stop
incurring charges.
Synopsis
- data UpdateEndpoint = UpdateEndpoint' {}
- newUpdateEndpoint :: Text -> Text -> UpdateEndpoint
- updateEndpoint_excludeRetainedVariantProperties :: Lens' UpdateEndpoint (Maybe [VariantProperty])
- updateEndpoint_retainAllVariantProperties :: Lens' UpdateEndpoint (Maybe Bool)
- updateEndpoint_deploymentConfig :: Lens' UpdateEndpoint (Maybe DeploymentConfig)
- updateEndpoint_endpointName :: Lens' UpdateEndpoint Text
- updateEndpoint_endpointConfigName :: Lens' UpdateEndpoint Text
- data UpdateEndpointResponse = UpdateEndpointResponse' {
- httpStatus :: Int
- endpointArn :: Text
- newUpdateEndpointResponse :: Int -> Text -> UpdateEndpointResponse
- updateEndpointResponse_httpStatus :: Lens' UpdateEndpointResponse Int
- updateEndpointResponse_endpointArn :: Lens' UpdateEndpointResponse Text
Creating a Request
data UpdateEndpoint Source #
See: newUpdateEndpoint smart constructor.
Constructors
| UpdateEndpoint' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> UpdateEndpoint |
Create a value of UpdateEndpoint 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:excludeRetainedVariantProperties:UpdateEndpoint', updateEndpoint_excludeRetainedVariantProperties - When you are updating endpoint resources with
UpdateEndpointInput$RetainAllVariantProperties, whose value is set to
true, ExcludeRetainedVariantProperties specifies the list of type
VariantProperty to override with the values provided by
EndpointConfig. If you don't specify a value for
ExcludeAllVariantProperties, no variant properties are overridden.
$sel:retainAllVariantProperties:UpdateEndpoint', updateEndpoint_retainAllVariantProperties - When updating endpoint resources, enables or disables the retention of
variant properties,
such as the instance count or the variant weight. To retain the variant
properties of an endpoint when updating it, set
RetainAllVariantProperties to true. To use the variant properties
specified in a new EndpointConfig call when updating an endpoint, set
RetainAllVariantProperties to false. The default is false.
$sel:deploymentConfig:UpdateEndpoint', updateEndpoint_deploymentConfig - The deployment configuration for the endpoint to be updated.
$sel:endpointName:UpdateEndpoint', updateEndpoint_endpointName - The name of the endpoint whose configuration you want to update.
$sel:endpointConfigName:UpdateEndpoint', updateEndpoint_endpointConfigName - The name of the new endpoint configuration.
Request Lenses
updateEndpoint_excludeRetainedVariantProperties :: Lens' UpdateEndpoint (Maybe [VariantProperty]) Source #
When you are updating endpoint resources with
UpdateEndpointInput$RetainAllVariantProperties, whose value is set to
true, ExcludeRetainedVariantProperties specifies the list of type
VariantProperty to override with the values provided by
EndpointConfig. If you don't specify a value for
ExcludeAllVariantProperties, no variant properties are overridden.
updateEndpoint_retainAllVariantProperties :: Lens' UpdateEndpoint (Maybe Bool) Source #
When updating endpoint resources, enables or disables the retention of
variant properties,
such as the instance count or the variant weight. To retain the variant
properties of an endpoint when updating it, set
RetainAllVariantProperties to true. To use the variant properties
specified in a new EndpointConfig call when updating an endpoint, set
RetainAllVariantProperties to false. The default is false.
updateEndpoint_deploymentConfig :: Lens' UpdateEndpoint (Maybe DeploymentConfig) Source #
The deployment configuration for the endpoint to be updated.
updateEndpoint_endpointName :: Lens' UpdateEndpoint Text Source #
The name of the endpoint whose configuration you want to update.
updateEndpoint_endpointConfigName :: Lens' UpdateEndpoint Text Source #
The name of the new endpoint configuration.
Destructuring the Response
data UpdateEndpointResponse Source #
See: newUpdateEndpointResponse smart constructor.
Constructors
| UpdateEndpointResponse' | |
Fields
| |
Instances
newUpdateEndpointResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> UpdateEndpointResponse |
Create a value of UpdateEndpointResponse 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:UpdateEndpointResponse', updateEndpointResponse_httpStatus - The response's http status code.
$sel:endpointArn:UpdateEndpointResponse', updateEndpointResponse_endpointArn - The Amazon Resource Name (ARN) of the endpoint.
Response Lenses
updateEndpointResponse_httpStatus :: Lens' UpdateEndpointResponse Int Source #
The response's http status code.
updateEndpointResponse_endpointArn :: Lens' UpdateEndpointResponse Text Source #
The Amazon Resource Name (ARN) of the endpoint.