com.amazonaws.services.augmentedairuntime

Class AmazonAugmentedAIRuntimeClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.augmentedairuntime.AmazonAugmentedAIRuntimeClient

All Implemented Interfaces:

AmazonAugmentedAIRuntime

Direct Known Subclasses:

AmazonAugmentedAIRuntimeAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonAugmentedAIRuntimeClient
extends AmazonWebServiceClient
implements AmazonAugmentedAIRuntime

Client for accessing Amazon Augmented AI Runtime. All service calls made using this client are blocking, and will not return until the service call completes.

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
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.augmentedairuntime.AmazonAugmentedAIRuntime

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonAugmentedAIRuntimeClientBuilder	builder()
DeleteHumanLoopResult	deleteHumanLoop(DeleteHumanLoopRequest request) Deletes the specified human loop for a flow definition.
DescribeHumanLoopResult	describeHumanLoop(DescribeHumanLoopRequest request) 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 request) Returns information about human loops, given the specified parameters.
StartHumanLoopResult	startHumanLoop(StartHumanLoopRequest request) Starts a human loop, provided that at least one activation condition is met.
StopHumanLoopResult	stopHumanLoop(StopHumanLoopRequest request) Stops the specified human loop.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.augmentedairuntime.AmazonAugmentedAIRuntime

shutdown

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AmazonAugmentedAIRuntimeClientBuilder builder()

deleteHumanLoop

public DeleteHumanLoopResult deleteHumanLoop(DeleteHumanLoopRequest request)

Deletes the specified human loop for a flow definition.

Specified by:

deleteHumanLoop in interface AmazonAugmentedAIRuntime

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

public DescribeHumanLoopResult describeHumanLoop(DescribeHumanLoopRequest request)

Returns information about the specified human loop.

Specified by:

describeHumanLoop in interface AmazonAugmentedAIRuntime

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

public ListHumanLoopsResult listHumanLoops(ListHumanLoopsRequest request)

Returns information about human loops, given the specified parameters.

Specified by:

listHumanLoops in interface AmazonAugmentedAIRuntime

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

public StartHumanLoopResult startHumanLoop(StartHumanLoopRequest request)

Starts a human loop, provided that at least one activation condition is met.

Specified by:

startHumanLoop in interface AmazonAugmentedAIRuntime

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

public StopHumanLoopResult stopHumanLoop(StopHumanLoopRequest request)

Stops the specified human loop.

Specified by:

stopHumanLoop in interface AmazonAugmentedAIRuntime

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AmazonAugmentedAIRuntime

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.