com.amazonaws.services.augmentedairuntime.AmazonAugmentedAIRuntimeAsync Maven / Gradle / Ivy
/*
* Copyright 2019-2024 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.augmentedairuntime;
import javax.annotation.Generated;
import com.amazonaws.services.augmentedairuntime.model.*;
/**
* Interface for accessing Amazon Augmented AI 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.augmentedairuntime.AbstractAmazonAugmentedAIRuntimeAsync} instead.
*
*
*
* Amazon Augmented AI (Amazon A2I) adds the benefit of human judgment to any machine learning application. When an AI
* application can't evaluate data with a high degree of confidence, human reviewers can take over. This human review is
* called a human review workflow. To create and start a human review workflow, you need three resources: a worker
* task template, a flow definition, and a human loop.
*
*
* For information about these resources and prerequisites for using Amazon A2I, see Get Started with Amazon Augmented
* AI in the Amazon SageMaker Developer Guide.
*
*
* This API reference includes information about API actions and data types that you can use to interact with Amazon A2I
* programmatically. Use this guide to:
*
*
* -
*
* Start a human loop with the StartHumanLoop operation when using Amazon A2I with a custom task
* type. To learn more about the difference between custom and built-in task types, see Use Task Types . To learn how
* to start a human loop using this API, see Create and Start a Human Loop for a Custom Task Type in the Amazon SageMaker Developer Guide.
*
*
* -
*
* Manage your human loops. You can list all human loops that you have created, describe individual human loops, and
* stop and delete human loops. To learn more, see Monitor and Manage Your
* Human Loop in the Amazon SageMaker Developer Guide.
*
*
*
*
* Amazon A2I integrates APIs from various AWS services to create and start human review workflows for those services.
* To learn how Amazon A2I uses these APIs, see Use APIs in Amazon A2I in the
* Amazon SageMaker Developer Guide.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonAugmentedAIRuntimeAsync extends AmazonAugmentedAIRuntime {
/**
*
* Deletes the specified human loop for a flow definition.
*
*
* If the human loop was deleted, this operation will return a ResourceNotFoundException.
*
*
* @param deleteHumanLoopRequest
* @return A Java Future containing the result of the DeleteHumanLoop operation returned by the service.
* @sample AmazonAugmentedAIRuntimeAsync.DeleteHumanLoop
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteHumanLoopAsync(DeleteHumanLoopRequest deleteHumanLoopRequest);
/**
*
* Deletes the specified human loop for a flow definition.
*
*
* If the human loop was deleted, this operation will return a ResourceNotFoundException.
*
*
* @param deleteHumanLoopRequest
* @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 DeleteHumanLoop operation returned by the service.
* @sample AmazonAugmentedAIRuntimeAsyncHandler.DeleteHumanLoop
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteHumanLoopAsync(DeleteHumanLoopRequest deleteHumanLoopRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns information about the specified human loop. If the human loop was deleted, this operation will return a
* ResourceNotFoundException error.
*
*
* @param describeHumanLoopRequest
* @return A Java Future containing the result of the DescribeHumanLoop operation returned by the service.
* @sample AmazonAugmentedAIRuntimeAsync.DescribeHumanLoop
* @see AWS API Documentation
*/
java.util.concurrent.Future describeHumanLoopAsync(DescribeHumanLoopRequest describeHumanLoopRequest);
/**
*
* Returns information about the specified human loop. If the human loop was deleted, this operation will return a
* ResourceNotFoundException error.
*
*
* @param describeHumanLoopRequest
* @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 DescribeHumanLoop operation returned by the service.
* @sample AmazonAugmentedAIRuntimeAsyncHandler.DescribeHumanLoop
* @see AWS API Documentation
*/
java.util.concurrent.Future describeHumanLoopAsync(DescribeHumanLoopRequest describeHumanLoopRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns information about human loops, given the specified parameters. If a human loop was deleted, it will not
* be included.
*
*
* @param listHumanLoopsRequest
* @return A Java Future containing the result of the ListHumanLoops operation returned by the service.
* @sample AmazonAugmentedAIRuntimeAsync.ListHumanLoops
* @see AWS API Documentation
*/
java.util.concurrent.Future listHumanLoopsAsync(ListHumanLoopsRequest listHumanLoopsRequest);
/**
*
* Returns information about human loops, given the specified parameters. If a human loop was deleted, it will not
* be included.
*
*
* @param listHumanLoopsRequest
* @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 ListHumanLoops operation returned by the service.
* @sample AmazonAugmentedAIRuntimeAsyncHandler.ListHumanLoops
* @see AWS API Documentation
*/
java.util.concurrent.Future listHumanLoopsAsync(ListHumanLoopsRequest listHumanLoopsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Starts a human loop, provided that at least one activation condition is met.
*
*
* @param startHumanLoopRequest
* @return A Java Future containing the result of the StartHumanLoop operation returned by the service.
* @sample AmazonAugmentedAIRuntimeAsync.StartHumanLoop
* @see AWS API Documentation
*/
java.util.concurrent.Future startHumanLoopAsync(StartHumanLoopRequest startHumanLoopRequest);
/**
*
* Starts a human loop, provided that at least one activation condition is met.
*
*
* @param startHumanLoopRequest
* @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 StartHumanLoop operation returned by the service.
* @sample AmazonAugmentedAIRuntimeAsyncHandler.StartHumanLoop
* @see AWS API Documentation
*/
java.util.concurrent.Future startHumanLoopAsync(StartHumanLoopRequest startHumanLoopRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Stops the specified human loop.
*
*
* @param stopHumanLoopRequest
* @return A Java Future containing the result of the StopHumanLoop operation returned by the service.
* @sample AmazonAugmentedAIRuntimeAsync.StopHumanLoop
* @see AWS API Documentation
*/
java.util.concurrent.Future stopHumanLoopAsync(StopHumanLoopRequest stopHumanLoopRequest);
/**
*
* Stops the specified human loop.
*
*
* @param stopHumanLoopRequest
* @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 StopHumanLoop operation returned by the service.
* @sample AmazonAugmentedAIRuntimeAsyncHandler.StopHumanLoop
* @see AWS API Documentation
*/
java.util.concurrent.Future stopHumanLoopAsync(StopHumanLoopRequest stopHumanLoopRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}