AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Implementation for accessing AugmentedAIRuntime

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:

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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.AugmentedAIRuntime.AmazonAugmentedAIRuntimeClient

Namespace: Amazon.AugmentedAIRuntime
Assembly: AWSSDK.AugmentedAIRuntime.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonAugmentedAIRuntimeClient : AmazonServiceClient
         IAmazonAugmentedAIRuntime, IAmazonService, IDisposable

The AmazonAugmentedAIRuntimeClient type exposes the following members

Constructors

NameDescription
Public Method AmazonAugmentedAIRuntimeClient()

Constructs AmazonAugmentedAIRuntimeClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             

Public Method AmazonAugmentedAIRuntimeClient(RegionEndpoint)

Constructs AmazonAugmentedAIRuntimeClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             

Public Method AmazonAugmentedAIRuntimeClient(AmazonAugmentedAIRuntimeConfig)

Constructs AmazonAugmentedAIRuntimeClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             

Public Method AmazonAugmentedAIRuntimeClient(AWSCredentials)

Constructs AmazonAugmentedAIRuntimeClient with AWS Credentials

Public Method AmazonAugmentedAIRuntimeClient(AWSCredentials, RegionEndpoint)

Constructs AmazonAugmentedAIRuntimeClient with AWS Credentials

Public Method AmazonAugmentedAIRuntimeClient(AWSCredentials, AmazonAugmentedAIRuntimeConfig)

Constructs AmazonAugmentedAIRuntimeClient with AWS Credentials and an AmazonAugmentedAIRuntimeClient Configuration object.

Public Method AmazonAugmentedAIRuntimeClient(string, string)

Constructs AmazonAugmentedAIRuntimeClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAugmentedAIRuntimeClient(string, string, RegionEndpoint)

Constructs AmazonAugmentedAIRuntimeClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAugmentedAIRuntimeClient(string, string, AmazonAugmentedAIRuntimeConfig)

Constructs AmazonAugmentedAIRuntimeClient with AWS Access Key ID, AWS Secret Key and an AmazonAugmentedAIRuntimeClient Configuration object.

Public Method AmazonAugmentedAIRuntimeClient(string, string, string)

Constructs AmazonAugmentedAIRuntimeClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAugmentedAIRuntimeClient(string, string, string, RegionEndpoint)

Constructs AmazonAugmentedAIRuntimeClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAugmentedAIRuntimeClient(string, string, string, AmazonAugmentedAIRuntimeConfig)

Constructs AmazonAugmentedAIRuntimeClient with AWS Access Key ID, AWS Secret Key and an AmazonAugmentedAIRuntimeClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.
Public Property Paginators Amazon.AugmentedAIRuntime.Model.IAugmentedAIRuntimePaginatorFactory

Paginators for the service

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method DeleteHumanLoop(DeleteHumanLoopRequest)

Deletes the specified human loop for a flow definition.

If the human loop was deleted, this operation will return a ResourceNotFoundException.

Public Method DeleteHumanLoopAsync(DeleteHumanLoopRequest, CancellationToken)

Deletes the specified human loop for a flow definition.

If the human loop was deleted, this operation will return a ResourceNotFoundException.

Public Method DescribeHumanLoop(DescribeHumanLoopRequest)

Returns information about the specified human loop. If the human loop was deleted, this operation will return a ResourceNotFoundException error.

Public Method DescribeHumanLoopAsync(DescribeHumanLoopRequest, CancellationToken)

Returns information about the specified human loop. If the human loop was deleted, this operation will return a ResourceNotFoundException error.

Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method ListHumanLoops(ListHumanLoopsRequest)

Returns information about human loops, given the specified parameters. If a human loop was deleted, it will not be included.

Public Method ListHumanLoopsAsync(ListHumanLoopsRequest, CancellationToken)

Returns information about human loops, given the specified parameters. If a human loop was deleted, it will not be included.

Public Method StartHumanLoop(StartHumanLoopRequest)

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

Public Method StartHumanLoopAsync(StartHumanLoopRequest, CancellationToken)

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

Public Method StopHumanLoop(StopHumanLoopRequest)

Stops the specified human loop.

Public Method StopHumanLoopAsync(StopHumanLoopRequest, CancellationToken)

Stops the specified human loop.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5