DeleteHumanLoop

$result = $client->deleteHumanLoop([/* ... */]);
$promise = $client->deleteHumanLoopAsync([/* ... */]);

Deletes the specified human loop for a flow definition.

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

Parameter Syntax

$result = $client->deleteHumanLoop([
    'HumanLoopName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The request isn't valid. Check the syntax and try again.

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.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

We couldn't process your request because of an issue with the server. Try again later.

DescribeHumanLoop

$result = $client->describeHumanLoop([/* ... */]);
$promise = $client->describeHumanLoopAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeHumanLoop([
    'HumanLoopName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CreationTime' => <DateTime>,
    'FailureCode' => '<string>',
    'FailureReason' => '<string>',
    'FlowDefinitionArn' => '<string>',
    'HumanLoopArn' => '<string>',
    'HumanLoopName' => '<string>',
    'HumanLoopOutput' => [
        'OutputS3Uri' => '<string>',
    ],
    'HumanLoopStatus' => 'InProgress|Failed|Completed|Stopped|Stopping',
]

Result Details

Errors

ValidationException:

The request isn't valid. Check the syntax and try again.

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.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

We couldn't process your request because of an issue with the server. Try again later.

ListHumanLoops

$result = $client->listHumanLoops([/* ... */]);
$promise = $client->listHumanLoopsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listHumanLoops([
    'CreationTimeAfter' => <integer || string || DateTime>,
    'CreationTimeBefore' => <integer || string || DateTime>,
    'FlowDefinitionArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SortOrder' => 'Ascending|Descending',
]);

Parameter Details

Result Syntax

[
    'HumanLoopSummaries' => [
        [
            'CreationTime' => <DateTime>,
            'FailureReason' => '<string>',
            'FlowDefinitionArn' => '<string>',
            'HumanLoopName' => '<string>',
            'HumanLoopStatus' => 'InProgress|Failed|Completed|Stopped|Stopping',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request isn't valid. Check the syntax and try again.

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.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

We couldn't process your request because of an issue with the server. Try again later.

StartHumanLoop

$result = $client->startHumanLoop([/* ... */]);
$promise = $client->startHumanLoopAsync([/* ... */]);

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

Parameter Syntax

$result = $client->startHumanLoop([
    'DataAttributes' => [
        'ContentClassifiers' => ['<string>', ...], // REQUIRED
    ],
    'FlowDefinitionArn' => '<string>', // REQUIRED
    'HumanLoopInput' => [ // REQUIRED
        'InputContent' => '<string>', // REQUIRED
    ],
    'HumanLoopName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'HumanLoopArn' => '<string>',
]

Result Details

Errors

ValidationException:

The request isn't valid. Check the syntax and try again.

ThrottlingException:

You exceeded the maximum number of requests.

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.

InternalServerException:

We couldn't process your request because of an issue with the server. Try again later.

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.

StopHumanLoop

$result = $client->stopHumanLoop([/* ... */]);
$promise = $client->stopHumanLoopAsync([/* ... */]);

Stops the specified human loop.

Parameter Syntax

$result = $client->stopHumanLoop([
    'HumanLoopName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The request isn't valid. Check the syntax and try again.

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.

ThrottlingException:

You exceeded the maximum number of requests.

InternalServerException:

We couldn't process your request because of an issue with the server. Try again later.