Skip to content

/AWS1/IF_SGM=>UPDATEENDPOINT()

About UpdateEndpoint

Deploys the EndpointConfig specified in the request to a new fleet of instances. SageMaker shifts endpoint traffic to the new instances with the updated endpoint configuration and then deletes the old instances using the previous EndpointConfig (there is no availability loss). For more information about how to control the update and traffic shifting process, see Update models in production.

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.

Method Signature

METHODS /AWS1/IF_SGM~UPDATEENDPOINT
  IMPORTING
    !IV_ENDPOINTNAME TYPE /AWS1/SGMENDPOINTNAME OPTIONAL
    !IV_ENDPOINTCONFIGNAME TYPE /AWS1/SGMENDPOINTCONFIGNAME OPTIONAL
    !IV_RETAINALLVARIANTPRPS TYPE /AWS1/SGMBOOLEAN OPTIONAL
    !IT_EXCLUDERTNEDVARIANTPRPS TYPE /AWS1/CL_SGMVARIANTPROPERTY=>TT_VARIANTPROPERTYLIST OPTIONAL
    !IO_DEPLOYMENTCONFIG TYPE REF TO /AWS1/CL_SGMDEPLOYMENTCONFIG OPTIONAL
    !IV_RETAINDEPLOYMENTCONFIG TYPE /AWS1/SGMBOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgmupdateendptoutput
  RAISING
    /AWS1/CX_SGMRESOURCELIMITEXCD
    /AWS1/CX_SGMCLIENTEXC
    /AWS1/CX_SGMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_endpointname TYPE /AWS1/SGMENDPOINTNAME /AWS1/SGMENDPOINTNAME

The name of the endpoint whose configuration you want to update.

iv_endpointconfigname TYPE /AWS1/SGMENDPOINTCONFIGNAME /AWS1/SGMENDPOINTCONFIGNAME

The name of the new endpoint configuration.

Optional arguments:

iv_retainallvariantprps TYPE /AWS1/SGMBOOLEAN /AWS1/SGMBOOLEAN

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.

it_excludertnedvariantprps TYPE /AWS1/CL_SGMVARIANTPROPERTY=>TT_VARIANTPROPERTYLIST TT_VARIANTPROPERTYLIST

When you are updating endpoint resources with 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 ExcludeRetainedVariantProperties, no variant properties are overridden.

io_deploymentconfig TYPE REF TO /AWS1/CL_SGMDEPLOYMENTCONFIG /AWS1/CL_SGMDEPLOYMENTCONFIG

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

iv_retaindeploymentconfig TYPE /AWS1/SGMBOOLEAN /AWS1/SGMBOOLEAN

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

RETURNING

oo_output TYPE REF TO /aws1/cl_sgmupdateendptoutput /AWS1/CL_SGMUPDATEENDPTOUTPUT

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->updateendpoint(
  io_deploymentconfig = new /aws1/cl_sgmdeploymentconfig(
    io_autorollbackconfiguration = new /aws1/cl_sgmautorollbackconfig(
      it_alarms = VALUE /aws1/cl_sgmalarm=>tt_alarmlist(
        ( new /aws1/cl_sgmalarm( |string| ) )
      )
    )
    io_bluegreenupdatepolicy = new /aws1/cl_sgmbluegreenupdateply(
      io_trafficroutingconf = new /aws1/cl_sgmtrafroutingconfig(
        io_canarysize = new /aws1/cl_sgmcapacitysize(
          iv_type = |string|
          iv_value = 123
        )
        io_linearstepsize = new /aws1/cl_sgmcapacitysize(
          iv_type = |string|
          iv_value = 123
        )
        iv_type = |string|
        iv_waitintervalinseconds = 123
      )
      iv_maxexectimeoutinseconds = 123
      iv_terminationwaitinseconds = 123
    )
    io_rollingupdatepolicy = new /aws1/cl_sgmrollingupdateply(
      io_maximumbatchsize = new /aws1/cl_sgmcapacitysize(
        iv_type = |string|
        iv_value = 123
      )
      io_rollbackmaximumbatchsize = new /aws1/cl_sgmcapacitysize(
        iv_type = |string|
        iv_value = 123
      )
      iv_maxexectimeoutinseconds = 123
      iv_waitintervalinseconds = 123
    )
  )
  it_excludertnedvariantprps = VALUE /aws1/cl_sgmvariantproperty=>tt_variantpropertylist(
    ( new /aws1/cl_sgmvariantproperty( |string| ) )
  )
  iv_endpointconfigname = |string|
  iv_endpointname = |string|
  iv_retainallvariantprps = ABAP_TRUE
  iv_retaindeploymentconfig = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_endpointarn = lo_result->get_endpointarn( ).
ENDIF.