Navigation

Table Of Contents

  1. Docs
  2. Available Services
  3. AugmentedAIRuntime

AugmentedAIRuntime

Client

class AugmentedAIRuntime.Client

A low-level client representing Amazon Augmented AI Runtime:

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.
delete_human_loop(**kwargs)

Deletes the specified human loop for a flow definition.

See also: AWS API Documentation

Request Syntax

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

[REQUIRED]

The name of the human loop you want to delete.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
describe_human_loop(**kwargs)

Returns information about the specified human loop.

See also: AWS API Documentation

Request Syntax

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

[REQUIRED]

The unique name of the human loop.

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 has failed. The failure reason is returned when the human loop status is Failed .

    • FailureCode (string) --

      A failure code denoting a specific type of failure.

    • HumanLoopStatus (string) --

      The status of the human loop. Valid values:

    • HumanLoopName (string) --

      The name of the human loop.

    • 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 containing 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.

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

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) -- An optional value that specifies whether you want the results sorted in Ascending or Descending order.
  • NextToken (string) -- A token to resume pagination.
  • 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 will be provided in the output that you can use to resume pagination.
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 containing 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. Valid values:

        • CreationTime (datetime) --

          When Amazon Augmented AI created the human loop.

        • FailureReason (string) --

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

        • FlowDefinitionArn (string) --

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

    • NextToken (string) --

      A token to resume pagination.

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.

  • HumanLoopInput (dict) --

    [REQUIRED]

    An object containing 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 data specified by the customer.

    • 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.

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 you want to stop.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

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) -- An optional value that specifies whether you want the results sorted in Ascending or Descending order.
  • 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 containing 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. Valid values:

        • CreationTime (datetime) --

          When Amazon Augmented AI created the human loop.

        • FailureReason (string) --

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

        • FlowDefinitionArn (string) --

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

SageMaker
SageMakerRuntime

Navigation

© Copyright 2019, Amazon Web Services, Inc. Created using Sphinx.