Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . sagemaker-a2i-runtime ]

start-human-loop

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  start-human-loop
--human-loop-name <value>
--flow-definition-arn <value>
--human-loop-input <value>
[--data-attributes <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--human-loop-name (string)

The name of the human loop.

--flow-definition-arn (string)

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

--human-loop-input (structure)

An object that contains information about the human loop.

InputContent -> (string)

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

Shorthand Syntax:

InputContent=string

JSON Syntax:

{
  "InputContent": "string"
}

--data-attributes (structure)

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)

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)

Shorthand Syntax:

ContentClassifiers=string,string

JSON Syntax:

{
  "ContentClassifiers": ["FreeOfPersonallyIdentifiableInformation"|"FreeOfAdultContent", ...]
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

HumanLoopArn -> (string)

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