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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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 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' {
- deploymentConfig :: Maybe DeploymentConfig
- excludeRetainedVariantProperties :: Maybe [VariantProperty]
- retainAllVariantProperties :: Maybe Bool
- retainDeploymentConfig :: Maybe Bool
- endpointName :: Text
- endpointConfigName :: Text
}
newUpdateEndpoint :: Text -> Text -> UpdateEndpoint
updateEndpoint_deploymentConfig :: Lens' UpdateEndpoint (Maybe DeploymentConfig)
updateEndpoint_excludeRetainedVariantProperties :: Lens' UpdateEndpoint (Maybe [VariantProperty])
updateEndpoint_retainAllVariantProperties :: Lens' UpdateEndpoint (Maybe Bool)
updateEndpoint_retainDeploymentConfig :: Lens' UpdateEndpoint (Maybe Bool)
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

deploymentConfig :: Maybe DeploymentConfig
The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
excludeRetainedVariantProperties :: Maybe [VariantProperty]
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.
retainAllVariantProperties :: Maybe Bool
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.
retainDeploymentConfig :: Maybe Bool
Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused).
endpointName :: Text
The name of the endpoint whose configuration you want to update.
endpointConfigName :: Text
The name of the new endpoint configuration.

Instances

Instances details

ToJSON UpdateEndpoint Source #
Instance details Defined in Amazonka.SageMaker.UpdateEndpoint Methods toJSON :: UpdateEndpoint -> Value # toEncoding :: UpdateEndpoint -> Encoding # toJSONList :: [UpdateEndpoint] -> Value # toEncodingList :: [UpdateEndpoint] -> Encoding #
ToHeaders UpdateEndpoint Source #
Instance details Defined in Amazonka.SageMaker.UpdateEndpoint Methods toHeaders :: UpdateEndpoint -> [Header] #
ToPath UpdateEndpoint Source #
Instance details Defined in Amazonka.SageMaker.UpdateEndpoint Methods toPath :: UpdateEndpoint -> ByteString #
ToQuery UpdateEndpoint Source #
Instance details Defined in Amazonka.SageMaker.UpdateEndpoint Methods toQuery :: UpdateEndpoint -> QueryString #
AWSRequest UpdateEndpoint Source #
Instance details Defined in Amazonka.SageMaker.UpdateEndpoint Associated Types type AWSResponse UpdateEndpoint # Methods request :: (Service -> Service) -> UpdateEndpoint -> Request UpdateEndpoint # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateEndpoint -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateEndpoint))) #
Generic UpdateEndpoint Source #
Instance details Defined in Amazonka.SageMaker.UpdateEndpoint Associated Types type Rep UpdateEndpoint :: Type -> Type # Methods from :: UpdateEndpoint -> Rep UpdateEndpoint x # to :: Rep UpdateEndpoint x -> UpdateEndpoint #
Read UpdateEndpoint Source #
Instance details Defined in Amazonka.SageMaker.UpdateEndpoint Methods readsPrec :: Int -> ReadS UpdateEndpoint # readList :: ReadS [UpdateEndpoint] # readPrec :: ReadPrec UpdateEndpoint # readListPrec :: ReadPrec [UpdateEndpoint] #
Show UpdateEndpoint Source #
Instance details Defined in Amazonka.SageMaker.UpdateEndpoint Methods showsPrec :: Int -> UpdateEndpoint -> ShowS # show :: UpdateEndpoint -> String # showList :: [UpdateEndpoint] -> ShowS #
NFData UpdateEndpoint Source #
Instance details Defined in Amazonka.SageMaker.UpdateEndpoint Methods rnf :: UpdateEndpoint -> () #
Eq UpdateEndpoint Source #
Instance details Defined in Amazonka.SageMaker.UpdateEndpoint Methods (==) :: UpdateEndpoint -> UpdateEndpoint -> Bool # (/=) :: UpdateEndpoint -> UpdateEndpoint -> Bool #
Hashable UpdateEndpoint Source #
Instance details Defined in Amazonka.SageMaker.UpdateEndpoint Methods hashWithSalt :: Int -> UpdateEndpoint -> Int # hash :: UpdateEndpoint -> Int #
type AWSResponse UpdateEndpoint Source #
Instance details Defined in Amazonka.SageMaker.UpdateEndpoint type AWSResponse UpdateEndpoint = UpdateEndpointResponse
type Rep UpdateEndpoint Source #
Instance details Defined in Amazonka.SageMaker.UpdateEndpoint type Rep UpdateEndpoint = D1 ('MetaData "UpdateEndpoint" "Amazonka.SageMaker.UpdateEndpoint" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "UpdateEndpoint'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "deploymentConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeploymentConfig)) :: (S1 ('MetaSel ('Just "excludeRetainedVariantProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [VariantProperty])) :: S1 ('MetaSel ('Just "retainAllVariantProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: (S1 ('MetaSel ('Just "retainDeploymentConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "endpointName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "endpointConfigName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateEndpoint Source #

Arguments

:: Text	`UpdateEndpoint`
-> Text	`UpdateEndpoint`
-> 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:

UpdateEndpoint, updateEndpoint_deploymentConfig - The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

$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:retainDeploymentConfig:UpdateEndpoint', updateEndpoint_retainDeploymentConfig - Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused).

UpdateEndpoint, updateEndpoint_endpointName - The name of the endpoint whose configuration you want to update.

UpdateEndpoint, updateEndpoint_endpointConfigName - The name of the new endpoint configuration.

Request Lenses

updateEndpoint_deploymentConfig :: Lens' UpdateEndpoint (Maybe DeploymentConfig) Source #

The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

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_retainDeploymentConfig :: Lens' UpdateEndpoint (Maybe Bool) Source #

Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused).

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 httpStatus :: Int The response's http status code. endpointArn :: Text The Amazon Resource Name (ARN) of the endpoint.

