StartExportLabelsTaskRun
Begins an asynchronous task to export all labeled data for a particular transform. This
task is the only label-related API call that is not part of the typical active learning
workflow. You typically use StartExportLabelsTaskRun when you want to work with
all of your existing labels at the same time, such as when you want to remove or change labels
that were previously submitted as truth. This API operation accepts the
TransformId whose labels you want to export and an Amazon Simple Storage
Service (Amazon S3) path to export the labels to. The operation returns a
TaskRunId. You can check on the status of your task run by calling the
GetMLTaskRun API.
Request Syntax
{
"OutputS3Path": "string",
"TransformId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- OutputS3Path
-
The Amazon S3 path where you export the labels.
Type: String
Required: Yes
- TransformId
-
The unique identifier of the machine learning transform.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*Required: Yes
Response Syntax
{
"TaskRunId": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- TaskRunId
-
The unique identifier for the task run.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*
Errors
For information about the errors that are common to all actions, see Common Errors.
- EntityNotFoundException
-
A specified entity does not exist
HTTP Status Code: 400
- InternalServiceException
-
An internal service error occurred.
HTTP Status Code: 500
- InvalidInputException
-
The input provided was not valid.
HTTP Status Code: 400
- OperationTimeoutException
-
The operation timed out.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
