/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.sagemakerruntime; import javax.annotation.Generated; import com.amazonaws.services.sagemakerruntime.model.*; /** * Interface for accessing Amazon SageMaker Runtime asynchronously. Each asynchronous method will return a Java Future * object representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive * notification when an asynchronous operation completes. *

* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.sagemakerruntime.AbstractAmazonSageMakerRuntimeAsync} instead. *

*

*

* The Amazon SageMaker runtime API. *

*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AmazonSageMakerRuntimeAsync extends AmazonSageMakerRuntime { /** *

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

*

* For an overview of Amazon SageMaker, see How It Works. *

*

* 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 InvokeEndpoint 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. *

*

* A customer's model containers must respond to requests within 60 seconds. The model itself can have a maximum * processing time of 60 seconds before responding to invocations. If your model is going to take 50-60 seconds of * processing time, the SDK socket timeout should be set to be 70 seconds. *

* *

* Endpoints are scoped to an individual account, and are not public. The URL does not contain the account ID, but * Amazon SageMaker determines the account ID from the authentication token that is supplied by the caller. *

* * * @param invokeEndpointRequest * @return A Java Future containing the result of the InvokeEndpoint operation returned by the service. * @sample AmazonSageMakerRuntimeAsync.InvokeEndpoint * @see AWS API Documentation */ java.util.concurrent.Future invokeEndpointAsync(InvokeEndpointRequest invokeEndpointRequest); /** *

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

*

* For an overview of Amazon SageMaker, see How It Works. *

*

* 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 InvokeEndpoint 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. *

*

* A customer's model containers must respond to requests within 60 seconds. The model itself can have a maximum * processing time of 60 seconds before responding to invocations. If your model is going to take 50-60 seconds of * processing time, the SDK socket timeout should be set to be 70 seconds. *

* *

* Endpoints are scoped to an individual account, and are not public. The URL does not contain the account ID, but * Amazon SageMaker determines the account ID from the authentication token that is supplied by the caller. *

* * * @param invokeEndpointRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the InvokeEndpoint operation returned by the service. * @sample AmazonSageMakerRuntimeAsyncHandler.InvokeEndpoint * @see AWS API Documentation */ java.util.concurrent.Future invokeEndpointAsync(InvokeEndpointRequest invokeEndpointRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param invokeEndpointAsyncRequest * @return A Java Future containing the result of the InvokeEndpointAsync operation returned by the service. * @sample AmazonSageMakerRuntimeAsync.InvokeEndpointAsync * @see AWS API Documentation */ java.util.concurrent.Future invokeEndpointAsyncAsync(InvokeEndpointAsyncRequest invokeEndpointAsyncRequest); /** *

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

* * @param invokeEndpointAsyncRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the InvokeEndpointAsync operation returned by the service. * @sample AmazonSageMakerRuntimeAsyncHandler.InvokeEndpointAsync * @see AWS API Documentation */ java.util.concurrent.Future invokeEndpointAsyncAsync(InvokeEndpointAsyncRequest invokeEndpointAsyncRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); }