The Amazon S3 location of the augmented manifest file.
", "smithy.api#required": {} } }, "AttributeNames": { "target": "com.amazonaws.comprehend#AttributeNamesList", "traits": { "smithy.api#documentation": "The JSON attribute that contains the annotations for your training documents. The number\n of attribute names that you specify depends on whether your augmented manifest file is the\n output of a single labeling job or a chained labeling job.
\nIf your file is the output of a single labeling job, specify the LabelAttributeName key\n that was used when the job was created in Ground Truth.
\nIf your file is the output of a chained labeling job, specify the LabelAttributeName key\n for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from\n an individual job.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An augmented manifest file that provides training data for your custom model. An augmented\n manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.
" } }, "com.amazonaws.comprehend#BatchDetectDominantLanguage": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#BatchDetectDominantLanguageRequest" }, "output": { "target": "com.amazonaws.comprehend#BatchDetectDominantLanguageResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#BatchSizeLimitExceededException" }, { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" } ], "traits": { "smithy.api#documentation": "Determines the dominant language of the input text for a batch of documents. For a list\n of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.\n
" } }, "com.amazonaws.comprehend#BatchDetectDominantLanguageItemResult": { "type": "structure", "members": { "Index": { "target": "com.amazonaws.comprehend#Integer", "traits": { "smithy.api#documentation": "The zero-based index of the document in the input list.
" } }, "Languages": { "target": "com.amazonaws.comprehend#ListOfDominantLanguages", "traits": { "smithy.api#documentation": "One or more DominantLanguage objects describing the dominant\n languages in the document.
" } } }, "traits": { "smithy.api#documentation": "The result of calling the operation.\n The operation returns one object for each document that is successfully processed by the\n operation.
" } }, "com.amazonaws.comprehend#BatchDetectDominantLanguageRequest": { "type": "structure", "members": { "TextList": { "target": "com.amazonaws.comprehend#CustomerInputStringList", "traits": { "smithy.api#documentation": "A list containing the text of the input documents. The list can contain a maximum of 25\n documents. Each document should contain at least 20 characters and must contain fewer than\n 5,000 bytes of UTF-8 encoded characters.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#BatchDetectDominantLanguageResponse": { "type": "structure", "members": { "ResultList": { "target": "com.amazonaws.comprehend#ListOfDetectDominantLanguageResult", "traits": { "smithy.api#documentation": "A list of objects\n containing the results of the operation. The results are sorted in ascending order by the\n Index field and match the order of the documents in the input list. If all of\n the documents contain an error, the ResultList is empty.
A list containing one object for each document\n that contained an error. The results are sorted in ascending order by the Index\n field and match the order of the documents in the input list. If there are no errors in the\n batch, the ErrorList is empty.
Inspects the text of a batch of documents for named entities and returns information\n about them. For more information about named entities, see how-entities\n
" } }, "com.amazonaws.comprehend#BatchDetectEntitiesItemResult": { "type": "structure", "members": { "Index": { "target": "com.amazonaws.comprehend#Integer", "traits": { "smithy.api#documentation": "The zero-based index of the document in the input list.
" } }, "Entities": { "target": "com.amazonaws.comprehend#ListOfEntities", "traits": { "smithy.api#documentation": "One or more Entity objects, one for each entity detected in the\n document.
" } } }, "traits": { "smithy.api#documentation": "The result of calling the operation. The\n operation returns one object for each document that is successfully processed by the\n operation.
" } }, "com.amazonaws.comprehend#BatchDetectEntitiesRequest": { "type": "structure", "members": { "TextList": { "target": "com.amazonaws.comprehend#CustomerInputStringList", "traits": { "smithy.api#documentation": "A list containing the text of the input documents. The list can contain a maximum of 25\n documents. Each document must contain fewer than 5,000 bytes of UTF-8 encoded\n characters.
", "smithy.api#required": {} } }, "LanguageCode": { "target": "com.amazonaws.comprehend#LanguageCode", "traits": { "smithy.api#documentation": "The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. All documents must be in the same language.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#BatchDetectEntitiesResponse": { "type": "structure", "members": { "ResultList": { "target": "com.amazonaws.comprehend#ListOfDetectEntitiesResult", "traits": { "smithy.api#documentation": "A list of objects containing the\n results of the operation. The results are sorted in ascending order by the Index\n field and match the order of the documents in the input list. If all of the documents contain\n an error, the ResultList is empty.
A list containing one object for each document\n that contained an error. The results are sorted in ascending order by the Index\n field and match the order of the documents in the input list. If there are no errors in the\n batch, the ErrorList is empty.
Detects the key noun phrases found in a batch of documents.
" } }, "com.amazonaws.comprehend#BatchDetectKeyPhrasesItemResult": { "type": "structure", "members": { "Index": { "target": "com.amazonaws.comprehend#Integer", "traits": { "smithy.api#documentation": "The zero-based index of the document in the input list.
" } }, "KeyPhrases": { "target": "com.amazonaws.comprehend#ListOfKeyPhrases", "traits": { "smithy.api#documentation": "One or more KeyPhrase objects, one for each key phrase detected in\n the document.
" } } }, "traits": { "smithy.api#documentation": "The result of calling the operation. The\n operation returns one object for each document that is successfully processed by the\n operation.
" } }, "com.amazonaws.comprehend#BatchDetectKeyPhrasesRequest": { "type": "structure", "members": { "TextList": { "target": "com.amazonaws.comprehend#CustomerInputStringList", "traits": { "smithy.api#documentation": "A list containing the text of the input documents. The list can contain a maximum of 25\n documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded\n characters.
", "smithy.api#required": {} } }, "LanguageCode": { "target": "com.amazonaws.comprehend#LanguageCode", "traits": { "smithy.api#documentation": "The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. All documents must be in the same language.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#BatchDetectKeyPhrasesResponse": { "type": "structure", "members": { "ResultList": { "target": "com.amazonaws.comprehend#ListOfDetectKeyPhrasesResult", "traits": { "smithy.api#documentation": "A list of objects containing the\n results of the operation. The results are sorted in ascending order by the Index\n field and match the order of the documents in the input list. If all of the documents contain\n an error, the ResultList is empty.
A list containing one object for each document\n that contained an error. The results are sorted in ascending order by the Index\n field and match the order of the documents in the input list. If there are no errors in the\n batch, the ErrorList is empty.
Inspects a batch of documents and returns an inference of the prevailing sentiment,\n POSITIVE, NEUTRAL, MIXED, or NEGATIVE,\n in each one.
The zero-based index of the document in the input list.
" } }, "Sentiment": { "target": "com.amazonaws.comprehend#SentimentType", "traits": { "smithy.api#documentation": "The sentiment detected in the document.
" } }, "SentimentScore": { "target": "com.amazonaws.comprehend#SentimentScore", "traits": { "smithy.api#documentation": "The level of confidence that Amazon Comprehend has in the accuracy of its sentiment\n detection.
" } } }, "traits": { "smithy.api#documentation": "The result of calling the operation. The\n operation returns one object for each document that is successfully processed by the\n operation.
" } }, "com.amazonaws.comprehend#BatchDetectSentimentRequest": { "type": "structure", "members": { "TextList": { "target": "com.amazonaws.comprehend#CustomerInputStringList", "traits": { "smithy.api#documentation": "A list containing the text of the input documents. The list can contain a maximum of 25\n documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded\n characters.
", "smithy.api#required": {} } }, "LanguageCode": { "target": "com.amazonaws.comprehend#LanguageCode", "traits": { "smithy.api#documentation": "The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. All documents must be in the same language.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#BatchDetectSentimentResponse": { "type": "structure", "members": { "ResultList": { "target": "com.amazonaws.comprehend#ListOfDetectSentimentResult", "traits": { "smithy.api#documentation": "A list of objects containing the\n results of the operation. The results are sorted in ascending order by the Index\n field and match the order of the documents in the input list. If all of the documents contain\n an error, the ResultList is empty.
A list containing one object for each document\n that contained an error. The results are sorted in ascending order by the Index\n field and match the order of the documents in the input list. If there are no errors in the\n batch, the ErrorList is empty.
Inspects the text of a batch of documents for the syntax and part of speech of the words\n in the document and returns information about them. For more information, see how-syntax.
" } }, "com.amazonaws.comprehend#BatchDetectSyntaxItemResult": { "type": "structure", "members": { "Index": { "target": "com.amazonaws.comprehend#Integer", "traits": { "smithy.api#documentation": "The zero-based index of the document in the input list.
" } }, "SyntaxTokens": { "target": "com.amazonaws.comprehend#ListOfSyntaxTokens", "traits": { "smithy.api#documentation": "The syntax tokens for the words in the document, one token for each word.
" } } }, "traits": { "smithy.api#documentation": "The result of calling the operation. The operation\n returns one object that is successfully processed by the operation.
" } }, "com.amazonaws.comprehend#BatchDetectSyntaxRequest": { "type": "structure", "members": { "TextList": { "target": "com.amazonaws.comprehend#CustomerInputStringList", "traits": { "smithy.api#documentation": "A list containing the text of the input documents. The list can contain a maximum of 25\n documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded\n characters.
", "smithy.api#required": {} } }, "LanguageCode": { "target": "com.amazonaws.comprehend#SyntaxLanguageCode", "traits": { "smithy.api#documentation": "The language of the input documents. You can specify any of the following languages\n supported by Amazon Comprehend: German (\"de\"), English (\"en\"), Spanish (\"es\"), French (\"fr\"),\n Italian (\"it\"), or Portuguese (\"pt\"). All documents must be in the same language.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#BatchDetectSyntaxResponse": { "type": "structure", "members": { "ResultList": { "target": "com.amazonaws.comprehend#ListOfDetectSyntaxResult", "traits": { "smithy.api#documentation": "A list of objects containing the results\n of the operation. The results are sorted in ascending order by the Index field\n and match the order of the documents in the input list. If all of the documents contain an\n error, the ResultList is empty.
A list containing one object for each document that\n contained an error. The results are sorted in ascending order by the Index field\n and match the order of the documents in the input list. If there are no errors in the batch,\n the ErrorList is empty.
The zero-based index of the document in the input list.
" } }, "ErrorCode": { "target": "com.amazonaws.comprehend#String", "traits": { "smithy.api#documentation": "The numeric error code of the error.
" } }, "ErrorMessage": { "target": "com.amazonaws.comprehend#String", "traits": { "smithy.api#documentation": "A text description of the error.
" } } }, "traits": { "smithy.api#documentation": "Describes an error that occurred while processing a document in a batch. The operation\n returns on BatchItemError object for each document that contained an\n error.
The number of documents in the request exceeds the limit of 25. Try your request again\n with fewer documents.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.comprehend#ClassifierEvaluationMetrics": { "type": "structure", "members": { "Accuracy": { "target": "com.amazonaws.comprehend#Double", "traits": { "smithy.api#documentation": "The fraction of the labels that were correct recognized. It is computed by dividing the\n number of labels in the test documents that were correctly recognized by the total number of\n labels in the test documents.
" } }, "Precision": { "target": "com.amazonaws.comprehend#Double", "traits": { "smithy.api#documentation": "A measure of the usefulness of the classifier results in the test data. High precision\n means that the classifier returned substantially more relevant results than irrelevant\n ones.
" } }, "Recall": { "target": "com.amazonaws.comprehend#Double", "traits": { "smithy.api#documentation": "A measure of how complete the classifier results are for the test data. High recall means\n that the classifier returned most of the relevant results.
" } }, "F1Score": { "target": "com.amazonaws.comprehend#Double", "traits": { "smithy.api#documentation": "A measure of how accurate the classifier results are for the test data. It is derived from\n the Precision and Recall values. The F1Score is the\n harmonic average of the two scores. The highest score is 1, and the worst score is 0.
A measure of the usefulness of the recognizer results in the test data. High precision\n means that the recognizer returned substantially more relevant results than irrelevant ones.\n Unlike the Precision metric which comes from averaging the precision of all available labels,\n this is based on the overall score of all precision scores added together.
" } }, "MicroRecall": { "target": "com.amazonaws.comprehend#Double", "traits": { "smithy.api#documentation": "A measure of how complete the classifier results are for the test data. High recall means\n that the classifier returned most of the relevant results. Specifically, this indicates how\n many of the correct categories in the text that the model can predict. It is a percentage of\n correct categories in the text that can found. Instead of averaging the recall scores of all\n labels (as with Recall), micro Recall is based on the overall score of all recall scores added\n together.
" } }, "MicroF1Score": { "target": "com.amazonaws.comprehend#Double", "traits": { "smithy.api#documentation": "A measure of how accurate the classifier results are for the test data. It is a\n combination of the Micro Precision and Micro Recall values. The\n Micro F1Score is the harmonic mean of the two scores. The highest score is 1,\n and the worst score is 0.
Indicates the fraction of labels that are incorrectly predicted. Also seen as the fraction\n of wrong labels compared to the total number of labels. Scores closer to zero are\n better.
" } } }, "traits": { "smithy.api#documentation": "Describes the result metrics for the test data associated with an documentation\n classifier.
" } }, "com.amazonaws.comprehend#ClassifierMetadata": { "type": "structure", "members": { "NumberOfLabels": { "target": "com.amazonaws.comprehend#Integer", "traits": { "smithy.api#documentation": "The number of labels in the input data.
" } }, "NumberOfTrainedDocuments": { "target": "com.amazonaws.comprehend#Integer", "traits": { "smithy.api#documentation": "The number of documents in the input data that were used to train the classifier.\n Typically this is 80 to 90 percent of the input documents.
" } }, "NumberOfTestDocuments": { "target": "com.amazonaws.comprehend#Integer", "traits": { "smithy.api#documentation": "The number of documents in the input data that were used to test the classifier. Typically\n this is 10 to 20 percent of the input documents, up to 10,000 documents.
" } }, "EvaluationMetrics": { "target": "com.amazonaws.comprehend#ClassifierEvaluationMetrics", "traits": { "smithy.api#documentation": "Describes the result metrics for the test data associated with an documentation\n classifier.
" } } }, "traits": { "smithy.api#documentation": "Provides information about a document classifier.
", "smithy.api#sensitive": {} } }, "com.amazonaws.comprehend#ClassifyDocument": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#ClassifyDocumentRequest" }, "output": { "target": "com.amazonaws.comprehend#ClassifyDocumentResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#ResourceUnavailableException" }, { "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" } ], "traits": { "smithy.api#documentation": "Creates a new document classification request to analyze a single document in real-time,\n using a previously created and trained custom model and an endpoint.
" } }, "com.amazonaws.comprehend#ClassifyDocumentRequest": { "type": "structure", "members": { "Text": { "target": "com.amazonaws.comprehend#CustomerInputString", "traits": { "smithy.api#documentation": "The document text to be analyzed.
", "smithy.api#required": {} } }, "EndpointArn": { "target": "com.amazonaws.comprehend#DocumentClassifierEndpointArn", "traits": { "smithy.api#documentation": "The Amazon Resource Number (ARN) of the endpoint.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#ClassifyDocumentResponse": { "type": "structure", "members": { "Classes": { "target": "com.amazonaws.comprehend#ListOfClasses", "traits": { "smithy.api#documentation": "The classes used by the document being analyzed. These are used for multi-class trained\n models. Individual classes are mutually exclusive and each document is expected to have only a\n single class assigned to it. For example, an animal can be a dog or a cat, but not both at the\n same time.
" } }, "Labels": { "target": "com.amazonaws.comprehend#ListOfLabels", "traits": { "smithy.api#documentation": "The labels used the document being analyzed. These are used for multi-label trained\n models. Individual labels represent different categories that are related in some manner and\n are not mutually exclusive. For example, a movie can be just an action movie, or it can be an\n action movie, a science fiction movie, and a comedy, all at the same time.
" } } }, "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.comprehend#ClientRequestTokenString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-zA-Z0-9-]+$" } }, "com.amazonaws.comprehend#ComprehendArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-Z0-9-]{1,64}/[a-zA-Z0-9](-*[a-zA-Z0-9])*" } }, "com.amazonaws.comprehend#ComprehendArnName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 63 }, "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" } }, "com.amazonaws.comprehend#ComprehendEndpointArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document-classifier-endpoint|entity-recognizer-endpoint)/[a-zA-Z0-9](-*[a-zA-Z0-9])*" } }, "com.amazonaws.comprehend#ComprehendEndpointName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 40 }, "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" } }, "com.amazonaws.comprehend#ComprehendModelArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document-classifier|entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*" } }, "com.amazonaws.comprehend#Comprehend_20171127": { "type": "service", "version": "2017-11-27", "operations": [ { "target": "com.amazonaws.comprehend#BatchDetectDominantLanguage" }, { "target": "com.amazonaws.comprehend#BatchDetectEntities" }, { "target": "com.amazonaws.comprehend#BatchDetectKeyPhrases" }, { "target": "com.amazonaws.comprehend#BatchDetectSentiment" }, { "target": "com.amazonaws.comprehend#BatchDetectSyntax" }, { "target": "com.amazonaws.comprehend#ClassifyDocument" }, { "target": "com.amazonaws.comprehend#ContainsPiiEntities" }, { "target": "com.amazonaws.comprehend#CreateDocumentClassifier" }, { "target": "com.amazonaws.comprehend#CreateEndpoint" }, { "target": "com.amazonaws.comprehend#CreateEntityRecognizer" }, { "target": "com.amazonaws.comprehend#DeleteDocumentClassifier" }, { "target": "com.amazonaws.comprehend#DeleteEndpoint" }, { "target": "com.amazonaws.comprehend#DeleteEntityRecognizer" }, { "target": "com.amazonaws.comprehend#DescribeDocumentClassificationJob" }, { "target": "com.amazonaws.comprehend#DescribeDocumentClassifier" }, { "target": "com.amazonaws.comprehend#DescribeDominantLanguageDetectionJob" }, { "target": "com.amazonaws.comprehend#DescribeEndpoint" }, { "target": "com.amazonaws.comprehend#DescribeEntitiesDetectionJob" }, { "target": "com.amazonaws.comprehend#DescribeEntityRecognizer" }, { "target": "com.amazonaws.comprehend#DescribeEventsDetectionJob" }, { "target": "com.amazonaws.comprehend#DescribeKeyPhrasesDetectionJob" }, { "target": "com.amazonaws.comprehend#DescribePiiEntitiesDetectionJob" }, { "target": "com.amazonaws.comprehend#DescribeSentimentDetectionJob" }, { "target": "com.amazonaws.comprehend#DescribeTopicsDetectionJob" }, { "target": "com.amazonaws.comprehend#DetectDominantLanguage" }, { "target": "com.amazonaws.comprehend#DetectEntities" }, { "target": "com.amazonaws.comprehend#DetectKeyPhrases" }, { "target": "com.amazonaws.comprehend#DetectPiiEntities" }, { "target": "com.amazonaws.comprehend#DetectSentiment" }, { "target": "com.amazonaws.comprehend#DetectSyntax" }, { "target": "com.amazonaws.comprehend#ListDocumentClassificationJobs" }, { "target": "com.amazonaws.comprehend#ListDocumentClassifiers" }, { "target": "com.amazonaws.comprehend#ListDominantLanguageDetectionJobs" }, { "target": "com.amazonaws.comprehend#ListEndpoints" }, { "target": "com.amazonaws.comprehend#ListEntitiesDetectionJobs" }, { "target": "com.amazonaws.comprehend#ListEntityRecognizers" }, { "target": "com.amazonaws.comprehend#ListEventsDetectionJobs" }, { "target": "com.amazonaws.comprehend#ListKeyPhrasesDetectionJobs" }, { "target": "com.amazonaws.comprehend#ListPiiEntitiesDetectionJobs" }, { "target": "com.amazonaws.comprehend#ListSentimentDetectionJobs" }, { "target": "com.amazonaws.comprehend#ListTagsForResource" }, { "target": "com.amazonaws.comprehend#ListTopicsDetectionJobs" }, { "target": "com.amazonaws.comprehend#StartDocumentClassificationJob" }, { "target": "com.amazonaws.comprehend#StartDominantLanguageDetectionJob" }, { "target": "com.amazonaws.comprehend#StartEntitiesDetectionJob" }, { "target": "com.amazonaws.comprehend#StartEventsDetectionJob" }, { "target": "com.amazonaws.comprehend#StartKeyPhrasesDetectionJob" }, { "target": "com.amazonaws.comprehend#StartPiiEntitiesDetectionJob" }, { "target": "com.amazonaws.comprehend#StartSentimentDetectionJob" }, { "target": "com.amazonaws.comprehend#StartTopicsDetectionJob" }, { "target": "com.amazonaws.comprehend#StopDominantLanguageDetectionJob" }, { "target": "com.amazonaws.comprehend#StopEntitiesDetectionJob" }, { "target": "com.amazonaws.comprehend#StopEventsDetectionJob" }, { "target": "com.amazonaws.comprehend#StopKeyPhrasesDetectionJob" }, { "target": "com.amazonaws.comprehend#StopPiiEntitiesDetectionJob" }, { "target": "com.amazonaws.comprehend#StopSentimentDetectionJob" }, { "target": "com.amazonaws.comprehend#StopTrainingDocumentClassifier" }, { "target": "com.amazonaws.comprehend#StopTrainingEntityRecognizer" }, { "target": "com.amazonaws.comprehend#TagResource" }, { "target": "com.amazonaws.comprehend#UntagResource" }, { "target": "com.amazonaws.comprehend#UpdateEndpoint" } ], "traits": { "aws.api#service": { "sdkId": "Comprehend", "arnNamespace": "comprehend", "cloudFormationName": "Comprehend", "cloudTrailEventSource": "comprehend.amazonaws.com", "endpointPrefix": "comprehend" }, "aws.auth#sigv4": { "name": "comprehend" }, "aws.protocols#awsJson1_1": {}, "smithy.api#documentation": "Amazon Comprehend is an AWS service for gaining insight into the content of documents.\n Use these actions to determine the topics contained in your documents, the topics they\n discuss, the predominant sentiment expressed in them, the predominant language used, and\n more.
", "smithy.api#title": "Amazon Comprehend" } }, "com.amazonaws.comprehend#ConcurrentModificationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.comprehend#String" } }, "traits": { "smithy.api#documentation": "Concurrent modification of the tags associated with an Amazon Comprehend resource is not\n supported.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.comprehend#ContainsPiiEntities": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#ContainsPiiEntitiesRequest" }, "output": { "target": "com.amazonaws.comprehend#ContainsPiiEntitiesResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" }, { "target": "com.amazonaws.comprehend#UnsupportedLanguageException" } ], "traits": { "smithy.api#documentation": "Analyzes input text for the presence of personally identifiable information (PII) and\n returns the labels of identified PII entity types such as name, address, bank account number,\n or phone number.
" } }, "com.amazonaws.comprehend#ContainsPiiEntitiesRequest": { "type": "structure", "members": { "Text": { "target": "com.amazonaws.comprehend#String", "traits": { "smithy.api#documentation": "Creates a new document classification request to analyze a single document in real-time,\n returning personally identifiable information (PII) entity labels.
", "smithy.api#required": {} } }, "LanguageCode": { "target": "com.amazonaws.comprehend#LanguageCode", "traits": { "smithy.api#documentation": "The language of the input documents.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#ContainsPiiEntitiesResponse": { "type": "structure", "members": { "Labels": { "target": "com.amazonaws.comprehend#ListOfEntityLabels", "traits": { "smithy.api#documentation": "The labels used in the document being analyzed. Individual labels represent personally\n identifiable information (PII) entity types.
" } } } }, "com.amazonaws.comprehend#CreateDocumentClassifier": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#CreateDocumentClassifierRequest" }, "output": { "target": "com.amazonaws.comprehend#CreateDocumentClassifierResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#KmsKeyValidationException" }, { "target": "com.amazonaws.comprehend#ResourceInUseException" }, { "target": "com.amazonaws.comprehend#ResourceLimitExceededException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" }, { "target": "com.amazonaws.comprehend#TooManyTagsException" }, { "target": "com.amazonaws.comprehend#UnsupportedLanguageException" } ], "traits": { "smithy.api#documentation": "Creates a new document classifier that you can use to categorize documents. To create a\n classifier, you provide a set of training documents that labeled with the categories that you\n want to use. After the classifier is trained you can use it to categorize a set of labeled\n documents into the categories. For more information, see how-document-classification.
" } }, "com.amazonaws.comprehend#CreateDocumentClassifierRequest": { "type": "structure", "members": { "DocumentClassifierName": { "target": "com.amazonaws.comprehend#ComprehendArnName", "traits": { "smithy.api#documentation": "The name of the document classifier.
", "smithy.api#required": {} } }, "DataAccessRoleArn": { "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants\n Amazon Comprehend read access to your input data.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.comprehend#TagList", "traits": { "smithy.api#documentation": "Tags to be associated with the document classifier being created. A tag is a key-value\n pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with\n \"Sales\" as the key might be added to a resource to indicate its use by the sales department.\n
" } }, "InputDataConfig": { "target": "com.amazonaws.comprehend#DocumentClassifierInputDataConfig", "traits": { "smithy.api#documentation": "Specifies the format and location of the input data for the job.
", "smithy.api#required": {} } }, "OutputDataConfig": { "target": "com.amazonaws.comprehend#DocumentClassifierOutputDataConfig", "traits": { "smithy.api#documentation": "Enables the addition of output results configuration parameters for custom classifier\n jobs.
" } }, "ClientRequestToken": { "target": "com.amazonaws.comprehend#ClientRequestTokenString", "traits": { "smithy.api#documentation": "A unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.
", "smithy.api#idempotencyToken": {} } }, "LanguageCode": { "target": "com.amazonaws.comprehend#LanguageCode", "traits": { "smithy.api#documentation": "The language of the input documents. You can specify any of the following languages\n supported by Amazon Comprehend: German (\"de\"), English (\"en\"), Spanish (\"es\"), French (\"fr\"),\n Italian (\"it\"), or Portuguese (\"pt\"). All documents must be in the same language.
", "smithy.api#required": {} } }, "VolumeKmsKeyId": { "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your custom classifier. For more information, see Amazon\n VPC.
" } }, "Mode": { "target": "com.amazonaws.comprehend#DocumentClassifierMode", "traits": { "smithy.api#documentation": "Indicates the mode in which the classifier will be trained. The classifier can be trained\n in multi-class mode, which identifies one and only one class for each document, or multi-label\n mode, which identifies one or more labels for each document. In multi-label mode, multiple\n labels for an individual document are separated by a delimiter. The default delimiter between\n labels is a pipe (|).
" } }, "ModelKmsKeyId": { "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n trained custom models. The ModelKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
The Amazon Resource Name (ARN) that identifies the document classifier.
" } } } }, "com.amazonaws.comprehend#CreateEndpoint": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#CreateEndpointRequest" }, "output": { "target": "com.amazonaws.comprehend#CreateEndpointResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#ResourceInUseException" }, { "target": "com.amazonaws.comprehend#ResourceLimitExceededException" }, { "target": "com.amazonaws.comprehend#ResourceNotFoundException" }, { "target": "com.amazonaws.comprehend#ResourceUnavailableException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" }, { "target": "com.amazonaws.comprehend#TooManyTagsException" } ], "traits": { "smithy.api#documentation": "Creates a model-specific endpoint for synchronous inference for a previously trained\n custom model\n
" } }, "com.amazonaws.comprehend#CreateEndpointRequest": { "type": "structure", "members": { "EndpointName": { "target": "com.amazonaws.comprehend#ComprehendEndpointName", "traits": { "smithy.api#documentation": "This is the descriptive suffix that becomes part of the EndpointArn used for\n all subsequent requests to this resource.
The Amazon Resource Number (ARN) of the model to which the endpoint will be\n attached.
", "smithy.api#required": {} } }, "DesiredInferenceUnits": { "target": "com.amazonaws.comprehend#InferenceUnitsInteger", "traits": { "smithy.api#documentation": "The desired number of inference units to be used by the model using this endpoint.\n \n Each inference unit represents of a throughput of 100 characters per second.
", "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.comprehend#ClientRequestTokenString", "traits": { "smithy.api#documentation": "An idempotency token provided by the customer. If this token matches a previous endpoint\n creation request, Amazon Comprehend will not return a ResourceInUseException.\n
Tags associated with the endpoint being created. A tag is a key-value pair that adds\n metadata to the endpoint. For example, a tag with \"Sales\" as the key might be added to an\n endpoint to indicate its use by the sales department.
" } }, "DataAccessRoleArn": { "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to trained custom models encrypted with a customer\n managed key (ModelKmsKeyId).
" } } } }, "com.amazonaws.comprehend#CreateEndpointResponse": { "type": "structure", "members": { "EndpointArn": { "target": "com.amazonaws.comprehend#ComprehendEndpointArn", "traits": { "smithy.api#documentation": "The Amazon Resource Number (ARN) of the endpoint being created.
" } } } }, "com.amazonaws.comprehend#CreateEntityRecognizer": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#CreateEntityRecognizerRequest" }, "output": { "target": "com.amazonaws.comprehend#CreateEntityRecognizerResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#KmsKeyValidationException" }, { "target": "com.amazonaws.comprehend#ResourceInUseException" }, { "target": "com.amazonaws.comprehend#ResourceLimitExceededException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" }, { "target": "com.amazonaws.comprehend#TooManyTagsException" }, { "target": "com.amazonaws.comprehend#UnsupportedLanguageException" } ], "traits": { "smithy.api#documentation": "Creates an entity recognizer using submitted files. After your\n CreateEntityRecognizer request is submitted, you can check job status using the\n API.
The name given to the newly created recognizer. Recognizer names can be a maximum of 256\n characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name\n must be unique in the account/region.
", "smithy.api#required": {} } }, "DataAccessRoleArn": { "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants\n Amazon Comprehend read access to your input data.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.comprehend#TagList", "traits": { "smithy.api#documentation": "Tags to be associated with the entity recognizer being created. A tag is a key-value pair\n that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with\n \"Sales\" as the key might be added to a resource to indicate its use by the sales department.\n
" } }, "InputDataConfig": { "target": "com.amazonaws.comprehend#EntityRecognizerInputDataConfig", "traits": { "smithy.api#documentation": "Specifies the format and location of the input data. The S3 bucket containing the input\n data must be located in the same region as the entity recognizer being created.
", "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.comprehend#ClientRequestTokenString", "traits": { "smithy.api#documentation": "A unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.
", "smithy.api#idempotencyToken": {} } }, "LanguageCode": { "target": "com.amazonaws.comprehend#LanguageCode", "traits": { "smithy.api#documentation": "You can specify any of the following languages supported by Amazon Comprehend: English\n (\"en\"), Spanish (\"es\"), French (\"fr\"), Italian (\"it\"), German (\"de\"), or Portuguese (\"pt\").\n All documents must be in the same language.
", "smithy.api#required": {} } }, "VolumeKmsKeyId": { "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your custom entity recognizer. For more information, see\n Amazon\n VPC.
" } }, "ModelKmsKeyId": { "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n trained custom models. The ModelKmsKeyId can be either of the following formats
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
The Amazon Resource Name (ARN) that identifies the entity recognizer.
" } } } }, "com.amazonaws.comprehend#CustomerInputString": { "type": "string", "traits": { "smithy.api#length": { "min": 1 }, "smithy.api#sensitive": {} } }, "com.amazonaws.comprehend#CustomerInputStringList": { "type": "list", "member": { "target": "com.amazonaws.comprehend#CustomerInputString" }, "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.comprehend#DeleteDocumentClassifier": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#DeleteDocumentClassifierRequest" }, "output": { "target": "com.amazonaws.comprehend#DeleteDocumentClassifierResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#ResourceInUseException" }, { "target": "com.amazonaws.comprehend#ResourceNotFoundException" }, { "target": "com.amazonaws.comprehend#ResourceUnavailableException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Deletes a previously created document classifier
\nOnly those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted.\n If an active inference job is using the model, a ResourceInUseException will be\n returned.
This is an asynchronous action that puts the classifier into a DELETING state, and it is\n then removed by a background job. Once removed, the classifier disappears from your account\n and is no longer available for use.
" } }, "com.amazonaws.comprehend#DeleteDocumentClassifierRequest": { "type": "structure", "members": { "DocumentClassifierArn": { "target": "com.amazonaws.comprehend#DocumentClassifierArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the document classifier.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#DeleteDocumentClassifierResponse": { "type": "structure", "members": {} }, "com.amazonaws.comprehend#DeleteEndpoint": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#DeleteEndpointRequest" }, "output": { "target": "com.amazonaws.comprehend#DeleteEndpointResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#ResourceInUseException" }, { "target": "com.amazonaws.comprehend#ResourceNotFoundException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Deletes a model-specific endpoint for a previously-trained custom model. All endpoints\n must be deleted in order for the model to be deleted.
" } }, "com.amazonaws.comprehend#DeleteEndpointRequest": { "type": "structure", "members": { "EndpointArn": { "target": "com.amazonaws.comprehend#ComprehendEndpointArn", "traits": { "smithy.api#documentation": "The Amazon Resource Number (ARN) of the endpoint being deleted.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#DeleteEndpointResponse": { "type": "structure", "members": {} }, "com.amazonaws.comprehend#DeleteEntityRecognizer": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#DeleteEntityRecognizerRequest" }, "output": { "target": "com.amazonaws.comprehend#DeleteEntityRecognizerResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#ResourceInUseException" }, { "target": "com.amazonaws.comprehend#ResourceNotFoundException" }, { "target": "com.amazonaws.comprehend#ResourceUnavailableException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Deletes an entity recognizer.
\nOnly those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted.\n If an active inference job is using the model, a ResourceInUseException will be\n returned.
This is an asynchronous action that puts the recognizer into a DELETING state, and it is\n then removed by a background job. Once removed, the recognizer disappears from your account\n and is no longer available for use.
" } }, "com.amazonaws.comprehend#DeleteEntityRecognizerRequest": { "type": "structure", "members": { "EntityRecognizerArn": { "target": "com.amazonaws.comprehend#EntityRecognizerArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the entity recognizer.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#DeleteEntityRecognizerResponse": { "type": "structure", "members": {} }, "com.amazonaws.comprehend#DescribeDocumentClassificationJob": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#DescribeDocumentClassificationJobRequest" }, "output": { "target": "com.amazonaws.comprehend#DescribeDocumentClassificationJobResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#JobNotFoundException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Gets the properties associated with a document classification job. Use this operation to\n get the status of a classification job.
" } }, "com.amazonaws.comprehend#DescribeDocumentClassificationJobRequest": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its\n response.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#DescribeDocumentClassificationJobResponse": { "type": "structure", "members": { "DocumentClassificationJobProperties": { "target": "com.amazonaws.comprehend#DocumentClassificationJobProperties", "traits": { "smithy.api#documentation": "An object that describes the properties associated with the document classification\n job.
" } } } }, "com.amazonaws.comprehend#DescribeDocumentClassifier": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#DescribeDocumentClassifierRequest" }, "output": { "target": "com.amazonaws.comprehend#DescribeDocumentClassifierResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#ResourceNotFoundException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Gets the properties associated with a document classifier.
" } }, "com.amazonaws.comprehend#DescribeDocumentClassifierRequest": { "type": "structure", "members": { "DocumentClassifierArn": { "target": "com.amazonaws.comprehend#DocumentClassifierArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the document classifier. The operation returns this identifier in its\n response.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#DescribeDocumentClassifierResponse": { "type": "structure", "members": { "DocumentClassifierProperties": { "target": "com.amazonaws.comprehend#DocumentClassifierProperties", "traits": { "smithy.api#documentation": "An object that contains the properties associated with a document classifier.
" } } } }, "com.amazonaws.comprehend#DescribeDominantLanguageDetectionJob": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#DescribeDominantLanguageDetectionJobRequest" }, "output": { "target": "com.amazonaws.comprehend#DescribeDominantLanguageDetectionJobResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#JobNotFoundException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Gets the properties associated with a dominant language detection job. Use this operation\n to get the status of a detection job.
" } }, "com.amazonaws.comprehend#DescribeDominantLanguageDetectionJobRequest": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its\n response.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#DescribeDominantLanguageDetectionJobResponse": { "type": "structure", "members": { "DominantLanguageDetectionJobProperties": { "target": "com.amazonaws.comprehend#DominantLanguageDetectionJobProperties", "traits": { "smithy.api#documentation": "An object that contains the properties associated with a dominant language detection\n job.
" } } } }, "com.amazonaws.comprehend#DescribeEndpoint": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#DescribeEndpointRequest" }, "output": { "target": "com.amazonaws.comprehend#DescribeEndpointResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#ResourceNotFoundException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Gets the properties associated with a specific endpoint. Use this operation to get the\n status of an endpoint.
" } }, "com.amazonaws.comprehend#DescribeEndpointRequest": { "type": "structure", "members": { "EndpointArn": { "target": "com.amazonaws.comprehend#ComprehendEndpointArn", "traits": { "smithy.api#documentation": "The Amazon Resource Number (ARN) of the endpoint being described.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#DescribeEndpointResponse": { "type": "structure", "members": { "EndpointProperties": { "target": "com.amazonaws.comprehend#EndpointProperties", "traits": { "smithy.api#documentation": "Describes information associated with the specific endpoint.
" } } } }, "com.amazonaws.comprehend#DescribeEntitiesDetectionJob": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#DescribeEntitiesDetectionJobRequest" }, "output": { "target": "com.amazonaws.comprehend#DescribeEntitiesDetectionJobResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#JobNotFoundException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Gets the properties associated with an entities detection job. Use this operation to get\n the status of a detection job.
" } }, "com.amazonaws.comprehend#DescribeEntitiesDetectionJobRequest": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its\n response.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#DescribeEntitiesDetectionJobResponse": { "type": "structure", "members": { "EntitiesDetectionJobProperties": { "target": "com.amazonaws.comprehend#EntitiesDetectionJobProperties", "traits": { "smithy.api#documentation": "An object that contains the properties associated with an entities detection job.
" } } } }, "com.amazonaws.comprehend#DescribeEntityRecognizer": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#DescribeEntityRecognizerRequest" }, "output": { "target": "com.amazonaws.comprehend#DescribeEntityRecognizerResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#ResourceNotFoundException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Provides details about an entity recognizer including status, S3 buckets containing\n training data, recognizer metadata, metrics, and so on.
" } }, "com.amazonaws.comprehend#DescribeEntityRecognizerRequest": { "type": "structure", "members": { "EntityRecognizerArn": { "target": "com.amazonaws.comprehend#EntityRecognizerArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the entity recognizer.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#DescribeEntityRecognizerResponse": { "type": "structure", "members": { "EntityRecognizerProperties": { "target": "com.amazonaws.comprehend#EntityRecognizerProperties", "traits": { "smithy.api#documentation": "Describes information associated with an entity recognizer.
" } } } }, "com.amazonaws.comprehend#DescribeEventsDetectionJob": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#DescribeEventsDetectionJobRequest" }, "output": { "target": "com.amazonaws.comprehend#DescribeEventsDetectionJobResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#JobNotFoundException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Gets the status and details of an events detection job.
" } }, "com.amazonaws.comprehend#DescribeEventsDetectionJobRequest": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "The identifier of the events detection job.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#DescribeEventsDetectionJobResponse": { "type": "structure", "members": { "EventsDetectionJobProperties": { "target": "com.amazonaws.comprehend#EventsDetectionJobProperties", "traits": { "smithy.api#documentation": "An object that contains the properties associated with an event detection job.
" } } } }, "com.amazonaws.comprehend#DescribeKeyPhrasesDetectionJob": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#DescribeKeyPhrasesDetectionJobRequest" }, "output": { "target": "com.amazonaws.comprehend#DescribeKeyPhrasesDetectionJobResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#JobNotFoundException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Gets the properties associated with a key phrases detection job. Use this operation to get\n the status of a detection job.
" } }, "com.amazonaws.comprehend#DescribeKeyPhrasesDetectionJobRequest": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its\n response.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#DescribeKeyPhrasesDetectionJobResponse": { "type": "structure", "members": { "KeyPhrasesDetectionJobProperties": { "target": "com.amazonaws.comprehend#KeyPhrasesDetectionJobProperties", "traits": { "smithy.api#documentation": "An object that contains the properties associated with a key phrases detection job.\n
" } } } }, "com.amazonaws.comprehend#DescribePiiEntitiesDetectionJob": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#DescribePiiEntitiesDetectionJobRequest" }, "output": { "target": "com.amazonaws.comprehend#DescribePiiEntitiesDetectionJobResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#JobNotFoundException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Gets the properties associated with a PII entities detection job. For example, you can use\n this operation to get the job status.
" } }, "com.amazonaws.comprehend#DescribePiiEntitiesDetectionJobRequest": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its\n response.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#DescribePiiEntitiesDetectionJobResponse": { "type": "structure", "members": { "PiiEntitiesDetectionJobProperties": { "target": "com.amazonaws.comprehend#PiiEntitiesDetectionJobProperties" } } }, "com.amazonaws.comprehend#DescribeSentimentDetectionJob": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#DescribeSentimentDetectionJobRequest" }, "output": { "target": "com.amazonaws.comprehend#DescribeSentimentDetectionJobResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#JobNotFoundException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Gets the properties associated with a sentiment detection job. Use this operation to get\n the status of a detection job.
" } }, "com.amazonaws.comprehend#DescribeSentimentDetectionJobRequest": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its\n response.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#DescribeSentimentDetectionJobResponse": { "type": "structure", "members": { "SentimentDetectionJobProperties": { "target": "com.amazonaws.comprehend#SentimentDetectionJobProperties", "traits": { "smithy.api#documentation": "An object that contains the properties associated with a sentiment detection job.
" } } } }, "com.amazonaws.comprehend#DescribeTopicsDetectionJob": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#DescribeTopicsDetectionJobRequest" }, "output": { "target": "com.amazonaws.comprehend#DescribeTopicsDetectionJobResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#JobNotFoundException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Gets the properties associated with a topic detection job. Use this operation to get\n the status of a detection job.
" } }, "com.amazonaws.comprehend#DescribeTopicsDetectionJobRequest": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "The identifier assigned by the user to the detection job.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#DescribeTopicsDetectionJobResponse": { "type": "structure", "members": { "TopicsDetectionJobProperties": { "target": "com.amazonaws.comprehend#TopicsDetectionJobProperties", "traits": { "smithy.api#documentation": "The list of properties for the requested job.
" } } } }, "com.amazonaws.comprehend#DetectDominantLanguage": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#DetectDominantLanguageRequest" }, "output": { "target": "com.amazonaws.comprehend#DetectDominantLanguageResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" } ], "traits": { "smithy.api#documentation": "Determines the dominant language of the input text. For a list of languages that Amazon\n Comprehend can detect, see Amazon Comprehend Supported Languages.
" } }, "com.amazonaws.comprehend#DetectDominantLanguageRequest": { "type": "structure", "members": { "Text": { "target": "com.amazonaws.comprehend#CustomerInputString", "traits": { "smithy.api#documentation": "A UTF-8 text string. Each string should contain at least 20 characters and must contain\n fewer that 5,000 bytes of UTF-8 encoded characters.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#DetectDominantLanguageResponse": { "type": "structure", "members": { "Languages": { "target": "com.amazonaws.comprehend#ListOfDominantLanguages", "traits": { "smithy.api#documentation": "The languages that Amazon Comprehend detected in the input text. For each language, the\n response returns the RFC 5646 language code and the level of confidence that Amazon Comprehend\n has in the accuracy of its inference. For more information about RFC 5646, see Tags for Identifying Languages on the\n IETF Tools web site.
" } } }, "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.comprehend#DetectEntities": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#DetectEntitiesRequest" }, "output": { "target": "com.amazonaws.comprehend#DetectEntitiesResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#ResourceUnavailableException" }, { "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" }, { "target": "com.amazonaws.comprehend#UnsupportedLanguageException" } ], "traits": { "smithy.api#documentation": "Inspects text for named entities, and returns information about them. For more\n information, about named entities, see how-entities.
" } }, "com.amazonaws.comprehend#DetectEntitiesRequest": { "type": "structure", "members": { "Text": { "target": "com.amazonaws.comprehend#CustomerInputString", "traits": { "smithy.api#documentation": "A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded\n characters.
", "smithy.api#required": {} } }, "LanguageCode": { "target": "com.amazonaws.comprehend#LanguageCode", "traits": { "smithy.api#documentation": "The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. All documents must be in the same language.
\nIf your request includes the endpoint for a custom entity recognition model, Amazon\n Comprehend uses the language of your custom model, and it ignores any language code that you\n specify here.
" } }, "EndpointArn": { "target": "com.amazonaws.comprehend#EntityRecognizerEndpointArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name of an endpoint that is associated with a custom entity\n recognition model. Provide an endpoint if you want to detect entities by using your own custom\n model instead of the default model that is used by Amazon Comprehend.
\nIf you specify an endpoint, Amazon Comprehend uses the language of your custom model, and\n it ignores any language code that you provide in your request.
" } } } }, "com.amazonaws.comprehend#DetectEntitiesResponse": { "type": "structure", "members": { "Entities": { "target": "com.amazonaws.comprehend#ListOfEntities", "traits": { "smithy.api#documentation": "A collection of entities identified in the input text. For each entity, the response\n provides the entity text, entity type, where the entity text begins and ends, and the level of\n confidence that Amazon Comprehend has in the detection.
\nIf your request uses a custom entity recognition model, Amazon Comprehend detects the\n entities that the model is trained to recognize. Otherwise, it detects the default entity\n types. For a list of default entity types, see how-entities.
" } } }, "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.comprehend#DetectKeyPhrases": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#DetectKeyPhrasesRequest" }, "output": { "target": "com.amazonaws.comprehend#DetectKeyPhrasesResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" }, { "target": "com.amazonaws.comprehend#UnsupportedLanguageException" } ], "traits": { "smithy.api#documentation": "Detects the key noun phrases found in the text.
" } }, "com.amazonaws.comprehend#DetectKeyPhrasesRequest": { "type": "structure", "members": { "Text": { "target": "com.amazonaws.comprehend#CustomerInputString", "traits": { "smithy.api#documentation": "A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded\n characters.
", "smithy.api#required": {} } }, "LanguageCode": { "target": "com.amazonaws.comprehend#LanguageCode", "traits": { "smithy.api#documentation": "The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. All documents must be in the same language.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#DetectKeyPhrasesResponse": { "type": "structure", "members": { "KeyPhrases": { "target": "com.amazonaws.comprehend#ListOfKeyPhrases", "traits": { "smithy.api#documentation": "A collection of key phrases that Amazon Comprehend identified in the input text. For\n each key phrase, the response provides the text of the key phrase, where the key phrase begins\n and ends, and the level of confidence that Amazon Comprehend has in the accuracy of the\n detection.
" } } }, "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.comprehend#DetectPiiEntities": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#DetectPiiEntitiesRequest" }, "output": { "target": "com.amazonaws.comprehend#DetectPiiEntitiesResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" }, { "target": "com.amazonaws.comprehend#UnsupportedLanguageException" } ], "traits": { "smithy.api#documentation": "Inspects the input text for entities that contain personally identifiable information\n (PII) and returns information about them.
" } }, "com.amazonaws.comprehend#DetectPiiEntitiesRequest": { "type": "structure", "members": { "Text": { "target": "com.amazonaws.comprehend#String", "traits": { "smithy.api#documentation": "A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded\n characters.
", "smithy.api#required": {} } }, "LanguageCode": { "target": "com.amazonaws.comprehend#LanguageCode", "traits": { "smithy.api#documentation": "The language of the input documents.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#DetectPiiEntitiesResponse": { "type": "structure", "members": { "Entities": { "target": "com.amazonaws.comprehend#ListOfPiiEntities", "traits": { "smithy.api#documentation": "A collection of PII entities identified in the input text. For each entity, the response\n provides the entity type, where the entity text begins and ends, and the level of confidence\n that Amazon Comprehend has in the detection.
" } } } }, "com.amazonaws.comprehend#DetectSentiment": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#DetectSentimentRequest" }, "output": { "target": "com.amazonaws.comprehend#DetectSentimentResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" }, { "target": "com.amazonaws.comprehend#UnsupportedLanguageException" } ], "traits": { "smithy.api#documentation": "Inspects text and returns an inference of the prevailing sentiment\n (POSITIVE, NEUTRAL, MIXED, or NEGATIVE).
A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded\n characters.
", "smithy.api#required": {} } }, "LanguageCode": { "target": "com.amazonaws.comprehend#LanguageCode", "traits": { "smithy.api#documentation": "The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. All documents must be in the same language.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#DetectSentimentResponse": { "type": "structure", "members": { "Sentiment": { "target": "com.amazonaws.comprehend#SentimentType", "traits": { "smithy.api#documentation": "The inferred sentiment that Amazon Comprehend has the highest level of confidence\n in.
" } }, "SentimentScore": { "target": "com.amazonaws.comprehend#SentimentScore", "traits": { "smithy.api#documentation": "An object that lists the sentiments, and their corresponding confidence\n levels.
" } } }, "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.comprehend#DetectSyntax": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#DetectSyntaxRequest" }, "output": { "target": "com.amazonaws.comprehend#DetectSyntaxResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#TextSizeLimitExceededException" }, { "target": "com.amazonaws.comprehend#UnsupportedLanguageException" } ], "traits": { "smithy.api#documentation": "Inspects text for syntax and the part of speech of words in the document. For more\n information, how-syntax.
" } }, "com.amazonaws.comprehend#DetectSyntaxRequest": { "type": "structure", "members": { "Text": { "target": "com.amazonaws.comprehend#CustomerInputString", "traits": { "smithy.api#documentation": "A UTF-8 string. Each string must contain fewer that 5,000 bytes of UTF encoded\n characters.
", "smithy.api#required": {} } }, "LanguageCode": { "target": "com.amazonaws.comprehend#SyntaxLanguageCode", "traits": { "smithy.api#documentation": "The language code of the input documents. You can specify any of the following languages\n supported by Amazon Comprehend: German (\"de\"), English (\"en\"), Spanish (\"es\"), French (\"fr\"),\n Italian (\"it\"), or Portuguese (\"pt\").
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#DetectSyntaxResponse": { "type": "structure", "members": { "SyntaxTokens": { "target": "com.amazonaws.comprehend#ListOfSyntaxTokens", "traits": { "smithy.api#documentation": "A collection of syntax tokens describing the text. For each token, the response provides\n the text, the token type, where the text begins and ends, and the level of confidence that\n Amazon Comprehend has that the token is correct. For a list of token types, see how-syntax.
" } } }, "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.comprehend#DocumentClass": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.comprehend#String", "traits": { "smithy.api#documentation": "The name of the class.
" } }, "Score": { "target": "com.amazonaws.comprehend#Float", "traits": { "smithy.api#documentation": "The confidence score that Amazon Comprehend has this class correctly attributed.
" } } }, "traits": { "smithy.api#documentation": "Specifies the class that categorizes the document being analyzed
" } }, "com.amazonaws.comprehend#DocumentClassificationJobFilter": { "type": "structure", "members": { "JobName": { "target": "com.amazonaws.comprehend#JobName", "traits": { "smithy.api#documentation": "Filters on the name of the job.
" } }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { "smithy.api#documentation": "Filters the list based on job status. Returns only jobs with the specified status.
" } }, "SubmitTimeBefore": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted before the specified time. Jobs are returned in ascending order,\n oldest to newest.
" } }, "SubmitTimeAfter": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in descending order,\n newest to oldest.
" } } }, "traits": { "smithy.api#documentation": "Provides information for filtering a list of document classification jobs. For more\n information, see the operation. You can\n provide only one filter parameter in each request.
" } }, "com.amazonaws.comprehend#DocumentClassificationJobProperties": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "The identifier assigned to the document classification job.
" } }, "JobName": { "target": "com.amazonaws.comprehend#JobName", "traits": { "smithy.api#documentation": "The name that you assigned to the document classification job.
" } }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { "smithy.api#documentation": "The current status of the document classification job. If the status is\n FAILED, the Message field shows the reason for the failure.
A description of the status of the job.
" } }, "SubmitTime": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "The time that the document classification job was submitted for processing.
" } }, "EndTime": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "The time that the document classification job completed.
" } }, "DocumentClassifierArn": { "target": "com.amazonaws.comprehend#DocumentClassifierArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the document classifier.
" } }, "InputDataConfig": { "target": "com.amazonaws.comprehend#InputDataConfig", "traits": { "smithy.api#documentation": "The input data configuration that you supplied when you created the document\n classification job.
" } }, "OutputDataConfig": { "target": "com.amazonaws.comprehend#OutputDataConfig", "traits": { "smithy.api#documentation": "The output data configuration that you supplied when you created the document\n classification job.
" } }, "DataAccessRoleArn": { "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to your input data.
" } }, "VolumeKmsKeyId": { "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your document classification job. For more information, see Amazon\n VPC.
" } } }, "traits": { "smithy.api#documentation": "Provides information about a document classification job.
" } }, "com.amazonaws.comprehend#DocumentClassificationJobPropertiesList": { "type": "list", "member": { "target": "com.amazonaws.comprehend#DocumentClassificationJobProperties" } }, "com.amazonaws.comprehend#DocumentClassifierArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document-classifier/[a-zA-Z0-9](-*[a-zA-Z0-9])*" } }, "com.amazonaws.comprehend#DocumentClassifierAugmentedManifestsList": { "type": "list", "member": { "target": "com.amazonaws.comprehend#AugmentedManifestsListItem" } }, "com.amazonaws.comprehend#DocumentClassifierDataFormat": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "COMPREHEND_CSV", "name": "COMPREHEND_CSV" }, { "value": "AUGMENTED_MANIFEST", "name": "AUGMENTED_MANIFEST" } ] } }, "com.amazonaws.comprehend#DocumentClassifierEndpointArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document-classifier-endpoint/[a-zA-Z0-9](-*[a-zA-Z0-9])*" } }, "com.amazonaws.comprehend#DocumentClassifierFilter": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.comprehend#ModelStatus", "traits": { "smithy.api#documentation": "Filters the list of classifiers based on status.
" } }, "SubmitTimeBefore": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "Filters the list of classifiers based on the time that the classifier was submitted for\n processing. Returns only classifiers submitted before the specified time. Classifiers are\n returned in ascending order, oldest to newest.
" } }, "SubmitTimeAfter": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "Filters the list of classifiers based on the time that the classifier was submitted for\n processing. Returns only classifiers submitted after the specified time. Classifiers are\n returned in descending order, newest to oldest.
" } } }, "traits": { "smithy.api#documentation": "Provides information for filtering a list of document classifiers. You can only specify\n one filtering parameter in a request. For more information, see the operation.
" } }, "com.amazonaws.comprehend#DocumentClassifierInputDataConfig": { "type": "structure", "members": { "DataFormat": { "target": "com.amazonaws.comprehend#DocumentClassifierDataFormat", "traits": { "smithy.api#documentation": "The format of your training data:
\n\n COMPREHEND_CSV: A two-column CSV file, where labels are provided in the\n first column, and documents are provided in the second. If you use this value, you must\n provide the S3Uri parameter in your request.
\n AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon\n SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON\n object that contains a training document and its associated labels.
If you use this value, you must provide the AugmentedManifests parameter\n in your request.
If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the\n default.
The Amazon S3 URI for the input data. The S3 bucket must be in the same region as the API\n endpoint that you are calling. The URI can point to a single input file or it can provide the\n prefix for a collection of input files.
\nFor example, if you use the URI S3://bucketName/prefix, if the prefix is a\n single file, Amazon Comprehend uses that file as input. If more than one file begins with the\n prefix, Amazon Comprehend uses all of them as input.
This parameter is required if you set DataFormat to\n COMPREHEND_CSV.
Indicates the delimiter used to separate each label for training a multi-label classifier.\n The default delimiter between labels is a pipe (|). You can use a different character as a\n delimiter (if it's an allowed character) by specifying it under Delimiter for labels. If the\n training documents use a delimiter other than the default or the delimiter you specify, the\n labels on that line will be combined to make a single unique label, such as\n LABELLABELLABEL.
" } }, "AugmentedManifests": { "target": "com.amazonaws.comprehend#DocumentClassifierAugmentedManifestsList", "traits": { "smithy.api#documentation": "A list of augmented manifest files that provide training data for your custom model. An\n augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground\n Truth.
\nThis parameter is required if you set DataFormat to\n AUGMENTED_MANIFEST.
The input properties for training a document classifier.
\nFor more information on how the input file is formatted, see how-document-classification-training-data.
" } }, "com.amazonaws.comprehend#DocumentClassifierMode": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "MULTI_CLASS", "name": "MULTI_CLASS" }, { "value": "MULTI_LABEL", "name": "MULTI_LABEL" } ] } }, "com.amazonaws.comprehend#DocumentClassifierOutputDataConfig": { "type": "structure", "members": { "S3Uri": { "target": "com.amazonaws.comprehend#S3Uri", "traits": { "smithy.api#documentation": "When you use the OutputDataConfig object while creating a custom\n classifier, you specify the Amazon S3 location where you want to write the confusion matrix.\n The URI must be in the same region as the API endpoint that you are calling. The location is\n used as the prefix for the actual location of this output file.
When the custom classifier job is finished, the service creates the output file in a\n directory specific to the job. The S3Uri field contains the location of the\n output file, called output.tar.gz. It is a compressed archive that contains the\n confusion matrix.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the\n output results from an analysis job. The KmsKeyId can be one of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
KMS Key Alias: \"alias/ExampleAlias\"\n
ARN of a KMS Key Alias:\n \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"\n
Provides output results configuration parameters for custom classifier jobs.
" } }, "com.amazonaws.comprehend#DocumentClassifierProperties": { "type": "structure", "members": { "DocumentClassifierArn": { "target": "com.amazonaws.comprehend#DocumentClassifierArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the document classifier.
" } }, "LanguageCode": { "target": "com.amazonaws.comprehend#LanguageCode", "traits": { "smithy.api#documentation": "The language code for the language of the documents that the classifier was trained\n on.
" } }, "Status": { "target": "com.amazonaws.comprehend#ModelStatus", "traits": { "smithy.api#documentation": "The status of the document classifier. If the status is TRAINED the\n classifier is ready to use. If the status is FAILED you can see additional\n information about why the classifier wasn't trained in the Message field.
Additional information about the status of the classifier.
" } }, "SubmitTime": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "The time that the document classifier was submitted for training.
" } }, "EndTime": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "The time that training the document classifier completed.
" } }, "TrainingStartTime": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "Indicates the time when the training starts on documentation classifiers. You are billed\n for the time interval between this time and the value of TrainingEndTime.
" } }, "TrainingEndTime": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "The time that training of the document classifier was completed. Indicates the time when\n the training completes on documentation classifiers. You are billed for the time interval\n between this time and the value of TrainingStartTime.
" } }, "InputDataConfig": { "target": "com.amazonaws.comprehend#DocumentClassifierInputDataConfig", "traits": { "smithy.api#documentation": "The input data configuration that you supplied when you created the document classifier\n for training.
" } }, "OutputDataConfig": { "target": "com.amazonaws.comprehend#DocumentClassifierOutputDataConfig", "traits": { "smithy.api#documentation": "Provides output results configuration parameters for custom classifier jobs.
" } }, "ClassifierMetadata": { "target": "com.amazonaws.comprehend#ClassifierMetadata", "traits": { "smithy.api#documentation": "Information about the document classifier, including the number of documents used for\n training the classifier, the number of documents used for test the classifier, and an accuracy\n rating.
" } }, "DataAccessRoleArn": { "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants\n Amazon Comprehend read access to your input data.
" } }, "VolumeKmsKeyId": { "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your custom classifier. For more information, see Amazon\n VPC.
" } }, "Mode": { "target": "com.amazonaws.comprehend#DocumentClassifierMode", "traits": { "smithy.api#documentation": "Indicates the mode in which the specific classifier was trained. This also indicates the\n format of input documents and the format of the confusion matrix. Each classifier can only be\n trained in one mode and this cannot be changed once the classifier is trained.
" } }, "ModelKmsKeyId": { "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n trained custom models. The ModelKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Provides information about a document classifier.
" } }, "com.amazonaws.comprehend#DocumentClassifierPropertiesList": { "type": "list", "member": { "target": "com.amazonaws.comprehend#DocumentClassifierProperties" } }, "com.amazonaws.comprehend#DocumentLabel": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.comprehend#String", "traits": { "smithy.api#documentation": "The name of the label.
" } }, "Score": { "target": "com.amazonaws.comprehend#Float", "traits": { "smithy.api#documentation": "The confidence score that Amazon Comprehend has this label correctly attributed.
" } } }, "traits": { "smithy.api#documentation": "Specifies one of the label or labels that categorize the document being analyzed.
" } }, "com.amazonaws.comprehend#DominantLanguage": { "type": "structure", "members": { "LanguageCode": { "target": "com.amazonaws.comprehend#String", "traits": { "smithy.api#documentation": "The RFC 5646 language code for the dominant language. For more information about RFC\n 5646, see Tags for Identifying\n Languages on the IETF Tools web site.
" } }, "Score": { "target": "com.amazonaws.comprehend#Float", "traits": { "smithy.api#documentation": "The level of confidence that Amazon Comprehend has in the accuracy of the\n detection.
" } } }, "traits": { "smithy.api#documentation": "Returns the code for the dominant language in the input text and the level of\n confidence that Amazon Comprehend has in the accuracy of the detection.
" } }, "com.amazonaws.comprehend#DominantLanguageDetectionJobFilter": { "type": "structure", "members": { "JobName": { "target": "com.amazonaws.comprehend#JobName", "traits": { "smithy.api#documentation": "Filters on the name of the job.
" } }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { "smithy.api#documentation": "Filters the list of jobs based on job status. Returns only jobs with the specified\n status.
" } }, "SubmitTimeBefore": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted before the specified time. Jobs are returned in ascending order,\n oldest to newest.
" } }, "SubmitTimeAfter": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in descending order,\n newest to oldest.
" } } }, "traits": { "smithy.api#documentation": "Provides information for filtering a list of dominant language detection jobs. For more\n information, see the operation.
" } }, "com.amazonaws.comprehend#DominantLanguageDetectionJobProperties": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "The identifier assigned to the dominant language detection job.
" } }, "JobName": { "target": "com.amazonaws.comprehend#JobName", "traits": { "smithy.api#documentation": "The name that you assigned to the dominant language detection job.
" } }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { "smithy.api#documentation": "The current status of the dominant language detection job. If the status is\n FAILED, the Message field shows the reason for the failure.
A description for the status of a job.
" } }, "SubmitTime": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "The time that the dominant language detection job was submitted for processing.
" } }, "EndTime": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "The time that the dominant language detection job completed.
" } }, "InputDataConfig": { "target": "com.amazonaws.comprehend#InputDataConfig", "traits": { "smithy.api#documentation": "The input data configuration that you supplied when you created the dominant language\n detection job.
" } }, "OutputDataConfig": { "target": "com.amazonaws.comprehend#OutputDataConfig", "traits": { "smithy.api#documentation": "The output data configuration that you supplied when you created the dominant language\n detection job.
" } }, "DataAccessRoleArn": { "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input\n data.
" } }, "VolumeKmsKeyId": { "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your dominant language detection job. For more information, see\n Amazon\n VPC.
" } } }, "traits": { "smithy.api#documentation": "Provides information about a dominant language detection job.
" } }, "com.amazonaws.comprehend#DominantLanguageDetectionJobPropertiesList": { "type": "list", "member": { "target": "com.amazonaws.comprehend#DominantLanguageDetectionJobProperties" } }, "com.amazonaws.comprehend#Double": { "type": "double", "traits": { "smithy.api#box": {} } }, "com.amazonaws.comprehend#EndpointFilter": { "type": "structure", "members": { "ModelArn": { "target": "com.amazonaws.comprehend#ComprehendModelArn", "traits": { "smithy.api#documentation": "The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
" } }, "Status": { "target": "com.amazonaws.comprehend#EndpointStatus", "traits": { "smithy.api#documentation": "Specifies the status of the endpoint being returned. Possible values are: Creating, Ready,\n Updating, Deleting, Failed.
" } }, "CreationTimeBefore": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "Specifies a date before which the returned endpoint or endpoints were created.
" } }, "CreationTimeAfter": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "Specifies a date after which the returned endpoint or endpoints were created.
" } } }, "traits": { "smithy.api#documentation": "The filter used to determine which endpoints are returned. You can filter jobs on their\n name, model, status, or the date and time that they were created. You can only set one filter\n at a time.
" } }, "com.amazonaws.comprehend#EndpointProperties": { "type": "structure", "members": { "EndpointArn": { "target": "com.amazonaws.comprehend#ComprehendEndpointArn", "traits": { "smithy.api#documentation": "The Amazon Resource Number (ARN) of the endpoint.
" } }, "Status": { "target": "com.amazonaws.comprehend#EndpointStatus", "traits": { "smithy.api#documentation": "Specifies the status of the endpoint. Because the endpoint updates and creation are\n asynchronous, so customers will need to wait for the endpoint to be Ready status\n before making inference requests.
Specifies a reason for failure in cases of Failed status.
The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
" } }, "DesiredInferenceUnits": { "target": "com.amazonaws.comprehend#InferenceUnitsInteger", "traits": { "smithy.api#documentation": "The desired number of inference units to be used by the model using this endpoint.\n \n Each inference unit represents of a throughput of 100 characters per second.
" } }, "CurrentInferenceUnits": { "target": "com.amazonaws.comprehend#InferenceUnitsInteger", "traits": { "smithy.api#documentation": "The number of inference units currently used by the model using this endpoint.
" } }, "CreationTime": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "The creation date and time of the endpoint.
" } }, "LastModifiedTime": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "The date and time that the endpoint was last modified.
" } }, "DataAccessRoleArn": { "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to trained custom models encrypted with a customer\n managed key (ModelKmsKeyId).
" } } }, "traits": { "smithy.api#documentation": "Specifies information about the specified endpoint.
" } }, "com.amazonaws.comprehend#EndpointPropertiesList": { "type": "list", "member": { "target": "com.amazonaws.comprehend#EndpointProperties" } }, "com.amazonaws.comprehend#EndpointStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "CREATING", "name": "CREATING" }, { "value": "DELETING", "name": "DELETING" }, { "value": "FAILED", "name": "FAILED" }, { "value": "IN_SERVICE", "name": "IN_SERVICE" }, { "value": "UPDATING", "name": "UPDATING" } ] } }, "com.amazonaws.comprehend#EntitiesDetectionJobFilter": { "type": "structure", "members": { "JobName": { "target": "com.amazonaws.comprehend#JobName", "traits": { "smithy.api#documentation": "Filters on the name of the job.
" } }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { "smithy.api#documentation": "Filters the list of jobs based on job status. Returns only jobs with the specified\n status.
" } }, "SubmitTimeBefore": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted before the specified time. Jobs are returned in ascending order,\n oldest to newest.
" } }, "SubmitTimeAfter": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in descending order,\n newest to oldest.
" } } }, "traits": { "smithy.api#documentation": "Provides information for filtering a list of dominant language detection jobs. For more\n information, see the operation.
" } }, "com.amazonaws.comprehend#EntitiesDetectionJobProperties": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "The identifier assigned to the entities detection job.
" } }, "JobName": { "target": "com.amazonaws.comprehend#JobName", "traits": { "smithy.api#documentation": "The name that you assigned the entities detection job.
" } }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { "smithy.api#documentation": "The current status of the entities detection job. If the status is FAILED,\n the Message field shows the reason for the failure.
A description of the status of a job.
" } }, "SubmitTime": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "The time that the entities detection job was submitted for processing.
" } }, "EndTime": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "The time that the entities detection job completed
" } }, "EntityRecognizerArn": { "target": "com.amazonaws.comprehend#EntityRecognizerArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the entity recognizer.
" } }, "InputDataConfig": { "target": "com.amazonaws.comprehend#InputDataConfig", "traits": { "smithy.api#documentation": "The input data configuration that you supplied when you created the entities detection\n job.
" } }, "OutputDataConfig": { "target": "com.amazonaws.comprehend#OutputDataConfig", "traits": { "smithy.api#documentation": "The output data configuration that you supplied when you created the entities detection\n job.
" } }, "LanguageCode": { "target": "com.amazonaws.comprehend#LanguageCode", "traits": { "smithy.api#documentation": "The language code of the input documents.
" } }, "DataAccessRoleArn": { "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input\n data.
" } }, "VolumeKmsKeyId": { "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your entity detection job. For more information, see Amazon\n VPC.
" } } }, "traits": { "smithy.api#documentation": "Provides information about an entities detection job.
" } }, "com.amazonaws.comprehend#EntitiesDetectionJobPropertiesList": { "type": "list", "member": { "target": "com.amazonaws.comprehend#EntitiesDetectionJobProperties" } }, "com.amazonaws.comprehend#Entity": { "type": "structure", "members": { "Score": { "target": "com.amazonaws.comprehend#Float", "traits": { "smithy.api#documentation": "The level of confidence that Amazon Comprehend has in the accuracy of the\n detection.
" } }, "Type": { "target": "com.amazonaws.comprehend#EntityType", "traits": { "smithy.api#documentation": "The entity's type.
" } }, "Text": { "target": "com.amazonaws.comprehend#String", "traits": { "smithy.api#documentation": "The text of the entity.
" } }, "BeginOffset": { "target": "com.amazonaws.comprehend#Integer", "traits": { "smithy.api#documentation": "A character offset in the input text that shows where the entity begins (the first\n character is at position 0). The offset returns the position of each UTF-8 code point in the\n string. A code point is the abstract character from a particular\n graphical representation. For example, a multi-byte UTF-8 character maps to a single code\n point.
" } }, "EndOffset": { "target": "com.amazonaws.comprehend#Integer", "traits": { "smithy.api#documentation": "A character offset in the input text that shows where the entity ends. The offset\n returns the position of each UTF-8 code point in the string. A code point\n is the abstract character from a particular graphical representation. For example, a\n multi-byte UTF-8 character maps to a single code point.
" } } }, "traits": { "smithy.api#documentation": "Provides information about an entity.
\n" } }, "com.amazonaws.comprehend#EntityLabel": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.comprehend#PiiEntityType", "traits": { "smithy.api#documentation": "
The name of the label.
" } }, "Score": { "target": "com.amazonaws.comprehend#Float", "traits": { "smithy.api#documentation": "The level of confidence that Amazon Comprehend has in the accuracy of the\n detection.
" } } }, "traits": { "smithy.api#documentation": "Specifies one of the label or labels that categorize the personally identifiable\n information (PII) entity being analyzed.
" } }, "com.amazonaws.comprehend#EntityRecognizerAnnotations": { "type": "structure", "members": { "S3Uri": { "target": "com.amazonaws.comprehend#S3Uri", "traits": { "smithy.api#documentation": "Specifies the Amazon S3 location where the annotations for an entity recognizer are\n located. The URI must be in the same region as the API endpoint that you are calling.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Describes the annotations associated with a entity recognizer.
" } }, "com.amazonaws.comprehend#EntityRecognizerArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity-recognizer/[a-zA-Z0-9](-*[a-zA-Z0-9])*" } }, "com.amazonaws.comprehend#EntityRecognizerAugmentedManifestsList": { "type": "list", "member": { "target": "com.amazonaws.comprehend#AugmentedManifestsListItem" } }, "com.amazonaws.comprehend#EntityRecognizerDataFormat": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "COMPREHEND_CSV", "name": "COMPREHEND_CSV" }, { "value": "AUGMENTED_MANIFEST", "name": "AUGMENTED_MANIFEST" } ] } }, "com.amazonaws.comprehend#EntityRecognizerDocuments": { "type": "structure", "members": { "S3Uri": { "target": "com.amazonaws.comprehend#S3Uri", "traits": { "smithy.api#documentation": "Specifies the Amazon S3 location where the training documents for an entity recognizer\n are located. The URI must be in the same region as the API endpoint that you are\n calling.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Describes the training documents submitted with an entity recognizer.
" } }, "com.amazonaws.comprehend#EntityRecognizerEndpointArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity-recognizer-endpoint/[a-zA-Z0-9](-*[a-zA-Z0-9])*" } }, "com.amazonaws.comprehend#EntityRecognizerEntityList": { "type": "structure", "members": { "S3Uri": { "target": "com.amazonaws.comprehend#S3Uri", "traits": { "smithy.api#documentation": "Specifies the Amazon S3 location where the entity list is located. The URI must be in the\n same region as the API endpoint that you are calling.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Describes the entity recognizer submitted with an entity recognizer.
" } }, "com.amazonaws.comprehend#EntityRecognizerEvaluationMetrics": { "type": "structure", "members": { "Precision": { "target": "com.amazonaws.comprehend#Double", "traits": { "smithy.api#documentation": "A measure of the usefulness of the recognizer results in the test data. High precision\n means that the recognizer returned substantially more relevant results than irrelevant ones.\n
" } }, "Recall": { "target": "com.amazonaws.comprehend#Double", "traits": { "smithy.api#documentation": "A measure of how complete the recognizer results are for the test data. High recall means\n that the recognizer returned most of the relevant results.
" } }, "F1Score": { "target": "com.amazonaws.comprehend#Double", "traits": { "smithy.api#documentation": "A measure of how accurate the recognizer results are for the test data. It is derived from\n the Precision and Recall values. The F1Score is the\n harmonic average of the two scores. The highest score is 1, and the worst score is 0.
Detailed information about the accuracy of an entity recognizer.
" } }, "com.amazonaws.comprehend#EntityRecognizerFilter": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.comprehend#ModelStatus", "traits": { "smithy.api#documentation": "The status of an entity recognizer.
" } }, "SubmitTimeBefore": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "Filters the list of entities based on the time that the list was submitted for processing.\n Returns only jobs submitted before the specified time. Jobs are returned in descending order,\n newest to oldest.
" } }, "SubmitTimeAfter": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "Filters the list of entities based on the time that the list was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in ascending order,\n oldest to newest.
" } } }, "traits": { "smithy.api#documentation": "Provides information for filtering a list of entity recognizers. You can only specify one\n filtering parameter in a request. For more information, see the operation./>
" } }, "com.amazonaws.comprehend#EntityRecognizerInputDataConfig": { "type": "structure", "members": { "DataFormat": { "target": "com.amazonaws.comprehend#EntityRecognizerDataFormat", "traits": { "smithy.api#documentation": "The format of your training data:
\n\n COMPREHEND_CSV: A CSV file that supplements your training documents. The\n CSV file contains information about the custom entities that your trained model will\n detect. The required format of the file depends on whether you are providing annotations\n or an entity list.
If you use this value, you must provide your CSV file by using either the\n Annotations or EntityList parameters. You must provide your\n training documents by using the Documents parameter.
\n AUGMENTED_MANIFEST: A labeled dataset that is produced by Amazon\n SageMaker Ground Truth. This file is in JSON lines format. Each line is a complete JSON\n object that contains a training document and its labels. Each label annotates a named\n entity in the training document.
If you use this value, you must provide the AugmentedManifests parameter\n in your request.
If you don't specify a value, Amazon Comprehend uses COMPREHEND_CSV as the\n default.
The entity types in the labeled training data that Amazon Comprehend uses to train the\n custom entity recognizer. Any entity types that you don't specify are ignored.
\nA maximum of 25 entity types can be used at one time to train an entity recognizer. Entity\n types must not contain the following invalid characters: \\n (line break), \\\\n (escaped line\n break), \\r (carriage return), \\\\r (escaped carriage return), \\t (tab), \\\\t (escaped tab),\n space, and , (comma).
", "smithy.api#required": {} } }, "Documents": { "target": "com.amazonaws.comprehend#EntityRecognizerDocuments", "traits": { "smithy.api#documentation": "The S3 location of the folder that contains the training documents for your custom entity\n recognizer.
\nThis parameter is required if you set DataFormat to\n COMPREHEND_CSV.
The S3 location of the CSV file that annotates your training documents.
" } }, "EntityList": { "target": "com.amazonaws.comprehend#EntityRecognizerEntityList", "traits": { "smithy.api#documentation": "The S3 location of the CSV file that has the entity list for your custom entity\n recognizer.
" } }, "AugmentedManifests": { "target": "com.amazonaws.comprehend#EntityRecognizerAugmentedManifestsList", "traits": { "smithy.api#documentation": "A list of augmented manifest files that provide training data for your custom model. An\n augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground\n Truth.
\nThis parameter is required if you set DataFormat to\n AUGMENTED_MANIFEST.
Specifies the format and location of the input data.
" } }, "com.amazonaws.comprehend#EntityRecognizerMetadata": { "type": "structure", "members": { "NumberOfTrainedDocuments": { "target": "com.amazonaws.comprehend#Integer", "traits": { "smithy.api#documentation": "The number of documents in the input data that were used to train the entity recognizer.\n Typically this is 80 to 90 percent of the input documents.
" } }, "NumberOfTestDocuments": { "target": "com.amazonaws.comprehend#Integer", "traits": { "smithy.api#documentation": "The number of documents in the input data that were used to test the entity recognizer.\n Typically this is 10 to 20 percent of the input documents.
" } }, "EvaluationMetrics": { "target": "com.amazonaws.comprehend#EntityRecognizerEvaluationMetrics", "traits": { "smithy.api#documentation": "Detailed information about the accuracy of an entity recognizer.
" } }, "EntityTypes": { "target": "com.amazonaws.comprehend#EntityRecognizerMetadataEntityTypesList", "traits": { "smithy.api#documentation": "Entity types from the metadata of an entity recognizer.
" } } }, "traits": { "smithy.api#documentation": "Detailed information about an entity recognizer.
", "smithy.api#sensitive": {} } }, "com.amazonaws.comprehend#EntityRecognizerMetadataEntityTypesList": { "type": "list", "member": { "target": "com.amazonaws.comprehend#EntityRecognizerMetadataEntityTypesListItem" } }, "com.amazonaws.comprehend#EntityRecognizerMetadataEntityTypesListItem": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.comprehend#AnyLengthString", "traits": { "smithy.api#documentation": "Type of entity from the list of entity types in the metadata of an entity recognizer.\n
" } }, "EvaluationMetrics": { "target": "com.amazonaws.comprehend#EntityTypesEvaluationMetrics", "traits": { "smithy.api#documentation": "Detailed information about the accuracy of the entity recognizer for a specific item on\n the list of entity types.
" } }, "NumberOfTrainMentions": { "target": "com.amazonaws.comprehend#Integer", "traits": { "smithy.api#documentation": "Indicates the number of times the given entity type was seen in the training data.
" } } }, "traits": { "smithy.api#documentation": "Individual item from the list of entity types in the metadata of an entity\n recognizer.
" } }, "com.amazonaws.comprehend#EntityRecognizerProperties": { "type": "structure", "members": { "EntityRecognizerArn": { "target": "com.amazonaws.comprehend#EntityRecognizerArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the entity recognizer.
" } }, "LanguageCode": { "target": "com.amazonaws.comprehend#LanguageCode", "traits": { "smithy.api#documentation": "The language of the input documents. All documents must be in the same language. Only\n English (\"en\") is currently supported.
" } }, "Status": { "target": "com.amazonaws.comprehend#ModelStatus", "traits": { "smithy.api#documentation": "Provides the status of the entity recognizer.
" } }, "Message": { "target": "com.amazonaws.comprehend#AnyLengthString", "traits": { "smithy.api#documentation": "A description of the status of the recognizer.
" } }, "SubmitTime": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "The time that the recognizer was submitted for processing.
" } }, "EndTime": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "The time that the recognizer creation completed.
" } }, "TrainingStartTime": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "The time that training of the entity recognizer started.
" } }, "TrainingEndTime": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "The time that training of the entity recognizer was completed.
" } }, "InputDataConfig": { "target": "com.amazonaws.comprehend#EntityRecognizerInputDataConfig", "traits": { "smithy.api#documentation": "The input data properties of an entity recognizer.
" } }, "RecognizerMetadata": { "target": "com.amazonaws.comprehend#EntityRecognizerMetadata", "traits": { "smithy.api#documentation": "Provides information about an entity recognizer.
" } }, "DataAccessRoleArn": { "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants\n Amazon Comprehend read access to your input data.
" } }, "VolumeKmsKeyId": { "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your custom entity recognizer. For more information, see Amazon\n VPC.
" } }, "ModelKmsKeyId": { "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n trained custom models. The ModelKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Describes information about an entity recognizer.
" } }, "com.amazonaws.comprehend#EntityRecognizerPropertiesList": { "type": "list", "member": { "target": "com.amazonaws.comprehend#EntityRecognizerProperties" } }, "com.amazonaws.comprehend#EntityType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "PERSON", "name": "PERSON" }, { "value": "LOCATION", "name": "LOCATION" }, { "value": "ORGANIZATION", "name": "ORGANIZATION" }, { "value": "COMMERCIAL_ITEM", "name": "COMMERCIAL_ITEM" }, { "value": "EVENT", "name": "EVENT" }, { "value": "DATE", "name": "DATE" }, { "value": "QUANTITY", "name": "QUANTITY" }, { "value": "TITLE", "name": "TITLE" }, { "value": "OTHER", "name": "OTHER" } ] } }, "com.amazonaws.comprehend#EntityTypeName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 64 }, "smithy.api#pattern": "^(?:(?!\\\\n+|\\\\t+|\\\\r+|[\\r\\t\\n,]).)+$" } }, "com.amazonaws.comprehend#EntityTypesEvaluationMetrics": { "type": "structure", "members": { "Precision": { "target": "com.amazonaws.comprehend#Double", "traits": { "smithy.api#documentation": "A measure of the usefulness of the recognizer results for a specific entity type in the\n test data. High precision means that the recognizer returned substantially more relevant\n results than irrelevant ones.
" } }, "Recall": { "target": "com.amazonaws.comprehend#Double", "traits": { "smithy.api#documentation": "A measure of how complete the recognizer results are for a specific entity type in the\n test data. High recall means that the recognizer returned most of the relevant results.
" } }, "F1Score": { "target": "com.amazonaws.comprehend#Double", "traits": { "smithy.api#documentation": "A measure of how accurate the recognizer results are for a specific entity type in the\n test data. It is derived from the Precision and Recall values. The\n F1Score is the harmonic average of the two scores. The highest score is 1, and\n the worst score is 0.
Detailed information about the accuracy of an entity recognizer for a specific entity\n type.
" } }, "com.amazonaws.comprehend#EntityTypesList": { "type": "list", "member": { "target": "com.amazonaws.comprehend#EntityTypesListItem" } }, "com.amazonaws.comprehend#EntityTypesListItem": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.comprehend#EntityTypeName", "traits": { "smithy.api#documentation": "An entity type within a labeled training dataset that Amazon Comprehend uses to train a\n custom entity recognizer.
\nEntity types must not contain the following invalid characters: \\n (line break), \\\\n\n (escaped line break, \\r (carriage return), \\\\r (escaped carriage return), \\t (tab), \\\\t\n (escaped tab), space, and , (comma).
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An entity type within a labeled training dataset that Amazon Comprehend uses to train a\n custom entity recognizer.
" } }, "com.amazonaws.comprehend#EventTypeString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 40 }, "smithy.api#pattern": "[A-Z_]*" } }, "com.amazonaws.comprehend#EventsDetectionJobFilter": { "type": "structure", "members": { "JobName": { "target": "com.amazonaws.comprehend#JobName", "traits": { "smithy.api#documentation": "Filters on the name of the events detection job.
" } }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { "smithy.api#documentation": "Filters the list of jobs based on job status. Returns only jobs with the specified\n status.
" } }, "SubmitTimeBefore": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted before the specified time. Jobs are returned in ascending order,\n oldest to newest.
" } }, "SubmitTimeAfter": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in descending order,\n newest to oldest.
" } } }, "traits": { "smithy.api#documentation": "Provides information for filtering a list of event detection jobs.
" } }, "com.amazonaws.comprehend#EventsDetectionJobProperties": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "The identifier assigned to the events detection job.
" } }, "JobName": { "target": "com.amazonaws.comprehend#JobName", "traits": { "smithy.api#documentation": "The name you assigned the events detection job.
" } }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { "smithy.api#documentation": "The current status of the events detection job.
" } }, "Message": { "target": "com.amazonaws.comprehend#AnyLengthString", "traits": { "smithy.api#documentation": "A description of the status of the events detection job.
" } }, "SubmitTime": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "The time that the events detection job was submitted for processing.
" } }, "EndTime": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "The time that the events detection job completed.
" } }, "InputDataConfig": { "target": "com.amazonaws.comprehend#InputDataConfig", "traits": { "smithy.api#documentation": "The input data configuration that you supplied when you created the events detection\n job.
" } }, "OutputDataConfig": { "target": "com.amazonaws.comprehend#OutputDataConfig", "traits": { "smithy.api#documentation": "The output data configuration that you supplied when you created the events detection\n job.
" } }, "LanguageCode": { "target": "com.amazonaws.comprehend#LanguageCode", "traits": { "smithy.api#documentation": "The language code of the input documents.
" } }, "DataAccessRoleArn": { "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identify and Access Management (IAM) role that\n grants Amazon Comprehend read access to your input data.
" } }, "TargetEventTypes": { "target": "com.amazonaws.comprehend#TargetEventTypes", "traits": { "smithy.api#documentation": "The types of events that are detected by the job.
" } } }, "traits": { "smithy.api#documentation": "Provides information about an events detection job.
" } }, "com.amazonaws.comprehend#EventsDetectionJobPropertiesList": { "type": "list", "member": { "target": "com.amazonaws.comprehend#EventsDetectionJobProperties" } }, "com.amazonaws.comprehend#Float": { "type": "float", "traits": { "smithy.api#box": {} } }, "com.amazonaws.comprehend#IamRoleArn": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": "arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+" } }, "com.amazonaws.comprehend#InferenceUnitsInteger": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1 } } }, "com.amazonaws.comprehend#InputDataConfig": { "type": "structure", "members": { "S3Uri": { "target": "com.amazonaws.comprehend#S3Uri", "traits": { "smithy.api#documentation": "The Amazon S3 URI for the input data. The URI must be in same region as the API\n endpoint that you are calling. The URI can point to a single input file or it can provide the\n prefix for a collection of data files.
\nFor example, if you use the URI S3://bucketName/prefix, if the prefix is a\n single file, Amazon Comprehend uses that file as input. If more than one file begins with the\n prefix, Amazon Comprehend uses all of them as input.
Specifies how the text in an input file should be processed:
\n\n ONE_DOC_PER_FILE - Each file is considered a separate document. Use\n this option when you are processing large documents, such as newspaper articles or\n scientific papers.
\n ONE_DOC_PER_LINE - Each line in a file is considered a separate\n document. Use this option when you are processing many short documents, such as text\n messages.
The input properties for a topic detection job.
" } }, "com.amazonaws.comprehend#InputFormat": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ONE_DOC_PER_FILE", "name": "ONE_DOC_PER_FILE" }, { "value": "ONE_DOC_PER_LINE", "name": "ONE_DOC_PER_LINE" } ] } }, "com.amazonaws.comprehend#Integer": { "type": "integer", "traits": { "smithy.api#box": {} } }, "com.amazonaws.comprehend#InternalServerException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.comprehend#String" } }, "traits": { "smithy.api#documentation": "An internal server error occurred. Retry your request.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.comprehend#InvalidFilterException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.comprehend#String" } }, "traits": { "smithy.api#documentation": "The filter specified for the operation is invalid. Specify a different\n filter.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.comprehend#InvalidRequestException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.comprehend#String" } }, "traits": { "smithy.api#documentation": "The request is invalid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.comprehend#JobId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 32 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$" } }, "com.amazonaws.comprehend#JobName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$" } }, "com.amazonaws.comprehend#JobNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.comprehend#String" } }, "traits": { "smithy.api#documentation": "The specified job was not found. Check the job ID and try again.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.comprehend#JobStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "SUBMITTED", "name": "SUBMITTED" }, { "value": "IN_PROGRESS", "name": "IN_PROGRESS" }, { "value": "COMPLETED", "name": "COMPLETED" }, { "value": "FAILED", "name": "FAILED" }, { "value": "STOP_REQUESTED", "name": "STOP_REQUESTED" }, { "value": "STOPPED", "name": "STOPPED" } ] } }, "com.amazonaws.comprehend#KeyPhrase": { "type": "structure", "members": { "Score": { "target": "com.amazonaws.comprehend#Float", "traits": { "smithy.api#documentation": "The level of confidence that Amazon Comprehend has in the accuracy of the\n detection.
" } }, "Text": { "target": "com.amazonaws.comprehend#String", "traits": { "smithy.api#documentation": "The text of a key noun phrase.
" } }, "BeginOffset": { "target": "com.amazonaws.comprehend#Integer", "traits": { "smithy.api#documentation": "A character offset in the input text that shows where the key phrase begins (the first\n character is at position 0). The offset returns the position of each UTF-8 code point in the\n string. A code point is the abstract character from a particular\n graphical representation. For example, a multi-byte UTF-8 character maps to a single code\n point.
" } }, "EndOffset": { "target": "com.amazonaws.comprehend#Integer", "traits": { "smithy.api#documentation": "A character offset in the input text where the key phrase ends. The offset returns the\n position of each UTF-8 code point in the string. A code point is the abstract\n character from a particular graphical representation. For example, a multi-byte UTF-8\n character maps to a single code point.
Describes a key noun phrase.
" } }, "com.amazonaws.comprehend#KeyPhrasesDetectionJobFilter": { "type": "structure", "members": { "JobName": { "target": "com.amazonaws.comprehend#JobName", "traits": { "smithy.api#documentation": "Filters on the name of the job.
" } }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { "smithy.api#documentation": "Filters the list of jobs based on job status. Returns only jobs with the specified\n status.
" } }, "SubmitTimeBefore": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted before the specified time. Jobs are returned in ascending order,\n oldest to newest.
" } }, "SubmitTimeAfter": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in descending order,\n newest to oldest.
" } } }, "traits": { "smithy.api#documentation": "Provides information for filtering a list of dominant language detection jobs. For more\n information, see the operation.
" } }, "com.amazonaws.comprehend#KeyPhrasesDetectionJobProperties": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "The identifier assigned to the key phrases detection job.
" } }, "JobName": { "target": "com.amazonaws.comprehend#JobName", "traits": { "smithy.api#documentation": "The name that you assigned the key phrases detection job.
" } }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { "smithy.api#documentation": "The current status of the key phrases detection job. If the status is FAILED,\n the Message field shows the reason for the failure.
A description of the status of a job.
" } }, "SubmitTime": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "The time that the key phrases detection job was submitted for processing.
" } }, "EndTime": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "The time that the key phrases detection job completed.
" } }, "InputDataConfig": { "target": "com.amazonaws.comprehend#InputDataConfig", "traits": { "smithy.api#documentation": "The input data configuration that you supplied when you created the key phrases detection\n job.
" } }, "OutputDataConfig": { "target": "com.amazonaws.comprehend#OutputDataConfig", "traits": { "smithy.api#documentation": "The output data configuration that you supplied when you created the key phrases detection\n job.
" } }, "LanguageCode": { "target": "com.amazonaws.comprehend#LanguageCode", "traits": { "smithy.api#documentation": "The language code of the input documents.
" } }, "DataAccessRoleArn": { "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input\n data.
" } }, "VolumeKmsKeyId": { "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your key phrases detection job. For more information, see Amazon\n VPC.
" } } }, "traits": { "smithy.api#documentation": "Provides information about a key phrases detection job.
" } }, "com.amazonaws.comprehend#KeyPhrasesDetectionJobPropertiesList": { "type": "list", "member": { "target": "com.amazonaws.comprehend#KeyPhrasesDetectionJobProperties" } }, "com.amazonaws.comprehend#KmsKeyId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 } } }, "com.amazonaws.comprehend#KmsKeyValidationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.comprehend#String" } }, "traits": { "smithy.api#documentation": "The KMS customer managed key (CMK) entered cannot be validated. Verify the key and\n re-enter it.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.comprehend#LabelDelimiter": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1 }, "smithy.api#pattern": "^[ ~!@#$%^*\\-_+=|\\\\:;\\t>?/]$" } }, "com.amazonaws.comprehend#LanguageCode": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "en", "name": "EN" }, { "value": "es", "name": "ES" }, { "value": "fr", "name": "FR" }, { "value": "de", "name": "DE" }, { "value": "it", "name": "IT" }, { "value": "pt", "name": "PT" }, { "value": "ar", "name": "AR" }, { "value": "hi", "name": "HI" }, { "value": "ja", "name": "JA" }, { "value": "ko", "name": "KO" }, { "value": "zh", "name": "ZH" }, { "value": "zh-TW", "name": "ZH_TW" } ] } }, "com.amazonaws.comprehend#ListDocumentClassificationJobs": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#ListDocumentClassificationJobsRequest" }, "output": { "target": "com.amazonaws.comprehend#ListDocumentClassificationJobsResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidFilterException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Gets a list of the documentation classification jobs that you have submitted.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.comprehend#ListDocumentClassificationJobsRequest": { "type": "structure", "members": { "Filter": { "target": "com.amazonaws.comprehend#DocumentClassificationJobFilter", "traits": { "smithy.api#documentation": "Filters the jobs that are returned. You can filter jobs on their names, status, or the\n date and time that they were submitted. You can only set one filter at a time.
" } }, "NextToken": { "target": "com.amazonaws.comprehend#String", "traits": { "smithy.api#documentation": "Identifies the next page of results to return.
" } }, "MaxResults": { "target": "com.amazonaws.comprehend#MaxResultsInteger", "traits": { "smithy.api#documentation": "The maximum number of results to return in each page. The default is 100.
" } } } }, "com.amazonaws.comprehend#ListDocumentClassificationJobsResponse": { "type": "structure", "members": { "DocumentClassificationJobPropertiesList": { "target": "com.amazonaws.comprehend#DocumentClassificationJobPropertiesList", "traits": { "smithy.api#documentation": "A list containing the properties of each job returned.
" } }, "NextToken": { "target": "com.amazonaws.comprehend#String", "traits": { "smithy.api#documentation": "Identifies the next page of results to return.
" } } } }, "com.amazonaws.comprehend#ListDocumentClassifiers": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#ListDocumentClassifiersRequest" }, "output": { "target": "com.amazonaws.comprehend#ListDocumentClassifiersResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidFilterException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Gets a list of the document classifiers that you have created.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.comprehend#ListDocumentClassifiersRequest": { "type": "structure", "members": { "Filter": { "target": "com.amazonaws.comprehend#DocumentClassifierFilter", "traits": { "smithy.api#documentation": "Filters the jobs that are returned. You can filter jobs on their name, status, or the date\n and time that they were submitted. You can only set one filter at a time.
" } }, "NextToken": { "target": "com.amazonaws.comprehend#String", "traits": { "smithy.api#documentation": "Identifies the next page of results to return.
" } }, "MaxResults": { "target": "com.amazonaws.comprehend#MaxResultsInteger", "traits": { "smithy.api#documentation": "The maximum number of results to return in each page. The default is 100.
" } } } }, "com.amazonaws.comprehend#ListDocumentClassifiersResponse": { "type": "structure", "members": { "DocumentClassifierPropertiesList": { "target": "com.amazonaws.comprehend#DocumentClassifierPropertiesList", "traits": { "smithy.api#documentation": "A list containing the properties of each job returned.
" } }, "NextToken": { "target": "com.amazonaws.comprehend#String", "traits": { "smithy.api#documentation": "Identifies the next page of results to return.
" } } } }, "com.amazonaws.comprehend#ListDominantLanguageDetectionJobs": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#ListDominantLanguageDetectionJobsRequest" }, "output": { "target": "com.amazonaws.comprehend#ListDominantLanguageDetectionJobsResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidFilterException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Gets a list of the dominant language detection jobs that you have submitted.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.comprehend#ListDominantLanguageDetectionJobsRequest": { "type": "structure", "members": { "Filter": { "target": "com.amazonaws.comprehend#DominantLanguageDetectionJobFilter", "traits": { "smithy.api#documentation": "Filters that jobs that are returned. You can filter jobs on their name, status, or the\n date and time that they were submitted. You can only set one filter at a time.
" } }, "NextToken": { "target": "com.amazonaws.comprehend#String", "traits": { "smithy.api#documentation": "Identifies the next page of results to return.
" } }, "MaxResults": { "target": "com.amazonaws.comprehend#MaxResultsInteger", "traits": { "smithy.api#documentation": "The maximum number of results to return in each page. The default is 100.
" } } } }, "com.amazonaws.comprehend#ListDominantLanguageDetectionJobsResponse": { "type": "structure", "members": { "DominantLanguageDetectionJobPropertiesList": { "target": "com.amazonaws.comprehend#DominantLanguageDetectionJobPropertiesList", "traits": { "smithy.api#documentation": "A list containing the properties of each job that is returned.
" } }, "NextToken": { "target": "com.amazonaws.comprehend#String", "traits": { "smithy.api#documentation": "Identifies the next page of results to return.
" } } } }, "com.amazonaws.comprehend#ListEndpoints": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#ListEndpointsRequest" }, "output": { "target": "com.amazonaws.comprehend#ListEndpointsResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Gets a list of all existing endpoints that you've created.
" } }, "com.amazonaws.comprehend#ListEndpointsRequest": { "type": "structure", "members": { "Filter": { "target": "com.amazonaws.comprehend#EndpointFilter", "traits": { "smithy.api#documentation": "Filters the endpoints that are returned. You can filter endpoints on their name, model,\n status, or the date and time that they were created. You can only set one filter at a time.\n
" } }, "NextToken": { "target": "com.amazonaws.comprehend#String", "traits": { "smithy.api#documentation": "Identifies the next page of results to return.
" } }, "MaxResults": { "target": "com.amazonaws.comprehend#MaxResultsInteger", "traits": { "smithy.api#documentation": "The maximum number of results to return in each page. The default is 100.
" } } } }, "com.amazonaws.comprehend#ListEndpointsResponse": { "type": "structure", "members": { "EndpointPropertiesList": { "target": "com.amazonaws.comprehend#EndpointPropertiesList", "traits": { "smithy.api#documentation": "Displays a list of endpoint properties being retrieved by the service in response to the\n request.
" } }, "NextToken": { "target": "com.amazonaws.comprehend#String", "traits": { "smithy.api#documentation": "Identifies the next page of results to return.
" } } } }, "com.amazonaws.comprehend#ListEntitiesDetectionJobs": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#ListEntitiesDetectionJobsRequest" }, "output": { "target": "com.amazonaws.comprehend#ListEntitiesDetectionJobsResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidFilterException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Gets a list of the entity detection jobs that you have submitted.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.comprehend#ListEntitiesDetectionJobsRequest": { "type": "structure", "members": { "Filter": { "target": "com.amazonaws.comprehend#EntitiesDetectionJobFilter", "traits": { "smithy.api#documentation": "Filters the jobs that are returned. You can filter jobs on their name, status, or the date\n and time that they were submitted. You can only set one filter at a time.
" } }, "NextToken": { "target": "com.amazonaws.comprehend#String", "traits": { "smithy.api#documentation": "Identifies the next page of results to return.
" } }, "MaxResults": { "target": "com.amazonaws.comprehend#MaxResultsInteger", "traits": { "smithy.api#documentation": "The maximum number of results to return in each page. The default is 100.
" } } } }, "com.amazonaws.comprehend#ListEntitiesDetectionJobsResponse": { "type": "structure", "members": { "EntitiesDetectionJobPropertiesList": { "target": "com.amazonaws.comprehend#EntitiesDetectionJobPropertiesList", "traits": { "smithy.api#documentation": "A list containing the properties of each job that is returned.
" } }, "NextToken": { "target": "com.amazonaws.comprehend#String", "traits": { "smithy.api#documentation": "Identifies the next page of results to return.
" } } } }, "com.amazonaws.comprehend#ListEntityRecognizers": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#ListEntityRecognizersRequest" }, "output": { "target": "com.amazonaws.comprehend#ListEntityRecognizersResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidFilterException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Gets a list of the properties of all entity recognizers that you created, including\n recognizers currently in training. Allows you to filter the list of recognizers based on\n criteria such as status and submission time. This call returns up to 500 entity recognizers in\n the list, with a default number of 100 recognizers in the list.
\nThe results of this list are not in any particular order. Please get the list and sort\n locally if needed.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.comprehend#ListEntityRecognizersRequest": { "type": "structure", "members": { "Filter": { "target": "com.amazonaws.comprehend#EntityRecognizerFilter", "traits": { "smithy.api#documentation": "Filters the list of entities returned. You can filter on Status,\n SubmitTimeBefore, or SubmitTimeAfter. You can only set one filter\n at a time.
Identifies the next page of results to return.
" } }, "MaxResults": { "target": "com.amazonaws.comprehend#MaxResultsInteger", "traits": { "smithy.api#documentation": "The maximum number of results to return on each page. The default is 100.
" } } } }, "com.amazonaws.comprehend#ListEntityRecognizersResponse": { "type": "structure", "members": { "EntityRecognizerPropertiesList": { "target": "com.amazonaws.comprehend#EntityRecognizerPropertiesList", "traits": { "smithy.api#documentation": "The list of properties of an entity recognizer.
" } }, "NextToken": { "target": "com.amazonaws.comprehend#String", "traits": { "smithy.api#documentation": "Identifies the next page of results to return.
" } } } }, "com.amazonaws.comprehend#ListEventsDetectionJobs": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#ListEventsDetectionJobsRequest" }, "output": { "target": "com.amazonaws.comprehend#ListEventsDetectionJobsResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidFilterException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Gets a list of the events detection jobs that you have submitted.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.comprehend#ListEventsDetectionJobsRequest": { "type": "structure", "members": { "Filter": { "target": "com.amazonaws.comprehend#EventsDetectionJobFilter", "traits": { "smithy.api#documentation": "Filters the jobs that are returned. You can filter jobs on their name, status, or the date\n and time that they were submitted. You can only set one filter at a time.
" } }, "NextToken": { "target": "com.amazonaws.comprehend#String", "traits": { "smithy.api#documentation": "Identifies the next page of results to return.
" } }, "MaxResults": { "target": "com.amazonaws.comprehend#MaxResultsInteger", "traits": { "smithy.api#documentation": "The maximum number of results to return in each page.
" } } } }, "com.amazonaws.comprehend#ListEventsDetectionJobsResponse": { "type": "structure", "members": { "EventsDetectionJobPropertiesList": { "target": "com.amazonaws.comprehend#EventsDetectionJobPropertiesList", "traits": { "smithy.api#documentation": "A list containing the properties of each job that is returned.
" } }, "NextToken": { "target": "com.amazonaws.comprehend#String", "traits": { "smithy.api#documentation": "Identifies the next page of results to return.
" } } } }, "com.amazonaws.comprehend#ListKeyPhrasesDetectionJobs": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#ListKeyPhrasesDetectionJobsRequest" }, "output": { "target": "com.amazonaws.comprehend#ListKeyPhrasesDetectionJobsResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidFilterException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Get a list of key phrase detection jobs that you have submitted.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.comprehend#ListKeyPhrasesDetectionJobsRequest": { "type": "structure", "members": { "Filter": { "target": "com.amazonaws.comprehend#KeyPhrasesDetectionJobFilter", "traits": { "smithy.api#documentation": "Filters the jobs that are returned. You can filter jobs on their name, status, or the date\n and time that they were submitted. You can only set one filter at a time.
" } }, "NextToken": { "target": "com.amazonaws.comprehend#String", "traits": { "smithy.api#documentation": "Identifies the next page of results to return.
" } }, "MaxResults": { "target": "com.amazonaws.comprehend#MaxResultsInteger", "traits": { "smithy.api#documentation": "The maximum number of results to return in each page. The default is 100.
" } } } }, "com.amazonaws.comprehend#ListKeyPhrasesDetectionJobsResponse": { "type": "structure", "members": { "KeyPhrasesDetectionJobPropertiesList": { "target": "com.amazonaws.comprehend#KeyPhrasesDetectionJobPropertiesList", "traits": { "smithy.api#documentation": "A list containing the properties of each job that is returned.
" } }, "NextToken": { "target": "com.amazonaws.comprehend#String", "traits": { "smithy.api#documentation": "Identifies the next page of results to return.
" } } } }, "com.amazonaws.comprehend#ListOfClasses": { "type": "list", "member": { "target": "com.amazonaws.comprehend#DocumentClass" } }, "com.amazonaws.comprehend#ListOfDetectDominantLanguageResult": { "type": "list", "member": { "target": "com.amazonaws.comprehend#BatchDetectDominantLanguageItemResult" } }, "com.amazonaws.comprehend#ListOfDetectEntitiesResult": { "type": "list", "member": { "target": "com.amazonaws.comprehend#BatchDetectEntitiesItemResult" } }, "com.amazonaws.comprehend#ListOfDetectKeyPhrasesResult": { "type": "list", "member": { "target": "com.amazonaws.comprehend#BatchDetectKeyPhrasesItemResult" } }, "com.amazonaws.comprehend#ListOfDetectSentimentResult": { "type": "list", "member": { "target": "com.amazonaws.comprehend#BatchDetectSentimentItemResult" } }, "com.amazonaws.comprehend#ListOfDetectSyntaxResult": { "type": "list", "member": { "target": "com.amazonaws.comprehend#BatchDetectSyntaxItemResult" } }, "com.amazonaws.comprehend#ListOfDominantLanguages": { "type": "list", "member": { "target": "com.amazonaws.comprehend#DominantLanguage" } }, "com.amazonaws.comprehend#ListOfEntities": { "type": "list", "member": { "target": "com.amazonaws.comprehend#Entity" } }, "com.amazonaws.comprehend#ListOfEntityLabels": { "type": "list", "member": { "target": "com.amazonaws.comprehend#EntityLabel" } }, "com.amazonaws.comprehend#ListOfKeyPhrases": { "type": "list", "member": { "target": "com.amazonaws.comprehend#KeyPhrase" } }, "com.amazonaws.comprehend#ListOfLabels": { "type": "list", "member": { "target": "com.amazonaws.comprehend#DocumentLabel" } }, "com.amazonaws.comprehend#ListOfPiiEntities": { "type": "list", "member": { "target": "com.amazonaws.comprehend#PiiEntity" } }, "com.amazonaws.comprehend#ListOfPiiEntityTypes": { "type": "list", "member": { "target": "com.amazonaws.comprehend#PiiEntityType" } }, "com.amazonaws.comprehend#ListOfSyntaxTokens": { "type": "list", "member": { "target": "com.amazonaws.comprehend#SyntaxToken" } }, "com.amazonaws.comprehend#ListPiiEntitiesDetectionJobs": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#ListPiiEntitiesDetectionJobsRequest" }, "output": { "target": "com.amazonaws.comprehend#ListPiiEntitiesDetectionJobsResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidFilterException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Gets a list of the PII entity detection jobs that you have submitted.
" } }, "com.amazonaws.comprehend#ListPiiEntitiesDetectionJobsRequest": { "type": "structure", "members": { "Filter": { "target": "com.amazonaws.comprehend#PiiEntitiesDetectionJobFilter", "traits": { "smithy.api#documentation": "Filters the jobs that are returned. You can filter jobs on their name, status, or the date\n and time that they were submitted. You can only set one filter at a time.
" } }, "NextToken": { "target": "com.amazonaws.comprehend#String", "traits": { "smithy.api#documentation": "Identifies the next page of results to return.
" } }, "MaxResults": { "target": "com.amazonaws.comprehend#MaxResultsInteger", "traits": { "smithy.api#documentation": "The maximum number of results to return in each page.
" } } } }, "com.amazonaws.comprehend#ListPiiEntitiesDetectionJobsResponse": { "type": "structure", "members": { "PiiEntitiesDetectionJobPropertiesList": { "target": "com.amazonaws.comprehend#PiiEntitiesDetectionJobPropertiesList", "traits": { "smithy.api#documentation": "A list containing the properties of each job that is returned.
" } }, "NextToken": { "target": "com.amazonaws.comprehend#String", "traits": { "smithy.api#documentation": "Identifies the next page of results to return.
" } } } }, "com.amazonaws.comprehend#ListSentimentDetectionJobs": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#ListSentimentDetectionJobsRequest" }, "output": { "target": "com.amazonaws.comprehend#ListSentimentDetectionJobsResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidFilterException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Gets a list of sentiment detection jobs that you have submitted.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.comprehend#ListSentimentDetectionJobsRequest": { "type": "structure", "members": { "Filter": { "target": "com.amazonaws.comprehend#SentimentDetectionJobFilter", "traits": { "smithy.api#documentation": "Filters the jobs that are returned. You can filter jobs on their name, status, or the date\n and time that they were submitted. You can only set one filter at a time.
" } }, "NextToken": { "target": "com.amazonaws.comprehend#String", "traits": { "smithy.api#documentation": "Identifies the next page of results to return.
" } }, "MaxResults": { "target": "com.amazonaws.comprehend#MaxResultsInteger", "traits": { "smithy.api#documentation": "The maximum number of results to return in each page. The default is 100.
" } } } }, "com.amazonaws.comprehend#ListSentimentDetectionJobsResponse": { "type": "structure", "members": { "SentimentDetectionJobPropertiesList": { "target": "com.amazonaws.comprehend#SentimentDetectionJobPropertiesList", "traits": { "smithy.api#documentation": "A list containing the properties of each job that is returned.
" } }, "NextToken": { "target": "com.amazonaws.comprehend#String", "traits": { "smithy.api#documentation": "Identifies the next page of results to return.
" } } } }, "com.amazonaws.comprehend#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.comprehend#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Lists all tags associated with a given Amazon Comprehend resource.
" } }, "com.amazonaws.comprehend#ListTagsForResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.comprehend#ComprehendArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are querying.\n
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#ListTagsForResourceResponse": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.comprehend#ComprehendArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are\n querying.
" } }, "Tags": { "target": "com.amazonaws.comprehend#TagList", "traits": { "smithy.api#documentation": "Tags associated with the Amazon Comprehend resource being queried. A tag is a key-value\n pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with\n \"Sales\" as the key might be added to a resource to indicate its use by the sales department.\n
" } } } }, "com.amazonaws.comprehend#ListTopicsDetectionJobs": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#ListTopicsDetectionJobsRequest" }, "output": { "target": "com.amazonaws.comprehend#ListTopicsDetectionJobsResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidFilterException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Gets a list of the topic detection jobs that you have submitted.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.comprehend#ListTopicsDetectionJobsRequest": { "type": "structure", "members": { "Filter": { "target": "com.amazonaws.comprehend#TopicsDetectionJobFilter", "traits": { "smithy.api#documentation": "Filters the jobs that are returned. Jobs can be filtered on their name, status, or the\n date and time that they were submitted. You can set only one filter at a time.
" } }, "NextToken": { "target": "com.amazonaws.comprehend#String", "traits": { "smithy.api#documentation": "Identifies the next page of results to return.
" } }, "MaxResults": { "target": "com.amazonaws.comprehend#MaxResultsInteger", "traits": { "smithy.api#documentation": "The maximum number of results to return in each page. The default is 100.
" } } } }, "com.amazonaws.comprehend#ListTopicsDetectionJobsResponse": { "type": "structure", "members": { "TopicsDetectionJobPropertiesList": { "target": "com.amazonaws.comprehend#TopicsDetectionJobPropertiesList", "traits": { "smithy.api#documentation": "A list containing the properties of each job that is returned.
" } }, "NextToken": { "target": "com.amazonaws.comprehend#String", "traits": { "smithy.api#documentation": "Identifies the next page of results to return.
" } } } }, "com.amazonaws.comprehend#MaskCharacter": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1 }, "smithy.api#pattern": "[!@#$%&*]" } }, "com.amazonaws.comprehend#MaxResultsInteger": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 500 } } }, "com.amazonaws.comprehend#ModelStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "SUBMITTED", "name": "SUBMITTED" }, { "value": "TRAINING", "name": "TRAINING" }, { "value": "DELETING", "name": "DELETING" }, { "value": "STOP_REQUESTED", "name": "STOP_REQUESTED" }, { "value": "STOPPED", "name": "STOPPED" }, { "value": "IN_ERROR", "name": "IN_ERROR" }, { "value": "TRAINED", "name": "TRAINED" } ] } }, "com.amazonaws.comprehend#NumberOfTopicsInteger": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.comprehend#OutputDataConfig": { "type": "structure", "members": { "S3Uri": { "target": "com.amazonaws.comprehend#S3Uri", "traits": { "smithy.api#documentation": "When you use the OutputDataConfig object with asynchronous operations, you\n specify the Amazon S3 location where you want to write the output data. The URI must be in the\n same region as the API endpoint that you are calling. The location is used as the prefix for\n the actual location of the output file.
When the topic detection job is finished, the service creates an output file in a\n directory specific to the job. The S3Uri field contains the location of the\n output file, called output.tar.gz. It is a compressed archive that contains the\n ouput of the operation.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the\n output results from an analysis job. The KmsKeyId can be one of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
KMS Key Alias: \"alias/ExampleAlias\"\n
ARN of a KMS Key Alias:\n \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"\n
Provides configuration parameters for the output of topic detection jobs.
\n " } }, "com.amazonaws.comprehend#PartOfSpeechTag": { "type": "structure", "members": { "Tag": { "target": "com.amazonaws.comprehend#PartOfSpeechTagType", "traits": { "smithy.api#documentation": "Identifies the part of speech that the token represents.
" } }, "Score": { "target": "com.amazonaws.comprehend#Float", "traits": { "smithy.api#documentation": "The confidence that Amazon Comprehend has that the part of speech was correctly\n identified.
" } } }, "traits": { "smithy.api#documentation": "Identifies the part of speech represented by the token and gives the confidence that\n Amazon Comprehend has that the part of speech was correctly identified. For more information\n about the parts of speech that Amazon Comprehend can identify, see how-syntax.
" } }, "com.amazonaws.comprehend#PartOfSpeechTagType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ADJ", "name": "ADJ" }, { "value": "ADP", "name": "ADP" }, { "value": "ADV", "name": "ADV" }, { "value": "AUX", "name": "AUX" }, { "value": "CONJ", "name": "CONJ" }, { "value": "CCONJ", "name": "CCONJ" }, { "value": "DET", "name": "DET" }, { "value": "INTJ", "name": "INTJ" }, { "value": "NOUN", "name": "NOUN" }, { "value": "NUM", "name": "NUM" }, { "value": "O", "name": "O" }, { "value": "PART", "name": "PART" }, { "value": "PRON", "name": "PRON" }, { "value": "PROPN", "name": "PROPN" }, { "value": "PUNCT", "name": "PUNCT" }, { "value": "SCONJ", "name": "SCONJ" }, { "value": "SYM", "name": "SYM" }, { "value": "VERB", "name": "VERB" } ] } }, "com.amazonaws.comprehend#PiiEntitiesDetectionJobFilter": { "type": "structure", "members": { "JobName": { "target": "com.amazonaws.comprehend#JobName", "traits": { "smithy.api#documentation": "Filters on the name of the job.
" } }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { "smithy.api#documentation": "Filters the list of jobs based on job status. Returns only jobs with the specified\n status.
" } }, "SubmitTimeBefore": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted before the specified time. Jobs are returned in ascending order,\n oldest to newest.
" } }, "SubmitTimeAfter": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in descending order,\n newest to oldest.
" } } }, "traits": { "smithy.api#documentation": "Provides information for filtering a list of PII entity detection jobs.
" } }, "com.amazonaws.comprehend#PiiEntitiesDetectionJobProperties": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "The identifier assigned to the PII entities detection job.
" } }, "JobName": { "target": "com.amazonaws.comprehend#JobName", "traits": { "smithy.api#documentation": "The name that you assigned the PII entities detection job.
" } }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { "smithy.api#documentation": "The current status of the PII entities detection job. If the status is\n FAILED, the Message field shows the reason for the failure.
A description of the status of a job.
" } }, "SubmitTime": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "The time that the PII entities detection job was submitted for processing.
" } }, "EndTime": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "The time that the PII entities detection job completed.
" } }, "InputDataConfig": { "target": "com.amazonaws.comprehend#InputDataConfig", "traits": { "smithy.api#documentation": "The input properties for a PII entities detection job.
" } }, "OutputDataConfig": { "target": "com.amazonaws.comprehend#PiiOutputDataConfig", "traits": { "smithy.api#documentation": "The output data configuration that you supplied when you created the PII entities\n detection job.
" } }, "RedactionConfig": { "target": "com.amazonaws.comprehend#RedactionConfig", "traits": { "smithy.api#documentation": "Provides configuration parameters for PII entity redaction.
\nThis parameter is required if you set the Mode parameter to\n ONLY_REDACTION. In that case, you must provide a RedactionConfig\n definition that includes the PiiEntityTypes parameter.
The language code of the input documents
" } }, "DataAccessRoleArn": { "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input\n data.
" } }, "Mode": { "target": "com.amazonaws.comprehend#PiiEntitiesDetectionMode", "traits": { "smithy.api#documentation": "Specifies whether the output provides the locations (offsets) of PII entities or a file in\n which PII entities are redacted.
" } } }, "traits": { "smithy.api#documentation": "Provides information about a PII entities detection job.
" } }, "com.amazonaws.comprehend#PiiEntitiesDetectionJobPropertiesList": { "type": "list", "member": { "target": "com.amazonaws.comprehend#PiiEntitiesDetectionJobProperties" } }, "com.amazonaws.comprehend#PiiEntitiesDetectionMaskMode": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "MASK", "name": "MASK" }, { "value": "REPLACE_WITH_PII_ENTITY_TYPE", "name": "REPLACE_WITH_PII_ENTITY_TYPE" } ] } }, "com.amazonaws.comprehend#PiiEntitiesDetectionMode": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ONLY_REDACTION", "name": "ONLY_REDACTION" }, { "value": "ONLY_OFFSETS", "name": "ONLY_OFFSETS" } ] } }, "com.amazonaws.comprehend#PiiEntity": { "type": "structure", "members": { "Score": { "target": "com.amazonaws.comprehend#Float", "traits": { "smithy.api#documentation": "The level of confidence that Amazon Comprehend has in the accuracy of the\n detection.
" } }, "Type": { "target": "com.amazonaws.comprehend#PiiEntityType", "traits": { "smithy.api#documentation": "The entity's type.
" } }, "BeginOffset": { "target": "com.amazonaws.comprehend#Integer", "traits": { "smithy.api#documentation": "A character offset in the input text that shows where the PII entity begins (the first\n character is at position 0). The offset returns the position of each UTF-8 code point in the\n string. A code point is the abstract character from a particular\n graphical representation. For example, a multi-byte UTF-8 character maps to a single code\n point.
" } }, "EndOffset": { "target": "com.amazonaws.comprehend#Integer", "traits": { "smithy.api#documentation": "A character offset in the input text that shows where the PII entity ends. The offset\n returns the position of each UTF-8 code point in the string. A code point\n is the abstract character from a particular graphical representation. For example, a\n multi-byte UTF-8 character maps to a single code point.
" } } }, "traits": { "smithy.api#documentation": "Provides information about a PII entity.
" } }, "com.amazonaws.comprehend#PiiEntityType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "BANK_ACCOUNT_NUMBER", "name": "BANK_ACCOUNT_NUMBER" }, { "value": "BANK_ROUTING", "name": "BANK_ROUTING" }, { "value": "CREDIT_DEBIT_NUMBER", "name": "CREDIT_DEBIT_NUMBER" }, { "value": "CREDIT_DEBIT_CVV", "name": "CREDIT_DEBIT_CVV" }, { "value": "CREDIT_DEBIT_EXPIRY", "name": "CREDIT_DEBIT_EXPIRY" }, { "value": "PIN", "name": "PIN" }, { "value": "EMAIL", "name": "EMAIL" }, { "value": "ADDRESS", "name": "ADDRESS" }, { "value": "NAME", "name": "NAME" }, { "value": "PHONE", "name": "PHONE" }, { "value": "SSN", "name": "SSN" }, { "value": "DATE_TIME", "name": "DATE_TIME" }, { "value": "PASSPORT_NUMBER", "name": "PASSPORT_NUMBER" }, { "value": "DRIVER_ID", "name": "DRIVER_ID" }, { "value": "URL", "name": "URL" }, { "value": "AGE", "name": "AGE" }, { "value": "USERNAME", "name": "USERNAME" }, { "value": "PASSWORD", "name": "PASSWORD" }, { "value": "AWS_ACCESS_KEY", "name": "AWS_ACCESS_KEY" }, { "value": "AWS_SECRET_KEY", "name": "AWS_SECRET_KEY" }, { "value": "IP_ADDRESS", "name": "IP_ADDRESS" }, { "value": "MAC_ADDRESS", "name": "MAC_ADDRESS" }, { "value": "ALL", "name": "ALL" } ] } }, "com.amazonaws.comprehend#PiiOutputDataConfig": { "type": "structure", "members": { "S3Uri": { "target": "com.amazonaws.comprehend#S3Uri", "traits": { "smithy.api#documentation": "When you use the PiiOutputDataConfig object with asynchronous operations,\n you specify the Amazon S3 location where you want to write the output data.
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the\n output results from an analysis job.
" } } }, "traits": { "smithy.api#documentation": "Provides configuration parameters for the output of PII entity detection jobs.
" } }, "com.amazonaws.comprehend#RedactionConfig": { "type": "structure", "members": { "PiiEntityTypes": { "target": "com.amazonaws.comprehend#ListOfPiiEntityTypes", "traits": { "smithy.api#documentation": "An array of the types of PII entities that Amazon Comprehend detects in the input text for\n your request.
" } }, "MaskMode": { "target": "com.amazonaws.comprehend#PiiEntitiesDetectionMaskMode", "traits": { "smithy.api#documentation": "Specifies whether the PII entity is redacted with the mask character or the entity\n type.
" } }, "MaskCharacter": { "target": "com.amazonaws.comprehend#MaskCharacter", "traits": { "smithy.api#documentation": "A character that replaces each character in the redacted PII entity.
" } } }, "traits": { "smithy.api#documentation": "Provides configuration parameters for PII entity redaction.
" } }, "com.amazonaws.comprehend#ResourceInUseException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.comprehend#String" } }, "traits": { "smithy.api#documentation": "The specified resource name is already in use. Use a different name and try your request\n again.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.comprehend#ResourceLimitExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.comprehend#String" } }, "traits": { "smithy.api#documentation": "The maximum number of resources per account has been exceeded. Review the resources, and\n then try your request again.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.comprehend#ResourceNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.comprehend#String" } }, "traits": { "smithy.api#documentation": "The specified resource ARN was not found. Check the ARN and try your request again.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.comprehend#ResourceUnavailableException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.comprehend#String" } }, "traits": { "smithy.api#documentation": "The specified resource is not available. Check the resource and try your request\n again.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.comprehend#S3Uri": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": "s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?" } }, "com.amazonaws.comprehend#SecurityGroupId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 32 }, "smithy.api#pattern": "[-0-9a-zA-Z]+" } }, "com.amazonaws.comprehend#SecurityGroupIds": { "type": "list", "member": { "target": "com.amazonaws.comprehend#SecurityGroupId" }, "traits": { "smithy.api#length": { "min": 1, "max": 5 } } }, "com.amazonaws.comprehend#SentimentDetectionJobFilter": { "type": "structure", "members": { "JobName": { "target": "com.amazonaws.comprehend#JobName", "traits": { "smithy.api#documentation": "Filters on the name of the job.
" } }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { "smithy.api#documentation": "Filters the list of jobs based on job status. Returns only jobs with the specified\n status.
" } }, "SubmitTimeBefore": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted before the specified time. Jobs are returned in ascending order,\n oldest to newest.
" } }, "SubmitTimeAfter": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "Filters the list of jobs based on the time that the job was submitted for processing.\n Returns only jobs submitted after the specified time. Jobs are returned in descending order,\n newest to oldest.
" } } }, "traits": { "smithy.api#documentation": "Provides information for filtering a list of dominant language detection jobs. For more\n information, see the operation.
" } }, "com.amazonaws.comprehend#SentimentDetectionJobProperties": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "The identifier assigned to the sentiment detection job.
" } }, "JobName": { "target": "com.amazonaws.comprehend#JobName", "traits": { "smithy.api#documentation": "The name that you assigned to the sentiment detection job
" } }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { "smithy.api#documentation": "The current status of the sentiment detection job. If the status is FAILED,\n the Messages field shows the reason for the failure.
A description of the status of a job.
" } }, "SubmitTime": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "The time that the sentiment detection job was submitted for processing.
" } }, "EndTime": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "The time that the sentiment detection job ended.
" } }, "InputDataConfig": { "target": "com.amazonaws.comprehend#InputDataConfig", "traits": { "smithy.api#documentation": "The input data configuration that you supplied when you created the sentiment detection\n job.
" } }, "OutputDataConfig": { "target": "com.amazonaws.comprehend#OutputDataConfig", "traits": { "smithy.api#documentation": "The output data configuration that you supplied when you created the sentiment detection\n job.
" } }, "LanguageCode": { "target": "com.amazonaws.comprehend#LanguageCode", "traits": { "smithy.api#documentation": "The language code of the input documents.
" } }, "DataAccessRoleArn": { "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input\n data.
" } }, "VolumeKmsKeyId": { "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your sentiment detection job. For more information, see Amazon\n VPC.
" } } }, "traits": { "smithy.api#documentation": "Provides information about a sentiment detection job.
" } }, "com.amazonaws.comprehend#SentimentDetectionJobPropertiesList": { "type": "list", "member": { "target": "com.amazonaws.comprehend#SentimentDetectionJobProperties" } }, "com.amazonaws.comprehend#SentimentScore": { "type": "structure", "members": { "Positive": { "target": "com.amazonaws.comprehend#Float", "traits": { "smithy.api#documentation": "The level of confidence that Amazon Comprehend has in the accuracy of its detection of\n the POSITIVE sentiment.
The level of confidence that Amazon Comprehend has in the accuracy of its detection of\n the NEGATIVE sentiment.
The level of confidence that Amazon Comprehend has in the accuracy of its detection of\n the NEUTRAL sentiment.
The level of confidence that Amazon Comprehend has in the accuracy of its detection of\n the MIXED sentiment.
Describes the level of confidence that Amazon Comprehend has in the accuracy of its\n detection of sentiments.
" } }, "com.amazonaws.comprehend#SentimentType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "POSITIVE", "name": "POSITIVE" }, { "value": "NEGATIVE", "name": "NEGATIVE" }, { "value": "NEUTRAL", "name": "NEUTRAL" }, { "value": "MIXED", "name": "MIXED" } ] } }, "com.amazonaws.comprehend#StartDocumentClassificationJob": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#StartDocumentClassificationJobRequest" }, "output": { "target": "com.amazonaws.comprehend#StartDocumentClassificationJobResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#KmsKeyValidationException" }, { "target": "com.amazonaws.comprehend#ResourceNotFoundException" }, { "target": "com.amazonaws.comprehend#ResourceUnavailableException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Starts an asynchronous document classification job. Use the operation to track the progress of the\n job.
" } }, "com.amazonaws.comprehend#StartDocumentClassificationJobRequest": { "type": "structure", "members": { "JobName": { "target": "com.amazonaws.comprehend#JobName", "traits": { "smithy.api#documentation": "The identifier of the job.
" } }, "DocumentClassifierArn": { "target": "com.amazonaws.comprehend#DocumentClassifierArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the document classifier to use to process the\n job.
", "smithy.api#required": {} } }, "InputDataConfig": { "target": "com.amazonaws.comprehend#InputDataConfig", "traits": { "smithy.api#documentation": "Specifies the format and location of the input data for the job.
", "smithy.api#required": {} } }, "OutputDataConfig": { "target": "com.amazonaws.comprehend#OutputDataConfig", "traits": { "smithy.api#documentation": "Specifies where to send the output files.
", "smithy.api#required": {} } }, "DataAccessRoleArn": { "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to your input data.
", "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.comprehend#ClientRequestTokenString", "traits": { "smithy.api#documentation": "A unique identifier for the request. If you do not set the client request token, Amazon\n Comprehend generates one.
", "smithy.api#idempotencyToken": {} } }, "VolumeKmsKeyId": { "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your document classification job. For more information, see\n Amazon\n VPC.
" } } } }, "com.amazonaws.comprehend#StartDocumentClassificationJobResponse": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "The identifier generated for the job. To get the status of the job, use this identifier\n with the operation.
" } }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { "smithy.api#documentation": "The status of the job:
\nSUBMITTED - The job has been received and queued for processing.
\nIN_PROGRESS - Amazon Comprehend is processing the job.
\nCOMPLETED - The job was successfully completed and the output is available.
\nFAILED - The job did not complete. For details, use the operation.
\nSTOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is\n processing the request.
\nSTOPPED - The job was successfully stopped without completing.
\nStarts an asynchronous dominant language detection job for a collection of documents. Use\n the operation to track the status\n of a job.
" } }, "com.amazonaws.comprehend#StartDominantLanguageDetectionJobRequest": { "type": "structure", "members": { "InputDataConfig": { "target": "com.amazonaws.comprehend#InputDataConfig", "traits": { "smithy.api#documentation": "Specifies the format and location of the input data for the job.
", "smithy.api#required": {} } }, "OutputDataConfig": { "target": "com.amazonaws.comprehend#OutputDataConfig", "traits": { "smithy.api#documentation": "Specifies where to send the output files.
", "smithy.api#required": {} } }, "DataAccessRoleArn": { "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
", "smithy.api#required": {} } }, "JobName": { "target": "com.amazonaws.comprehend#JobName", "traits": { "smithy.api#documentation": "An identifier for the job.
" } }, "ClientRequestToken": { "target": "com.amazonaws.comprehend#ClientRequestTokenString", "traits": { "smithy.api#documentation": "A unique identifier for the request. If you do not set the client request token, Amazon\n Comprehend generates one.
", "smithy.api#idempotencyToken": {} } }, "VolumeKmsKeyId": { "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your dominant language detection job. For more information,\n see Amazon VPC.
" } } } }, "com.amazonaws.comprehend#StartDominantLanguageDetectionJobResponse": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "The identifier generated for the job. To get the status of a job, use this identifier with\n the operation.
" } }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { "smithy.api#documentation": "The status of the job.
\nSUBMITTED - The job has been received and is queued for processing.
\nIN_PROGRESS - Amazon Comprehend is processing the job.
\nCOMPLETED - The job was successfully completed and the output is available.
\nFAILED - The job did not complete. To get details, use the operation.
\nStarts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.
\nThis API can be used for either standard entity detection or custom entity recognition. In\n order to be used for custom entity recognition, the optional EntityRecognizerArn\n must be used in order to provide access to the recognizer being used to detect the custom\n entity.
Specifies the format and location of the input data for the job.
", "smithy.api#required": {} } }, "OutputDataConfig": { "target": "com.amazonaws.comprehend#OutputDataConfig", "traits": { "smithy.api#documentation": "Specifies where to send the output files.
", "smithy.api#required": {} } }, "DataAccessRoleArn": { "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
", "smithy.api#required": {} } }, "JobName": { "target": "com.amazonaws.comprehend#JobName", "traits": { "smithy.api#documentation": "The identifier of the job.
" } }, "EntityRecognizerArn": { "target": "com.amazonaws.comprehend#EntityRecognizerArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used\n by the StartEntitiesDetectionJob. This ARN is optional and is only used for a\n custom entity recognition job.
The language of the input documents. All documents must be in the same language. You can\n specify any of the languages supported by Amazon Comprehend. If custom entities recognition is\n used, this parameter is ignored and the language used for training the model is used\n instead.
", "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.comprehend#ClientRequestTokenString", "traits": { "smithy.api#documentation": "A unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.
", "smithy.api#idempotencyToken": {} } }, "VolumeKmsKeyId": { "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your entity detection job. For more information, see Amazon\n VPC.
" } } } }, "com.amazonaws.comprehend#StartEntitiesDetectionJobResponse": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "The identifier generated for the job. To get the status of job, use this identifier with\n the operation.
" } }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { "smithy.api#documentation": "The status of the job.
\nSUBMITTED - The job has been received and is queued for processing.
\nIN_PROGRESS - Amazon Comprehend is processing the job.
\nCOMPLETED - The job was successfully completed and the output is available.
\nFAILED - The job did not complete. To get details, use the operation.
\nSTOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is\n processing the request.
\nSTOPPED - The job was successfully stopped without completing.
\nStarts an asynchronous event detection job for a collection of documents.
" } }, "com.amazonaws.comprehend#StartEventsDetectionJobRequest": { "type": "structure", "members": { "InputDataConfig": { "target": "com.amazonaws.comprehend#InputDataConfig", "traits": { "smithy.api#documentation": "Specifies the format and location of the input data for the job.
", "smithy.api#required": {} } }, "OutputDataConfig": { "target": "com.amazonaws.comprehend#OutputDataConfig", "traits": { "smithy.api#documentation": "Specifies where to send the output files.
", "smithy.api#required": {} } }, "DataAccessRoleArn": { "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to your input data.
", "smithy.api#required": {} } }, "JobName": { "target": "com.amazonaws.comprehend#JobName", "traits": { "smithy.api#documentation": "The identifier of the events detection job.
" } }, "LanguageCode": { "target": "com.amazonaws.comprehend#LanguageCode", "traits": { "smithy.api#documentation": "The language code of the input documents.
", "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.comprehend#ClientRequestTokenString", "traits": { "smithy.api#documentation": "An unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.
", "smithy.api#idempotencyToken": {} } }, "TargetEventTypes": { "target": "com.amazonaws.comprehend#TargetEventTypes", "traits": { "smithy.api#documentation": "The types of events to detect in the input documents.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#StartEventsDetectionJobResponse": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "An unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.
" } }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { "smithy.api#documentation": "The status of the events detection job.
" } } } }, "com.amazonaws.comprehend#StartKeyPhrasesDetectionJob": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#StartKeyPhrasesDetectionJobRequest" }, "output": { "target": "com.amazonaws.comprehend#StartKeyPhrasesDetectionJobResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#KmsKeyValidationException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Starts an asynchronous key phrase detection job for a collection of documents. Use the\n operation to track the status of a\n job.
" } }, "com.amazonaws.comprehend#StartKeyPhrasesDetectionJobRequest": { "type": "structure", "members": { "InputDataConfig": { "target": "com.amazonaws.comprehend#InputDataConfig", "traits": { "smithy.api#documentation": "Specifies the format and location of the input data for the job.
", "smithy.api#required": {} } }, "OutputDataConfig": { "target": "com.amazonaws.comprehend#OutputDataConfig", "traits": { "smithy.api#documentation": "Specifies where to send the output files.
", "smithy.api#required": {} } }, "DataAccessRoleArn": { "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
", "smithy.api#required": {} } }, "JobName": { "target": "com.amazonaws.comprehend#JobName", "traits": { "smithy.api#documentation": "The identifier of the job.
" } }, "LanguageCode": { "target": "com.amazonaws.comprehend#LanguageCode", "traits": { "smithy.api#documentation": "The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. All documents must be in the same language.
", "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.comprehend#ClientRequestTokenString", "traits": { "smithy.api#documentation": "A unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.
", "smithy.api#idempotencyToken": {} } }, "VolumeKmsKeyId": { "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your key phrases detection job. For more information, see\n Amazon\n VPC.
" } } } }, "com.amazonaws.comprehend#StartKeyPhrasesDetectionJobResponse": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "The identifier generated for the job. To get the status of a job, use this identifier with\n the operation.
" } }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { "smithy.api#documentation": "The status of the job.
\nSUBMITTED - The job has been received and is queued for processing.
\nIN_PROGRESS - Amazon Comprehend is processing the job.
\nCOMPLETED - The job was successfully completed and the output is available.
\nFAILED - The job did not complete. To get details, use the operation.
\nStarts an asynchronous PII entity detection job for a collection of documents.
" } }, "com.amazonaws.comprehend#StartPiiEntitiesDetectionJobRequest": { "type": "structure", "members": { "InputDataConfig": { "target": "com.amazonaws.comprehend#InputDataConfig", "traits": { "smithy.api#documentation": "The input properties for a PII entities detection job.
", "smithy.api#required": {} } }, "OutputDataConfig": { "target": "com.amazonaws.comprehend#OutputDataConfig", "traits": { "smithy.api#documentation": "Provides configuration parameters for the output of PII entity detection jobs.
", "smithy.api#required": {} } }, "Mode": { "target": "com.amazonaws.comprehend#PiiEntitiesDetectionMode", "traits": { "smithy.api#documentation": "Specifies whether the output provides the locations (offsets) of PII entities or a file in\n which PII entities are redacted.
", "smithy.api#required": {} } }, "RedactionConfig": { "target": "com.amazonaws.comprehend#RedactionConfig", "traits": { "smithy.api#documentation": "Provides configuration parameters for PII entity redaction.
\nThis parameter is required if you set the Mode parameter to\n ONLY_REDACTION. In that case, you must provide a RedactionConfig\n definition that includes the PiiEntityTypes parameter.
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to your input data.
", "smithy.api#required": {} } }, "JobName": { "target": "com.amazonaws.comprehend#JobName", "traits": { "smithy.api#documentation": "The identifier of the job.
" } }, "LanguageCode": { "target": "com.amazonaws.comprehend#LanguageCode", "traits": { "smithy.api#documentation": "The language of the input documents.
", "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.comprehend#ClientRequestTokenString", "traits": { "smithy.api#documentation": "A unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.
", "smithy.api#idempotencyToken": {} } } } }, "com.amazonaws.comprehend#StartPiiEntitiesDetectionJobResponse": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "The identifier generated for the job.
" } }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { "smithy.api#documentation": "The status of the job.
" } } } }, "com.amazonaws.comprehend#StartSentimentDetectionJob": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#StartSentimentDetectionJobRequest" }, "output": { "target": "com.amazonaws.comprehend#StartSentimentDetectionJobResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#KmsKeyValidationException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Starts an asynchronous sentiment detection job for a collection of documents. use the\n operation to track the status of a\n job.
" } }, "com.amazonaws.comprehend#StartSentimentDetectionJobRequest": { "type": "structure", "members": { "InputDataConfig": { "target": "com.amazonaws.comprehend#InputDataConfig", "traits": { "smithy.api#documentation": "Specifies the format and location of the input data for the job.
", "smithy.api#required": {} } }, "OutputDataConfig": { "target": "com.amazonaws.comprehend#OutputDataConfig", "traits": { "smithy.api#documentation": "Specifies where to send the output files.
", "smithy.api#required": {} } }, "DataAccessRoleArn": { "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
", "smithy.api#required": {} } }, "JobName": { "target": "com.amazonaws.comprehend#JobName", "traits": { "smithy.api#documentation": "The identifier of the job.
" } }, "LanguageCode": { "target": "com.amazonaws.comprehend#LanguageCode", "traits": { "smithy.api#documentation": "The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. All documents must be in the same language.
", "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.comprehend#ClientRequestTokenString", "traits": { "smithy.api#documentation": "A unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.
", "smithy.api#idempotencyToken": {} } }, "VolumeKmsKeyId": { "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your sentiment detection job. For more information, see Amazon\n VPC.
" } } } }, "com.amazonaws.comprehend#StartSentimentDetectionJobResponse": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "The identifier generated for the job. To get the status of a job, use this identifier with\n the operation.
" } }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { "smithy.api#documentation": "The status of the job.
\nSUBMITTED - The job has been received and is queued for processing.
\nIN_PROGRESS - Amazon Comprehend is processing the job.
\nCOMPLETED - The job was successfully completed and the output is available.
\nFAILED - The job did not complete. To get details, use the operation.
\nStarts an asynchronous topic detection job. Use the\n DescribeTopicDetectionJob operation to track the status of a job.
Specifies the format and location of the input data for the job.
", "smithy.api#required": {} } }, "OutputDataConfig": { "target": "com.amazonaws.comprehend#OutputDataConfig", "traits": { "smithy.api#documentation": "Specifies where to send the output files. The output is a compressed archive with two\n files, topic-terms.csv that lists the terms associated with each topic, and\n doc-topics.csv that lists the documents associated with each topic
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role\n that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
", "smithy.api#required": {} } }, "JobName": { "target": "com.amazonaws.comprehend#JobName", "traits": { "smithy.api#documentation": "The identifier of the job.
" } }, "NumberOfTopics": { "target": "com.amazonaws.comprehend#NumberOfTopicsInteger", "traits": { "smithy.api#documentation": "The number of topics to detect.
" } }, "ClientRequestToken": { "target": "com.amazonaws.comprehend#ClientRequestTokenString", "traits": { "smithy.api#documentation": "A unique identifier for the request. If you do not set the client request token, Amazon\n Comprehend generates one.
", "smithy.api#idempotencyToken": {} } }, "VolumeKmsKeyId": { "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your topic detection job. For more information, see Amazon\n VPC.
" } } } }, "com.amazonaws.comprehend#StartTopicsDetectionJobResponse": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "The identifier generated for the job. To get the status of the job, use this identifier\n with the DescribeTopicDetectionJob operation.
The status of the job:
\nSUBMITTED - The job has been received and is queued for processing.
\nIN_PROGRESS - Amazon Comprehend is processing the job.
\nCOMPLETED - The job was successfully completed and the output is\n available.
\nFAILED - The job did not complete. To get details, use the\n DescribeTopicDetectionJob operation.
Stops a dominant language detection job in progress.
\nIf the job state is IN_PROGRESS the job is marked for termination and put\n into the STOP_REQUESTED state. If the job completes before it can be stopped, it\n is put into the COMPLETED state; otherwise the job is stopped and put into the\n STOPPED state.
If the job is in the COMPLETED or FAILED state when you call the\n StopDominantLanguageDetectionJob operation, the operation returns a 400\n Internal Request Exception.
When a job is stopped, any documents already processed are written to the output\n location.
" } }, "com.amazonaws.comprehend#StopDominantLanguageDetectionJobRequest": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "The identifier of the dominant language detection job to stop.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#StopDominantLanguageDetectionJobResponse": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "The identifier of the dominant language detection job to stop.
" } }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { "smithy.api#documentation": "Either STOP_REQUESTED if the job is currently running, or\n STOPPED if the job was previously stopped with the\n StopDominantLanguageDetectionJob operation.
Stops an entities detection job in progress.
\nIf the job state is IN_PROGRESS the job is marked for termination and put\n into the STOP_REQUESTED state. If the job completes before it can be stopped, it\n is put into the COMPLETED state; otherwise the job is stopped and put into the\n STOPPED state.
If the job is in the COMPLETED or FAILED state when you call the\n StopDominantLanguageDetectionJob operation, the operation returns a 400\n Internal Request Exception.
When a job is stopped, any documents already processed are written to the output\n location.
" } }, "com.amazonaws.comprehend#StopEntitiesDetectionJobRequest": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "The identifier of the entities detection job to stop.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#StopEntitiesDetectionJobResponse": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "The identifier of the entities detection job to stop.
" } }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { "smithy.api#documentation": "Either STOP_REQUESTED if the job is currently running, or\n STOPPED if the job was previously stopped with the\n StopEntitiesDetectionJob operation.
Stops an events detection job in progress.
" } }, "com.amazonaws.comprehend#StopEventsDetectionJobRequest": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "The identifier of the events detection job to stop.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#StopEventsDetectionJobResponse": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "The identifier of the events detection job to stop.
" } }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { "smithy.api#documentation": "The status of the events detection job.
" } } } }, "com.amazonaws.comprehend#StopKeyPhrasesDetectionJob": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#StopKeyPhrasesDetectionJobRequest" }, "output": { "target": "com.amazonaws.comprehend#StopKeyPhrasesDetectionJobResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#JobNotFoundException" } ], "traits": { "smithy.api#documentation": "Stops a key phrases detection job in progress.
\nIf the job state is IN_PROGRESS the job is marked for termination and put\n into the STOP_REQUESTED state. If the job completes before it can be stopped, it\n is put into the COMPLETED state; otherwise the job is stopped and put into the\n STOPPED state.
If the job is in the COMPLETED or FAILED state when you call the\n StopDominantLanguageDetectionJob operation, the operation returns a 400\n Internal Request Exception.
When a job is stopped, any documents already processed are written to the output\n location.
" } }, "com.amazonaws.comprehend#StopKeyPhrasesDetectionJobRequest": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "The identifier of the key phrases detection job to stop.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#StopKeyPhrasesDetectionJobResponse": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "The identifier of the key phrases detection job to stop.
" } }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { "smithy.api#documentation": "Either STOP_REQUESTED if the job is currently running, or\n STOPPED if the job was previously stopped with the\n StopKeyPhrasesDetectionJob operation.
Stops a PII entities detection job in progress.
" } }, "com.amazonaws.comprehend#StopPiiEntitiesDetectionJobRequest": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "The identifier of the PII entities detection job to stop.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#StopPiiEntitiesDetectionJobResponse": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "The identifier of the PII entities detection job to stop.
" } }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { "smithy.api#documentation": "The status of the PII entities detection job.
" } } } }, "com.amazonaws.comprehend#StopSentimentDetectionJob": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#StopSentimentDetectionJobRequest" }, "output": { "target": "com.amazonaws.comprehend#StopSentimentDetectionJobResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#JobNotFoundException" } ], "traits": { "smithy.api#documentation": "Stops a sentiment detection job in progress.
\nIf the job state is IN_PROGRESS the job is marked for termination and put\n into the STOP_REQUESTED state. If the job completes before it can be stopped, it\n is put into the COMPLETED state; otherwise the job is be stopped and put into the\n STOPPED state.
If the job is in the COMPLETED or FAILED state when you call the\n StopDominantLanguageDetectionJob operation, the operation returns a 400\n Internal Request Exception.
When a job is stopped, any documents already processed are written to the output\n location.
" } }, "com.amazonaws.comprehend#StopSentimentDetectionJobRequest": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "The identifier of the sentiment detection job to stop.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#StopSentimentDetectionJobResponse": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "The identifier of the sentiment detection job to stop.
" } }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { "smithy.api#documentation": "Either STOP_REQUESTED if the job is currently running, or\n STOPPED if the job was previously stopped with the\n StopSentimentDetectionJob operation.
Stops a document classifier training job while in progress.
\nIf the training job state is TRAINING, the job is marked for termination and\n put into the STOP_REQUESTED state. If the training job completes before it can be\n stopped, it is put into the TRAINED; otherwise the training job is stopped and\n put into the STOPPED state and the service sends back an HTTP 200 response with\n an empty HTTP body.
The Amazon Resource Name (ARN) that identifies the document classifier currently being\n trained.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#StopTrainingDocumentClassifierResponse": { "type": "structure", "members": {} }, "com.amazonaws.comprehend#StopTrainingEntityRecognizer": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#StopTrainingEntityRecognizerRequest" }, "output": { "target": "com.amazonaws.comprehend#StopTrainingEntityRecognizerResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#ResourceNotFoundException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Stops an entity recognizer training job while in progress.
\nIf the training job state is TRAINING, the job is marked for termination and\n put into the STOP_REQUESTED state. If the training job completes before it can be\n stopped, it is put into the TRAINED; otherwise the training job is stopped and\n putted into the STOPPED state and the service sends back an HTTP 200 response\n with an empty HTTP body.
The Amazon Resource Name (ARN) that identifies the entity recognizer currently being\n trained.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#StopTrainingEntityRecognizerResponse": { "type": "structure", "members": {} }, "com.amazonaws.comprehend#String": { "type": "string", "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.comprehend#SubnetId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 32 }, "smithy.api#pattern": "[-0-9a-zA-Z]+" } }, "com.amazonaws.comprehend#Subnets": { "type": "list", "member": { "target": "com.amazonaws.comprehend#SubnetId" }, "traits": { "smithy.api#length": { "min": 1, "max": 16 } } }, "com.amazonaws.comprehend#SyntaxLanguageCode": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "en", "name": "EN" }, { "value": "es", "name": "ES" }, { "value": "fr", "name": "FR" }, { "value": "de", "name": "DE" }, { "value": "it", "name": "IT" }, { "value": "pt", "name": "PT" } ] } }, "com.amazonaws.comprehend#SyntaxToken": { "type": "structure", "members": { "TokenId": { "target": "com.amazonaws.comprehend#Integer", "traits": { "smithy.api#documentation": "A unique identifier for a token.
" } }, "Text": { "target": "com.amazonaws.comprehend#String", "traits": { "smithy.api#documentation": "The word that was recognized in the source text.
" } }, "BeginOffset": { "target": "com.amazonaws.comprehend#Integer", "traits": { "smithy.api#documentation": "The zero-based offset from the beginning of the source text to the first character in the\n word.
" } }, "EndOffset": { "target": "com.amazonaws.comprehend#Integer", "traits": { "smithy.api#documentation": "The zero-based offset from the beginning of the source text to the last character in the\n word.
" } }, "PartOfSpeech": { "target": "com.amazonaws.comprehend#PartOfSpeechTag", "traits": { "smithy.api#documentation": "Provides the part of speech label and the confidence level that Amazon Comprehend has that\n the part of speech was correctly identified. For more information, see how-syntax.
" } } }, "traits": { "smithy.api#documentation": "Represents a work in the input text that was recognized and assigned a part of speech.\n There is one syntax token record for each word in the source text.
" } }, "com.amazonaws.comprehend#Tag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.comprehend#TagKey", "traits": { "smithy.api#documentation": "The initial part of a key-value pair that forms a tag associated with a given resource.\n For instance, if you want to show which resources are used by which departments, you might use\n “Department” as the key portion of the pair, with multiple possible values such as “sales,”\n “legal,” and “administration.”
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.comprehend#TagValue", "traits": { "smithy.api#documentation": "The second part of a key-value pair that forms a tag associated with a given resource.\n For instance, if you want to show which resources are used by which departments, you might use\n “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the\n sales department.
" } } }, "traits": { "smithy.api#documentation": "A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For\n example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to\n indicate its use by a particular department.
" } }, "com.amazonaws.comprehend#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.comprehend#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.comprehend#TagKey" } }, "com.amazonaws.comprehend#TagList": { "type": "list", "member": { "target": "com.amazonaws.comprehend#Tag" } }, "com.amazonaws.comprehend#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#TagResourceRequest" }, "output": { "target": "com.amazonaws.comprehend#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#ConcurrentModificationException" }, { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#ResourceNotFoundException" }, { "target": "com.amazonaws.comprehend#TooManyTagsException" } ], "traits": { "smithy.api#documentation": "Associates a specific tag with an Amazon Comprehend resource. A tag is a key-value pair\n that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with\n \"Sales\" as the key might be added to a resource to indicate its use by the sales department.\n
" } }, "com.amazonaws.comprehend#TagResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.comprehend#ComprehendArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the given Amazon Comprehend resource to which you want\n to associate the tags.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.comprehend#TagList", "traits": { "smithy.api#documentation": "Tags being associated with a specific Amazon Comprehend resource. There can be a maximum\n of 50 tags (both existing and pending) associated with a specific resource.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#TagResourceResponse": { "type": "structure", "members": {} }, "com.amazonaws.comprehend#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.comprehend#TargetEventTypes": { "type": "list", "member": { "target": "com.amazonaws.comprehend#EventTypeString" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.comprehend#TextSizeLimitExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.comprehend#String" } }, "traits": { "smithy.api#documentation": "The size of the input text exceeds the limit. Use a smaller document.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.comprehend#Timestamp": { "type": "timestamp" }, "com.amazonaws.comprehend#TooManyRequestsException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.comprehend#String" } }, "traits": { "smithy.api#documentation": "The number of requests exceeds the limit. Resubmit your request later.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.comprehend#TooManyTagKeysException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.comprehend#String" } }, "traits": { "smithy.api#documentation": "The request contains more tag keys than can be associated with a resource (50 tag keys per\n resource).
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.comprehend#TooManyTagsException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.comprehend#String" } }, "traits": { "smithy.api#documentation": "The request contains more tags than can be associated with a resource (50 tags per\n resource). The maximum number of tags includes both existing tags and those included in your\n current request.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.comprehend#TopicsDetectionJobFilter": { "type": "structure", "members": { "JobName": { "target": "com.amazonaws.comprehend#JobName", "traits": { "smithy.api#documentation": "" } }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { "smithy.api#documentation": "Filters the list of topic detection jobs based on job status. Returns only jobs with\n the specified status.
" } }, "SubmitTimeBefore": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "Filters the list of jobs based on the time that the job was submitted for processing.\n Only returns jobs submitted before the specified time. Jobs are returned in descending order,\n newest to oldest.
" } }, "SubmitTimeAfter": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "Filters the list of jobs based on the time that the job was submitted for processing.\n Only returns jobs submitted after the specified time. Jobs are returned in ascending order,\n oldest to newest.
" } } }, "traits": { "smithy.api#documentation": "Provides information for filtering topic detection jobs. For more information, see\n .
" } }, "com.amazonaws.comprehend#TopicsDetectionJobProperties": { "type": "structure", "members": { "JobId": { "target": "com.amazonaws.comprehend#JobId", "traits": { "smithy.api#documentation": "The identifier assigned to the topic detection job.
" } }, "JobName": { "target": "com.amazonaws.comprehend#JobName", "traits": { "smithy.api#documentation": "The name of the topic detection job.
" } }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { "smithy.api#documentation": "The current status of the topic detection job. If the status is Failed,\n the reason for the failure is shown in the Message field.
A description for the status of a job.
" } }, "SubmitTime": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "The time that the topic detection job was submitted for processing.
" } }, "EndTime": { "target": "com.amazonaws.comprehend#Timestamp", "traits": { "smithy.api#documentation": "The time that the topic detection job was completed.
" } }, "InputDataConfig": { "target": "com.amazonaws.comprehend#InputDataConfig", "traits": { "smithy.api#documentation": "The input data configuration supplied when you created the topic detection\n job.
" } }, "OutputDataConfig": { "target": "com.amazonaws.comprehend#OutputDataConfig", "traits": { "smithy.api#documentation": "The output data configuration supplied when you created the topic detection\n job.
" } }, "NumberOfTopics": { "target": "com.amazonaws.comprehend#Integer", "traits": { "smithy.api#documentation": "The number of topics to detect supplied when you created the topic detection job. The\n default is 10.
" } }, "DataAccessRoleArn": { "target": "com.amazonaws.comprehend#IamRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants\n Amazon Comprehend read access to your job data.
" } }, "VolumeKmsKeyId": { "target": "com.amazonaws.comprehend#KmsKeyId", "traits": { "smithy.api#documentation": "ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt\n data on the storage volume attached to the ML compute instance(s) that process the analysis\n job. The VolumeKmsKeyId can be either of the following formats:
\nKMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Amazon Resource Name (ARN) of a KMS Key:\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
Configuration parameters for a private Virtual Private Cloud (VPC) containing the\n resources you are using for your topic detection job. For more information, see Amazon\n VPC.
" } } }, "traits": { "smithy.api#documentation": "Provides information about a topic detection job.
" } }, "com.amazonaws.comprehend#TopicsDetectionJobPropertiesList": { "type": "list", "member": { "target": "com.amazonaws.comprehend#TopicsDetectionJobProperties" } }, "com.amazonaws.comprehend#UnsupportedLanguageException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.comprehend#String" } }, "traits": { "smithy.api#documentation": "Amazon Comprehend can't process the language of the input text. For custom entity\n recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.\n For a list of supported languages, see supported-languages.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.comprehend#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#UntagResourceRequest" }, "output": { "target": "com.amazonaws.comprehend#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#ConcurrentModificationException" }, { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#ResourceNotFoundException" }, { "target": "com.amazonaws.comprehend#TooManyTagKeysException" } ], "traits": { "smithy.api#documentation": "Removes a specific tag associated with an Amazon Comprehend resource.
" } }, "com.amazonaws.comprehend#UntagResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.comprehend#ComprehendArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the given Amazon Comprehend resource from which you\n want to remove the tags.
", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.comprehend#TagKeyList", "traits": { "smithy.api#documentation": "The initial part of a key-value pair that forms a tag being removed from a given resource.\n For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by\n the sales department. Keys must be unique and cannot be duplicated for a particular resource.\n
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#UntagResourceResponse": { "type": "structure", "members": {} }, "com.amazonaws.comprehend#UpdateEndpoint": { "type": "operation", "input": { "target": "com.amazonaws.comprehend#UpdateEndpointRequest" }, "output": { "target": "com.amazonaws.comprehend#UpdateEndpointResponse" }, "errors": [ { "target": "com.amazonaws.comprehend#InternalServerException" }, { "target": "com.amazonaws.comprehend#InvalidRequestException" }, { "target": "com.amazonaws.comprehend#ResourceInUseException" }, { "target": "com.amazonaws.comprehend#ResourceLimitExceededException" }, { "target": "com.amazonaws.comprehend#ResourceNotFoundException" }, { "target": "com.amazonaws.comprehend#ResourceUnavailableException" }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Updates information about the specified endpoint.
" } }, "com.amazonaws.comprehend#UpdateEndpointRequest": { "type": "structure", "members": { "EndpointArn": { "target": "com.amazonaws.comprehend#ComprehendEndpointArn", "traits": { "smithy.api#documentation": "The Amazon Resource Number (ARN) of the endpoint being updated.
", "smithy.api#required": {} } }, "DesiredInferenceUnits": { "target": "com.amazonaws.comprehend#InferenceUnitsInteger", "traits": { "smithy.api#documentation": "The desired number of inference units to be used by the model using this endpoint.\n \n Each inference unit represents of a throughput of 100 characters per second.
", "smithy.api#required": {} } } } }, "com.amazonaws.comprehend#UpdateEndpointResponse": { "type": "structure", "members": {} }, "com.amazonaws.comprehend#VpcConfig": { "type": "structure", "members": { "SecurityGroupIds": { "target": "com.amazonaws.comprehend#SecurityGroupIds", "traits": { "smithy.api#documentation": "The ID number for a security group on an instance of your private VPC. Security groups on\n your VPC function serve as a virtual firewall to control inbound and outbound traffic and\n provides security for the resources that you’ll be accessing on the VPC. This ID number is\n preceded by \"sg-\", for instance: \"sg-03b388029b0a285ea\". For more information, see Security\n Groups for your VPC.
", "smithy.api#required": {} } }, "Subnets": { "target": "com.amazonaws.comprehend#Subnets", "traits": { "smithy.api#documentation": "The ID for each subnet being used in your private VPC. This subnet is a subset of the a\n range of IPv4 addresses used by the VPC and is specific to a given availability zone in the\n VPC’s region. This ID number is preceded by \"subnet-\", for instance:\n \"subnet-04ccf456919e69055\". For more information, see VPCs and\n Subnets.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for the job. For more information, see Amazon\n VPC.
" } } } }