Instances

Instances details

Generic UpdateEndpointResponse Source #
Instance details Defined in Amazonka.SageMaker.UpdateEndpoint Associated Types type Rep UpdateEndpointResponse :: Type -> Type # Methods from :: UpdateEndpointResponse -> Rep UpdateEndpointResponse x # to :: Rep UpdateEndpointResponse x -> UpdateEndpointResponse #
Read UpdateEndpointResponse Source #
Instance details Defined in Amazonka.SageMaker.UpdateEndpoint Methods readsPrec :: Int -> ReadS UpdateEndpointResponse # readList :: ReadS [UpdateEndpointResponse] # readPrec :: ReadPrec UpdateEndpointResponse # readListPrec :: ReadPrec [UpdateEndpointResponse] #
Show UpdateEndpointResponse Source #
Instance details Defined in Amazonka.SageMaker.UpdateEndpoint Methods showsPrec :: Int -> UpdateEndpointResponse -> ShowS # show :: UpdateEndpointResponse -> String # showList :: [UpdateEndpointResponse] -> ShowS #
NFData UpdateEndpointResponse Source #
Instance details Defined in Amazonka.SageMaker.UpdateEndpoint Methods rnf :: UpdateEndpointResponse -> () #
Eq UpdateEndpointResponse Source #
Instance details Defined in Amazonka.SageMaker.UpdateEndpoint Methods (==) :: UpdateEndpointResponse -> UpdateEndpointResponse -> Bool # (/=) :: UpdateEndpointResponse -> UpdateEndpointResponse -> Bool #
type Rep UpdateEndpointResponse Source #
Instance details Defined in Amazonka.SageMaker.UpdateEndpoint type Rep UpdateEndpointResponse = D1 ('MetaData "UpdateEndpointResponse" "Amazonka.SageMaker.UpdateEndpoint" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "UpdateEndpointResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "endpointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newUpdateEndpointResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateEndpointResponse'`
-> Text	`UpdateEndpointResponse`
-> 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.

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.