AugmentedAIRuntime / Client / start_human_loop

start_human_loop#

AugmentedAIRuntime.Client.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