com.amazonaws.services.sagemakerruntime.AmazonSageMakerRuntimeAsync Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2012-2018 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.
 * 
 * 
 * 

 * 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.
     * 
     * 
     * @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.
     * 
     * 
     * @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);

}