@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Amazon Augmented AI Runtime
@version 2019-11-07
@auth AWS SigV4
@endpoints 5
@toc human-loops(5)

@endpoint DELETE /human-loops/{HumanLoopName}
@desc Deletes the specified human loop for a flow definition. If the human loop was deleted, this operation will return a ResourceNotFoundException.
@required {HumanLoopName: str}

@endpoint GET /human-loops/{HumanLoopName}
@desc Returns information about the specified human loop. If the human loop was deleted, this operation will return a ResourceNotFoundException error.
@required {HumanLoopName: str}
@returns(200) {CreationTime: str(timestamp), FailureReason: str?, FailureCode: str?, HumanLoopStatus: str, HumanLoopName: str, HumanLoopArn: str, FlowDefinitionArn: str, HumanLoopOutput: HumanLoopOutput?{OutputS3Uri: str}}

@endpoint GET /human-loops
@desc Returns information about human loops, given the specified parameters. If a human loop was deleted, it will not be included.
@required {FlowDefinitionArn: str}
@optional {CreationTimeAfter: str(timestamp), CreationTimeBefore: str(timestamp), SortOrder: str, NextToken: str, MaxResults: int}
@returns(200) {HumanLoopSummaries: [HumanLoopSummary], NextToken: str?}

@endpoint POST /human-loops
@desc Starts a human loop, provided that at least one activation condition is met.
@required {HumanLoopName: str, FlowDefinitionArn: str, HumanLoopInput: HumanLoopInput}
@optional {DataAttributes: HumanLoopDataAttributes}
@returns(200) {HumanLoopArn: str?}

@endpoint POST /human-loops/stop
@desc Stops the specified human loop.
@required {HumanLoopName: str}

@end