Table Of Contents

  1. Docs
  2. Available services
  3. AugmentedAIRuntime

AugmentedAIRuntime

Client

class AugmentedAIRuntime.Client

A low-level client representing Amazon Augmented AI Runtime

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:

  • 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. To learn how to start a human loop using this API, see Create and Start a Human Loop for a Custom Task Type 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 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 in the Amazon SageMaker Developer Guide.

import boto3

client = boto3.client('sagemaker-a2i-runtime')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
close()

Closes underlying endpoint connections.

delete_human_loop(**kwargs)

Deletes the specified human loop for a flow definition.

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

See also: AWS API Documentation

Request Syntax

response = client.delete_human_loop(
    HumanLoopName='string'
)
Parameters
HumanLoopName (string) --

[REQUIRED]

The name of the human loop that you want to delete.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • AugmentedAIRuntime.Client.exceptions.ValidationException
  • AugmentedAIRuntime.Client.exceptions.ResourceNotFoundException
  • AugmentedAIRuntime.Client.exceptions.ThrottlingException
  • AugmentedAIRuntime.Client.exceptions.InternalServerException
describe_human_loop(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_human_loop(
    HumanLoopName='string'
)
Parameters
HumanLoopName (string) --

[REQUIRED]

The name of the human loop that you want information about.

Return type
dict
Returns
Response Syntax
{
    'CreationTime': datetime(2015, 1, 1),
    'FailureReason': 'string',
    'FailureCode': 'string',
    'HumanLoopStatus': 'InProgress'|'Failed'|'Completed'|'Stopped'|'Stopping',
    'HumanLoopName': 'string',
    'HumanLoopArn': 'string',
    'FlowDefinitionArn': 'string',
    'HumanLoopOutput': {
        'OutputS3Uri': 'string'
    }
}

Response Structure

  • (dict) --
    • CreationTime (datetime) --

      The creation time when Amazon Augmented AI created the human loop.

    • FailureReason (string) --

      The reason why a human loop failed. The failure reason is returned when the status of the human loop is Failed .

    • FailureCode (string) --

      A failure code that identifies the type of failure.

      Possible values: ValidationError , Expired , InternalError

    • HumanLoopStatus (string) --

      The status of the human loop.

    • HumanLoopName (string) --

      The name of the human loop. The name must be lowercase, unique within the Region in your account, and can have up to 63 characters. Valid characters: a-z, 0-9, and - (hyphen).

    • HumanLoopArn (string) --

      The Amazon Resource Name (ARN) of the human loop.

    • FlowDefinitionArn (string) --

      The Amazon Resource Name (ARN) of the flow definition.

    • HumanLoopOutput (dict) --

      An object that contains information about the output of the human loop.

      • OutputS3Uri (string) --

        The location of the Amazon S3 object where Amazon Augmented AI stores your human loop output.

Exceptions

  • AugmentedAIRuntime.Client.exceptions.ValidationException
  • AugmentedAIRuntime.Client.exceptions.ResourceNotFoundException
  • AugmentedAIRuntime.Client.exceptions.ThrottlingException
  • AugmentedAIRuntime.Client.exceptions.InternalServerException
get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_human_loops(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_human_loops(
    CreationTimeAfter=datetime(2015, 1, 1),
    CreationTimeBefore=datetime(2015, 1, 1),
    FlowDefinitionArn='string',
    SortOrder='Ascending'|'Descending',
    NextToken='string',
    MaxResults=123
)
Parameters
  • CreationTimeAfter (datetime) -- (Optional) The timestamp of the date when you want the human loops to begin in ISO 8601 format. For example, 2020-02-24 .
  • CreationTimeBefore (datetime) -- (Optional) The timestamp of the date before which you want the human loops to begin in ISO 8601 format. For example, 2020-02-24 .
  • FlowDefinitionArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of a flow definition.

  • SortOrder (string) -- Optional. The order for displaying results. Valid values: Ascending and Descending .
  • NextToken (string) -- A token to display the next page of results.
  • MaxResults (integer) -- The total number of items to return. If the total number of available items is more than the value specified in MaxResults , then a NextToken is returned in the output. You can use this token to display the next page of results.
Return type

dict

Returns

Response Syntax

{
    'HumanLoopSummaries': [
        {
            'HumanLoopName': 'string',
            'HumanLoopStatus': 'InProgress'|'Failed'|'Completed'|'Stopped'|'Stopping',
            'CreationTime': datetime(2015, 1, 1),
            'FailureReason': 'string',
            'FlowDefinitionArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • HumanLoopSummaries (list) --

      An array of objects that contain information about the human loops.

      • (dict) --

        Summary information about the human loop.

        • HumanLoopName (string) --

          The name of the human loop.

        • HumanLoopStatus (string) --

          The status of the human loop.

        • CreationTime (datetime) --

          When Amazon Augmented AI created the human loop.

        • FailureReason (string) --

          The reason why the human loop failed. A failure reason is returned when the status of the human loop is Failed .

        • FlowDefinitionArn (string) --

          The Amazon Resource Name (ARN) of the flow definition used to configure the human loop.

    • NextToken (string) --

      A token to display the next page of results.

Exceptions

  • AugmentedAIRuntime.Client.exceptions.ValidationException
  • AugmentedAIRuntime.Client.exceptions.ResourceNotFoundException
  • AugmentedAIRuntime.Client.exceptions.ThrottlingException
  • AugmentedAIRuntime.Client.exceptions.InternalServerException
start_human_loop(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.start_human_loop(
    HumanLoopName='string',
    FlowDefinitionArn='string',
    HumanLoopInput={
        'InputContent': 'string'
    },
    DataAttributes={
        'ContentClassifiers': [
            'FreeOfPersonallyIdentifiableInformation'|'FreeOfAdultContent',
        ]
    }
)
Parameters
  • HumanLoopName (string) --

    [REQUIRED]

    The name of the human loop.

  • FlowDefinitionArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the flow definition associated with this human loop.

  • HumanLoopInput (dict) --

    [REQUIRED]

    An object that contains information about the human loop.

    • InputContent (string) -- [REQUIRED]

      Serialized input from the human loop. The input must be a string representation of a file in JSON format.

  • DataAttributes (dict) --

    Attributes of the specified data. Use DataAttributes to specify if your data is free of personally identifiable information and/or free of adult content.

    • ContentClassifiers (list) -- [REQUIRED]

      Declares that your content is free of personally identifiable information or adult content.

      Amazon SageMaker can restrict the Amazon Mechanical Turk workers who can view your task based on this information.

      • (string) --
Return type

dict

Returns

Response Syntax

{
    'HumanLoopArn': 'string'
}

Response Structure

  • (dict) --

    • HumanLoopArn (string) --

      The Amazon Resource Name (ARN) of the human loop.

Exceptions

  • AugmentedAIRuntime.Client.exceptions.ValidationException
  • AugmentedAIRuntime.Client.exceptions.ThrottlingException
  • AugmentedAIRuntime.Client.exceptions.ServiceQuotaExceededException
  • AugmentedAIRuntime.Client.exceptions.InternalServerException
  • AugmentedAIRuntime.Client.exceptions.ConflictException
stop_human_loop(**kwargs)

Stops the specified human loop.

See also: AWS API Documentation

Request Syntax

response = client.stop_human_loop(
    HumanLoopName='string'
)
Parameters
HumanLoopName (string) --

[REQUIRED]

The name of the human loop that you want to stop.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • AugmentedAIRuntime.Client.exceptions.ValidationException
  • AugmentedAIRuntime.Client.exceptions.ResourceNotFoundException
  • AugmentedAIRuntime.Client.exceptions.ThrottlingException
  • AugmentedAIRuntime.Client.exceptions.InternalServerException

Paginators

The available paginators are:

class AugmentedAIRuntime.Paginator.ListHumanLoops
paginator = client.get_paginator('list_human_loops')
paginate(**kwargs)

Creates an iterator that will paginate through responses from AugmentedAIRuntime.Client.list_human_loops().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    CreationTimeAfter=datetime(2015, 1, 1),
    CreationTimeBefore=datetime(2015, 1, 1),
    FlowDefinitionArn='string',
    SortOrder='Ascending'|'Descending',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • CreationTimeAfter (datetime) -- (Optional) The timestamp of the date when you want the human loops to begin in ISO 8601 format. For example, 2020-02-24 .
  • CreationTimeBefore (datetime) -- (Optional) The timestamp of the date before which you want the human loops to begin in ISO 8601 format. For example, 2020-02-24 .
  • FlowDefinitionArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of a flow definition.

  • SortOrder (string) -- Optional. The order for displaying results. Valid values: Ascending and Descending .
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'HumanLoopSummaries': [
        {
            'HumanLoopName': 'string',
            'HumanLoopStatus': 'InProgress'|'Failed'|'Completed'|'Stopped'|'Stopping',
            'CreationTime': datetime(2015, 1, 1),
            'FailureReason': 'string',
            'FlowDefinitionArn': 'string'
        },
    ],

}

Response Structure

  • (dict) --

    • HumanLoopSummaries (list) --

      An array of objects that contain information about the human loops.

      • (dict) --

        Summary information about the human loop.

        • HumanLoopName (string) --

          The name of the human loop.

        • HumanLoopStatus (string) --

          The status of the human loop.

        • CreationTime (datetime) --

          When Amazon Augmented AI created the human loop.

        • FailureReason (string) --

          The reason why the human loop failed. A failure reason is returned when the status of the human loop is Failed .

        • FlowDefinitionArn (string) --

          The Amazon Resource Name (ARN) of the flow definition used to configure the human loop.

SageMaker
SagemakerEdgeManager
Privacy | Site Terms | Cookie preferences | © Copyright 2022, Amazon Web Services, Inc. Created using Sphinx.