ListDocumentClassifiers
Gets a list of the document classifiers that you have created.
Request Syntax
{
"Filter": {
"DocumentClassifierName": "string",
"Status": "string",
"SubmitTimeAfter": number,
"SubmitTimeBefore": number
},
"MaxResults": number,
"NextToken": "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.
- Filter
-
Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
Type: DocumentClassifierFilter object
Required: No
- MaxResults
-
The maximum number of results to return in each page. The default is 100.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 500.
Required: No
- NextToken
-
Identifies the next page of results to return.
Type: String
Length Constraints: Minimum length of 1.
Required: No
Response Syntax
{
"DocumentClassifierPropertiesList": [
{
"ClassifierMetadata": {
"EvaluationMetrics": {
"Accuracy": number,
"F1Score": number,
"HammingLoss": number,
"MicroF1Score": number,
"MicroPrecision": number,
"MicroRecall": number,
"Precision": number,
"Recall": number
},
"NumberOfLabels": number,
"NumberOfTestDocuments": number,
"NumberOfTrainedDocuments": number
},
"DataAccessRoleArn": "string",
"DocumentClassifierArn": "string",
"EndTime": number,
"FlywheelArn": "string",
"InputDataConfig": {
"AugmentedManifests": [
{
"AnnotationDataS3Uri": "string",
"AttributeNames": [ "string" ],
"DocumentType": "string",
"S3Uri": "string",
"SourceDocumentsS3Uri": "string",
"Split": "string"
}
],
"DataFormat": "string",
"DocumentReaderConfig": {
"DocumentReadAction": "string",
"DocumentReadMode": "string",
"FeatureTypes": [ "string" ]
},
"Documents": {
"S3Uri": "string",
"TestS3Uri": "string"
},
"DocumentType": "string",
"LabelDelimiter": "string",
"S3Uri": "string",
"TestS3Uri": "string"
},
"LanguageCode": "string",
"Message": "string",
"Mode": "string",
"ModelKmsKeyId": "string",
"OutputDataConfig": {
"FlywheelStatsS3Prefix": "string",
"KmsKeyId": "string",
"S3Uri": "string"
},
"SourceModelArn": "string",
"Status": "string",
"SubmitTime": number,
"TrainingEndTime": number,
"TrainingStartTime": number,
"VersionName": "string",
"VolumeKmsKeyId": "string",
"VpcConfig": {
"SecurityGroupIds": [ "string" ],
"Subnets": [ "string" ]
}
}
],
"NextToken": "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.
- DocumentClassifierPropertiesList
-
A list containing the properties of each job returned.
Type: Array of DocumentClassifierProperties objects
- NextToken
-
Identifies the next page of results to return.
Type: String
Length Constraints: Minimum length of 1.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerException
-
An internal server error occurred. Retry your request.
HTTP Status Code: 500
- InvalidFilterException
-
The filter specified for the operation is invalid. Specify a different filter.
HTTP Status Code: 400
- InvalidRequestException
-
The request is invalid.
HTTP Status Code: 400
- TooManyRequestsException
-
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
