NAME

Paws::SageMakerA2IRuntime - Perl Interface to AWS Amazon Augmented AI Runtime

SYNOPSIS

  use Paws;
  my $obj = Paws->service('SageMakerA2IRuntime');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

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 (https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-getting-started.html) 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 (https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-task-types-general.html). To learn how to start a human loop using this API, see Create and Start a Human Loop for a Custom Task Type (https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-start-human-loop.html#a2i-instructions-starthumanloop) 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 (https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-monitor-humanloop-results.html) 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 (https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-api-references.html) in the Amazon SageMaker Developer Guide.

For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/a2i-runtime.sagemaker-2019-11-07>

METHODS

DeleteHumanLoop

HumanLoopName => Str

Each argument is described in detail in: Paws::SageMakerA2IRuntime::DeleteHumanLoop

Returns: a Paws::SageMakerA2IRuntime::DeleteHumanLoopResponse instance

Deletes the specified human loop for a flow definition.

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

DescribeHumanLoop

HumanLoopName => Str

Each argument is described in detail in: Paws::SageMakerA2IRuntime::DescribeHumanLoop

Returns: a Paws::SageMakerA2IRuntime::DescribeHumanLoopResponse instance

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

ListHumanLoops

FlowDefinitionArn => Str
[CreationTimeAfter => Str]
[CreationTimeBefore => Str]
[MaxResults => Int]
[NextToken => Str]
[SortOrder => Str]

Each argument is described in detail in: Paws::SageMakerA2IRuntime::ListHumanLoops

Returns: a Paws::SageMakerA2IRuntime::ListHumanLoopsResponse instance

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

StartHumanLoop

FlowDefinitionArn => Str
HumanLoopInput => Paws::SageMakerA2IRuntime::HumanLoopInput
HumanLoopName => Str
[DataAttributes => Paws::SageMakerA2IRuntime::HumanLoopDataAttributes]

Each argument is described in detail in: Paws::SageMakerA2IRuntime::StartHumanLoop

Returns: a Paws::SageMakerA2IRuntime::StartHumanLoopResponse instance

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

StopHumanLoop

HumanLoopName => Str

Each argument is described in detail in: Paws::SageMakerA2IRuntime::StopHumanLoop

Returns: a Paws::SageMakerA2IRuntime::StopHumanLoopResponse instance

Stops the specified human loop.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

ListAllHumanLoops(sub { },FlowDefinitionArn => Str, [CreationTimeAfter => Str, CreationTimeBefore => Str, MaxResults => Int, NextToken => Str, SortOrder => Str])

ListAllHumanLoops(FlowDefinitionArn => Str, [CreationTimeAfter => Str, CreationTimeBefore => Str, MaxResults => Int, NextToken => Str, SortOrder => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - HumanLoopSummaries, passing the object as the first parameter, and the string 'HumanLoopSummaries' as the second parameter

If not, it will return a a Paws::SageMakerA2IRuntime::ListHumanLoopsResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>