Skip to content

/AWS1/CL_SGR=>INVOKEENDPOINTASYNC()

About InvokeEndpointAsync

After you deploy a model into production using Amazon SageMaker hosting services, your client applications use this API to get inferences from the model hosted at the specified endpoint in an asynchronous manner.

Inference requests sent to this API are enqueued for asynchronous processing. The processing of the inference request may or may not complete before you receive a response from this API. The response from this API will not contain the result of the inference request but contain information about where you can locate it.

Amazon SageMaker strips all POST headers except those supported by the API. Amazon SageMaker might add additional headers. You should not rely on the behavior of headers outside those enumerated in the request syntax.

Calls to InvokeEndpointAsync are authenticated by using Amazon Web Services Signature Version 4. For information, see Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon S3 API Reference.

Method Signature

IMPORTING

Required arguments:

iv_endpointname TYPE /AWS1/SGRENDPOINTNAME /AWS1/SGRENDPOINTNAME

The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.

iv_inputlocation TYPE /AWS1/SGRINPUTLOCATIONHEADER /AWS1/SGRINPUTLOCATIONHEADER

The Amazon S3 URI where the inference request payload is stored.

Optional arguments:

iv_contenttype TYPE /AWS1/SGRHEADER /AWS1/SGRHEADER

The MIME type of the input data in the request body.

iv_accept TYPE /AWS1/SGRHEADER /AWS1/SGRHEADER

The desired MIME type of the inference response from the model container.

iv_customattributes TYPE /AWS1/SGRCUSTOMATTRSHEADER /AWS1/SGRCUSTOMATTRSHEADER

Provides additional information about a request for an inference submitted to a model hosted at an Amazon SageMaker endpoint. The information is an opaque value that is forwarded verbatim. You could use this value, for example, to provide an ID that you can use to track a request or to provide other metadata that a service endpoint was programmed to process. The value must consist of no more than 1024 visible US-ASCII characters as specified in Section 3.3.6. Field Value Components of the Hypertext Transfer Protocol (HTTP/1.1).

The code in your model is responsible for setting or updating any custom attributes in the response. If your code does not set this value in the response, an empty value is returned. For example, if a custom attribute represents the trace ID, your model can prepend the custom attribute with Trace ID: in your post-processing function.

This feature is currently supported in the Amazon Web Services SDKs but not in the Amazon SageMaker Python SDK.

iv_inferenceid TYPE /AWS1/SGRINFERENCEID /AWS1/SGRINFERENCEID

The identifier for the inference request. Amazon SageMaker will generate an identifier for you if none is specified.

iv_requestttlseconds TYPE /AWS1/SGRREQTTLSECONDSHEADER /AWS1/SGRREQTTLSECONDSHEADER

Maximum age in seconds a request can be in the queue before it is marked as expired. The default is 6 hours, or 21,600 seconds.

iv_invocationtimeoutseconds TYPE /AWS1/SGRINVCTMOUTSECSHEADER /AWS1/SGRINVCTMOUTSECSHEADER

Maximum amount of time in seconds a request can be processed before it is marked as expired. The default is 15 minutes, or 900 seconds.

RETURNING

oo_output TYPE REF TO /aws1/cl_sgrinvkendptasyncout /AWS1/CL_SGRINVKENDPTASYNCOUT

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->/aws1/if_sgr~invokeendpointasync(
  iv_accept = |string|
  iv_contenttype = |string|
  iv_customattributes = |string|
  iv_endpointname = |string|
  iv_inferenceid = |string|
  iv_inputlocation = |string|
  iv_invocationtimeoutseconds = 123
  iv_requestttlseconds = 123
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_header = lo_result->get_inferenceid( ).
  lv_header = lo_result->get_outputlocation( ).
  lv_header = lo_result->get_failurelocation( ).
ENDIF.