AmazonAugmentedAIRuntime (AWS Java SDK for Amazon Augmented AI Runtime 1.11.692 API)

All Known Subinterfaces:

AmazonAugmentedAIRuntimeAsync

All Known Implementing Classes:

AbstractAmazonAugmentedAIRuntime, AbstractAmazonAugmentedAIRuntimeAsync, AmazonAugmentedAIRuntimeAsyncClient, AmazonAugmentedAIRuntimeClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonAugmentedAIRuntime
```
Interface for accessing Amazon Augmented AI Runtime.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonAugmentedAIRuntime instead.

Amazon Augmented AI (Augmented AI) (Preview) is a service that adds human judgment to any machine learning application. Human reviewers can take over when an AI application can't evaluate data with a high degree of confidence.

From fraudulent bank transaction identification to document processing to image analysis, machine learning models can be trained to make decisions as well as or better than a human. Nevertheless, some decisions require contextual interpretation, such as when you need to decide whether an image is appropriate for a given audience. Content moderation guidelines are nuanced and highly dependent on context, and they vary between countries. When trying to apply AI in these situations, you can be forced to choose between "ML only" systems with unacceptably high error rates or "human only" systems that are expensive and difficult to scale, and that slow down decision making.

This API reference includes information about API actions and data types you can use to interact with Augmented AI programmatically.

You can create a flow definition against the Augmented AI API. Provide the Amazon Resource Name (ARN) of a flow definition to integrate AI service APIs, such as Textract.AnalyzeDocument and Rekognition.DetectModerationLabels. These AI services, in turn, invoke the StartHumanLoop API, which evaluates conditions under which humans will be invoked. If humans are required, Augmented AI creates a human loop. Results of human work are available asynchronously in Amazon Simple Storage Service (Amazon S3). You can use Amazon CloudWatch Events to detect human work results.

You can find additional Augmented AI API documentation in the following reference guides: Amazon Rekognition, Amazon SageMaker, and Amazon Textract.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`DeleteHumanLoopResult`	`deleteHumanLoop(DeleteHumanLoopRequest deleteHumanLoopRequest)` Deletes the specified human loop for a flow definition.
`DescribeHumanLoopResult`	`describeHumanLoop(DescribeHumanLoopRequest describeHumanLoopRequest)` Returns information about the specified human loop.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`ListHumanLoopsResult`	`listHumanLoops(ListHumanLoopsRequest listHumanLoopsRequest)` Returns information about human loops, given the specified parameters.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartHumanLoopResult`	`startHumanLoop(StartHumanLoopRequest startHumanLoopRequest)` Starts a human loop, provided that at least one activation condition is met.
`StopHumanLoopResult`	`stopHumanLoop(StopHumanLoopRequest stopHumanLoopRequest)` Stops the specified human loop.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    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 Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - deleteHumanLoop
```
DeleteHumanLoopResult deleteHumanLoop(DeleteHumanLoopRequest deleteHumanLoopRequest)
```
    Deletes the specified human loop for a flow definition.
    
    Parameters:
    
    deleteHumanLoopRequest -
    
    Returns:
    
    Result of the DeleteHumanLoop operation returned by the service.
    
    Throws:
    
    ValidationException - Your request was not valid. Check the syntax and try again.
    
    ResourceNotFoundException - We were unable to find the requested resource.
    
    ThrottlingException - Your request has exceeded the allowed amount of requests.
    
    InternalServerException - Your request could not be processed.
    
    See Also:
    
    AWS API Documentation
  - describeHumanLoop
```
DescribeHumanLoopResult describeHumanLoop(DescribeHumanLoopRequest describeHumanLoopRequest)
```
    Returns information about the specified human loop.
    
    Parameters:
    
    describeHumanLoopRequest -
    
    Returns:
    
    Result of the DescribeHumanLoop operation returned by the service.
    
    Throws:
    
    ValidationException - Your request was not valid. Check the syntax and try again.
    
    ResourceNotFoundException - We were unable to find the requested resource.
    
    ThrottlingException - Your request has exceeded the allowed amount of requests.
    
    InternalServerException - Your request could not be processed.
    
    See Also:
    
    AWS API Documentation
  - listHumanLoops
```
ListHumanLoopsResult listHumanLoops(ListHumanLoopsRequest listHumanLoopsRequest)
```
    Returns information about human loops, given the specified parameters.
    
    Parameters:
    
    listHumanLoopsRequest -
    
    Returns:
    
    Result of the ListHumanLoops operation returned by the service.
    
    Throws:
    
    ValidationException - Your request was not valid. Check the syntax and try again.
    
    ThrottlingException - Your request has exceeded the allowed amount of requests.
    
    InternalServerException - Your request could not be processed.
    
    See Also:
    
    AWS API Documentation
  - startHumanLoop
```
StartHumanLoopResult startHumanLoop(StartHumanLoopRequest startHumanLoopRequest)
```
    Starts a human loop, provided that at least one activation condition is met.
    
    Parameters:
    
    startHumanLoopRequest -
    
    Returns:
    
    Result of the StartHumanLoop operation returned by the service.
    
    Throws:
    
    ValidationException - Your request was not valid. Check the syntax and try again.
    
    ThrottlingException - Your request has exceeded the allowed amount of requests.
    
    ServiceQuotaExceededException - You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or request a service quota increase.
    
    InternalServerException - Your request could not be processed.
    
    See Also:
    
    AWS API Documentation
  - stopHumanLoop
```
StopHumanLoopResult stopHumanLoop(StopHumanLoopRequest stopHumanLoopRequest)
```
    Stops the specified human loop.
    
    Parameters:
    
    stopHumanLoopRequest -
    
    Returns:
    
    Result of the StopHumanLoop operation returned by the service.
    
    Throws:
    
    ValidationException - Your request was not valid. Check the syntax and try again.
    
    ResourceNotFoundException - We were unable to find the requested resource.
    
    ThrottlingException - Your request has exceeded the allowed amount of requests.
    
    InternalServerException - Your request could not be processed.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    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.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    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.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Interface AmazonAugmentedAIRuntime

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

deleteHumanLoop

describeHumanLoop

listHumanLoops

startHumanLoop

stopHumanLoop

shutdown

getCachedResponseMetadata