We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.AugmentedAIRuntime

Inherits:
AWS.Service show all
Identifier:
augmentedairuntime
API Version:
2019-11-07
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

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

Sending a Request Using AugmentedAIRuntime

var augmentedairuntime = new AWS.AugmentedAIRuntime();
augmentedairuntime.deleteHumanLoop(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the AugmentedAIRuntime object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var augmentedairuntime = new AWS.AugmentedAIRuntime({apiVersion: '2019-11-07'});

You can also set the API version globally in AWS.config.apiVersions using the augmentedairuntime service identifier:

AWS.config.apiVersions = {
  augmentedairuntime: '2019-11-07',
  // other service API versions
};

var augmentedairuntime = new AWS.AugmentedAIRuntime();

Version:

  • 2019-11-07

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.AugmentedAIRuntime(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a AugmentedAIRuntime object

var augmentedairuntime = new AWS.AugmentedAIRuntime({apiVersion: '2019-11-07'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.AugmentedAIRuntime.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.AugmentedAIRuntime.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.AugmentedAIRuntime.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean) —

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean) —

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

deleteHumanLoop(params = {}, callback) ⇒ AWS.Request

Deletes the specified human loop for a flow definition.

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

Service Reference:

Examples:

Calling the deleteHumanLoop operation

var params = {
  HumanLoopName: 'STRING_VALUE' /* required */
};
augmentedairuntime.deleteHumanLoop(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • HumanLoopName — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeHumanLoop(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the describeHumanLoop operation

var params = {
  HumanLoopName: 'STRING_VALUE' /* required */
};
augmentedairuntime.describeHumanLoop(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • HumanLoopName — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CreationTime — (Date)

        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.

        Possible values include:
        • "InProgress"
        • "Failed"
        • "Completed"
        • "Stopped"
        • "Stopping"
      • 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 — (map)

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

        • OutputS3Uri — required — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listHumanLoops(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listHumanLoops operation

var params = {
  FlowDefinitionArn: 'STRING_VALUE', /* required */
  CreationTimeAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  CreationTimeBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SortOrder: Ascending | Descending
};
augmentedairuntime.listHumanLoops(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CreationTimeAfter — (Date)

      (Optional) The timestamp of the date when you want the human loops to begin in ISO 8601 format. For example, 2020-02-24.

    • CreationTimeBefore — (Date)

      (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)

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

    • SortOrder — (String)

      Optional. The order for displaying results. Valid values: Ascending and Descending.

      Possible values include:
      • "Ascending"
      • "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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • HumanLoopSummaries — (Array<map>)

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

        • HumanLoopName — (String)

          The name of the human loop.

        • HumanLoopStatus — (String)

          The status of the human loop.

          Possible values include:
          • "InProgress"
          • "Failed"
          • "Completed"
          • "Stopped"
          • "Stopping"
        • CreationTime — (Date)

          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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

startHumanLoop(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the startHumanLoop operation

var params = {
  FlowDefinitionArn: 'STRING_VALUE', /* required */
  HumanLoopInput: { /* required */
    InputContent: 'STRING_VALUE' /* required */
  },
  HumanLoopName: 'STRING_VALUE', /* required */
  DataAttributes: {
    ContentClassifiers: [ /* required */
      FreeOfPersonallyIdentifiableInformation | FreeOfAdultContent,
      /* more items */
    ]
  }
};
augmentedairuntime.startHumanLoop(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • HumanLoopName — (String)

      The name of the human loop.

    • FlowDefinitionArn — (String)

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

    • HumanLoopInput — (map)

      An object that contains information about the human loop.

      • InputContent — required — (String)

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

    • DataAttributes — (map)

      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 — required — (Array<String>)

        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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • HumanLoopArn — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

stopHumanLoop(params = {}, callback) ⇒ AWS.Request

Stops the specified human loop.

Service Reference:

Examples:

Calling the stopHumanLoop operation

var params = {
  HumanLoopName: 'STRING_VALUE' /* required */
};
augmentedairuntime.stopHumanLoop(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • HumanLoopName — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.