com.amazonaws.services.augmentedairuntime.AmazonAugmentedAIRuntime 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.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.augmentedairuntime.model.*;
/**
* Interface for accessing Amazon Augmented AI Runtime.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.augmentedairuntime.AbstractAmazonAugmentedAIRuntime} 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 AmazonAugmentedAIRuntime {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "a2i-runtime.sagemaker";
/**
*
* Deletes the specified human loop for a flow definition.
*
*
* If the human loop was deleted, this operation will return a ResourceNotFoundException.
*
*
* @param deleteHumanLoopRequest
* @return Result of the DeleteHumanLoop operation returned by the service.
* @throws ValidationException
* The request isn't valid. Check the syntax and try again.
* @throws ResourceNotFoundException
* We couldn't find the requested resource. Check that your resources exists and were created in the same
* AWS Region as your request, and try your request again.
* @throws ThrottlingException
* You exceeded the maximum number of requests.
* @throws InternalServerException
* We couldn't process your request because of an issue with the server. Try again later.
* @sample AmazonAugmentedAIRuntime.DeleteHumanLoop
* @see AWS API Documentation
*/
DeleteHumanLoopResult deleteHumanLoop(DeleteHumanLoopRequest deleteHumanLoopRequest);
/**
*
* Returns information about the specified human loop. If the human loop was deleted, this operation will return a
* ResourceNotFoundException error.
*
*
* @param describeHumanLoopRequest
* @return Result of the DescribeHumanLoop operation returned by the service.
* @throws ValidationException
* The request isn't valid. Check the syntax and try again.
* @throws ResourceNotFoundException
* We couldn't find the requested resource. Check that your resources exists and were created in the same
* AWS Region as your request, and try your request again.
* @throws ThrottlingException
* You exceeded the maximum number of requests.
* @throws InternalServerException
* We couldn't process your request because of an issue with the server. Try again later.
* @sample AmazonAugmentedAIRuntime.DescribeHumanLoop
* @see AWS API Documentation
*/
DescribeHumanLoopResult describeHumanLoop(DescribeHumanLoopRequest describeHumanLoopRequest);
/**
*
* Returns information about human loops, given the specified parameters. If a human loop was deleted, it will not
* be included.
*
*
* @param listHumanLoopsRequest
* @return Result of the ListHumanLoops operation returned by the service.
* @throws ValidationException
* The request isn't valid. Check the syntax and try again.
* @throws ResourceNotFoundException
* We couldn't find the requested resource. Check that your resources exists and were created in the same
* AWS Region as your request, and try your request again.
* @throws ThrottlingException
* You exceeded the maximum number of requests.
* @throws InternalServerException
* We couldn't process your request because of an issue with the server. Try again later.
* @sample AmazonAugmentedAIRuntime.ListHumanLoops
* @see AWS API Documentation
*/
ListHumanLoopsResult listHumanLoops(ListHumanLoopsRequest listHumanLoopsRequest);
/**
*
* Starts a human loop, provided that at least one activation condition is met.
*
*
* @param startHumanLoopRequest
* @return Result of the StartHumanLoop operation returned by the service.
* @throws ValidationException
* The request isn't valid. Check the syntax and try again.
* @throws ThrottlingException
* You exceeded the maximum number of requests.
* @throws ServiceQuotaExceededException
* You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of
* service resources or operations for your AWS account. For a list of Amazon A2I service quotes, see Amazon Augmented AI Service Quotes.
* Delete some resources or request an increase in your service quota. You can request a quota increase
* using Service Quotas or the AWS Support Center. To request an increase, see AWS Service Quotas in
* the AWS General Reference.
* @throws InternalServerException
* We couldn't process your request because of an issue with the server. Try again later.
* @throws ConflictException
* Your request has the same name as another active human loop but has different input data. You cannot
* start two human loops with the same name and different input data.
* @sample AmazonAugmentedAIRuntime.StartHumanLoop
* @see AWS API Documentation
*/
StartHumanLoopResult startHumanLoop(StartHumanLoopRequest startHumanLoopRequest);
/**
*
* Stops the specified human loop.
*
*
* @param stopHumanLoopRequest
* @return Result of the StopHumanLoop operation returned by the service.
* @throws ValidationException
* The request isn't valid. Check the syntax and try again.
* @throws ResourceNotFoundException
* We couldn't find the requested resource. Check that your resources exists and were created in the same
* AWS Region as your request, and try your request again.
* @throws ThrottlingException
* You exceeded the maximum number of requests.
* @throws InternalServerException
* We couldn't process your request because of an issue with the server. Try again later.
* @sample AmazonAugmentedAIRuntime.StopHumanLoop
* @see AWS API Documentation
*/
StopHumanLoopResult stopHumanLoop(StopHumanLoopRequest stopHumanLoopRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic
* information for an executed request, you should use this method to retrieve it as soon as possible after
* executing a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}