| 1 |
{ |
| 2 |
"version": "2.0", |
| 3 |
"service": "<p>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 <i>worker task template</i>, a <i>flow definition</i>, and a <i>human loop</i>.</p> <p>For information about these resources and prerequisites for using Amazon A2I, see <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-getting-started.html\">Get Started with Amazon Augmented AI</a> in the Amazon SageMaker Developer Guide.</p> <p>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:</p> <ul> <li> <p>Start a human loop with the <code>StartHumanLoop</code> operation when using Amazon A2I with a <i>custom task type</i>. To learn more about the difference between custom and built-in task types, see <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-task-types-general.html\">Use Task Types </a>. To learn how to start a human loop using this API, see <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-start-human-loop.html#a2i-instructions-starthumanloop\">Create and Start a Human Loop for a Custom Task Type </a> in the Amazon SageMaker Developer Guide.</p> </li> <li> <p>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 <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-monitor-humanloop-results.html\">Monitor and Manage Your Human Loop </a> in the Amazon SageMaker Developer Guide.</p> </li> </ul> <p>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 <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-api-references.html\">Use APIs in Amazon A2I</a> in the Amazon SageMaker Developer Guide.</p>", |
| 4 |
"operations": { |
| 5 |
"DeleteHumanLoop": "<p>Deletes the specified human loop for a flow definition.</p> <p>If the human loop was deleted, this operation will return a <code>ResourceNotFoundException</code>. </p>", |
| 6 |
"DescribeHumanLoop": "<p>Returns information about the specified human loop. If the human loop was deleted, this operation will return a <code>ResourceNotFoundException</code> error. </p>", |
| 7 |
"ListHumanLoops": "<p>Returns information about human loops, given the specified parameters. If a human loop was deleted, it will not be included.</p>", |
| 8 |
"StartHumanLoop": "<p>Starts a human loop, provided that at least one activation condition is met.</p>", |
| 9 |
"StopHumanLoop": "<p>Stops the specified human loop.</p>" |
| 10 |
}, |
| 11 |
"shapes": { |
| 12 |
"ConflictException": { |
| 13 |
"base": "<p>Your request has the same name as another active human loop but has different input data. You cannot start two human loops with the same name and different input data.</p>", |
| 14 |
"refs": { |
| 15 |
} |
| 16 |
}, |
| 17 |
"ContentClassifier": { |
| 18 |
"base": null, |
| 19 |
"refs": { |
| 20 |
"ContentClassifiers$member": null |
| 21 |
} |
| 22 |
}, |
| 23 |
"ContentClassifiers": { |
| 24 |
"base": null, |
| 25 |
"refs": { |
| 26 |
"HumanLoopDataAttributes$ContentClassifiers": "<p>Declares that your content is free of personally identifiable information or adult content.</p> <p>Amazon SageMaker can restrict the Amazon Mechanical Turk workers who can view your task based on this information.</p>" |
| 27 |
} |
| 28 |
}, |
| 29 |
"DeleteHumanLoopRequest": { |
| 30 |
"base": null, |
| 31 |
"refs": { |
| 32 |
} |
| 33 |
}, |
| 34 |
"DeleteHumanLoopResponse": { |
| 35 |
"base": null, |
| 36 |
"refs": { |
| 37 |
} |
| 38 |
}, |
| 39 |
"DescribeHumanLoopRequest": { |
| 40 |
"base": null, |
| 41 |
"refs": { |
| 42 |
} |
| 43 |
}, |
| 44 |
"DescribeHumanLoopResponse": { |
| 45 |
"base": null, |
| 46 |
"refs": { |
| 47 |
} |
| 48 |
}, |
| 49 |
"FailureReason": { |
| 50 |
"base": null, |
| 51 |
"refs": { |
| 52 |
"ConflictException$Message": null, |
| 53 |
"HumanLoopSummary$FailureReason": "<p>The reason why the human loop failed. A failure reason is returned when the status of the human loop is <code>Failed</code>.</p>", |
| 54 |
"InternalServerException$Message": null, |
| 55 |
"ResourceNotFoundException$Message": null, |
| 56 |
"ServiceQuotaExceededException$Message": null, |
| 57 |
"ThrottlingException$Message": null, |
| 58 |
"ValidationException$Message": null |
| 59 |
} |
| 60 |
}, |
| 61 |
"FlowDefinitionArn": { |
| 62 |
"base": null, |
| 63 |
"refs": { |
| 64 |
"DescribeHumanLoopResponse$FlowDefinitionArn": "<p>The Amazon Resource Name (ARN) of the flow definition.</p>", |
| 65 |
"HumanLoopSummary$FlowDefinitionArn": "<p>The Amazon Resource Name (ARN) of the flow definition used to configure the human loop.</p>", |
| 66 |
"ListHumanLoopsRequest$FlowDefinitionArn": "<p>The Amazon Resource Name (ARN) of a flow definition.</p>", |
| 67 |
"StartHumanLoopRequest$FlowDefinitionArn": "<p>The Amazon Resource Name (ARN) of the flow definition associated with this human loop.</p>" |
| 68 |
} |
| 69 |
}, |
| 70 |
"HumanLoopArn": { |
| 71 |
"base": null, |
| 72 |
"refs": { |
| 73 |
"DescribeHumanLoopResponse$HumanLoopArn": "<p>The Amazon Resource Name (ARN) of the human loop.</p>", |
| 74 |
"StartHumanLoopResponse$HumanLoopArn": "<p>The Amazon Resource Name (ARN) of the human loop.</p>" |
| 75 |
} |
| 76 |
}, |
| 77 |
"HumanLoopDataAttributes": { |
| 78 |
"base": "<p>Attributes of the data specified by the customer. Use these to describe the data to be labeled.</p>", |
| 79 |
"refs": { |
| 80 |
"StartHumanLoopRequest$DataAttributes": "<p>Attributes of the specified data. Use <code>DataAttributes</code> to specify if your data is free of personally identifiable information and/or free of adult content.</p>" |
| 81 |
} |
| 82 |
}, |
| 83 |
"HumanLoopInput": { |
| 84 |
"base": "<p>An object containing the human loop input in JSON format.</p>", |
| 85 |
"refs": { |
| 86 |
"StartHumanLoopRequest$HumanLoopInput": "<p>An object that contains information about the human loop.</p>" |
| 87 |
} |
| 88 |
}, |
| 89 |
"HumanLoopName": { |
| 90 |
"base": null, |
| 91 |
"refs": { |
| 92 |
"DeleteHumanLoopRequest$HumanLoopName": "<p>The name of the human loop that you want to delete.</p>", |
| 93 |
"DescribeHumanLoopRequest$HumanLoopName": "<p>The name of the human loop that you want information about.</p>", |
| 94 |
"DescribeHumanLoopResponse$HumanLoopName": "<p>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).</p>", |
| 95 |
"HumanLoopSummary$HumanLoopName": "<p>The name of the human loop.</p>", |
| 96 |
"StartHumanLoopRequest$HumanLoopName": "<p>The name of the human loop.</p>", |
| 97 |
"StopHumanLoopRequest$HumanLoopName": "<p>The name of the human loop that you want to stop.</p>" |
| 98 |
} |
| 99 |
}, |
| 100 |
"HumanLoopOutput": { |
| 101 |
"base": "<p>Information about where the human output will be stored.</p>", |
| 102 |
"refs": { |
| 103 |
"DescribeHumanLoopResponse$HumanLoopOutput": "<p>An object that contains information about the output of the human loop.</p>" |
| 104 |
} |
| 105 |
}, |
| 106 |
"HumanLoopStatus": { |
| 107 |
"base": null, |
| 108 |
"refs": { |
| 109 |
"DescribeHumanLoopResponse$HumanLoopStatus": "<p>The status of the human loop. </p>", |
| 110 |
"HumanLoopSummary$HumanLoopStatus": "<p>The status of the human loop. </p>" |
| 111 |
} |
| 112 |
}, |
| 113 |
"HumanLoopSummaries": { |
| 114 |
"base": null, |
| 115 |
"refs": { |
| 116 |
"ListHumanLoopsResponse$HumanLoopSummaries": "<p>An array of objects that contain information about the human loops.</p>" |
| 117 |
} |
| 118 |
}, |
| 119 |
"HumanLoopSummary": { |
| 120 |
"base": "<p>Summary information about the human loop.</p>", |
| 121 |
"refs": { |
| 122 |
"HumanLoopSummaries$member": null |
| 123 |
} |
| 124 |
}, |
| 125 |
"InputContent": { |
| 126 |
"base": null, |
| 127 |
"refs": { |
| 128 |
"HumanLoopInput$InputContent": "<p>Serialized input from the human loop. The input must be a string representation of a file in JSON format.</p>" |
| 129 |
} |
| 130 |
}, |
| 131 |
"InternalServerException": { |
| 132 |
"base": "<p>We couldn't process your request because of an issue with the server. Try again later.</p>", |
| 133 |
"refs": { |
| 134 |
} |
| 135 |
}, |
| 136 |
"ListHumanLoopsRequest": { |
| 137 |
"base": null, |
| 138 |
"refs": { |
| 139 |
} |
| 140 |
}, |
| 141 |
"ListHumanLoopsResponse": { |
| 142 |
"base": null, |
| 143 |
"refs": { |
| 144 |
} |
| 145 |
}, |
| 146 |
"MaxResults": { |
| 147 |
"base": null, |
| 148 |
"refs": { |
| 149 |
"ListHumanLoopsRequest$MaxResults": "<p>The total number of items to return. If the total number of available items is more than the value specified in <code>MaxResults</code>, then a <code>NextToken</code> is returned in the output. You can use this token to display the next page of results. </p>" |
| 150 |
} |
| 151 |
}, |
| 152 |
"NextToken": { |
| 153 |
"base": null, |
| 154 |
"refs": { |
| 155 |
"ListHumanLoopsRequest$NextToken": "<p>A token to display the next page of results.</p>", |
| 156 |
"ListHumanLoopsResponse$NextToken": "<p>A token to display the next page of results.</p>" |
| 157 |
} |
| 158 |
}, |
| 159 |
"ResourceNotFoundException": { |
| 160 |
"base": "<p>We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again. </p>", |
| 161 |
"refs": { |
| 162 |
} |
| 163 |
}, |
| 164 |
"ServiceQuotaExceededException": { |
| 165 |
"base": "<p>You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your AWS account. For a list of Amazon A2I service quotes, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/a2i.html\">Amazon Augmented AI Service Quotes</a>. Delete some resources or request an increase in your service quota. You can request a quota increase using Service Quotas or the AWS Support Center. To request an increase, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html\">AWS Service Quotas</a> in the <i>AWS General Reference</i>.</p>", |
| 166 |
"refs": { |
| 167 |
} |
| 168 |
}, |
| 169 |
"SortOrder": { |
| 170 |
"base": null, |
| 171 |
"refs": { |
| 172 |
"ListHumanLoopsRequest$SortOrder": "<p>Optional. The order for displaying results. Valid values: <code>Ascending</code> and <code>Descending</code>.</p>" |
| 173 |
} |
| 174 |
}, |
| 175 |
"StartHumanLoopRequest": { |
| 176 |
"base": null, |
| 177 |
"refs": { |
| 178 |
} |
| 179 |
}, |
| 180 |
"StartHumanLoopResponse": { |
| 181 |
"base": null, |
| 182 |
"refs": { |
| 183 |
} |
| 184 |
}, |
| 185 |
"StopHumanLoopRequest": { |
| 186 |
"base": null, |
| 187 |
"refs": { |
| 188 |
} |
| 189 |
}, |
| 190 |
"StopHumanLoopResponse": { |
| 191 |
"base": null, |
| 192 |
"refs": { |
| 193 |
} |
| 194 |
}, |
| 195 |
"String": { |
| 196 |
"base": null, |
| 197 |
"refs": { |
| 198 |
"DescribeHumanLoopResponse$FailureReason": "<p>The reason why a human loop failed. The failure reason is returned when the status of the human loop is <code>Failed</code>.</p>", |
| 199 |
"DescribeHumanLoopResponse$FailureCode": "<p>A failure code that identifies the type of failure.</p> <p>Possible values: <code>ValidationError</code>, <code>Expired</code>, <code>InternalError</code> </p>", |
| 200 |
"HumanLoopOutput$OutputS3Uri": "<p>The location of the Amazon S3 object where Amazon Augmented AI stores your human loop output.</p>" |
| 201 |
} |
| 202 |
}, |
| 203 |
"ThrottlingException": { |
| 204 |
"base": "<p>You exceeded the maximum number of requests.</p>", |
| 205 |
"refs": { |
| 206 |
} |
| 207 |
}, |
| 208 |
"Timestamp": { |
| 209 |
"base": null, |
| 210 |
"refs": { |
| 211 |
"DescribeHumanLoopResponse$CreationTime": "<p>The creation time when Amazon Augmented AI created the human loop.</p>", |
| 212 |
"HumanLoopSummary$CreationTime": "<p>When Amazon Augmented AI created the human loop.</p>", |
| 213 |
"ListHumanLoopsRequest$CreationTimeAfter": "<p>(Optional) The timestamp of the date when you want the human loops to begin in ISO 8601 format. For example, <code>2020-02-24</code>.</p>", |
| 214 |
"ListHumanLoopsRequest$CreationTimeBefore": "<p>(Optional) The timestamp of the date before which you want the human loops to begin in ISO 8601 format. For example, <code>2020-02-24</code>.</p>" |
| 215 |
} |
| 216 |
}, |
| 217 |
"ValidationException": { |
| 218 |
"base": "<p>The request isn't valid. Check the syntax and try again.</p>", |
| 219 |
"refs": { |
| 220 |
} |
| 221 |
} |
| 222 |
} |
| 223 |
} |