-- Hoogle documentation, generated by Haddock -- See Hoogle, http://www.haskell.org/hoogle/ -- | Amazon Comprehend SDK. -- -- Derived from API version 2017-11-27 of the AWS service -- descriptions, licensed under Apache 2.0. -- -- The types from this library are intended to be used with -- amazonka, which provides mechanisms for specifying AuthN/AuthZ -- information, sending requests, and receiving responses. -- -- It is recommended to use generic lenses or optics from packages such -- as generic-lens or optics to modify optional fields and -- deconstruct responses. -- -- Generated lenses can be found in Amazonka.Comprehend.Lens and -- are suitable for use with a lens package such as lens or -- lens-family-core. -- -- See Amazonka.Comprehend and the AWS documentation to get -- started. @package amazonka-comprehend @version 2.0 module Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat newtype AugmentedManifestsDocumentTypeFormat AugmentedManifestsDocumentTypeFormat' :: Text -> AugmentedManifestsDocumentTypeFormat [fromAugmentedManifestsDocumentTypeFormat] :: AugmentedManifestsDocumentTypeFormat -> Text pattern AugmentedManifestsDocumentTypeFormat_PLAIN_TEXT_DOCUMENT :: AugmentedManifestsDocumentTypeFormat pattern AugmentedManifestsDocumentTypeFormat_SEMI_STRUCTURED_DOCUMENT :: AugmentedManifestsDocumentTypeFormat instance Amazonka.Data.XML.ToXML Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat.AugmentedManifestsDocumentTypeFormat instance Amazonka.Data.XML.FromXML Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat.AugmentedManifestsDocumentTypeFormat instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat.AugmentedManifestsDocumentTypeFormat instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat.AugmentedManifestsDocumentTypeFormat instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat.AugmentedManifestsDocumentTypeFormat instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat.AugmentedManifestsDocumentTypeFormat instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat.AugmentedManifestsDocumentTypeFormat instance Amazonka.Data.Headers.ToHeader Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat.AugmentedManifestsDocumentTypeFormat instance Amazonka.Data.Log.ToLog Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat.AugmentedManifestsDocumentTypeFormat instance Amazonka.Data.ByteString.ToByteString Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat.AugmentedManifestsDocumentTypeFormat instance Amazonka.Data.Text.ToText Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat.AugmentedManifestsDocumentTypeFormat instance Amazonka.Data.Text.FromText Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat.AugmentedManifestsDocumentTypeFormat instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat.AugmentedManifestsDocumentTypeFormat instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat.AugmentedManifestsDocumentTypeFormat instance GHC.Generics.Generic Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat.AugmentedManifestsDocumentTypeFormat instance GHC.Classes.Ord Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat.AugmentedManifestsDocumentTypeFormat instance GHC.Classes.Eq Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat.AugmentedManifestsDocumentTypeFormat instance GHC.Read.Read Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat.AugmentedManifestsDocumentTypeFormat instance GHC.Show.Show Amazonka.Comprehend.Types.AugmentedManifestsDocumentTypeFormat.AugmentedManifestsDocumentTypeFormat module Amazonka.Comprehend.Types.BatchItemError -- | Describes an error that occurred while processing a document in a -- batch. The operation returns on BatchItemError object for -- each document that contained an error. -- -- See: newBatchItemError smart constructor. data BatchItemError BatchItemError' :: Maybe Text -> Maybe Text -> Maybe Int -> BatchItemError -- | The numeric error code of the error. [$sel:errorCode:BatchItemError'] :: BatchItemError -> Maybe Text -- | A text description of the error. [$sel:errorMessage:BatchItemError'] :: BatchItemError -> Maybe Text -- | The zero-based index of the document in the input list. [$sel:index:BatchItemError'] :: BatchItemError -> Maybe Int -- | Create a value of BatchItemError with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:errorCode:BatchItemError', batchItemError_errorCode -- - The numeric error code of the error. -- -- $sel:errorMessage:BatchItemError', -- batchItemError_errorMessage - A text description of the error. -- -- $sel:index:BatchItemError', batchItemError_index - The -- zero-based index of the document in the input list. newBatchItemError :: BatchItemError -- | The numeric error code of the error. batchItemError_errorCode :: Lens' BatchItemError (Maybe Text) -- | A text description of the error. batchItemError_errorMessage :: Lens' BatchItemError (Maybe Text) -- | The zero-based index of the document in the input list. batchItemError_index :: Lens' BatchItemError (Maybe Int) instance GHC.Generics.Generic Amazonka.Comprehend.Types.BatchItemError.BatchItemError instance GHC.Show.Show Amazonka.Comprehend.Types.BatchItemError.BatchItemError instance GHC.Read.Read Amazonka.Comprehend.Types.BatchItemError.BatchItemError instance GHC.Classes.Eq Amazonka.Comprehend.Types.BatchItemError.BatchItemError instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.BatchItemError.BatchItemError instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.BatchItemError.BatchItemError instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.BatchItemError.BatchItemError module Amazonka.Comprehend.Types.BlockType newtype BlockType BlockType' :: Text -> BlockType [fromBlockType] :: BlockType -> Text pattern BlockType_LINE :: BlockType pattern BlockType_WORD :: BlockType instance Amazonka.Data.XML.ToXML Amazonka.Comprehend.Types.BlockType.BlockType instance Amazonka.Data.XML.FromXML Amazonka.Comprehend.Types.BlockType.BlockType instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.Comprehend.Types.BlockType.BlockType instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.BlockType.BlockType instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.Comprehend.Types.BlockType.BlockType instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.BlockType.BlockType instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.Types.BlockType.BlockType instance Amazonka.Data.Headers.ToHeader Amazonka.Comprehend.Types.BlockType.BlockType instance Amazonka.Data.Log.ToLog Amazonka.Comprehend.Types.BlockType.BlockType instance Amazonka.Data.ByteString.ToByteString Amazonka.Comprehend.Types.BlockType.BlockType instance Amazonka.Data.Text.ToText Amazonka.Comprehend.Types.BlockType.BlockType instance Amazonka.Data.Text.FromText Amazonka.Comprehend.Types.BlockType.BlockType instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.BlockType.BlockType instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.BlockType.BlockType instance GHC.Generics.Generic Amazonka.Comprehend.Types.BlockType.BlockType instance GHC.Classes.Ord Amazonka.Comprehend.Types.BlockType.BlockType instance GHC.Classes.Eq Amazonka.Comprehend.Types.BlockType.BlockType instance GHC.Read.Read Amazonka.Comprehend.Types.BlockType.BlockType instance GHC.Show.Show Amazonka.Comprehend.Types.BlockType.BlockType module Amazonka.Comprehend.Types.BoundingBox -- | The bounding box around the detected page or around an element on a -- document page. The left (x-coordinate) and top (y-coordinate) are -- coordinates that represent the top and left sides of the bounding box. -- Note that the upper-left corner of the image is the origin (0,0). -- -- For additional information, see BoundingBox in the Amazon -- Textract API reference. -- -- See: newBoundingBox smart constructor. data BoundingBox BoundingBox' :: Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> BoundingBox -- | The height of the bounding box as a ratio of the overall document page -- height. [$sel:height:BoundingBox'] :: BoundingBox -> Maybe Double -- | The left coordinate of the bounding box as a ratio of overall document -- page width. [$sel:left:BoundingBox'] :: BoundingBox -> Maybe Double -- | The top coordinate of the bounding box as a ratio of overall document -- page height. [$sel:top:BoundingBox'] :: BoundingBox -> Maybe Double -- | The width of the bounding box as a ratio of the overall document page -- width. [$sel:width:BoundingBox'] :: BoundingBox -> Maybe Double -- | Create a value of BoundingBox with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:height:BoundingBox', boundingBox_height - The -- height of the bounding box as a ratio of the overall document page -- height. -- -- $sel:left:BoundingBox', boundingBox_left - The left -- coordinate of the bounding box as a ratio of overall document page -- width. -- -- $sel:top:BoundingBox', boundingBox_top - The top -- coordinate of the bounding box as a ratio of overall document page -- height. -- -- $sel:width:BoundingBox', boundingBox_width - The width -- of the bounding box as a ratio of the overall document page width. newBoundingBox :: BoundingBox -- | The height of the bounding box as a ratio of the overall document page -- height. boundingBox_height :: Lens' BoundingBox (Maybe Double) -- | The left coordinate of the bounding box as a ratio of overall document -- page width. boundingBox_left :: Lens' BoundingBox (Maybe Double) -- | The top coordinate of the bounding box as a ratio of overall document -- page height. boundingBox_top :: Lens' BoundingBox (Maybe Double) -- | The width of the bounding box as a ratio of the overall document page -- width. boundingBox_width :: Lens' BoundingBox (Maybe Double) instance GHC.Generics.Generic Amazonka.Comprehend.Types.BoundingBox.BoundingBox instance GHC.Show.Show Amazonka.Comprehend.Types.BoundingBox.BoundingBox instance GHC.Read.Read Amazonka.Comprehend.Types.BoundingBox.BoundingBox instance GHC.Classes.Eq Amazonka.Comprehend.Types.BoundingBox.BoundingBox instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.BoundingBox.BoundingBox instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.BoundingBox.BoundingBox instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.BoundingBox.BoundingBox module Amazonka.Comprehend.Types.ChildBlock -- | Nested block contained within a block. -- -- See: newChildBlock smart constructor. data ChildBlock ChildBlock' :: Maybe Int -> Maybe Text -> Maybe Int -> ChildBlock -- | Offset of the start of the child block within its parent block. [$sel:beginOffset:ChildBlock'] :: ChildBlock -> Maybe Int -- | Unique identifier for the child block. [$sel:childBlockId:ChildBlock'] :: ChildBlock -> Maybe Text -- | Offset of the end of the child block within its parent block. [$sel:endOffset:ChildBlock'] :: ChildBlock -> Maybe Int -- | Create a value of ChildBlock with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:beginOffset:ChildBlock', childBlock_beginOffset - -- Offset of the start of the child block within its parent block. -- -- $sel:childBlockId:ChildBlock', childBlock_childBlockId - -- Unique identifier for the child block. -- -- $sel:endOffset:ChildBlock', childBlock_endOffset - -- Offset of the end of the child block within its parent block. newChildBlock :: ChildBlock -- | Offset of the start of the child block within its parent block. childBlock_beginOffset :: Lens' ChildBlock (Maybe Int) -- | Unique identifier for the child block. childBlock_childBlockId :: Lens' ChildBlock (Maybe Text) -- | Offset of the end of the child block within its parent block. childBlock_endOffset :: Lens' ChildBlock (Maybe Int) instance GHC.Generics.Generic Amazonka.Comprehend.Types.ChildBlock.ChildBlock instance GHC.Show.Show Amazonka.Comprehend.Types.ChildBlock.ChildBlock instance GHC.Read.Read Amazonka.Comprehend.Types.ChildBlock.ChildBlock instance GHC.Classes.Eq Amazonka.Comprehend.Types.ChildBlock.ChildBlock instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.ChildBlock.ChildBlock instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.ChildBlock.ChildBlock instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.ChildBlock.ChildBlock module Amazonka.Comprehend.Types.BlockReference -- | A reference to a block. -- -- See: newBlockReference smart constructor. data BlockReference BlockReference' :: Maybe Int -> Maybe Text -> Maybe [ChildBlock] -> Maybe Int -> BlockReference -- | Offset of the start of the block within its parent block. [$sel:beginOffset:BlockReference'] :: BlockReference -> Maybe Int -- | Unique identifier for the block. [$sel:blockId:BlockReference'] :: BlockReference -> Maybe Text -- | List of child blocks within this block. [$sel:childBlocks:BlockReference'] :: BlockReference -> Maybe [ChildBlock] -- | Offset of the end of the block within its parent block. [$sel:endOffset:BlockReference'] :: BlockReference -> Maybe Int -- | Create a value of BlockReference with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- BlockReference, blockReference_beginOffset - Offset of -- the start of the block within its parent block. -- -- $sel:blockId:BlockReference', blockReference_blockId - -- Unique identifier for the block. -- -- $sel:childBlocks:BlockReference', -- blockReference_childBlocks - List of child blocks within this -- block. -- -- BlockReference, blockReference_endOffset - Offset of the -- end of the block within its parent block. newBlockReference :: BlockReference -- | Offset of the start of the block within its parent block. blockReference_beginOffset :: Lens' BlockReference (Maybe Int) -- | Unique identifier for the block. blockReference_blockId :: Lens' BlockReference (Maybe Text) -- | List of child blocks within this block. blockReference_childBlocks :: Lens' BlockReference (Maybe [ChildBlock]) -- | Offset of the end of the block within its parent block. blockReference_endOffset :: Lens' BlockReference (Maybe Int) instance GHC.Generics.Generic Amazonka.Comprehend.Types.BlockReference.BlockReference instance GHC.Show.Show Amazonka.Comprehend.Types.BlockReference.BlockReference instance GHC.Read.Read Amazonka.Comprehend.Types.BlockReference.BlockReference instance GHC.Classes.Eq Amazonka.Comprehend.Types.BlockReference.BlockReference instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.BlockReference.BlockReference instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.BlockReference.BlockReference instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.BlockReference.BlockReference module Amazonka.Comprehend.Types.ClassifierEvaluationMetrics -- | Describes the result metrics for the test data associated with an -- documentation classifier. -- -- See: newClassifierEvaluationMetrics smart constructor. data ClassifierEvaluationMetrics ClassifierEvaluationMetrics' :: Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> ClassifierEvaluationMetrics -- | The fraction of the labels that were correct recognized. It is -- computed by dividing the number of labels in the test documents that -- were correctly recognized by the total number of labels in the test -- documents. [$sel:accuracy:ClassifierEvaluationMetrics'] :: ClassifierEvaluationMetrics -> Maybe Double -- | A measure of how accurate the classifier results are for the test -- data. It is derived from the Precision and Recall -- values. The F1Score is the harmonic average of the two -- scores. The highest score is 1, and the worst score is 0. [$sel:f1Score:ClassifierEvaluationMetrics'] :: ClassifierEvaluationMetrics -> Maybe Double -- | Indicates the fraction of labels that are incorrectly predicted. Also -- seen as the fraction of wrong labels compared to the total number of -- labels. Scores closer to zero are better. [$sel:hammingLoss:ClassifierEvaluationMetrics'] :: ClassifierEvaluationMetrics -> Maybe Double -- | A measure of how accurate the classifier results are for the test -- data. It is a combination of the Micro Precision and -- Micro Recall values. The Micro F1Score is the -- harmonic mean of the two scores. The highest score is 1, and the worst -- score is 0. [$sel:microF1Score:ClassifierEvaluationMetrics'] :: ClassifierEvaluationMetrics -> Maybe Double -- | A measure of the usefulness of the recognizer results in the test -- data. High precision means that the recognizer returned substantially -- more relevant results than irrelevant ones. Unlike the Precision -- metric which comes from averaging the precision of all available -- labels, this is based on the overall score of all precision scores -- added together. [$sel:microPrecision:ClassifierEvaluationMetrics'] :: ClassifierEvaluationMetrics -> Maybe Double -- | A measure of how complete the classifier results are for the test -- data. High recall means that the classifier returned most of the -- relevant results. Specifically, this indicates how many of the correct -- categories in the text that the model can predict. It is a percentage -- of correct categories in the text that can found. Instead of averaging -- the recall scores of all labels (as with Recall), micro Recall is -- based on the overall score of all recall scores added together. [$sel:microRecall:ClassifierEvaluationMetrics'] :: ClassifierEvaluationMetrics -> Maybe Double -- | A measure of the usefulness of the classifier results in the test -- data. High precision means that the classifier returned substantially -- more relevant results than irrelevant ones. [$sel:precision:ClassifierEvaluationMetrics'] :: ClassifierEvaluationMetrics -> Maybe Double -- | A measure of how complete the classifier results are for the test -- data. High recall means that the classifier returned most of the -- relevant results. [$sel:recall:ClassifierEvaluationMetrics'] :: ClassifierEvaluationMetrics -> Maybe Double -- | Create a value of ClassifierEvaluationMetrics with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:accuracy:ClassifierEvaluationMetrics', -- classifierEvaluationMetrics_accuracy - The fraction of the -- labels that were correct recognized. It is computed by dividing the -- number of labels in the test documents that were correctly recognized -- by the total number of labels in the test documents. -- -- $sel:f1Score:ClassifierEvaluationMetrics', -- classifierEvaluationMetrics_f1Score - A measure of how accurate -- the classifier results are for the test data. It is derived from the -- Precision and Recall values. The F1Score is -- the harmonic average of the two scores. The highest score is 1, and -- the worst score is 0. -- -- $sel:hammingLoss:ClassifierEvaluationMetrics', -- classifierEvaluationMetrics_hammingLoss - Indicates the -- fraction of labels that are incorrectly predicted. Also seen as the -- fraction of wrong labels compared to the total number of labels. -- Scores closer to zero are better. -- -- $sel:microF1Score:ClassifierEvaluationMetrics', -- classifierEvaluationMetrics_microF1Score - A measure of how -- accurate the classifier results are for the test data. It is a -- combination of the Micro Precision and Micro Recall -- values. The Micro F1Score is the harmonic mean of the two -- scores. The highest score is 1, and the worst score is 0. -- -- $sel:microPrecision:ClassifierEvaluationMetrics', -- classifierEvaluationMetrics_microPrecision - A measure of the -- usefulness of the recognizer results in the test data. High precision -- means that the recognizer returned substantially more relevant results -- than irrelevant ones. Unlike the Precision metric which comes from -- averaging the precision of all available labels, this is based on the -- overall score of all precision scores added together. -- -- $sel:microRecall:ClassifierEvaluationMetrics', -- classifierEvaluationMetrics_microRecall - A measure of how -- complete the classifier results are for the test data. High recall -- means that the classifier returned most of the relevant results. -- Specifically, this indicates how many of the correct categories in the -- text that the model can predict. It is a percentage of correct -- categories in the text that can found. Instead of averaging the recall -- scores of all labels (as with Recall), micro Recall is based on the -- overall score of all recall scores added together. -- -- $sel:precision:ClassifierEvaluationMetrics', -- classifierEvaluationMetrics_precision - A measure of the -- usefulness of the classifier results in the test data. High precision -- means that the classifier returned substantially more relevant results -- than irrelevant ones. -- -- $sel:recall:ClassifierEvaluationMetrics', -- classifierEvaluationMetrics_recall - A measure of how complete -- the classifier results are for the test data. High recall means that -- the classifier returned most of the relevant results. newClassifierEvaluationMetrics :: ClassifierEvaluationMetrics -- | The fraction of the labels that were correct recognized. It is -- computed by dividing the number of labels in the test documents that -- were correctly recognized by the total number of labels in the test -- documents. classifierEvaluationMetrics_accuracy :: Lens' ClassifierEvaluationMetrics (Maybe Double) -- | A measure of how accurate the classifier results are for the test -- data. It is derived from the Precision and Recall -- values. The F1Score is the harmonic average of the two -- scores. The highest score is 1, and the worst score is 0. classifierEvaluationMetrics_f1Score :: Lens' ClassifierEvaluationMetrics (Maybe Double) -- | Indicates the fraction of labels that are incorrectly predicted. Also -- seen as the fraction of wrong labels compared to the total number of -- labels. Scores closer to zero are better. classifierEvaluationMetrics_hammingLoss :: Lens' ClassifierEvaluationMetrics (Maybe Double) -- | A measure of how accurate the classifier results are for the test -- data. It is a combination of the Micro Precision and -- Micro Recall values. The Micro F1Score is the -- harmonic mean of the two scores. The highest score is 1, and the worst -- score is 0. classifierEvaluationMetrics_microF1Score :: Lens' ClassifierEvaluationMetrics (Maybe Double) -- | A measure of the usefulness of the recognizer results in the test -- data. High precision means that the recognizer returned substantially -- more relevant results than irrelevant ones. Unlike the Precision -- metric which comes from averaging the precision of all available -- labels, this is based on the overall score of all precision scores -- added together. classifierEvaluationMetrics_microPrecision :: Lens' ClassifierEvaluationMetrics (Maybe Double) -- | A measure of how complete the classifier results are for the test -- data. High recall means that the classifier returned most of the -- relevant results. Specifically, this indicates how many of the correct -- categories in the text that the model can predict. It is a percentage -- of correct categories in the text that can found. Instead of averaging -- the recall scores of all labels (as with Recall), micro Recall is -- based on the overall score of all recall scores added together. classifierEvaluationMetrics_microRecall :: Lens' ClassifierEvaluationMetrics (Maybe Double) -- | A measure of the usefulness of the classifier results in the test -- data. High precision means that the classifier returned substantially -- more relevant results than irrelevant ones. classifierEvaluationMetrics_precision :: Lens' ClassifierEvaluationMetrics (Maybe Double) -- | A measure of how complete the classifier results are for the test -- data. High recall means that the classifier returned most of the -- relevant results. classifierEvaluationMetrics_recall :: Lens' ClassifierEvaluationMetrics (Maybe Double) instance GHC.Generics.Generic Amazonka.Comprehend.Types.ClassifierEvaluationMetrics.ClassifierEvaluationMetrics instance GHC.Show.Show Amazonka.Comprehend.Types.ClassifierEvaluationMetrics.ClassifierEvaluationMetrics instance GHC.Read.Read Amazonka.Comprehend.Types.ClassifierEvaluationMetrics.ClassifierEvaluationMetrics instance GHC.Classes.Eq Amazonka.Comprehend.Types.ClassifierEvaluationMetrics.ClassifierEvaluationMetrics instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.ClassifierEvaluationMetrics.ClassifierEvaluationMetrics instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.ClassifierEvaluationMetrics.ClassifierEvaluationMetrics instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.ClassifierEvaluationMetrics.ClassifierEvaluationMetrics module Amazonka.Comprehend.Types.ClassifierMetadata -- | Provides information about a document classifier. -- -- See: newClassifierMetadata smart constructor. data ClassifierMetadata ClassifierMetadata' :: Maybe ClassifierEvaluationMetrics -> Maybe Int -> Maybe Int -> Maybe Int -> ClassifierMetadata -- | Describes the result metrics for the test data associated with an -- documentation classifier. [$sel:evaluationMetrics:ClassifierMetadata'] :: ClassifierMetadata -> Maybe ClassifierEvaluationMetrics -- | The number of labels in the input data. [$sel:numberOfLabels:ClassifierMetadata'] :: ClassifierMetadata -> Maybe Int -- | The number of documents in the input data that were used to test the -- classifier. Typically this is 10 to 20 percent of the input documents, -- up to 10,000 documents. [$sel:numberOfTestDocuments:ClassifierMetadata'] :: ClassifierMetadata -> Maybe Int -- | The number of documents in the input data that were used to train the -- classifier. Typically this is 80 to 90 percent of the input documents. [$sel:numberOfTrainedDocuments:ClassifierMetadata'] :: ClassifierMetadata -> Maybe Int -- | Create a value of ClassifierMetadata with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:evaluationMetrics:ClassifierMetadata', -- classifierMetadata_evaluationMetrics - Describes the result -- metrics for the test data associated with an documentation classifier. -- -- $sel:numberOfLabels:ClassifierMetadata', -- classifierMetadata_numberOfLabels - The number of labels in the -- input data. -- -- $sel:numberOfTestDocuments:ClassifierMetadata', -- classifierMetadata_numberOfTestDocuments - The number of -- documents in the input data that were used to test the classifier. -- Typically this is 10 to 20 percent of the input documents, up to -- 10,000 documents. -- -- $sel:numberOfTrainedDocuments:ClassifierMetadata', -- classifierMetadata_numberOfTrainedDocuments - The number of -- documents in the input data that were used to train the classifier. -- Typically this is 80 to 90 percent of the input documents. newClassifierMetadata :: ClassifierMetadata -- | Describes the result metrics for the test data associated with an -- documentation classifier. classifierMetadata_evaluationMetrics :: Lens' ClassifierMetadata (Maybe ClassifierEvaluationMetrics) -- | The number of labels in the input data. classifierMetadata_numberOfLabels :: Lens' ClassifierMetadata (Maybe Int) -- | The number of documents in the input data that were used to test the -- classifier. Typically this is 10 to 20 percent of the input documents, -- up to 10,000 documents. classifierMetadata_numberOfTestDocuments :: Lens' ClassifierMetadata (Maybe Int) -- | The number of documents in the input data that were used to train the -- classifier. Typically this is 80 to 90 percent of the input documents. classifierMetadata_numberOfTrainedDocuments :: Lens' ClassifierMetadata (Maybe Int) instance GHC.Generics.Generic Amazonka.Comprehend.Types.ClassifierMetadata.ClassifierMetadata instance GHC.Show.Show Amazonka.Comprehend.Types.ClassifierMetadata.ClassifierMetadata instance GHC.Classes.Eq Amazonka.Comprehend.Types.ClassifierMetadata.ClassifierMetadata instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.ClassifierMetadata.ClassifierMetadata instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.ClassifierMetadata.ClassifierMetadata instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.ClassifierMetadata.ClassifierMetadata module Amazonka.Comprehend.Types.DocumentClass -- | Specifies the class that categorizes the document being analyzed -- -- See: newDocumentClass smart constructor. data DocumentClass DocumentClass' :: Maybe Text -> Maybe Int -> Maybe Double -> DocumentClass -- | The name of the class. [$sel:name:DocumentClass'] :: DocumentClass -> Maybe Text -- | Page number in the input document. This field is present in the -- response only if your request includes the Byte parameter. [$sel:page:DocumentClass'] :: DocumentClass -> Maybe Int -- | The confidence score that Amazon Comprehend has this class correctly -- attributed. [$sel:score:DocumentClass'] :: DocumentClass -> Maybe Double -- | Create a value of DocumentClass with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:name:DocumentClass', documentClass_name - The name -- of the class. -- -- $sel:page:DocumentClass', documentClass_page - Page -- number in the input document. This field is present in the response -- only if your request includes the Byte parameter. -- -- $sel:score:DocumentClass', documentClass_score - The -- confidence score that Amazon Comprehend has this class correctly -- attributed. newDocumentClass :: DocumentClass -- | The name of the class. documentClass_name :: Lens' DocumentClass (Maybe Text) -- | Page number in the input document. This field is present in the -- response only if your request includes the Byte parameter. documentClass_page :: Lens' DocumentClass (Maybe Int) -- | The confidence score that Amazon Comprehend has this class correctly -- attributed. documentClass_score :: Lens' DocumentClass (Maybe Double) instance GHC.Generics.Generic Amazonka.Comprehend.Types.DocumentClass.DocumentClass instance GHC.Show.Show Amazonka.Comprehend.Types.DocumentClass.DocumentClass instance GHC.Read.Read Amazonka.Comprehend.Types.DocumentClass.DocumentClass instance GHC.Classes.Eq Amazonka.Comprehend.Types.DocumentClass.DocumentClass instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.DocumentClass.DocumentClass instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.DocumentClass.DocumentClass instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.DocumentClass.DocumentClass module Amazonka.Comprehend.Types.DocumentClassifierDataFormat newtype DocumentClassifierDataFormat DocumentClassifierDataFormat' :: Text -> DocumentClassifierDataFormat [fromDocumentClassifierDataFormat] :: DocumentClassifierDataFormat -> Text pattern DocumentClassifierDataFormat_AUGMENTED_MANIFEST :: DocumentClassifierDataFormat pattern DocumentClassifierDataFormat_COMPREHEND_CSV :: DocumentClassifierDataFormat instance Amazonka.Data.XML.ToXML Amazonka.Comprehend.Types.DocumentClassifierDataFormat.DocumentClassifierDataFormat instance Amazonka.Data.XML.FromXML Amazonka.Comprehend.Types.DocumentClassifierDataFormat.DocumentClassifierDataFormat instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.Comprehend.Types.DocumentClassifierDataFormat.DocumentClassifierDataFormat instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.DocumentClassifierDataFormat.DocumentClassifierDataFormat instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.Comprehend.Types.DocumentClassifierDataFormat.DocumentClassifierDataFormat instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.DocumentClassifierDataFormat.DocumentClassifierDataFormat instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.Types.DocumentClassifierDataFormat.DocumentClassifierDataFormat instance Amazonka.Data.Headers.ToHeader Amazonka.Comprehend.Types.DocumentClassifierDataFormat.DocumentClassifierDataFormat instance Amazonka.Data.Log.ToLog Amazonka.Comprehend.Types.DocumentClassifierDataFormat.DocumentClassifierDataFormat instance Amazonka.Data.ByteString.ToByteString Amazonka.Comprehend.Types.DocumentClassifierDataFormat.DocumentClassifierDataFormat instance Amazonka.Data.Text.ToText Amazonka.Comprehend.Types.DocumentClassifierDataFormat.DocumentClassifierDataFormat instance Amazonka.Data.Text.FromText Amazonka.Comprehend.Types.DocumentClassifierDataFormat.DocumentClassifierDataFormat instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.DocumentClassifierDataFormat.DocumentClassifierDataFormat instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.DocumentClassifierDataFormat.DocumentClassifierDataFormat instance GHC.Generics.Generic Amazonka.Comprehend.Types.DocumentClassifierDataFormat.DocumentClassifierDataFormat instance GHC.Classes.Ord Amazonka.Comprehend.Types.DocumentClassifierDataFormat.DocumentClassifierDataFormat instance GHC.Classes.Eq Amazonka.Comprehend.Types.DocumentClassifierDataFormat.DocumentClassifierDataFormat instance GHC.Read.Read Amazonka.Comprehend.Types.DocumentClassifierDataFormat.DocumentClassifierDataFormat instance GHC.Show.Show Amazonka.Comprehend.Types.DocumentClassifierDataFormat.DocumentClassifierDataFormat module Amazonka.Comprehend.Types.DocumentClassifierMode newtype DocumentClassifierMode DocumentClassifierMode' :: Text -> DocumentClassifierMode [fromDocumentClassifierMode] :: DocumentClassifierMode -> Text pattern DocumentClassifierMode_MULTI_CLASS :: DocumentClassifierMode pattern DocumentClassifierMode_MULTI_LABEL :: DocumentClassifierMode instance Amazonka.Data.XML.ToXML Amazonka.Comprehend.Types.DocumentClassifierMode.DocumentClassifierMode instance Amazonka.Data.XML.FromXML Amazonka.Comprehend.Types.DocumentClassifierMode.DocumentClassifierMode instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.Comprehend.Types.DocumentClassifierMode.DocumentClassifierMode instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.DocumentClassifierMode.DocumentClassifierMode instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.Comprehend.Types.DocumentClassifierMode.DocumentClassifierMode instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.DocumentClassifierMode.DocumentClassifierMode instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.Types.DocumentClassifierMode.DocumentClassifierMode instance Amazonka.Data.Headers.ToHeader Amazonka.Comprehend.Types.DocumentClassifierMode.DocumentClassifierMode instance Amazonka.Data.Log.ToLog Amazonka.Comprehend.Types.DocumentClassifierMode.DocumentClassifierMode instance Amazonka.Data.ByteString.ToByteString Amazonka.Comprehend.Types.DocumentClassifierMode.DocumentClassifierMode instance Amazonka.Data.Text.ToText Amazonka.Comprehend.Types.DocumentClassifierMode.DocumentClassifierMode instance Amazonka.Data.Text.FromText Amazonka.Comprehend.Types.DocumentClassifierMode.DocumentClassifierMode instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.DocumentClassifierMode.DocumentClassifierMode instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.DocumentClassifierMode.DocumentClassifierMode instance GHC.Generics.Generic Amazonka.Comprehend.Types.DocumentClassifierMode.DocumentClassifierMode instance GHC.Classes.Ord Amazonka.Comprehend.Types.DocumentClassifierMode.DocumentClassifierMode instance GHC.Classes.Eq Amazonka.Comprehend.Types.DocumentClassifierMode.DocumentClassifierMode instance GHC.Read.Read Amazonka.Comprehend.Types.DocumentClassifierMode.DocumentClassifierMode instance GHC.Show.Show Amazonka.Comprehend.Types.DocumentClassifierMode.DocumentClassifierMode module Amazonka.Comprehend.Types.DocumentClassifierOutputDataConfig -- | Provides output results configuration parameters for custom classifier -- jobs. -- -- See: newDocumentClassifierOutputDataConfig smart -- constructor. data DocumentClassifierOutputDataConfig DocumentClassifierOutputDataConfig' :: Maybe Text -> Maybe Text -> DocumentClassifierOutputDataConfig -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt the output results from an analysis job. The KmsKeyId -- can be one of the following formats: -- -- [$sel:kmsKeyId:DocumentClassifierOutputDataConfig'] :: DocumentClassifierOutputDataConfig -> Maybe Text -- | When you use the OutputDataConfig object while creating a -- custom classifier, you specify the Amazon S3 location where you want -- to write the confusion matrix. The URI must be in the same region as -- the API endpoint that you are calling. The location is 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 directory specific to the job. The S3Uri -- field contains the location of the output file, called -- output.tar.gz. It is a compressed archive that contains the -- confusion matrix. [$sel:s3Uri:DocumentClassifierOutputDataConfig'] :: DocumentClassifierOutputDataConfig -> Maybe Text -- | Create a value of DocumentClassifierOutputDataConfig with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:kmsKeyId:DocumentClassifierOutputDataConfig', -- documentClassifierOutputDataConfig_kmsKeyId - ID for the AWS -- Key Management Service (KMS) key that Amazon Comprehend uses to -- encrypt the output results from an analysis job. The KmsKeyId can be -- one of the following formats: -- -- -- -- $sel:s3Uri:DocumentClassifierOutputDataConfig', -- documentClassifierOutputDataConfig_s3Uri - When you use the -- OutputDataConfig object while creating a custom classifier, -- you specify the Amazon S3 location where you want to write the -- confusion matrix. The URI must be in the same region as the API -- endpoint that you are calling. The location is 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 directory specific to the job. The S3Uri -- field contains the location of the output file, called -- output.tar.gz. It is a compressed archive that contains the -- confusion matrix. newDocumentClassifierOutputDataConfig :: DocumentClassifierOutputDataConfig -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt the output results from an analysis job. The KmsKeyId -- can be one of the following formats: -- -- documentClassifierOutputDataConfig_kmsKeyId :: Lens' DocumentClassifierOutputDataConfig (Maybe Text) -- | When you use the OutputDataConfig object while creating a -- custom classifier, you specify the Amazon S3 location where you want -- to write the confusion matrix. The URI must be in the same region as -- the API endpoint that you are calling. The location is 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 directory specific to the job. The S3Uri -- field contains the location of the output file, called -- output.tar.gz. It is a compressed archive that contains the -- confusion matrix. documentClassifierOutputDataConfig_s3Uri :: Lens' DocumentClassifierOutputDataConfig (Maybe Text) instance GHC.Generics.Generic Amazonka.Comprehend.Types.DocumentClassifierOutputDataConfig.DocumentClassifierOutputDataConfig instance GHC.Show.Show Amazonka.Comprehend.Types.DocumentClassifierOutputDataConfig.DocumentClassifierOutputDataConfig instance GHC.Read.Read Amazonka.Comprehend.Types.DocumentClassifierOutputDataConfig.DocumentClassifierOutputDataConfig instance GHC.Classes.Eq Amazonka.Comprehend.Types.DocumentClassifierOutputDataConfig.DocumentClassifierOutputDataConfig instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.DocumentClassifierOutputDataConfig.DocumentClassifierOutputDataConfig instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.DocumentClassifierOutputDataConfig.DocumentClassifierOutputDataConfig instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.DocumentClassifierOutputDataConfig.DocumentClassifierOutputDataConfig instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.DocumentClassifierOutputDataConfig.DocumentClassifierOutputDataConfig module Amazonka.Comprehend.Types.DocumentLabel -- | Specifies one of the label or labels that categorize the document -- being analyzed. -- -- See: newDocumentLabel smart constructor. data DocumentLabel DocumentLabel' :: Maybe Text -> Maybe Int -> Maybe Double -> DocumentLabel -- | The name of the label. [$sel:name:DocumentLabel'] :: DocumentLabel -> Maybe Text -- | Page number where the label occurs. This field is present in the -- response only if your request includes the Byte parameter. [$sel:page:DocumentLabel'] :: DocumentLabel -> Maybe Int -- | The confidence score that Amazon Comprehend has this label correctly -- attributed. [$sel:score:DocumentLabel'] :: DocumentLabel -> Maybe Double -- | Create a value of DocumentLabel with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:name:DocumentLabel', documentLabel_name - The name -- of the label. -- -- $sel:page:DocumentLabel', documentLabel_page - Page -- number where the label occurs. This field is present in the response -- only if your request includes the Byte parameter. -- -- $sel:score:DocumentLabel', documentLabel_score - The -- confidence score that Amazon Comprehend has this label correctly -- attributed. newDocumentLabel :: DocumentLabel -- | The name of the label. documentLabel_name :: Lens' DocumentLabel (Maybe Text) -- | Page number where the label occurs. This field is present in the -- response only if your request includes the Byte parameter. documentLabel_page :: Lens' DocumentLabel (Maybe Int) -- | The confidence score that Amazon Comprehend has this label correctly -- attributed. documentLabel_score :: Lens' DocumentLabel (Maybe Double) instance GHC.Generics.Generic Amazonka.Comprehend.Types.DocumentLabel.DocumentLabel instance GHC.Show.Show Amazonka.Comprehend.Types.DocumentLabel.DocumentLabel instance GHC.Read.Read Amazonka.Comprehend.Types.DocumentLabel.DocumentLabel instance GHC.Classes.Eq Amazonka.Comprehend.Types.DocumentLabel.DocumentLabel instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.DocumentLabel.DocumentLabel instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.DocumentLabel.DocumentLabel instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.DocumentLabel.DocumentLabel module Amazonka.Comprehend.Types.DocumentReadAction newtype DocumentReadAction DocumentReadAction' :: Text -> DocumentReadAction [fromDocumentReadAction] :: DocumentReadAction -> Text pattern DocumentReadAction_TEXTRACT_ANALYZE_DOCUMENT :: DocumentReadAction pattern DocumentReadAction_TEXTRACT_DETECT_DOCUMENT_TEXT :: DocumentReadAction instance Amazonka.Data.XML.ToXML Amazonka.Comprehend.Types.DocumentReadAction.DocumentReadAction instance Amazonka.Data.XML.FromXML Amazonka.Comprehend.Types.DocumentReadAction.DocumentReadAction instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.Comprehend.Types.DocumentReadAction.DocumentReadAction instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.DocumentReadAction.DocumentReadAction instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.Comprehend.Types.DocumentReadAction.DocumentReadAction instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.DocumentReadAction.DocumentReadAction instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.Types.DocumentReadAction.DocumentReadAction instance Amazonka.Data.Headers.ToHeader Amazonka.Comprehend.Types.DocumentReadAction.DocumentReadAction instance Amazonka.Data.Log.ToLog Amazonka.Comprehend.Types.DocumentReadAction.DocumentReadAction instance Amazonka.Data.ByteString.ToByteString Amazonka.Comprehend.Types.DocumentReadAction.DocumentReadAction instance Amazonka.Data.Text.ToText Amazonka.Comprehend.Types.DocumentReadAction.DocumentReadAction instance Amazonka.Data.Text.FromText Amazonka.Comprehend.Types.DocumentReadAction.DocumentReadAction instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.DocumentReadAction.DocumentReadAction instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.DocumentReadAction.DocumentReadAction instance GHC.Generics.Generic Amazonka.Comprehend.Types.DocumentReadAction.DocumentReadAction instance GHC.Classes.Ord Amazonka.Comprehend.Types.DocumentReadAction.DocumentReadAction instance GHC.Classes.Eq Amazonka.Comprehend.Types.DocumentReadAction.DocumentReadAction instance GHC.Read.Read Amazonka.Comprehend.Types.DocumentReadAction.DocumentReadAction instance GHC.Show.Show Amazonka.Comprehend.Types.DocumentReadAction.DocumentReadAction module Amazonka.Comprehend.Types.DocumentReadFeatureTypes -- | Specifies the type of Amazon Textract features to apply. If you chose -- TEXTRACT_ANALYZE_DOCUMENT as the read action, you must -- specify one or both of the following values: -- -- newtype DocumentReadFeatureTypes DocumentReadFeatureTypes' :: Text -> DocumentReadFeatureTypes [fromDocumentReadFeatureTypes] :: DocumentReadFeatureTypes -> Text pattern DocumentReadFeatureTypes_FORMS :: DocumentReadFeatureTypes pattern DocumentReadFeatureTypes_TABLES :: DocumentReadFeatureTypes instance Amazonka.Data.XML.ToXML Amazonka.Comprehend.Types.DocumentReadFeatureTypes.DocumentReadFeatureTypes instance Amazonka.Data.XML.FromXML Amazonka.Comprehend.Types.DocumentReadFeatureTypes.DocumentReadFeatureTypes instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.Comprehend.Types.DocumentReadFeatureTypes.DocumentReadFeatureTypes instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.DocumentReadFeatureTypes.DocumentReadFeatureTypes instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.Comprehend.Types.DocumentReadFeatureTypes.DocumentReadFeatureTypes instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.DocumentReadFeatureTypes.DocumentReadFeatureTypes instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.Types.DocumentReadFeatureTypes.DocumentReadFeatureTypes instance Amazonka.Data.Headers.ToHeader Amazonka.Comprehend.Types.DocumentReadFeatureTypes.DocumentReadFeatureTypes instance Amazonka.Data.Log.ToLog Amazonka.Comprehend.Types.DocumentReadFeatureTypes.DocumentReadFeatureTypes instance Amazonka.Data.ByteString.ToByteString Amazonka.Comprehend.Types.DocumentReadFeatureTypes.DocumentReadFeatureTypes instance Amazonka.Data.Text.ToText Amazonka.Comprehend.Types.DocumentReadFeatureTypes.DocumentReadFeatureTypes instance Amazonka.Data.Text.FromText Amazonka.Comprehend.Types.DocumentReadFeatureTypes.DocumentReadFeatureTypes instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.DocumentReadFeatureTypes.DocumentReadFeatureTypes instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.DocumentReadFeatureTypes.DocumentReadFeatureTypes instance GHC.Generics.Generic Amazonka.Comprehend.Types.DocumentReadFeatureTypes.DocumentReadFeatureTypes instance GHC.Classes.Ord Amazonka.Comprehend.Types.DocumentReadFeatureTypes.DocumentReadFeatureTypes instance GHC.Classes.Eq Amazonka.Comprehend.Types.DocumentReadFeatureTypes.DocumentReadFeatureTypes instance GHC.Read.Read Amazonka.Comprehend.Types.DocumentReadFeatureTypes.DocumentReadFeatureTypes instance GHC.Show.Show Amazonka.Comprehend.Types.DocumentReadFeatureTypes.DocumentReadFeatureTypes module Amazonka.Comprehend.Types.DocumentReadMode newtype DocumentReadMode DocumentReadMode' :: Text -> DocumentReadMode [fromDocumentReadMode] :: DocumentReadMode -> Text pattern DocumentReadMode_FORCE_DOCUMENT_READ_ACTION :: DocumentReadMode pattern DocumentReadMode_SERVICE_DEFAULT :: DocumentReadMode instance Amazonka.Data.XML.ToXML Amazonka.Comprehend.Types.DocumentReadMode.DocumentReadMode instance Amazonka.Data.XML.FromXML Amazonka.Comprehend.Types.DocumentReadMode.DocumentReadMode instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.Comprehend.Types.DocumentReadMode.DocumentReadMode instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.DocumentReadMode.DocumentReadMode instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.Comprehend.Types.DocumentReadMode.DocumentReadMode instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.DocumentReadMode.DocumentReadMode instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.Types.DocumentReadMode.DocumentReadMode instance Amazonka.Data.Headers.ToHeader Amazonka.Comprehend.Types.DocumentReadMode.DocumentReadMode instance Amazonka.Data.Log.ToLog Amazonka.Comprehend.Types.DocumentReadMode.DocumentReadMode instance Amazonka.Data.ByteString.ToByteString Amazonka.Comprehend.Types.DocumentReadMode.DocumentReadMode instance Amazonka.Data.Text.ToText Amazonka.Comprehend.Types.DocumentReadMode.DocumentReadMode instance Amazonka.Data.Text.FromText Amazonka.Comprehend.Types.DocumentReadMode.DocumentReadMode instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.DocumentReadMode.DocumentReadMode instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.DocumentReadMode.DocumentReadMode instance GHC.Generics.Generic Amazonka.Comprehend.Types.DocumentReadMode.DocumentReadMode instance GHC.Classes.Ord Amazonka.Comprehend.Types.DocumentReadMode.DocumentReadMode instance GHC.Classes.Eq Amazonka.Comprehend.Types.DocumentReadMode.DocumentReadMode instance GHC.Read.Read Amazonka.Comprehend.Types.DocumentReadMode.DocumentReadMode instance GHC.Show.Show Amazonka.Comprehend.Types.DocumentReadMode.DocumentReadMode module Amazonka.Comprehend.Types.DocumentReaderConfig -- | Provides configuration parameters to override the default actions for -- extracting text from PDF documents and image files. -- -- By default, Amazon Comprehend performs the following actions to -- extract text from files, based on the input file type: -- -- -- -- DocumentReaderConfig does not apply to plain text files or -- Word files. -- -- For image files and PDF documents, you can override these default -- actions using the fields listed below. For more information, see -- Setting text extraction options. -- -- See: newDocumentReaderConfig smart constructor. data DocumentReaderConfig DocumentReaderConfig' :: Maybe DocumentReadMode -> Maybe (NonEmpty DocumentReadFeatureTypes) -> DocumentReadAction -> DocumentReaderConfig -- | Determines the text extraction actions for PDF files. Enter one of the -- following values: -- -- [$sel:documentReadMode:DocumentReaderConfig'] :: DocumentReaderConfig -> Maybe DocumentReadMode -- | Specifies the type of Amazon Textract features to apply. If you chose -- TEXTRACT_ANALYZE_DOCUMENT as the read action, you must -- specify one or both of the following values: -- -- [$sel:featureTypes:DocumentReaderConfig'] :: DocumentReaderConfig -> Maybe (NonEmpty DocumentReadFeatureTypes) -- | This field defines the Amazon Textract API operation that Amazon -- Comprehend uses to extract text from PDF files and image files. Enter -- one of the following values: -- -- [$sel:documentReadAction:DocumentReaderConfig'] :: DocumentReaderConfig -> DocumentReadAction -- | Create a value of DocumentReaderConfig with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:documentReadMode:DocumentReaderConfig', -- documentReaderConfig_documentReadMode - Determines the text -- extraction actions for PDF files. Enter one of the following values: -- -- -- -- $sel:featureTypes:DocumentReaderConfig', -- documentReaderConfig_featureTypes - Specifies the type of -- Amazon Textract features to apply. If you chose -- TEXTRACT_ANALYZE_DOCUMENT as the read action, you must -- specify one or both of the following values: -- -- -- -- $sel:documentReadAction:DocumentReaderConfig', -- documentReaderConfig_documentReadAction - This field defines -- the Amazon Textract API operation that Amazon Comprehend uses to -- extract text from PDF files and image files. Enter one of the -- following values: -- -- newDocumentReaderConfig :: DocumentReadAction -> DocumentReaderConfig -- | Determines the text extraction actions for PDF files. Enter one of the -- following values: -- -- documentReaderConfig_documentReadMode :: Lens' DocumentReaderConfig (Maybe DocumentReadMode) -- | Specifies the type of Amazon Textract features to apply. If you chose -- TEXTRACT_ANALYZE_DOCUMENT as the read action, you must -- specify one or both of the following values: -- -- documentReaderConfig_featureTypes :: Lens' DocumentReaderConfig (Maybe (NonEmpty DocumentReadFeatureTypes)) -- | This field defines the Amazon Textract API operation that Amazon -- Comprehend uses to extract text from PDF files and image files. Enter -- one of the following values: -- -- documentReaderConfig_documentReadAction :: Lens' DocumentReaderConfig DocumentReadAction instance GHC.Generics.Generic Amazonka.Comprehend.Types.DocumentReaderConfig.DocumentReaderConfig instance GHC.Show.Show Amazonka.Comprehend.Types.DocumentReaderConfig.DocumentReaderConfig instance GHC.Read.Read Amazonka.Comprehend.Types.DocumentReaderConfig.DocumentReaderConfig instance GHC.Classes.Eq Amazonka.Comprehend.Types.DocumentReaderConfig.DocumentReaderConfig instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.DocumentReaderConfig.DocumentReaderConfig instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.DocumentReaderConfig.DocumentReaderConfig instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.DocumentReaderConfig.DocumentReaderConfig instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.DocumentReaderConfig.DocumentReaderConfig module Amazonka.Comprehend.Types.DocumentType newtype DocumentType DocumentType' :: Text -> DocumentType [fromDocumentType] :: DocumentType -> Text pattern DocumentType_IMAGE :: DocumentType pattern DocumentType_MS_WORD :: DocumentType pattern DocumentType_NATIVE_PDF :: DocumentType pattern DocumentType_PLAIN_TEXT :: DocumentType pattern DocumentType_SCANNED_PDF :: DocumentType pattern DocumentType_TEXTRACT_ANALYZE_DOCUMENT_JSON :: DocumentType pattern DocumentType_TEXTRACT_DETECT_DOCUMENT_TEXT_JSON :: DocumentType instance Amazonka.Data.XML.ToXML Amazonka.Comprehend.Types.DocumentType.DocumentType instance Amazonka.Data.XML.FromXML Amazonka.Comprehend.Types.DocumentType.DocumentType instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.Comprehend.Types.DocumentType.DocumentType instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.DocumentType.DocumentType instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.Comprehend.Types.DocumentType.DocumentType instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.DocumentType.DocumentType instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.Types.DocumentType.DocumentType instance Amazonka.Data.Headers.ToHeader Amazonka.Comprehend.Types.DocumentType.DocumentType instance Amazonka.Data.Log.ToLog Amazonka.Comprehend.Types.DocumentType.DocumentType instance Amazonka.Data.ByteString.ToByteString Amazonka.Comprehend.Types.DocumentType.DocumentType instance Amazonka.Data.Text.ToText Amazonka.Comprehend.Types.DocumentType.DocumentType instance Amazonka.Data.Text.FromText Amazonka.Comprehend.Types.DocumentType.DocumentType instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.DocumentType.DocumentType instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.DocumentType.DocumentType instance GHC.Generics.Generic Amazonka.Comprehend.Types.DocumentType.DocumentType instance GHC.Classes.Ord Amazonka.Comprehend.Types.DocumentType.DocumentType instance GHC.Classes.Eq Amazonka.Comprehend.Types.DocumentType.DocumentType instance GHC.Read.Read Amazonka.Comprehend.Types.DocumentType.DocumentType instance GHC.Show.Show Amazonka.Comprehend.Types.DocumentType.DocumentType module Amazonka.Comprehend.Types.DocumentTypeListItem -- | Document type for each page in the document. -- -- See: newDocumentTypeListItem smart constructor. data DocumentTypeListItem DocumentTypeListItem' :: Maybe Int -> Maybe DocumentType -> DocumentTypeListItem -- | Page number. [$sel:page:DocumentTypeListItem'] :: DocumentTypeListItem -> Maybe Int -- | Document type. [$sel:type':DocumentTypeListItem'] :: DocumentTypeListItem -> Maybe DocumentType -- | Create a value of DocumentTypeListItem with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:page:DocumentTypeListItem', -- documentTypeListItem_page - Page number. -- -- $sel:type':DocumentTypeListItem', -- documentTypeListItem_type - Document type. newDocumentTypeListItem :: DocumentTypeListItem -- | Page number. documentTypeListItem_page :: Lens' DocumentTypeListItem (Maybe Int) -- | Document type. documentTypeListItem_type :: Lens' DocumentTypeListItem (Maybe DocumentType) instance GHC.Generics.Generic Amazonka.Comprehend.Types.DocumentTypeListItem.DocumentTypeListItem instance GHC.Show.Show Amazonka.Comprehend.Types.DocumentTypeListItem.DocumentTypeListItem instance GHC.Read.Read Amazonka.Comprehend.Types.DocumentTypeListItem.DocumentTypeListItem instance GHC.Classes.Eq Amazonka.Comprehend.Types.DocumentTypeListItem.DocumentTypeListItem instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.DocumentTypeListItem.DocumentTypeListItem instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.DocumentTypeListItem.DocumentTypeListItem instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.DocumentTypeListItem.DocumentTypeListItem module Amazonka.Comprehend.Types.DominantLanguage -- | Returns the code for the dominant language in the input text and the -- level of confidence that Amazon Comprehend has in the accuracy of the -- detection. -- -- See: newDominantLanguage smart constructor. data DominantLanguage DominantLanguage' :: Maybe Text -> Maybe Double -> DominantLanguage -- | The RFC 5646 language code for the dominant language. For more -- information about RFC 5646, see Tags for Identifying Languages -- on the IETF Tools web site. [$sel:languageCode:DominantLanguage'] :: DominantLanguage -> Maybe Text -- | The level of confidence that Amazon Comprehend has in the accuracy of -- the detection. [$sel:score:DominantLanguage'] :: DominantLanguage -> Maybe Double -- | Create a value of DominantLanguage with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:languageCode:DominantLanguage', -- dominantLanguage_languageCode - The RFC 5646 language code for -- the dominant language. For more information about RFC 5646, see -- Tags for Identifying Languages on the IETF Tools web -- site. -- -- $sel:score:DominantLanguage', dominantLanguage_score - -- The level of confidence that Amazon Comprehend has in the accuracy of -- the detection. newDominantLanguage :: DominantLanguage -- | The RFC 5646 language code for the dominant language. For more -- information about RFC 5646, see Tags for Identifying Languages -- on the IETF Tools web site. dominantLanguage_languageCode :: Lens' DominantLanguage (Maybe Text) -- | The level of confidence that Amazon Comprehend has in the accuracy of -- the detection. dominantLanguage_score :: Lens' DominantLanguage (Maybe Double) instance GHC.Generics.Generic Amazonka.Comprehend.Types.DominantLanguage.DominantLanguage instance GHC.Show.Show Amazonka.Comprehend.Types.DominantLanguage.DominantLanguage instance GHC.Read.Read Amazonka.Comprehend.Types.DominantLanguage.DominantLanguage instance GHC.Classes.Eq Amazonka.Comprehend.Types.DominantLanguage.DominantLanguage instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.DominantLanguage.DominantLanguage instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.DominantLanguage.DominantLanguage instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.DominantLanguage.DominantLanguage module Amazonka.Comprehend.Types.BatchDetectDominantLanguageItemResult -- | The result of calling the operation. The operation returns one object -- for each document that is successfully processed by the operation. -- -- See: newBatchDetectDominantLanguageItemResult smart -- constructor. data BatchDetectDominantLanguageItemResult BatchDetectDominantLanguageItemResult' :: Maybe Int -> Maybe [DominantLanguage] -> BatchDetectDominantLanguageItemResult -- | The zero-based index of the document in the input list. [$sel:index:BatchDetectDominantLanguageItemResult'] :: BatchDetectDominantLanguageItemResult -> Maybe Int -- | One or more DominantLanguage objects describing the dominant languages -- in the document. [$sel:languages:BatchDetectDominantLanguageItemResult'] :: BatchDetectDominantLanguageItemResult -> Maybe [DominantLanguage] -- | Create a value of BatchDetectDominantLanguageItemResult with -- all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:index:BatchDetectDominantLanguageItemResult', -- batchDetectDominantLanguageItemResult_index - The zero-based -- index of the document in the input list. -- -- $sel:languages:BatchDetectDominantLanguageItemResult', -- batchDetectDominantLanguageItemResult_languages - One or more -- DominantLanguage objects describing the dominant languages in the -- document. newBatchDetectDominantLanguageItemResult :: BatchDetectDominantLanguageItemResult -- | The zero-based index of the document in the input list. batchDetectDominantLanguageItemResult_index :: Lens' BatchDetectDominantLanguageItemResult (Maybe Int) -- | One or more DominantLanguage objects describing the dominant languages -- in the document. batchDetectDominantLanguageItemResult_languages :: Lens' BatchDetectDominantLanguageItemResult (Maybe [DominantLanguage]) instance GHC.Generics.Generic Amazonka.Comprehend.Types.BatchDetectDominantLanguageItemResult.BatchDetectDominantLanguageItemResult instance GHC.Show.Show Amazonka.Comprehend.Types.BatchDetectDominantLanguageItemResult.BatchDetectDominantLanguageItemResult instance GHC.Read.Read Amazonka.Comprehend.Types.BatchDetectDominantLanguageItemResult.BatchDetectDominantLanguageItemResult instance GHC.Classes.Eq Amazonka.Comprehend.Types.BatchDetectDominantLanguageItemResult.BatchDetectDominantLanguageItemResult instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.BatchDetectDominantLanguageItemResult.BatchDetectDominantLanguageItemResult instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.BatchDetectDominantLanguageItemResult.BatchDetectDominantLanguageItemResult instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.BatchDetectDominantLanguageItemResult.BatchDetectDominantLanguageItemResult module Amazonka.Comprehend.Types.EndpointStatus newtype EndpointStatus EndpointStatus' :: Text -> EndpointStatus [fromEndpointStatus] :: EndpointStatus -> Text pattern EndpointStatus_CREATING :: EndpointStatus pattern EndpointStatus_DELETING :: EndpointStatus pattern EndpointStatus_FAILED :: EndpointStatus pattern EndpointStatus_IN_SERVICE :: EndpointStatus pattern EndpointStatus_UPDATING :: EndpointStatus instance Amazonka.Data.XML.ToXML Amazonka.Comprehend.Types.EndpointStatus.EndpointStatus instance Amazonka.Data.XML.FromXML Amazonka.Comprehend.Types.EndpointStatus.EndpointStatus instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.Comprehend.Types.EndpointStatus.EndpointStatus instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.EndpointStatus.EndpointStatus instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.Comprehend.Types.EndpointStatus.EndpointStatus instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.EndpointStatus.EndpointStatus instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.Types.EndpointStatus.EndpointStatus instance Amazonka.Data.Headers.ToHeader Amazonka.Comprehend.Types.EndpointStatus.EndpointStatus instance Amazonka.Data.Log.ToLog Amazonka.Comprehend.Types.EndpointStatus.EndpointStatus instance Amazonka.Data.ByteString.ToByteString Amazonka.Comprehend.Types.EndpointStatus.EndpointStatus instance Amazonka.Data.Text.ToText Amazonka.Comprehend.Types.EndpointStatus.EndpointStatus instance Amazonka.Data.Text.FromText Amazonka.Comprehend.Types.EndpointStatus.EndpointStatus instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.EndpointStatus.EndpointStatus instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.EndpointStatus.EndpointStatus instance GHC.Generics.Generic Amazonka.Comprehend.Types.EndpointStatus.EndpointStatus instance GHC.Classes.Ord Amazonka.Comprehend.Types.EndpointStatus.EndpointStatus instance GHC.Classes.Eq Amazonka.Comprehend.Types.EndpointStatus.EndpointStatus instance GHC.Read.Read Amazonka.Comprehend.Types.EndpointStatus.EndpointStatus instance GHC.Show.Show Amazonka.Comprehend.Types.EndpointStatus.EndpointStatus module Amazonka.Comprehend.Types.EndpointProperties -- | Specifies information about the specified endpoint. For information -- about endpoints, see Managing endpoints. -- -- See: newEndpointProperties smart constructor. data EndpointProperties EndpointProperties' :: Maybe POSIX -> Maybe Natural -> Maybe Text -> Maybe Text -> Maybe Natural -> Maybe Text -> Maybe Text -> Maybe POSIX -> Maybe Text -> Maybe Text -> Maybe EndpointStatus -> EndpointProperties -- | The creation date and time of the endpoint. [$sel:creationTime:EndpointProperties'] :: EndpointProperties -> Maybe POSIX -- | The number of inference units currently used by the model using this -- endpoint. [$sel:currentInferenceUnits:EndpointProperties'] :: EndpointProperties -> Maybe Natural -- | The Amazon Resource Name (ARN) of the AWS identity and Access -- Management (IAM) role that grants Amazon Comprehend read access to -- trained custom models encrypted with a customer managed key -- (ModelKmsKeyId). [$sel:dataAccessRoleArn:EndpointProperties'] :: EndpointProperties -> Maybe Text -- | Data access role ARN to use in case the new model is encrypted with a -- customer KMS key. [$sel:desiredDataAccessRoleArn:EndpointProperties'] :: EndpointProperties -> Maybe Text -- | The desired number of inference units to be used by the model using -- this endpoint. Each inference unit represents of a throughput of 100 -- characters per second. [$sel:desiredInferenceUnits:EndpointProperties'] :: EndpointProperties -> Maybe Natural -- | ARN of the new model to use for updating an existing endpoint. This -- ARN is going to be different from the model ARN when the update is in -- progress [$sel:desiredModelArn:EndpointProperties'] :: EndpointProperties -> Maybe Text -- | The Amazon Resource Number (ARN) of the endpoint. [$sel:endpointArn:EndpointProperties'] :: EndpointProperties -> Maybe Text -- | The date and time that the endpoint was last modified. [$sel:lastModifiedTime:EndpointProperties'] :: EndpointProperties -> Maybe POSIX -- | Specifies a reason for failure in cases of Failed status. [$sel:message:EndpointProperties'] :: EndpointProperties -> Maybe Text -- | The Amazon Resource Number (ARN) of the model to which the endpoint is -- attached. [$sel:modelArn:EndpointProperties'] :: EndpointProperties -> Maybe Text -- | Specifies the status of the endpoint. Because the endpoint updates and -- creation are asynchronous, so customers will need to wait for the -- endpoint to be Ready status before making inference requests. [$sel:status:EndpointProperties'] :: EndpointProperties -> Maybe EndpointStatus -- | Create a value of EndpointProperties with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:creationTime:EndpointProperties', -- endpointProperties_creationTime - The creation date and time of -- the endpoint. -- -- $sel:currentInferenceUnits:EndpointProperties', -- endpointProperties_currentInferenceUnits - The number of -- inference units currently used by the model using this endpoint. -- -- $sel:dataAccessRoleArn:EndpointProperties', -- endpointProperties_dataAccessRoleArn - The Amazon Resource Name -- (ARN) of the AWS identity and Access Management (IAM) role that grants -- Amazon Comprehend read access to trained custom models encrypted with -- a customer managed key (ModelKmsKeyId). -- -- $sel:desiredDataAccessRoleArn:EndpointProperties', -- endpointProperties_desiredDataAccessRoleArn - Data access role -- ARN to use in case the new model is encrypted with a customer KMS key. -- -- $sel:desiredInferenceUnits:EndpointProperties', -- endpointProperties_desiredInferenceUnits - The desired number -- of inference units to be used by the model using this endpoint. Each -- inference unit represents of a throughput of 100 characters per -- second. -- -- $sel:desiredModelArn:EndpointProperties', -- endpointProperties_desiredModelArn - ARN of the new model to -- use for updating an existing endpoint. This ARN is going to be -- different from the model ARN when the update is in progress -- -- $sel:endpointArn:EndpointProperties', -- endpointProperties_endpointArn - The Amazon Resource Number -- (ARN) of the endpoint. -- -- $sel:lastModifiedTime:EndpointProperties', -- endpointProperties_lastModifiedTime - The date and time that -- the endpoint was last modified. -- -- $sel:message:EndpointProperties', -- endpointProperties_message - Specifies a reason for failure in -- cases of Failed status. -- -- $sel:modelArn:EndpointProperties', -- endpointProperties_modelArn - The Amazon Resource Number (ARN) -- of the model to which the endpoint is attached. -- -- $sel:status:EndpointProperties', -- endpointProperties_status - Specifies the status of the -- endpoint. Because the endpoint updates and creation are asynchronous, -- so customers will need to wait for the endpoint to be Ready -- status before making inference requests. newEndpointProperties :: EndpointProperties -- | The creation date and time of the endpoint. endpointProperties_creationTime :: Lens' EndpointProperties (Maybe UTCTime) -- | The number of inference units currently used by the model using this -- endpoint. endpointProperties_currentInferenceUnits :: Lens' EndpointProperties (Maybe Natural) -- | The Amazon Resource Name (ARN) of the AWS identity and Access -- Management (IAM) role that grants Amazon Comprehend read access to -- trained custom models encrypted with a customer managed key -- (ModelKmsKeyId). endpointProperties_dataAccessRoleArn :: Lens' EndpointProperties (Maybe Text) -- | Data access role ARN to use in case the new model is encrypted with a -- customer KMS key. endpointProperties_desiredDataAccessRoleArn :: Lens' EndpointProperties (Maybe Text) -- | The desired number of inference units to be used by the model using -- this endpoint. Each inference unit represents of a throughput of 100 -- characters per second. endpointProperties_desiredInferenceUnits :: Lens' EndpointProperties (Maybe Natural) -- | ARN of the new model to use for updating an existing endpoint. This -- ARN is going to be different from the model ARN when the update is in -- progress endpointProperties_desiredModelArn :: Lens' EndpointProperties (Maybe Text) -- | The Amazon Resource Number (ARN) of the endpoint. endpointProperties_endpointArn :: Lens' EndpointProperties (Maybe Text) -- | The date and time that the endpoint was last modified. endpointProperties_lastModifiedTime :: Lens' EndpointProperties (Maybe UTCTime) -- | Specifies a reason for failure in cases of Failed status. endpointProperties_message :: Lens' EndpointProperties (Maybe Text) -- | The Amazon Resource Number (ARN) of the model to which the endpoint is -- attached. endpointProperties_modelArn :: Lens' EndpointProperties (Maybe Text) -- | Specifies the status of the endpoint. Because the endpoint updates and -- creation are asynchronous, so customers will need to wait for the -- endpoint to be Ready status before making inference requests. endpointProperties_status :: Lens' EndpointProperties (Maybe EndpointStatus) instance GHC.Generics.Generic Amazonka.Comprehend.Types.EndpointProperties.EndpointProperties instance GHC.Show.Show Amazonka.Comprehend.Types.EndpointProperties.EndpointProperties instance GHC.Read.Read Amazonka.Comprehend.Types.EndpointProperties.EndpointProperties instance GHC.Classes.Eq Amazonka.Comprehend.Types.EndpointProperties.EndpointProperties instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.EndpointProperties.EndpointProperties instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.EndpointProperties.EndpointProperties instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.EndpointProperties.EndpointProperties module Amazonka.Comprehend.Types.EndpointFilter -- | The filter used to determine which endpoints are returned. You can -- filter jobs on their name, model, status, or the date and time that -- they were created. You can only set one filter at a time. -- -- See: newEndpointFilter smart constructor. data EndpointFilter EndpointFilter' :: Maybe POSIX -> Maybe POSIX -> Maybe Text -> Maybe EndpointStatus -> EndpointFilter -- | Specifies a date after which the returned endpoint or endpoints were -- created. [$sel:creationTimeAfter:EndpointFilter'] :: EndpointFilter -> Maybe POSIX -- | Specifies a date before which the returned endpoint or endpoints were -- created. [$sel:creationTimeBefore:EndpointFilter'] :: EndpointFilter -> Maybe POSIX -- | The Amazon Resource Number (ARN) of the model to which the endpoint is -- attached. [$sel:modelArn:EndpointFilter'] :: EndpointFilter -> Maybe Text -- | Specifies the status of the endpoint being returned. Possible values -- are: Creating, Ready, Updating, Deleting, Failed. [$sel:status:EndpointFilter'] :: EndpointFilter -> Maybe EndpointStatus -- | Create a value of EndpointFilter with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:creationTimeAfter:EndpointFilter', -- endpointFilter_creationTimeAfter - Specifies a date after which -- the returned endpoint or endpoints were created. -- -- $sel:creationTimeBefore:EndpointFilter', -- endpointFilter_creationTimeBefore - Specifies a date before -- which the returned endpoint or endpoints were created. -- -- $sel:modelArn:EndpointFilter', endpointFilter_modelArn - -- The Amazon Resource Number (ARN) of the model to which the endpoint is -- attached. -- -- $sel:status:EndpointFilter', endpointFilter_status - -- Specifies the status of the endpoint being returned. Possible values -- are: Creating, Ready, Updating, Deleting, Failed. newEndpointFilter :: EndpointFilter -- | Specifies a date after which the returned endpoint or endpoints were -- created. endpointFilter_creationTimeAfter :: Lens' EndpointFilter (Maybe UTCTime) -- | Specifies a date before which the returned endpoint or endpoints were -- created. endpointFilter_creationTimeBefore :: Lens' EndpointFilter (Maybe UTCTime) -- | The Amazon Resource Number (ARN) of the model to which the endpoint is -- attached. endpointFilter_modelArn :: Lens' EndpointFilter (Maybe Text) -- | Specifies the status of the endpoint being returned. Possible values -- are: Creating, Ready, Updating, Deleting, Failed. endpointFilter_status :: Lens' EndpointFilter (Maybe EndpointStatus) instance GHC.Generics.Generic Amazonka.Comprehend.Types.EndpointFilter.EndpointFilter instance GHC.Show.Show Amazonka.Comprehend.Types.EndpointFilter.EndpointFilter instance GHC.Read.Read Amazonka.Comprehend.Types.EndpointFilter.EndpointFilter instance GHC.Classes.Eq Amazonka.Comprehend.Types.EndpointFilter.EndpointFilter instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.EndpointFilter.EndpointFilter instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.EndpointFilter.EndpointFilter instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.EndpointFilter.EndpointFilter module Amazonka.Comprehend.Types.EntityRecognizerAnnotations -- | Describes the annotations associated with a entity recognizer. -- -- See: newEntityRecognizerAnnotations smart constructor. data EntityRecognizerAnnotations EntityRecognizerAnnotations' :: Maybe Text -> Text -> EntityRecognizerAnnotations -- | Specifies the Amazon S3 location where the test annotations for an -- entity recognizer are located. The URI must be in the same region as -- the API endpoint that you are calling. [$sel:testS3Uri:EntityRecognizerAnnotations'] :: EntityRecognizerAnnotations -> Maybe Text -- | Specifies the Amazon S3 location where the annotations for an entity -- recognizer are located. The URI must be in the same region as the API -- endpoint that you are calling. [$sel:s3Uri:EntityRecognizerAnnotations'] :: EntityRecognizerAnnotations -> Text -- | Create a value of EntityRecognizerAnnotations with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:testS3Uri:EntityRecognizerAnnotations', -- entityRecognizerAnnotations_testS3Uri - Specifies the Amazon S3 -- location where the test annotations for an entity recognizer are -- located. The URI must be in the same region as the API endpoint that -- you are calling. -- -- $sel:s3Uri:EntityRecognizerAnnotations', -- entityRecognizerAnnotations_s3Uri - Specifies the Amazon S3 -- location where the annotations for an entity recognizer are located. -- The URI must be in the same region as the API endpoint that you are -- calling. newEntityRecognizerAnnotations :: Text -> EntityRecognizerAnnotations -- | Specifies the Amazon S3 location where the test annotations for an -- entity recognizer are located. The URI must be in the same region as -- the API endpoint that you are calling. entityRecognizerAnnotations_testS3Uri :: Lens' EntityRecognizerAnnotations (Maybe Text) -- | Specifies the Amazon S3 location where the annotations for an entity -- recognizer are located. The URI must be in the same region as the API -- endpoint that you are calling. entityRecognizerAnnotations_s3Uri :: Lens' EntityRecognizerAnnotations Text instance GHC.Generics.Generic Amazonka.Comprehend.Types.EntityRecognizerAnnotations.EntityRecognizerAnnotations instance GHC.Show.Show Amazonka.Comprehend.Types.EntityRecognizerAnnotations.EntityRecognizerAnnotations instance GHC.Read.Read Amazonka.Comprehend.Types.EntityRecognizerAnnotations.EntityRecognizerAnnotations instance GHC.Classes.Eq Amazonka.Comprehend.Types.EntityRecognizerAnnotations.EntityRecognizerAnnotations instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.EntityRecognizerAnnotations.EntityRecognizerAnnotations instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.EntityRecognizerAnnotations.EntityRecognizerAnnotations instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.EntityRecognizerAnnotations.EntityRecognizerAnnotations instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.EntityRecognizerAnnotations.EntityRecognizerAnnotations module Amazonka.Comprehend.Types.EntityRecognizerDataFormat newtype EntityRecognizerDataFormat EntityRecognizerDataFormat' :: Text -> EntityRecognizerDataFormat [fromEntityRecognizerDataFormat] :: EntityRecognizerDataFormat -> Text pattern EntityRecognizerDataFormat_AUGMENTED_MANIFEST :: EntityRecognizerDataFormat pattern EntityRecognizerDataFormat_COMPREHEND_CSV :: EntityRecognizerDataFormat instance Amazonka.Data.XML.ToXML Amazonka.Comprehend.Types.EntityRecognizerDataFormat.EntityRecognizerDataFormat instance Amazonka.Data.XML.FromXML Amazonka.Comprehend.Types.EntityRecognizerDataFormat.EntityRecognizerDataFormat instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.Comprehend.Types.EntityRecognizerDataFormat.EntityRecognizerDataFormat instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.EntityRecognizerDataFormat.EntityRecognizerDataFormat instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.Comprehend.Types.EntityRecognizerDataFormat.EntityRecognizerDataFormat instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.EntityRecognizerDataFormat.EntityRecognizerDataFormat instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.Types.EntityRecognizerDataFormat.EntityRecognizerDataFormat instance Amazonka.Data.Headers.ToHeader Amazonka.Comprehend.Types.EntityRecognizerDataFormat.EntityRecognizerDataFormat instance Amazonka.Data.Log.ToLog Amazonka.Comprehend.Types.EntityRecognizerDataFormat.EntityRecognizerDataFormat instance Amazonka.Data.ByteString.ToByteString Amazonka.Comprehend.Types.EntityRecognizerDataFormat.EntityRecognizerDataFormat instance Amazonka.Data.Text.ToText Amazonka.Comprehend.Types.EntityRecognizerDataFormat.EntityRecognizerDataFormat instance Amazonka.Data.Text.FromText Amazonka.Comprehend.Types.EntityRecognizerDataFormat.EntityRecognizerDataFormat instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.EntityRecognizerDataFormat.EntityRecognizerDataFormat instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.EntityRecognizerDataFormat.EntityRecognizerDataFormat instance GHC.Generics.Generic Amazonka.Comprehend.Types.EntityRecognizerDataFormat.EntityRecognizerDataFormat instance GHC.Classes.Ord Amazonka.Comprehend.Types.EntityRecognizerDataFormat.EntityRecognizerDataFormat instance GHC.Classes.Eq Amazonka.Comprehend.Types.EntityRecognizerDataFormat.EntityRecognizerDataFormat instance GHC.Read.Read Amazonka.Comprehend.Types.EntityRecognizerDataFormat.EntityRecognizerDataFormat instance GHC.Show.Show Amazonka.Comprehend.Types.EntityRecognizerDataFormat.EntityRecognizerDataFormat module Amazonka.Comprehend.Types.EntityRecognizerEntityList -- | Describes the entity recognizer submitted with an entity recognizer. -- -- See: newEntityRecognizerEntityList smart constructor. data EntityRecognizerEntityList EntityRecognizerEntityList' :: Text -> EntityRecognizerEntityList -- | Specifies the Amazon S3 location where the entity list is located. The -- URI must be in the same region as the API endpoint that you are -- calling. [$sel:s3Uri:EntityRecognizerEntityList'] :: EntityRecognizerEntityList -> Text -- | Create a value of EntityRecognizerEntityList with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:s3Uri:EntityRecognizerEntityList', -- entityRecognizerEntityList_s3Uri - Specifies the Amazon S3 -- location where the entity list is located. The URI must be in the same -- region as the API endpoint that you are calling. newEntityRecognizerEntityList :: Text -> EntityRecognizerEntityList -- | Specifies the Amazon S3 location where the entity list is located. The -- URI must be in the same region as the API endpoint that you are -- calling. entityRecognizerEntityList_s3Uri :: Lens' EntityRecognizerEntityList Text instance GHC.Generics.Generic Amazonka.Comprehend.Types.EntityRecognizerEntityList.EntityRecognizerEntityList instance GHC.Show.Show Amazonka.Comprehend.Types.EntityRecognizerEntityList.EntityRecognizerEntityList instance GHC.Read.Read Amazonka.Comprehend.Types.EntityRecognizerEntityList.EntityRecognizerEntityList instance GHC.Classes.Eq Amazonka.Comprehend.Types.EntityRecognizerEntityList.EntityRecognizerEntityList instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.EntityRecognizerEntityList.EntityRecognizerEntityList instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.EntityRecognizerEntityList.EntityRecognizerEntityList instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.EntityRecognizerEntityList.EntityRecognizerEntityList instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.EntityRecognizerEntityList.EntityRecognizerEntityList module Amazonka.Comprehend.Types.EntityRecognizerEvaluationMetrics -- | Detailed information about the accuracy of an entity recognizer. -- -- See: newEntityRecognizerEvaluationMetrics smart -- constructor. data EntityRecognizerEvaluationMetrics EntityRecognizerEvaluationMetrics' :: Maybe Double -> Maybe Double -> Maybe Double -> EntityRecognizerEvaluationMetrics -- | A measure of how accurate the recognizer results are for the test -- data. It is derived from the Precision and Recall -- values. The F1Score is the harmonic average of the two -- scores. For plain text entity recognizer models, the range is 0 to -- 100, where 100 is the best score. For PDF/Word entity recognizer -- models, the range is 0 to 1, where 1 is the best score. [$sel:f1Score:EntityRecognizerEvaluationMetrics'] :: EntityRecognizerEvaluationMetrics -> Maybe Double -- | A measure of the usefulness of the recognizer results in the test -- data. High precision means that the recognizer returned substantially -- more relevant results than irrelevant ones. [$sel:precision:EntityRecognizerEvaluationMetrics'] :: EntityRecognizerEvaluationMetrics -> Maybe Double -- | A measure of how complete the recognizer results are for the test -- data. High recall means that the recognizer returned most of the -- relevant results. [$sel:recall:EntityRecognizerEvaluationMetrics'] :: EntityRecognizerEvaluationMetrics -> Maybe Double -- | Create a value of EntityRecognizerEvaluationMetrics with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:f1Score:EntityRecognizerEvaluationMetrics', -- entityRecognizerEvaluationMetrics_f1Score - A measure of how -- accurate the recognizer results are for the test data. It is derived -- from the Precision and Recall values. The -- F1Score is the harmonic average of the two scores. For plain -- text entity recognizer models, the range is 0 to 100, where 100 is the -- best score. For PDF/Word entity recognizer models, the range is 0 to -- 1, where 1 is the best score. -- -- $sel:precision:EntityRecognizerEvaluationMetrics', -- entityRecognizerEvaluationMetrics_precision - A measure of the -- usefulness of the recognizer results in the test data. High precision -- means that the recognizer returned substantially more relevant results -- than irrelevant ones. -- -- $sel:recall:EntityRecognizerEvaluationMetrics', -- entityRecognizerEvaluationMetrics_recall - A measure of how -- complete the recognizer results are for the test data. High recall -- means that the recognizer returned most of the relevant results. newEntityRecognizerEvaluationMetrics :: EntityRecognizerEvaluationMetrics -- | A measure of how accurate the recognizer results are for the test -- data. It is derived from the Precision and Recall -- values. The F1Score is the harmonic average of the two -- scores. For plain text entity recognizer models, the range is 0 to -- 100, where 100 is the best score. For PDF/Word entity recognizer -- models, the range is 0 to 1, where 1 is the best score. entityRecognizerEvaluationMetrics_f1Score :: Lens' EntityRecognizerEvaluationMetrics (Maybe Double) -- | A measure of the usefulness of the recognizer results in the test -- data. High precision means that the recognizer returned substantially -- more relevant results than irrelevant ones. entityRecognizerEvaluationMetrics_precision :: Lens' EntityRecognizerEvaluationMetrics (Maybe Double) -- | A measure of how complete the recognizer results are for the test -- data. High recall means that the recognizer returned most of the -- relevant results. entityRecognizerEvaluationMetrics_recall :: Lens' EntityRecognizerEvaluationMetrics (Maybe Double) instance GHC.Generics.Generic Amazonka.Comprehend.Types.EntityRecognizerEvaluationMetrics.EntityRecognizerEvaluationMetrics instance GHC.Show.Show Amazonka.Comprehend.Types.EntityRecognizerEvaluationMetrics.EntityRecognizerEvaluationMetrics instance GHC.Read.Read Amazonka.Comprehend.Types.EntityRecognizerEvaluationMetrics.EntityRecognizerEvaluationMetrics instance GHC.Classes.Eq Amazonka.Comprehend.Types.EntityRecognizerEvaluationMetrics.EntityRecognizerEvaluationMetrics instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.EntityRecognizerEvaluationMetrics.EntityRecognizerEvaluationMetrics instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.EntityRecognizerEvaluationMetrics.EntityRecognizerEvaluationMetrics instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.EntityRecognizerEvaluationMetrics.EntityRecognizerEvaluationMetrics module Amazonka.Comprehend.Types.EntityType newtype EntityType EntityType' :: Text -> EntityType [fromEntityType] :: EntityType -> Text pattern EntityType_COMMERCIAL_ITEM :: EntityType pattern EntityType_DATE :: EntityType pattern EntityType_EVENT :: EntityType pattern EntityType_LOCATION :: EntityType pattern EntityType_ORGANIZATION :: EntityType pattern EntityType_OTHER :: EntityType pattern EntityType_PERSON :: EntityType pattern EntityType_QUANTITY :: EntityType pattern EntityType_TITLE :: EntityType instance Amazonka.Data.XML.ToXML Amazonka.Comprehend.Types.EntityType.EntityType instance Amazonka.Data.XML.FromXML Amazonka.Comprehend.Types.EntityType.EntityType instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.Comprehend.Types.EntityType.EntityType instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.EntityType.EntityType instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.Comprehend.Types.EntityType.EntityType instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.EntityType.EntityType instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.Types.EntityType.EntityType instance Amazonka.Data.Headers.ToHeader Amazonka.Comprehend.Types.EntityType.EntityType instance Amazonka.Data.Log.ToLog Amazonka.Comprehend.Types.EntityType.EntityType instance Amazonka.Data.ByteString.ToByteString Amazonka.Comprehend.Types.EntityType.EntityType instance Amazonka.Data.Text.ToText Amazonka.Comprehend.Types.EntityType.EntityType instance Amazonka.Data.Text.FromText Amazonka.Comprehend.Types.EntityType.EntityType instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.EntityType.EntityType instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.EntityType.EntityType instance GHC.Generics.Generic Amazonka.Comprehend.Types.EntityType.EntityType instance GHC.Classes.Ord Amazonka.Comprehend.Types.EntityType.EntityType instance GHC.Classes.Eq Amazonka.Comprehend.Types.EntityType.EntityType instance GHC.Read.Read Amazonka.Comprehend.Types.EntityType.EntityType instance GHC.Show.Show Amazonka.Comprehend.Types.EntityType.EntityType module Amazonka.Comprehend.Types.Entity -- | Provides information about an entity. -- -- See: newEntity smart constructor. data Entity Entity' :: Maybe Int -> Maybe [BlockReference] -> Maybe Int -> Maybe Double -> Maybe Text -> Maybe EntityType -> Entity -- | The zero-based offset from the beginning of the source text to the -- first character in the entity. -- -- This field is empty for non-text input. [$sel:beginOffset:Entity'] :: Entity -> Maybe Int -- | A reference to each block for this entity. This field is empty for -- plain-text input. [$sel:blockReferences:Entity'] :: Entity -> Maybe [BlockReference] -- | The zero-based offset from the beginning of the source text to the -- last character in the entity. -- -- This field is empty for non-text input. [$sel:endOffset:Entity'] :: Entity -> Maybe Int -- | The level of confidence that Amazon Comprehend has in the accuracy of -- the detection. [$sel:score:Entity'] :: Entity -> Maybe Double -- | The text of the entity. [$sel:text:Entity'] :: Entity -> Maybe Text -- | The entity type. For entity detection using the built-in model, this -- field contains one of the standard entity types listed below. -- -- For custom entity detection, this field contains one of the entity -- types that you specified when you trained your custom model. [$sel:type':Entity'] :: Entity -> Maybe EntityType -- | Create a value of Entity with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- Entity, entity_beginOffset - The zero-based offset from -- the beginning of the source text to the first character in the entity. -- -- This field is empty for non-text input. -- -- $sel:blockReferences:Entity', entity_blockReferences - A -- reference to each block for this entity. This field is empty for -- plain-text input. -- -- Entity, entity_endOffset - The zero-based offset from -- the beginning of the source text to the last character in the entity. -- -- This field is empty for non-text input. -- -- $sel:score:Entity', entity_score - The level of -- confidence that Amazon Comprehend has in the accuracy of the -- detection. -- -- $sel:text:Entity', entity_text - The text of the entity. -- -- $sel:type':Entity', entity_type - The entity type. For -- entity detection using the built-in model, this field contains one of -- the standard entity types listed below. -- -- For custom entity detection, this field contains one of the entity -- types that you specified when you trained your custom model. newEntity :: Entity -- | The zero-based offset from the beginning of the source text to the -- first character in the entity. -- -- This field is empty for non-text input. entity_beginOffset :: Lens' Entity (Maybe Int) -- | A reference to each block for this entity. This field is empty for -- plain-text input. entity_blockReferences :: Lens' Entity (Maybe [BlockReference]) -- | The zero-based offset from the beginning of the source text to the -- last character in the entity. -- -- This field is empty for non-text input. entity_endOffset :: Lens' Entity (Maybe Int) -- | The level of confidence that Amazon Comprehend has in the accuracy of -- the detection. entity_score :: Lens' Entity (Maybe Double) -- | The text of the entity. entity_text :: Lens' Entity (Maybe Text) -- | The entity type. For entity detection using the built-in model, this -- field contains one of the standard entity types listed below. -- -- For custom entity detection, this field contains one of the entity -- types that you specified when you trained your custom model. entity_type :: Lens' Entity (Maybe EntityType) instance GHC.Generics.Generic Amazonka.Comprehend.Types.Entity.Entity instance GHC.Show.Show Amazonka.Comprehend.Types.Entity.Entity instance GHC.Read.Read Amazonka.Comprehend.Types.Entity.Entity instance GHC.Classes.Eq Amazonka.Comprehend.Types.Entity.Entity instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.Entity.Entity instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.Entity.Entity instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.Entity.Entity module Amazonka.Comprehend.Types.BatchDetectEntitiesItemResult -- | The result of calling the operation. The operation returns one object -- for each document that is successfully processed by the operation. -- -- See: newBatchDetectEntitiesItemResult smart constructor. data BatchDetectEntitiesItemResult BatchDetectEntitiesItemResult' :: Maybe [Entity] -> Maybe Int -> BatchDetectEntitiesItemResult -- | One or more Entity objects, one for each entity detected in the -- document. [$sel:entities:BatchDetectEntitiesItemResult'] :: BatchDetectEntitiesItemResult -> Maybe [Entity] -- | The zero-based index of the document in the input list. [$sel:index:BatchDetectEntitiesItemResult'] :: BatchDetectEntitiesItemResult -> Maybe Int -- | Create a value of BatchDetectEntitiesItemResult with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:entities:BatchDetectEntitiesItemResult', -- batchDetectEntitiesItemResult_entities - One or more Entity -- objects, one for each entity detected in the document. -- -- $sel:index:BatchDetectEntitiesItemResult', -- batchDetectEntitiesItemResult_index - The zero-based index of -- the document in the input list. newBatchDetectEntitiesItemResult :: BatchDetectEntitiesItemResult -- | One or more Entity objects, one for each entity detected in the -- document. batchDetectEntitiesItemResult_entities :: Lens' BatchDetectEntitiesItemResult (Maybe [Entity]) -- | The zero-based index of the document in the input list. batchDetectEntitiesItemResult_index :: Lens' BatchDetectEntitiesItemResult (Maybe Int) instance GHC.Generics.Generic Amazonka.Comprehend.Types.BatchDetectEntitiesItemResult.BatchDetectEntitiesItemResult instance GHC.Show.Show Amazonka.Comprehend.Types.BatchDetectEntitiesItemResult.BatchDetectEntitiesItemResult instance GHC.Read.Read Amazonka.Comprehend.Types.BatchDetectEntitiesItemResult.BatchDetectEntitiesItemResult instance GHC.Classes.Eq Amazonka.Comprehend.Types.BatchDetectEntitiesItemResult.BatchDetectEntitiesItemResult instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.BatchDetectEntitiesItemResult.BatchDetectEntitiesItemResult instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.BatchDetectEntitiesItemResult.BatchDetectEntitiesItemResult instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.BatchDetectEntitiesItemResult.BatchDetectEntitiesItemResult module Amazonka.Comprehend.Types.EntityTypesEvaluationMetrics -- | Detailed information about the accuracy of an entity recognizer for a -- specific entity type. -- -- See: newEntityTypesEvaluationMetrics smart constructor. data EntityTypesEvaluationMetrics EntityTypesEvaluationMetrics' :: Maybe Double -> Maybe Double -> Maybe Double -> EntityTypesEvaluationMetrics -- | A measure of how accurate the recognizer results are for a specific -- entity type in the test data. It is derived from the -- Precision and Recall values. The F1Score is -- the harmonic average of the two scores. The highest score is 1, and -- the worst score is 0. [$sel:f1Score:EntityTypesEvaluationMetrics'] :: EntityTypesEvaluationMetrics -> Maybe Double -- | A measure of the usefulness of the recognizer results for a specific -- entity type in the test data. High precision means that the recognizer -- returned substantially more relevant results than irrelevant ones. [$sel:precision:EntityTypesEvaluationMetrics'] :: EntityTypesEvaluationMetrics -> Maybe Double -- | A measure of how complete the recognizer results are for a specific -- entity type in the test data. High recall means that the recognizer -- returned most of the relevant results. [$sel:recall:EntityTypesEvaluationMetrics'] :: EntityTypesEvaluationMetrics -> Maybe Double -- | Create a value of EntityTypesEvaluationMetrics with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:f1Score:EntityTypesEvaluationMetrics', -- entityTypesEvaluationMetrics_f1Score - A measure of how -- accurate the recognizer results are for a specific entity type in the -- test data. It is derived from the Precision and -- Recall values. The F1Score is the harmonic average -- of the two scores. The highest score is 1, and the worst score is 0. -- -- $sel:precision:EntityTypesEvaluationMetrics', -- entityTypesEvaluationMetrics_precision - A measure of the -- usefulness of the recognizer results for a specific entity type in the -- test data. High precision means that the recognizer returned -- substantially more relevant results than irrelevant ones. -- -- $sel:recall:EntityTypesEvaluationMetrics', -- entityTypesEvaluationMetrics_recall - A measure of how complete -- the recognizer results are for a specific entity type in the test -- data. High recall means that the recognizer returned most of the -- relevant results. newEntityTypesEvaluationMetrics :: EntityTypesEvaluationMetrics -- | A measure of how accurate the recognizer results are for a specific -- entity type in the test data. It is derived from the -- Precision and Recall values. The F1Score is -- the harmonic average of the two scores. The highest score is 1, and -- the worst score is 0. entityTypesEvaluationMetrics_f1Score :: Lens' EntityTypesEvaluationMetrics (Maybe Double) -- | A measure of the usefulness of the recognizer results for a specific -- entity type in the test data. High precision means that the recognizer -- returned substantially more relevant results than irrelevant ones. entityTypesEvaluationMetrics_precision :: Lens' EntityTypesEvaluationMetrics (Maybe Double) -- | A measure of how complete the recognizer results are for a specific -- entity type in the test data. High recall means that the recognizer -- returned most of the relevant results. entityTypesEvaluationMetrics_recall :: Lens' EntityTypesEvaluationMetrics (Maybe Double) instance GHC.Generics.Generic Amazonka.Comprehend.Types.EntityTypesEvaluationMetrics.EntityTypesEvaluationMetrics instance GHC.Show.Show Amazonka.Comprehend.Types.EntityTypesEvaluationMetrics.EntityTypesEvaluationMetrics instance GHC.Read.Read Amazonka.Comprehend.Types.EntityTypesEvaluationMetrics.EntityTypesEvaluationMetrics instance GHC.Classes.Eq Amazonka.Comprehend.Types.EntityTypesEvaluationMetrics.EntityTypesEvaluationMetrics instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.EntityTypesEvaluationMetrics.EntityTypesEvaluationMetrics instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.EntityTypesEvaluationMetrics.EntityTypesEvaluationMetrics instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.EntityTypesEvaluationMetrics.EntityTypesEvaluationMetrics module Amazonka.Comprehend.Types.EntityRecognizerMetadataEntityTypesListItem -- | Individual item from the list of entity types in the metadata of an -- entity recognizer. -- -- See: newEntityRecognizerMetadataEntityTypesListItem -- smart constructor. data EntityRecognizerMetadataEntityTypesListItem EntityRecognizerMetadataEntityTypesListItem' :: Maybe EntityTypesEvaluationMetrics -> Maybe Int -> Maybe Text -> EntityRecognizerMetadataEntityTypesListItem -- | Detailed information about the accuracy of the entity recognizer for a -- specific item on the list of entity types. [$sel:evaluationMetrics:EntityRecognizerMetadataEntityTypesListItem'] :: EntityRecognizerMetadataEntityTypesListItem -> Maybe EntityTypesEvaluationMetrics -- | Indicates the number of times the given entity type was seen in the -- training data. [$sel:numberOfTrainMentions:EntityRecognizerMetadataEntityTypesListItem'] :: EntityRecognizerMetadataEntityTypesListItem -> Maybe Int -- | Type of entity from the list of entity types in the metadata of an -- entity recognizer. [$sel:type':EntityRecognizerMetadataEntityTypesListItem'] :: EntityRecognizerMetadataEntityTypesListItem -> Maybe Text -- | Create a value of EntityRecognizerMetadataEntityTypesListItem -- with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:evaluationMetrics:EntityRecognizerMetadataEntityTypesListItem', -- entityRecognizerMetadataEntityTypesListItem_evaluationMetrics - -- Detailed information about the accuracy of the entity recognizer for a -- specific item on the list of entity types. -- -- -- $sel:numberOfTrainMentions:EntityRecognizerMetadataEntityTypesListItem', -- entityRecognizerMetadataEntityTypesListItem_numberOfTrainMentions -- - Indicates the number of times the given entity type was seen in the -- training data. -- -- $sel:type':EntityRecognizerMetadataEntityTypesListItem', -- entityRecognizerMetadataEntityTypesListItem_type - Type of -- entity from the list of entity types in the metadata of an entity -- recognizer. newEntityRecognizerMetadataEntityTypesListItem :: EntityRecognizerMetadataEntityTypesListItem -- | Detailed information about the accuracy of the entity recognizer for a -- specific item on the list of entity types. entityRecognizerMetadataEntityTypesListItem_evaluationMetrics :: Lens' EntityRecognizerMetadataEntityTypesListItem (Maybe EntityTypesEvaluationMetrics) -- | Indicates the number of times the given entity type was seen in the -- training data. entityRecognizerMetadataEntityTypesListItem_numberOfTrainMentions :: Lens' EntityRecognizerMetadataEntityTypesListItem (Maybe Int) -- | Type of entity from the list of entity types in the metadata of an -- entity recognizer. entityRecognizerMetadataEntityTypesListItem_type :: Lens' EntityRecognizerMetadataEntityTypesListItem (Maybe Text) instance GHC.Generics.Generic Amazonka.Comprehend.Types.EntityRecognizerMetadataEntityTypesListItem.EntityRecognizerMetadataEntityTypesListItem instance GHC.Show.Show Amazonka.Comprehend.Types.EntityRecognizerMetadataEntityTypesListItem.EntityRecognizerMetadataEntityTypesListItem instance GHC.Read.Read Amazonka.Comprehend.Types.EntityRecognizerMetadataEntityTypesListItem.EntityRecognizerMetadataEntityTypesListItem instance GHC.Classes.Eq Amazonka.Comprehend.Types.EntityRecognizerMetadataEntityTypesListItem.EntityRecognizerMetadataEntityTypesListItem instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.EntityRecognizerMetadataEntityTypesListItem.EntityRecognizerMetadataEntityTypesListItem instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.EntityRecognizerMetadataEntityTypesListItem.EntityRecognizerMetadataEntityTypesListItem instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.EntityRecognizerMetadataEntityTypesListItem.EntityRecognizerMetadataEntityTypesListItem module Amazonka.Comprehend.Types.EntityRecognizerMetadata -- | Detailed information about an entity recognizer. -- -- See: newEntityRecognizerMetadata smart constructor. data EntityRecognizerMetadata EntityRecognizerMetadata' :: Maybe [EntityRecognizerMetadataEntityTypesListItem] -> Maybe EntityRecognizerEvaluationMetrics -> Maybe Int -> Maybe Int -> EntityRecognizerMetadata -- | Entity types from the metadata of an entity recognizer. [$sel:entityTypes:EntityRecognizerMetadata'] :: EntityRecognizerMetadata -> Maybe [EntityRecognizerMetadataEntityTypesListItem] -- | Detailed information about the accuracy of an entity recognizer. [$sel:evaluationMetrics:EntityRecognizerMetadata'] :: EntityRecognizerMetadata -> Maybe EntityRecognizerEvaluationMetrics -- | The number of documents in the input data that were used to test the -- entity recognizer. Typically this is 10 to 20 percent of the input -- documents. [$sel:numberOfTestDocuments:EntityRecognizerMetadata'] :: EntityRecognizerMetadata -> Maybe Int -- | The number of documents in the input data that were used to train the -- entity recognizer. Typically this is 80 to 90 percent of the input -- documents. [$sel:numberOfTrainedDocuments:EntityRecognizerMetadata'] :: EntityRecognizerMetadata -> Maybe Int -- | Create a value of EntityRecognizerMetadata with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:entityTypes:EntityRecognizerMetadata', -- entityRecognizerMetadata_entityTypes - Entity types from the -- metadata of an entity recognizer. -- -- EntityRecognizerMetadata, -- entityRecognizerMetadata_evaluationMetrics - Detailed -- information about the accuracy of an entity recognizer. -- -- $sel:numberOfTestDocuments:EntityRecognizerMetadata', -- entityRecognizerMetadata_numberOfTestDocuments - The number of -- documents in the input data that were used to test the entity -- recognizer. Typically this is 10 to 20 percent of the input documents. -- -- $sel:numberOfTrainedDocuments:EntityRecognizerMetadata', -- entityRecognizerMetadata_numberOfTrainedDocuments - The number -- of documents in the input data that were used to train the entity -- recognizer. Typically this is 80 to 90 percent of the input documents. newEntityRecognizerMetadata :: EntityRecognizerMetadata -- | Entity types from the metadata of an entity recognizer. entityRecognizerMetadata_entityTypes :: Lens' EntityRecognizerMetadata (Maybe [EntityRecognizerMetadataEntityTypesListItem]) -- | Detailed information about the accuracy of an entity recognizer. entityRecognizerMetadata_evaluationMetrics :: Lens' EntityRecognizerMetadata (Maybe EntityRecognizerEvaluationMetrics) -- | The number of documents in the input data that were used to test the -- entity recognizer. Typically this is 10 to 20 percent of the input -- documents. entityRecognizerMetadata_numberOfTestDocuments :: Lens' EntityRecognizerMetadata (Maybe Int) -- | The number of documents in the input data that were used to train the -- entity recognizer. Typically this is 80 to 90 percent of the input -- documents. entityRecognizerMetadata_numberOfTrainedDocuments :: Lens' EntityRecognizerMetadata (Maybe Int) instance GHC.Generics.Generic Amazonka.Comprehend.Types.EntityRecognizerMetadata.EntityRecognizerMetadata instance GHC.Show.Show Amazonka.Comprehend.Types.EntityRecognizerMetadata.EntityRecognizerMetadata instance GHC.Classes.Eq Amazonka.Comprehend.Types.EntityRecognizerMetadata.EntityRecognizerMetadata instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.EntityRecognizerMetadata.EntityRecognizerMetadata instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.EntityRecognizerMetadata.EntityRecognizerMetadata instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.EntityRecognizerMetadata.EntityRecognizerMetadata module Amazonka.Comprehend.Types.EntityTypesListItem -- | An entity type within a labeled training dataset that Amazon -- Comprehend uses to train a custom entity recognizer. -- -- See: newEntityTypesListItem smart constructor. data EntityTypesListItem EntityTypesListItem' :: Text -> EntityTypesListItem -- | An entity type within a labeled training dataset that Amazon -- Comprehend uses to train a custom entity recognizer. -- -- Entity types must not contain the following invalid characters: \n -- (line break), \\n (escaped line break, \r (carriage return), \\r -- (escaped carriage return), \t (tab), \\t (escaped tab), space, and , -- (comma). [$sel:type':EntityTypesListItem'] :: EntityTypesListItem -> Text -- | Create a value of EntityTypesListItem with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:type':EntityTypesListItem', -- entityTypesListItem_type - An entity type within a labeled -- training dataset that Amazon Comprehend uses to train a custom entity -- recognizer. -- -- Entity types must not contain the following invalid characters: \n -- (line break), \\n (escaped line break, \r (carriage return), \\r -- (escaped carriage return), \t (tab), \\t (escaped tab), space, and , -- (comma). newEntityTypesListItem :: Text -> EntityTypesListItem -- | An entity type within a labeled training dataset that Amazon -- Comprehend uses to train a custom entity recognizer. -- -- Entity types must not contain the following invalid characters: \n -- (line break), \\n (escaped line break, \r (carriage return), \\r -- (escaped carriage return), \t (tab), \\t (escaped tab), space, and , -- (comma). entityTypesListItem_type :: Lens' EntityTypesListItem Text instance GHC.Generics.Generic Amazonka.Comprehend.Types.EntityTypesListItem.EntityTypesListItem instance GHC.Show.Show Amazonka.Comprehend.Types.EntityTypesListItem.EntityTypesListItem instance GHC.Read.Read Amazonka.Comprehend.Types.EntityTypesListItem.EntityTypesListItem instance GHC.Classes.Eq Amazonka.Comprehend.Types.EntityTypesListItem.EntityTypesListItem instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.EntityTypesListItem.EntityTypesListItem instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.EntityTypesListItem.EntityTypesListItem instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.EntityTypesListItem.EntityTypesListItem instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.EntityTypesListItem.EntityTypesListItem module Amazonka.Comprehend.Types.ExtractedCharactersListItem -- | Array of the number of characters extracted from each page. -- -- See: newExtractedCharactersListItem smart constructor. data ExtractedCharactersListItem ExtractedCharactersListItem' :: Maybe Int -> Maybe Int -> ExtractedCharactersListItem -- | Number of characters extracted from each page. [$sel:count:ExtractedCharactersListItem'] :: ExtractedCharactersListItem -> Maybe Int -- | Page number. [$sel:page:ExtractedCharactersListItem'] :: ExtractedCharactersListItem -> Maybe Int -- | Create a value of ExtractedCharactersListItem with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:count:ExtractedCharactersListItem', -- extractedCharactersListItem_count - Number of characters -- extracted from each page. -- -- $sel:page:ExtractedCharactersListItem', -- extractedCharactersListItem_page - Page number. newExtractedCharactersListItem :: ExtractedCharactersListItem -- | Number of characters extracted from each page. extractedCharactersListItem_count :: Lens' ExtractedCharactersListItem (Maybe Int) -- | Page number. extractedCharactersListItem_page :: Lens' ExtractedCharactersListItem (Maybe Int) instance GHC.Generics.Generic Amazonka.Comprehend.Types.ExtractedCharactersListItem.ExtractedCharactersListItem instance GHC.Show.Show Amazonka.Comprehend.Types.ExtractedCharactersListItem.ExtractedCharactersListItem instance GHC.Read.Read Amazonka.Comprehend.Types.ExtractedCharactersListItem.ExtractedCharactersListItem instance GHC.Classes.Eq Amazonka.Comprehend.Types.ExtractedCharactersListItem.ExtractedCharactersListItem instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.ExtractedCharactersListItem.ExtractedCharactersListItem instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.ExtractedCharactersListItem.ExtractedCharactersListItem instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.ExtractedCharactersListItem.ExtractedCharactersListItem module Amazonka.Comprehend.Types.DocumentMetadata -- | Information about the document, discovered during text extraction. -- -- See: newDocumentMetadata smart constructor. data DocumentMetadata DocumentMetadata' :: Maybe [ExtractedCharactersListItem] -> Maybe Int -> DocumentMetadata -- | List of pages in the document, with the number of characters extracted -- from each page. [$sel:extractedCharacters:DocumentMetadata'] :: DocumentMetadata -> Maybe [ExtractedCharactersListItem] -- | Number of pages in the document. [$sel:pages:DocumentMetadata'] :: DocumentMetadata -> Maybe Int -- | Create a value of DocumentMetadata with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:extractedCharacters:DocumentMetadata', -- documentMetadata_extractedCharacters - List of pages in the -- document, with the number of characters extracted from each page. -- -- $sel:pages:DocumentMetadata', documentMetadata_pages - -- Number of pages in the document. newDocumentMetadata :: DocumentMetadata -- | List of pages in the document, with the number of characters extracted -- from each page. documentMetadata_extractedCharacters :: Lens' DocumentMetadata (Maybe [ExtractedCharactersListItem]) -- | Number of pages in the document. documentMetadata_pages :: Lens' DocumentMetadata (Maybe Int) instance GHC.Generics.Generic Amazonka.Comprehend.Types.DocumentMetadata.DocumentMetadata instance GHC.Show.Show Amazonka.Comprehend.Types.DocumentMetadata.DocumentMetadata instance GHC.Read.Read Amazonka.Comprehend.Types.DocumentMetadata.DocumentMetadata instance GHC.Classes.Eq Amazonka.Comprehend.Types.DocumentMetadata.DocumentMetadata instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.DocumentMetadata.DocumentMetadata instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.DocumentMetadata.DocumentMetadata instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.DocumentMetadata.DocumentMetadata module Amazonka.Comprehend.Types.InputFormat newtype InputFormat InputFormat' :: Text -> InputFormat [fromInputFormat] :: InputFormat -> Text pattern InputFormat_ONE_DOC_PER_FILE :: InputFormat pattern InputFormat_ONE_DOC_PER_LINE :: InputFormat instance Amazonka.Data.XML.ToXML Amazonka.Comprehend.Types.InputFormat.InputFormat instance Amazonka.Data.XML.FromXML Amazonka.Comprehend.Types.InputFormat.InputFormat instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.Comprehend.Types.InputFormat.InputFormat instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.InputFormat.InputFormat instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.Comprehend.Types.InputFormat.InputFormat instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.InputFormat.InputFormat instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.Types.InputFormat.InputFormat instance Amazonka.Data.Headers.ToHeader Amazonka.Comprehend.Types.InputFormat.InputFormat instance Amazonka.Data.Log.ToLog Amazonka.Comprehend.Types.InputFormat.InputFormat instance Amazonka.Data.ByteString.ToByteString Amazonka.Comprehend.Types.InputFormat.InputFormat instance Amazonka.Data.Text.ToText Amazonka.Comprehend.Types.InputFormat.InputFormat instance Amazonka.Data.Text.FromText Amazonka.Comprehend.Types.InputFormat.InputFormat instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.InputFormat.InputFormat instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.InputFormat.InputFormat instance GHC.Generics.Generic Amazonka.Comprehend.Types.InputFormat.InputFormat instance GHC.Classes.Ord Amazonka.Comprehend.Types.InputFormat.InputFormat instance GHC.Classes.Eq Amazonka.Comprehend.Types.InputFormat.InputFormat instance GHC.Read.Read Amazonka.Comprehend.Types.InputFormat.InputFormat instance GHC.Show.Show Amazonka.Comprehend.Types.InputFormat.InputFormat module Amazonka.Comprehend.Types.InputDataConfig -- | The input properties for an inference job. The document reader config -- field applies only to non-text inputs for custom analysis. -- -- See: newInputDataConfig smart constructor. data InputDataConfig InputDataConfig' :: Maybe DocumentReaderConfig -> Maybe InputFormat -> Text -> InputDataConfig -- | Provides configuration parameters to override the default actions for -- extracting text from PDF documents and image files. [$sel:documentReaderConfig:InputDataConfig'] :: InputDataConfig -> Maybe DocumentReaderConfig -- | Specifies how the text in an input file should be processed: -- -- [$sel:inputFormat:InputDataConfig'] :: InputDataConfig -> Maybe InputFormat -- | The Amazon S3 URI for the input data. The URI must be in same region -- as the API endpoint that you are calling. The URI can point to a -- single input file or it can provide the prefix for a collection of -- data files. -- -- For example, if you use the URI S3://bucketName/prefix, if -- the prefix is a single file, Amazon Comprehend uses that file as -- input. If more than one file begins with the prefix, Amazon Comprehend -- uses all of them as input. [$sel:s3Uri:InputDataConfig'] :: InputDataConfig -> Text -- | Create a value of InputDataConfig with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:documentReaderConfig:InputDataConfig', -- inputDataConfig_documentReaderConfig - Provides configuration -- parameters to override the default actions for extracting text from -- PDF documents and image files. -- -- $sel:inputFormat:InputDataConfig', -- inputDataConfig_inputFormat - Specifies how the text in an -- input file should be processed: -- -- -- -- $sel:s3Uri:InputDataConfig', inputDataConfig_s3Uri - The -- Amazon S3 URI for the input data. The URI must be in same region as -- the API endpoint that you are calling. The URI can point to a single -- input file or it can provide the prefix for a collection of data -- files. -- -- For example, if you use the URI S3://bucketName/prefix, if -- the prefix is a single file, Amazon Comprehend uses that file as -- input. If more than one file begins with the prefix, Amazon Comprehend -- uses all of them as input. newInputDataConfig :: Text -> InputDataConfig -- | Provides configuration parameters to override the default actions for -- extracting text from PDF documents and image files. inputDataConfig_documentReaderConfig :: Lens' InputDataConfig (Maybe DocumentReaderConfig) -- | Specifies how the text in an input file should be processed: -- -- inputDataConfig_inputFormat :: Lens' InputDataConfig (Maybe InputFormat) -- | The Amazon S3 URI for the input data. The URI must be in same region -- as the API endpoint that you are calling. The URI can point to a -- single input file or it can provide the prefix for a collection of -- data files. -- -- For example, if you use the URI S3://bucketName/prefix, if -- the prefix is a single file, Amazon Comprehend uses that file as -- input. If more than one file begins with the prefix, Amazon Comprehend -- uses all of them as input. inputDataConfig_s3Uri :: Lens' InputDataConfig Text instance GHC.Generics.Generic Amazonka.Comprehend.Types.InputDataConfig.InputDataConfig instance GHC.Show.Show Amazonka.Comprehend.Types.InputDataConfig.InputDataConfig instance GHC.Read.Read Amazonka.Comprehend.Types.InputDataConfig.InputDataConfig instance GHC.Classes.Eq Amazonka.Comprehend.Types.InputDataConfig.InputDataConfig instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.InputDataConfig.InputDataConfig instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.InputDataConfig.InputDataConfig instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.InputDataConfig.InputDataConfig instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.InputDataConfig.InputDataConfig module Amazonka.Comprehend.Types.EntityRecognizerDocuments -- | Describes the training documents submitted with an entity recognizer. -- -- See: newEntityRecognizerDocuments smart constructor. data EntityRecognizerDocuments EntityRecognizerDocuments' :: Maybe InputFormat -> Maybe Text -> Text -> EntityRecognizerDocuments -- | Specifies how the text in an input file should be processed. This is -- optional, and the default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each -- file is considered a separate document. Use this option when you are -- processing large documents, such as newspaper articles or scientific -- papers. ONE_DOC_PER_LINE - Each line in a file is considered a -- separate document. Use this option when you are processing many short -- documents, such as text messages. [$sel:inputFormat:EntityRecognizerDocuments'] :: EntityRecognizerDocuments -> Maybe InputFormat -- | Specifies the Amazon S3 location where the test documents for an -- entity recognizer are located. The URI must be in the same AWS Region -- as the API endpoint that you are calling. [$sel:testS3Uri:EntityRecognizerDocuments'] :: EntityRecognizerDocuments -> Maybe Text -- | Specifies the Amazon S3 location where the training documents for an -- entity recognizer are located. The URI must be in the same region as -- the API endpoint that you are calling. [$sel:s3Uri:EntityRecognizerDocuments'] :: EntityRecognizerDocuments -> Text -- | Create a value of EntityRecognizerDocuments with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:inputFormat:EntityRecognizerDocuments', -- entityRecognizerDocuments_inputFormat - Specifies how the text -- in an input file should be processed. This is optional, and the -- default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is -- considered a separate document. Use this option when you are -- processing large documents, such as newspaper articles or scientific -- papers. ONE_DOC_PER_LINE - Each line in a file is considered a -- separate document. Use this option when you are processing many short -- documents, such as text messages. -- -- $sel:testS3Uri:EntityRecognizerDocuments', -- entityRecognizerDocuments_testS3Uri - Specifies the Amazon S3 -- location where the test documents for an entity recognizer are -- located. The URI must be in the same AWS Region as the API endpoint -- that you are calling. -- -- $sel:s3Uri:EntityRecognizerDocuments', -- entityRecognizerDocuments_s3Uri - Specifies the Amazon S3 -- location where the training documents for an entity recognizer are -- located. The URI must be in the same region as the API endpoint that -- you are calling. newEntityRecognizerDocuments :: Text -> EntityRecognizerDocuments -- | Specifies how the text in an input file should be processed. This is -- optional, and the default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each -- file is considered a separate document. Use this option when you are -- processing large documents, such as newspaper articles or scientific -- papers. ONE_DOC_PER_LINE - Each line in a file is considered a -- separate document. Use this option when you are processing many short -- documents, such as text messages. entityRecognizerDocuments_inputFormat :: Lens' EntityRecognizerDocuments (Maybe InputFormat) -- | Specifies the Amazon S3 location where the test documents for an -- entity recognizer are located. The URI must be in the same AWS Region -- as the API endpoint that you are calling. entityRecognizerDocuments_testS3Uri :: Lens' EntityRecognizerDocuments (Maybe Text) -- | Specifies the Amazon S3 location where the training documents for an -- entity recognizer are located. The URI must be in the same region as -- the API endpoint that you are calling. entityRecognizerDocuments_s3Uri :: Lens' EntityRecognizerDocuments Text instance GHC.Generics.Generic Amazonka.Comprehend.Types.EntityRecognizerDocuments.EntityRecognizerDocuments instance GHC.Show.Show Amazonka.Comprehend.Types.EntityRecognizerDocuments.EntityRecognizerDocuments instance GHC.Read.Read Amazonka.Comprehend.Types.EntityRecognizerDocuments.EntityRecognizerDocuments instance GHC.Classes.Eq Amazonka.Comprehend.Types.EntityRecognizerDocuments.EntityRecognizerDocuments instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.EntityRecognizerDocuments.EntityRecognizerDocuments instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.EntityRecognizerDocuments.EntityRecognizerDocuments instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.EntityRecognizerDocuments.EntityRecognizerDocuments instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.EntityRecognizerDocuments.EntityRecognizerDocuments module Amazonka.Comprehend.Types.JobStatus newtype JobStatus JobStatus' :: Text -> JobStatus [fromJobStatus] :: JobStatus -> Text pattern JobStatus_COMPLETED :: JobStatus pattern JobStatus_FAILED :: JobStatus pattern JobStatus_IN_PROGRESS :: JobStatus pattern JobStatus_STOPPED :: JobStatus pattern JobStatus_STOP_REQUESTED :: JobStatus pattern JobStatus_SUBMITTED :: JobStatus instance Amazonka.Data.XML.ToXML Amazonka.Comprehend.Types.JobStatus.JobStatus instance Amazonka.Data.XML.FromXML Amazonka.Comprehend.Types.JobStatus.JobStatus instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.Comprehend.Types.JobStatus.JobStatus instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.JobStatus.JobStatus instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.Comprehend.Types.JobStatus.JobStatus instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.JobStatus.JobStatus instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.Types.JobStatus.JobStatus instance Amazonka.Data.Headers.ToHeader Amazonka.Comprehend.Types.JobStatus.JobStatus instance Amazonka.Data.Log.ToLog Amazonka.Comprehend.Types.JobStatus.JobStatus instance Amazonka.Data.ByteString.ToByteString Amazonka.Comprehend.Types.JobStatus.JobStatus instance Amazonka.Data.Text.ToText Amazonka.Comprehend.Types.JobStatus.JobStatus instance Amazonka.Data.Text.FromText Amazonka.Comprehend.Types.JobStatus.JobStatus instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.JobStatus.JobStatus instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.JobStatus.JobStatus instance GHC.Generics.Generic Amazonka.Comprehend.Types.JobStatus.JobStatus instance GHC.Classes.Ord Amazonka.Comprehend.Types.JobStatus.JobStatus instance GHC.Classes.Eq Amazonka.Comprehend.Types.JobStatus.JobStatus instance GHC.Read.Read Amazonka.Comprehend.Types.JobStatus.JobStatus instance GHC.Show.Show Amazonka.Comprehend.Types.JobStatus.JobStatus module Amazonka.Comprehend.Types.EventsDetectionJobFilter -- | Provides information for filtering a list of event detection jobs. -- -- See: newEventsDetectionJobFilter smart constructor. data EventsDetectionJobFilter EventsDetectionJobFilter' :: Maybe Text -> Maybe JobStatus -> Maybe POSIX -> Maybe POSIX -> EventsDetectionJobFilter -- | Filters on the name of the events detection job. [$sel:jobName:EventsDetectionJobFilter'] :: EventsDetectionJobFilter -> Maybe Text -- | Filters the list of jobs based on job status. Returns only jobs with -- the specified status. [$sel:jobStatus:EventsDetectionJobFilter'] :: EventsDetectionJobFilter -> Maybe JobStatus -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. [$sel:submitTimeAfter:EventsDetectionJobFilter'] :: EventsDetectionJobFilter -> Maybe POSIX -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. [$sel:submitTimeBefore:EventsDetectionJobFilter'] :: EventsDetectionJobFilter -> Maybe POSIX -- | Create a value of EventsDetectionJobFilter with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:jobName:EventsDetectionJobFilter', -- eventsDetectionJobFilter_jobName - Filters on the name of the -- events detection job. -- -- $sel:jobStatus:EventsDetectionJobFilter', -- eventsDetectionJobFilter_jobStatus - Filters the list of jobs -- based on job status. Returns only jobs with the specified status. -- -- $sel:submitTimeAfter:EventsDetectionJobFilter', -- eventsDetectionJobFilter_submitTimeAfter - Filters the list of -- jobs based on the time that the job was submitted for processing. -- Returns only jobs submitted after the specified time. Jobs are -- returned in descending order, newest to oldest. -- -- $sel:submitTimeBefore:EventsDetectionJobFilter', -- eventsDetectionJobFilter_submitTimeBefore - Filters the list of -- jobs based on the time that the job was submitted for processing. -- Returns only jobs submitted before the specified time. Jobs are -- returned in ascending order, oldest to newest. newEventsDetectionJobFilter :: EventsDetectionJobFilter -- | Filters on the name of the events detection job. eventsDetectionJobFilter_jobName :: Lens' EventsDetectionJobFilter (Maybe Text) -- | Filters the list of jobs based on job status. Returns only jobs with -- the specified status. eventsDetectionJobFilter_jobStatus :: Lens' EventsDetectionJobFilter (Maybe JobStatus) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. eventsDetectionJobFilter_submitTimeAfter :: Lens' EventsDetectionJobFilter (Maybe UTCTime) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. eventsDetectionJobFilter_submitTimeBefore :: Lens' EventsDetectionJobFilter (Maybe UTCTime) instance GHC.Generics.Generic Amazonka.Comprehend.Types.EventsDetectionJobFilter.EventsDetectionJobFilter instance GHC.Show.Show Amazonka.Comprehend.Types.EventsDetectionJobFilter.EventsDetectionJobFilter instance GHC.Read.Read Amazonka.Comprehend.Types.EventsDetectionJobFilter.EventsDetectionJobFilter instance GHC.Classes.Eq Amazonka.Comprehend.Types.EventsDetectionJobFilter.EventsDetectionJobFilter instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.EventsDetectionJobFilter.EventsDetectionJobFilter instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.EventsDetectionJobFilter.EventsDetectionJobFilter instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.EventsDetectionJobFilter.EventsDetectionJobFilter module Amazonka.Comprehend.Types.EntitiesDetectionJobFilter -- | Provides information for filtering a list of dominant language -- detection jobs. For more information, see the operation. -- -- See: newEntitiesDetectionJobFilter smart constructor. data EntitiesDetectionJobFilter EntitiesDetectionJobFilter' :: Maybe Text -> Maybe JobStatus -> Maybe POSIX -> Maybe POSIX -> EntitiesDetectionJobFilter -- | Filters on the name of the job. [$sel:jobName:EntitiesDetectionJobFilter'] :: EntitiesDetectionJobFilter -> Maybe Text -- | Filters the list of jobs based on job status. Returns only jobs with -- the specified status. [$sel:jobStatus:EntitiesDetectionJobFilter'] :: EntitiesDetectionJobFilter -> Maybe JobStatus -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. [$sel:submitTimeAfter:EntitiesDetectionJobFilter'] :: EntitiesDetectionJobFilter -> Maybe POSIX -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. [$sel:submitTimeBefore:EntitiesDetectionJobFilter'] :: EntitiesDetectionJobFilter -> Maybe POSIX -- | Create a value of EntitiesDetectionJobFilter with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:jobName:EntitiesDetectionJobFilter', -- entitiesDetectionJobFilter_jobName - Filters on the name of the -- job. -- -- $sel:jobStatus:EntitiesDetectionJobFilter', -- entitiesDetectionJobFilter_jobStatus - Filters the list of jobs -- based on job status. Returns only jobs with the specified status. -- -- $sel:submitTimeAfter:EntitiesDetectionJobFilter', -- entitiesDetectionJobFilter_submitTimeAfter - Filters the list -- of jobs based on the time that the job was submitted for processing. -- Returns only jobs submitted after the specified time. Jobs are -- returned in descending order, newest to oldest. -- -- $sel:submitTimeBefore:EntitiesDetectionJobFilter', -- entitiesDetectionJobFilter_submitTimeBefore - Filters the list -- of jobs based on the time that the job was submitted for processing. -- Returns only jobs submitted before the specified time. Jobs are -- returned in ascending order, oldest to newest. newEntitiesDetectionJobFilter :: EntitiesDetectionJobFilter -- | Filters on the name of the job. entitiesDetectionJobFilter_jobName :: Lens' EntitiesDetectionJobFilter (Maybe Text) -- | Filters the list of jobs based on job status. Returns only jobs with -- the specified status. entitiesDetectionJobFilter_jobStatus :: Lens' EntitiesDetectionJobFilter (Maybe JobStatus) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. entitiesDetectionJobFilter_submitTimeAfter :: Lens' EntitiesDetectionJobFilter (Maybe UTCTime) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. entitiesDetectionJobFilter_submitTimeBefore :: Lens' EntitiesDetectionJobFilter (Maybe UTCTime) instance GHC.Generics.Generic Amazonka.Comprehend.Types.EntitiesDetectionJobFilter.EntitiesDetectionJobFilter instance GHC.Show.Show Amazonka.Comprehend.Types.EntitiesDetectionJobFilter.EntitiesDetectionJobFilter instance GHC.Read.Read Amazonka.Comprehend.Types.EntitiesDetectionJobFilter.EntitiesDetectionJobFilter instance GHC.Classes.Eq Amazonka.Comprehend.Types.EntitiesDetectionJobFilter.EntitiesDetectionJobFilter instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.EntitiesDetectionJobFilter.EntitiesDetectionJobFilter instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.EntitiesDetectionJobFilter.EntitiesDetectionJobFilter instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.EntitiesDetectionJobFilter.EntitiesDetectionJobFilter module Amazonka.Comprehend.Types.DominantLanguageDetectionJobFilter -- | Provides information for filtering a list of dominant language -- detection jobs. For more information, see the operation. -- -- See: newDominantLanguageDetectionJobFilter smart -- constructor. data DominantLanguageDetectionJobFilter DominantLanguageDetectionJobFilter' :: Maybe Text -> Maybe JobStatus -> Maybe POSIX -> Maybe POSIX -> DominantLanguageDetectionJobFilter -- | Filters on the name of the job. [$sel:jobName:DominantLanguageDetectionJobFilter'] :: DominantLanguageDetectionJobFilter -> Maybe Text -- | Filters the list of jobs based on job status. Returns only jobs with -- the specified status. [$sel:jobStatus:DominantLanguageDetectionJobFilter'] :: DominantLanguageDetectionJobFilter -> Maybe JobStatus -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. [$sel:submitTimeAfter:DominantLanguageDetectionJobFilter'] :: DominantLanguageDetectionJobFilter -> Maybe POSIX -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. [$sel:submitTimeBefore:DominantLanguageDetectionJobFilter'] :: DominantLanguageDetectionJobFilter -> Maybe POSIX -- | Create a value of DominantLanguageDetectionJobFilter with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:jobName:DominantLanguageDetectionJobFilter', -- dominantLanguageDetectionJobFilter_jobName - Filters on the -- name of the job. -- -- $sel:jobStatus:DominantLanguageDetectionJobFilter', -- dominantLanguageDetectionJobFilter_jobStatus - Filters the list -- of jobs based on job status. Returns only jobs with the specified -- status. -- -- $sel:submitTimeAfter:DominantLanguageDetectionJobFilter', -- dominantLanguageDetectionJobFilter_submitTimeAfter - Filters -- the list of jobs based on the time that the job was submitted for -- processing. Returns only jobs submitted after the specified time. Jobs -- are returned in descending order, newest to oldest. -- -- $sel:submitTimeBefore:DominantLanguageDetectionJobFilter', -- dominantLanguageDetectionJobFilter_submitTimeBefore - Filters -- the list of jobs based on the time that the job was submitted for -- processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. newDominantLanguageDetectionJobFilter :: DominantLanguageDetectionJobFilter -- | Filters on the name of the job. dominantLanguageDetectionJobFilter_jobName :: Lens' DominantLanguageDetectionJobFilter (Maybe Text) -- | Filters the list of jobs based on job status. Returns only jobs with -- the specified status. dominantLanguageDetectionJobFilter_jobStatus :: Lens' DominantLanguageDetectionJobFilter (Maybe JobStatus) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. dominantLanguageDetectionJobFilter_submitTimeAfter :: Lens' DominantLanguageDetectionJobFilter (Maybe UTCTime) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. dominantLanguageDetectionJobFilter_submitTimeBefore :: Lens' DominantLanguageDetectionJobFilter (Maybe UTCTime) instance GHC.Generics.Generic Amazonka.Comprehend.Types.DominantLanguageDetectionJobFilter.DominantLanguageDetectionJobFilter instance GHC.Show.Show Amazonka.Comprehend.Types.DominantLanguageDetectionJobFilter.DominantLanguageDetectionJobFilter instance GHC.Read.Read Amazonka.Comprehend.Types.DominantLanguageDetectionJobFilter.DominantLanguageDetectionJobFilter instance GHC.Classes.Eq Amazonka.Comprehend.Types.DominantLanguageDetectionJobFilter.DominantLanguageDetectionJobFilter instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.DominantLanguageDetectionJobFilter.DominantLanguageDetectionJobFilter instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.DominantLanguageDetectionJobFilter.DominantLanguageDetectionJobFilter instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.DominantLanguageDetectionJobFilter.DominantLanguageDetectionJobFilter module Amazonka.Comprehend.Types.DocumentClassificationJobFilter -- | Provides information for filtering a list of document classification -- jobs. For more information, see the operation. You can provide only -- one filter parameter in each request. -- -- See: newDocumentClassificationJobFilter smart -- constructor. data DocumentClassificationJobFilter DocumentClassificationJobFilter' :: Maybe Text -> Maybe JobStatus -> Maybe POSIX -> Maybe POSIX -> DocumentClassificationJobFilter -- | Filters on the name of the job. [$sel:jobName:DocumentClassificationJobFilter'] :: DocumentClassificationJobFilter -> Maybe Text -- | Filters the list based on job status. Returns only jobs with the -- specified status. [$sel:jobStatus:DocumentClassificationJobFilter'] :: DocumentClassificationJobFilter -> Maybe JobStatus -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. [$sel:submitTimeAfter:DocumentClassificationJobFilter'] :: DocumentClassificationJobFilter -> Maybe POSIX -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. [$sel:submitTimeBefore:DocumentClassificationJobFilter'] :: DocumentClassificationJobFilter -> Maybe POSIX -- | Create a value of DocumentClassificationJobFilter with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:jobName:DocumentClassificationJobFilter', -- documentClassificationJobFilter_jobName - Filters on the name -- of the job. -- -- $sel:jobStatus:DocumentClassificationJobFilter', -- documentClassificationJobFilter_jobStatus - Filters the list -- based on job status. Returns only jobs with the specified status. -- -- $sel:submitTimeAfter:DocumentClassificationJobFilter', -- documentClassificationJobFilter_submitTimeAfter - Filters the -- list of jobs based on the time that the job was submitted for -- processing. Returns only jobs submitted after the specified time. Jobs -- are returned in descending order, newest to oldest. -- -- $sel:submitTimeBefore:DocumentClassificationJobFilter', -- documentClassificationJobFilter_submitTimeBefore - Filters the -- list of jobs based on the time that the job was submitted for -- processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. newDocumentClassificationJobFilter :: DocumentClassificationJobFilter -- | Filters on the name of the job. documentClassificationJobFilter_jobName :: Lens' DocumentClassificationJobFilter (Maybe Text) -- | Filters the list based on job status. Returns only jobs with the -- specified status. documentClassificationJobFilter_jobStatus :: Lens' DocumentClassificationJobFilter (Maybe JobStatus) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. documentClassificationJobFilter_submitTimeAfter :: Lens' DocumentClassificationJobFilter (Maybe UTCTime) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. documentClassificationJobFilter_submitTimeBefore :: Lens' DocumentClassificationJobFilter (Maybe UTCTime) instance GHC.Generics.Generic Amazonka.Comprehend.Types.DocumentClassificationJobFilter.DocumentClassificationJobFilter instance GHC.Show.Show Amazonka.Comprehend.Types.DocumentClassificationJobFilter.DocumentClassificationJobFilter instance GHC.Read.Read Amazonka.Comprehend.Types.DocumentClassificationJobFilter.DocumentClassificationJobFilter instance GHC.Classes.Eq Amazonka.Comprehend.Types.DocumentClassificationJobFilter.DocumentClassificationJobFilter instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.DocumentClassificationJobFilter.DocumentClassificationJobFilter instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.DocumentClassificationJobFilter.DocumentClassificationJobFilter instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.DocumentClassificationJobFilter.DocumentClassificationJobFilter module Amazonka.Comprehend.Types.KeyPhrase -- | Describes a key noun phrase. -- -- See: newKeyPhrase smart constructor. data KeyPhrase KeyPhrase' :: Maybe Int -> Maybe Int -> Maybe Double -> Maybe Text -> KeyPhrase -- | The zero-based offset from the beginning of the source text to the -- first character in the key phrase. [$sel:beginOffset:KeyPhrase'] :: KeyPhrase -> Maybe Int -- | The zero-based offset from the beginning of the source text to the -- last character in the key phrase. [$sel:endOffset:KeyPhrase'] :: KeyPhrase -> Maybe Int -- | The level of confidence that Amazon Comprehend has in the accuracy of -- the detection. [$sel:score:KeyPhrase'] :: KeyPhrase -> Maybe Double -- | The text of a key noun phrase. [$sel:text:KeyPhrase'] :: KeyPhrase -> Maybe Text -- | Create a value of KeyPhrase with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:beginOffset:KeyPhrase', keyPhrase_beginOffset - The -- zero-based offset from the beginning of the source text to the first -- character in the key phrase. -- -- $sel:endOffset:KeyPhrase', keyPhrase_endOffset - The -- zero-based offset from the beginning of the source text to the last -- character in the key phrase. -- -- $sel:score:KeyPhrase', keyPhrase_score - The level of -- confidence that Amazon Comprehend has in the accuracy of the -- detection. -- -- $sel:text:KeyPhrase', keyPhrase_text - The text of a key -- noun phrase. newKeyPhrase :: KeyPhrase -- | The zero-based offset from the beginning of the source text to the -- first character in the key phrase. keyPhrase_beginOffset :: Lens' KeyPhrase (Maybe Int) -- | The zero-based offset from the beginning of the source text to the -- last character in the key phrase. keyPhrase_endOffset :: Lens' KeyPhrase (Maybe Int) -- | The level of confidence that Amazon Comprehend has in the accuracy of -- the detection. keyPhrase_score :: Lens' KeyPhrase (Maybe Double) -- | The text of a key noun phrase. keyPhrase_text :: Lens' KeyPhrase (Maybe Text) instance GHC.Generics.Generic Amazonka.Comprehend.Types.KeyPhrase.KeyPhrase instance GHC.Show.Show Amazonka.Comprehend.Types.KeyPhrase.KeyPhrase instance GHC.Read.Read Amazonka.Comprehend.Types.KeyPhrase.KeyPhrase instance GHC.Classes.Eq Amazonka.Comprehend.Types.KeyPhrase.KeyPhrase instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.KeyPhrase.KeyPhrase instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.KeyPhrase.KeyPhrase instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.KeyPhrase.KeyPhrase module Amazonka.Comprehend.Types.BatchDetectKeyPhrasesItemResult -- | The result of calling the operation. The operation returns one object -- for each document that is successfully processed by the operation. -- -- See: newBatchDetectKeyPhrasesItemResult smart -- constructor. data BatchDetectKeyPhrasesItemResult BatchDetectKeyPhrasesItemResult' :: Maybe Int -> Maybe [KeyPhrase] -> BatchDetectKeyPhrasesItemResult -- | The zero-based index of the document in the input list. [$sel:index:BatchDetectKeyPhrasesItemResult'] :: BatchDetectKeyPhrasesItemResult -> Maybe Int -- | One or more KeyPhrase objects, one for each key phrase detected in the -- document. [$sel:keyPhrases:BatchDetectKeyPhrasesItemResult'] :: BatchDetectKeyPhrasesItemResult -> Maybe [KeyPhrase] -- | Create a value of BatchDetectKeyPhrasesItemResult with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:index:BatchDetectKeyPhrasesItemResult', -- batchDetectKeyPhrasesItemResult_index - The zero-based index of -- the document in the input list. -- -- $sel:keyPhrases:BatchDetectKeyPhrasesItemResult', -- batchDetectKeyPhrasesItemResult_keyPhrases - One or more -- KeyPhrase objects, one for each key phrase detected in the document. newBatchDetectKeyPhrasesItemResult :: BatchDetectKeyPhrasesItemResult -- | The zero-based index of the document in the input list. batchDetectKeyPhrasesItemResult_index :: Lens' BatchDetectKeyPhrasesItemResult (Maybe Int) -- | One or more KeyPhrase objects, one for each key phrase detected in the -- document. batchDetectKeyPhrasesItemResult_keyPhrases :: Lens' BatchDetectKeyPhrasesItemResult (Maybe [KeyPhrase]) instance GHC.Generics.Generic Amazonka.Comprehend.Types.BatchDetectKeyPhrasesItemResult.BatchDetectKeyPhrasesItemResult instance GHC.Show.Show Amazonka.Comprehend.Types.BatchDetectKeyPhrasesItemResult.BatchDetectKeyPhrasesItemResult instance GHC.Read.Read Amazonka.Comprehend.Types.BatchDetectKeyPhrasesItemResult.BatchDetectKeyPhrasesItemResult instance GHC.Classes.Eq Amazonka.Comprehend.Types.BatchDetectKeyPhrasesItemResult.BatchDetectKeyPhrasesItemResult instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.BatchDetectKeyPhrasesItemResult.BatchDetectKeyPhrasesItemResult instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.BatchDetectKeyPhrasesItemResult.BatchDetectKeyPhrasesItemResult instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.BatchDetectKeyPhrasesItemResult.BatchDetectKeyPhrasesItemResult module Amazonka.Comprehend.Types.KeyPhrasesDetectionJobFilter -- | Provides information for filtering a list of dominant language -- detection jobs. For more information, see the operation. -- -- See: newKeyPhrasesDetectionJobFilter smart constructor. data KeyPhrasesDetectionJobFilter KeyPhrasesDetectionJobFilter' :: Maybe Text -> Maybe JobStatus -> Maybe POSIX -> Maybe POSIX -> KeyPhrasesDetectionJobFilter -- | Filters on the name of the job. [$sel:jobName:KeyPhrasesDetectionJobFilter'] :: KeyPhrasesDetectionJobFilter -> Maybe Text -- | Filters the list of jobs based on job status. Returns only jobs with -- the specified status. [$sel:jobStatus:KeyPhrasesDetectionJobFilter'] :: KeyPhrasesDetectionJobFilter -> Maybe JobStatus -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. [$sel:submitTimeAfter:KeyPhrasesDetectionJobFilter'] :: KeyPhrasesDetectionJobFilter -> Maybe POSIX -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. [$sel:submitTimeBefore:KeyPhrasesDetectionJobFilter'] :: KeyPhrasesDetectionJobFilter -> Maybe POSIX -- | Create a value of KeyPhrasesDetectionJobFilter with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:jobName:KeyPhrasesDetectionJobFilter', -- keyPhrasesDetectionJobFilter_jobName - Filters on the name of -- the job. -- -- $sel:jobStatus:KeyPhrasesDetectionJobFilter', -- keyPhrasesDetectionJobFilter_jobStatus - Filters the list of -- jobs based on job status. Returns only jobs with the specified status. -- -- $sel:submitTimeAfter:KeyPhrasesDetectionJobFilter', -- keyPhrasesDetectionJobFilter_submitTimeAfter - Filters the list -- of jobs based on the time that the job was submitted for processing. -- Returns only jobs submitted after the specified time. Jobs are -- returned in descending order, newest to oldest. -- -- $sel:submitTimeBefore:KeyPhrasesDetectionJobFilter', -- keyPhrasesDetectionJobFilter_submitTimeBefore - Filters the -- list of jobs based on the time that the job was submitted for -- processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. newKeyPhrasesDetectionJobFilter :: KeyPhrasesDetectionJobFilter -- | Filters on the name of the job. keyPhrasesDetectionJobFilter_jobName :: Lens' KeyPhrasesDetectionJobFilter (Maybe Text) -- | Filters the list of jobs based on job status. Returns only jobs with -- the specified status. keyPhrasesDetectionJobFilter_jobStatus :: Lens' KeyPhrasesDetectionJobFilter (Maybe JobStatus) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. keyPhrasesDetectionJobFilter_submitTimeAfter :: Lens' KeyPhrasesDetectionJobFilter (Maybe UTCTime) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. keyPhrasesDetectionJobFilter_submitTimeBefore :: Lens' KeyPhrasesDetectionJobFilter (Maybe UTCTime) instance GHC.Generics.Generic Amazonka.Comprehend.Types.KeyPhrasesDetectionJobFilter.KeyPhrasesDetectionJobFilter instance GHC.Show.Show Amazonka.Comprehend.Types.KeyPhrasesDetectionJobFilter.KeyPhrasesDetectionJobFilter instance GHC.Read.Read Amazonka.Comprehend.Types.KeyPhrasesDetectionJobFilter.KeyPhrasesDetectionJobFilter instance GHC.Classes.Eq Amazonka.Comprehend.Types.KeyPhrasesDetectionJobFilter.KeyPhrasesDetectionJobFilter instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.KeyPhrasesDetectionJobFilter.KeyPhrasesDetectionJobFilter instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.KeyPhrasesDetectionJobFilter.KeyPhrasesDetectionJobFilter instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.KeyPhrasesDetectionJobFilter.KeyPhrasesDetectionJobFilter module Amazonka.Comprehend.Types.LanguageCode newtype LanguageCode LanguageCode' :: Text -> LanguageCode [fromLanguageCode] :: LanguageCode -> Text pattern LanguageCode_Ar :: LanguageCode pattern LanguageCode_De :: LanguageCode pattern LanguageCode_En :: LanguageCode pattern LanguageCode_Es :: LanguageCode pattern LanguageCode_Fr :: LanguageCode pattern LanguageCode_Hi :: LanguageCode pattern LanguageCode_It :: LanguageCode pattern LanguageCode_Ja :: LanguageCode pattern LanguageCode_Ko :: LanguageCode pattern LanguageCode_Pt :: LanguageCode pattern LanguageCode_Zh :: LanguageCode pattern LanguageCode_Zh_TW :: LanguageCode instance Amazonka.Data.XML.ToXML Amazonka.Comprehend.Types.LanguageCode.LanguageCode instance Amazonka.Data.XML.FromXML Amazonka.Comprehend.Types.LanguageCode.LanguageCode instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.Comprehend.Types.LanguageCode.LanguageCode instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.LanguageCode.LanguageCode instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.Comprehend.Types.LanguageCode.LanguageCode instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.LanguageCode.LanguageCode instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.Types.LanguageCode.LanguageCode instance Amazonka.Data.Headers.ToHeader Amazonka.Comprehend.Types.LanguageCode.LanguageCode instance Amazonka.Data.Log.ToLog Amazonka.Comprehend.Types.LanguageCode.LanguageCode instance Amazonka.Data.ByteString.ToByteString Amazonka.Comprehend.Types.LanguageCode.LanguageCode instance Amazonka.Data.Text.ToText Amazonka.Comprehend.Types.LanguageCode.LanguageCode instance Amazonka.Data.Text.FromText Amazonka.Comprehend.Types.LanguageCode.LanguageCode instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.LanguageCode.LanguageCode instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.LanguageCode.LanguageCode instance GHC.Generics.Generic Amazonka.Comprehend.Types.LanguageCode.LanguageCode instance GHC.Classes.Ord Amazonka.Comprehend.Types.LanguageCode.LanguageCode instance GHC.Classes.Eq Amazonka.Comprehend.Types.LanguageCode.LanguageCode instance GHC.Read.Read Amazonka.Comprehend.Types.LanguageCode.LanguageCode instance GHC.Show.Show Amazonka.Comprehend.Types.LanguageCode.LanguageCode module Amazonka.Comprehend.Types.ModelStatus newtype ModelStatus ModelStatus' :: Text -> ModelStatus [fromModelStatus] :: ModelStatus -> Text pattern ModelStatus_DELETING :: ModelStatus pattern ModelStatus_IN_ERROR :: ModelStatus pattern ModelStatus_STOPPED :: ModelStatus pattern ModelStatus_STOP_REQUESTED :: ModelStatus pattern ModelStatus_SUBMITTED :: ModelStatus pattern ModelStatus_TRAINED :: ModelStatus pattern ModelStatus_TRAINING :: ModelStatus instance Amazonka.Data.XML.ToXML Amazonka.Comprehend.Types.ModelStatus.ModelStatus instance Amazonka.Data.XML.FromXML Amazonka.Comprehend.Types.ModelStatus.ModelStatus instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.Comprehend.Types.ModelStatus.ModelStatus instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.ModelStatus.ModelStatus instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.Comprehend.Types.ModelStatus.ModelStatus instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.ModelStatus.ModelStatus instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.Types.ModelStatus.ModelStatus instance Amazonka.Data.Headers.ToHeader Amazonka.Comprehend.Types.ModelStatus.ModelStatus instance Amazonka.Data.Log.ToLog Amazonka.Comprehend.Types.ModelStatus.ModelStatus instance Amazonka.Data.ByteString.ToByteString Amazonka.Comprehend.Types.ModelStatus.ModelStatus instance Amazonka.Data.Text.ToText Amazonka.Comprehend.Types.ModelStatus.ModelStatus instance Amazonka.Data.Text.FromText Amazonka.Comprehend.Types.ModelStatus.ModelStatus instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.ModelStatus.ModelStatus instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.ModelStatus.ModelStatus instance GHC.Generics.Generic Amazonka.Comprehend.Types.ModelStatus.ModelStatus instance GHC.Classes.Ord Amazonka.Comprehend.Types.ModelStatus.ModelStatus instance GHC.Classes.Eq Amazonka.Comprehend.Types.ModelStatus.ModelStatus instance GHC.Read.Read Amazonka.Comprehend.Types.ModelStatus.ModelStatus instance GHC.Show.Show Amazonka.Comprehend.Types.ModelStatus.ModelStatus module Amazonka.Comprehend.Types.EntityRecognizerSummary -- | Describes the information about an entity recognizer and its versions. -- -- See: newEntityRecognizerSummary smart constructor. data EntityRecognizerSummary EntityRecognizerSummary' :: Maybe POSIX -> Maybe Text -> Maybe ModelStatus -> Maybe Int -> Maybe Text -> EntityRecognizerSummary -- | The time that the latest entity recognizer version was submitted for -- processing. [$sel:latestVersionCreatedAt:EntityRecognizerSummary'] :: EntityRecognizerSummary -> Maybe POSIX -- | The version name you assigned to the latest entity recognizer version. [$sel:latestVersionName:EntityRecognizerSummary'] :: EntityRecognizerSummary -> Maybe Text -- | Provides the status of the latest entity recognizer version. [$sel:latestVersionStatus:EntityRecognizerSummary'] :: EntityRecognizerSummary -> Maybe ModelStatus -- | The number of versions you created. [$sel:numberOfVersions:EntityRecognizerSummary'] :: EntityRecognizerSummary -> Maybe Int -- | The name that you assigned the entity recognizer. [$sel:recognizerName:EntityRecognizerSummary'] :: EntityRecognizerSummary -> Maybe Text -- | Create a value of EntityRecognizerSummary with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:latestVersionCreatedAt:EntityRecognizerSummary', -- entityRecognizerSummary_latestVersionCreatedAt - The time that -- the latest entity recognizer version was submitted for processing. -- -- $sel:latestVersionName:EntityRecognizerSummary', -- entityRecognizerSummary_latestVersionName - The version name -- you assigned to the latest entity recognizer version. -- -- $sel:latestVersionStatus:EntityRecognizerSummary', -- entityRecognizerSummary_latestVersionStatus - Provides the -- status of the latest entity recognizer version. -- -- $sel:numberOfVersions:EntityRecognizerSummary', -- entityRecognizerSummary_numberOfVersions - The number of -- versions you created. -- -- $sel:recognizerName:EntityRecognizerSummary', -- entityRecognizerSummary_recognizerName - The name that you -- assigned the entity recognizer. newEntityRecognizerSummary :: EntityRecognizerSummary -- | The time that the latest entity recognizer version was submitted for -- processing. entityRecognizerSummary_latestVersionCreatedAt :: Lens' EntityRecognizerSummary (Maybe UTCTime) -- | The version name you assigned to the latest entity recognizer version. entityRecognizerSummary_latestVersionName :: Lens' EntityRecognizerSummary (Maybe Text) -- | Provides the status of the latest entity recognizer version. entityRecognizerSummary_latestVersionStatus :: Lens' EntityRecognizerSummary (Maybe ModelStatus) -- | The number of versions you created. entityRecognizerSummary_numberOfVersions :: Lens' EntityRecognizerSummary (Maybe Int) -- | The name that you assigned the entity recognizer. entityRecognizerSummary_recognizerName :: Lens' EntityRecognizerSummary (Maybe Text) instance GHC.Generics.Generic Amazonka.Comprehend.Types.EntityRecognizerSummary.EntityRecognizerSummary instance GHC.Show.Show Amazonka.Comprehend.Types.EntityRecognizerSummary.EntityRecognizerSummary instance GHC.Read.Read Amazonka.Comprehend.Types.EntityRecognizerSummary.EntityRecognizerSummary instance GHC.Classes.Eq Amazonka.Comprehend.Types.EntityRecognizerSummary.EntityRecognizerSummary instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.EntityRecognizerSummary.EntityRecognizerSummary instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.EntityRecognizerSummary.EntityRecognizerSummary instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.EntityRecognizerSummary.EntityRecognizerSummary module Amazonka.Comprehend.Types.EntityRecognizerFilter -- | Provides information for filtering a list of entity recognizers. You -- can only specify one filtering parameter in a request. For more -- information, see the operation./> -- -- See: newEntityRecognizerFilter smart constructor. data EntityRecognizerFilter EntityRecognizerFilter' :: Maybe Text -> Maybe ModelStatus -> Maybe POSIX -> Maybe POSIX -> EntityRecognizerFilter -- | The name that you assigned the entity recognizer. [$sel:recognizerName:EntityRecognizerFilter'] :: EntityRecognizerFilter -> Maybe Text -- | The status of an entity recognizer. [$sel:status:EntityRecognizerFilter'] :: EntityRecognizerFilter -> Maybe ModelStatus -- | Filters the list of entities based on the time that the list was -- submitted for processing. Returns only jobs submitted after the -- specified time. Jobs are returned in ascending order, oldest to -- newest. [$sel:submitTimeAfter:EntityRecognizerFilter'] :: EntityRecognizerFilter -> Maybe POSIX -- | Filters the list of entities based on the time that the list was -- submitted for processing. Returns only jobs submitted before the -- specified time. Jobs are returned in descending order, newest to -- oldest. [$sel:submitTimeBefore:EntityRecognizerFilter'] :: EntityRecognizerFilter -> Maybe POSIX -- | Create a value of EntityRecognizerFilter with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:recognizerName:EntityRecognizerFilter', -- entityRecognizerFilter_recognizerName - The name that you -- assigned the entity recognizer. -- -- $sel:status:EntityRecognizerFilter', -- entityRecognizerFilter_status - The status of an entity -- recognizer. -- -- $sel:submitTimeAfter:EntityRecognizerFilter', -- entityRecognizerFilter_submitTimeAfter - Filters the list of -- entities based on the time that the list was submitted for processing. -- Returns only jobs submitted after the specified time. Jobs are -- returned in ascending order, oldest to newest. -- -- $sel:submitTimeBefore:EntityRecognizerFilter', -- entityRecognizerFilter_submitTimeBefore - Filters the list of -- entities based on the time that the list was submitted for processing. -- Returns only jobs submitted before the specified time. Jobs are -- returned in descending order, newest to oldest. newEntityRecognizerFilter :: EntityRecognizerFilter -- | The name that you assigned the entity recognizer. entityRecognizerFilter_recognizerName :: Lens' EntityRecognizerFilter (Maybe Text) -- | The status of an entity recognizer. entityRecognizerFilter_status :: Lens' EntityRecognizerFilter (Maybe ModelStatus) -- | Filters the list of entities based on the time that the list was -- submitted for processing. Returns only jobs submitted after the -- specified time. Jobs are returned in ascending order, oldest to -- newest. entityRecognizerFilter_submitTimeAfter :: Lens' EntityRecognizerFilter (Maybe UTCTime) -- | Filters the list of entities based on the time that the list was -- submitted for processing. Returns only jobs submitted before the -- specified time. Jobs are returned in descending order, newest to -- oldest. entityRecognizerFilter_submitTimeBefore :: Lens' EntityRecognizerFilter (Maybe UTCTime) instance GHC.Generics.Generic Amazonka.Comprehend.Types.EntityRecognizerFilter.EntityRecognizerFilter instance GHC.Show.Show Amazonka.Comprehend.Types.EntityRecognizerFilter.EntityRecognizerFilter instance GHC.Read.Read Amazonka.Comprehend.Types.EntityRecognizerFilter.EntityRecognizerFilter instance GHC.Classes.Eq Amazonka.Comprehend.Types.EntityRecognizerFilter.EntityRecognizerFilter instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.EntityRecognizerFilter.EntityRecognizerFilter instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.EntityRecognizerFilter.EntityRecognizerFilter instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.EntityRecognizerFilter.EntityRecognizerFilter module Amazonka.Comprehend.Types.DocumentClassifierSummary -- | Describes information about a document classifier and its versions. -- -- See: newDocumentClassifierSummary smart constructor. data DocumentClassifierSummary DocumentClassifierSummary' :: Maybe Text -> Maybe POSIX -> Maybe Text -> Maybe ModelStatus -> Maybe Int -> DocumentClassifierSummary -- | The name that you assigned the document classifier. [$sel:documentClassifierName:DocumentClassifierSummary'] :: DocumentClassifierSummary -> Maybe Text -- | The time that the latest document classifier version was submitted for -- processing. [$sel:latestVersionCreatedAt:DocumentClassifierSummary'] :: DocumentClassifierSummary -> Maybe POSIX -- | The version name you assigned to the latest document classifier -- version. [$sel:latestVersionName:DocumentClassifierSummary'] :: DocumentClassifierSummary -> Maybe Text -- | Provides the status of the latest document classifier version. [$sel:latestVersionStatus:DocumentClassifierSummary'] :: DocumentClassifierSummary -> Maybe ModelStatus -- | The number of versions you created. [$sel:numberOfVersions:DocumentClassifierSummary'] :: DocumentClassifierSummary -> Maybe Int -- | Create a value of DocumentClassifierSummary with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:documentClassifierName:DocumentClassifierSummary', -- documentClassifierSummary_documentClassifierName - The name -- that you assigned the document classifier. -- -- $sel:latestVersionCreatedAt:DocumentClassifierSummary', -- documentClassifierSummary_latestVersionCreatedAt - The time -- that the latest document classifier version was submitted for -- processing. -- -- $sel:latestVersionName:DocumentClassifierSummary', -- documentClassifierSummary_latestVersionName - The version name -- you assigned to the latest document classifier version. -- -- $sel:latestVersionStatus:DocumentClassifierSummary', -- documentClassifierSummary_latestVersionStatus - Provides the -- status of the latest document classifier version. -- -- $sel:numberOfVersions:DocumentClassifierSummary', -- documentClassifierSummary_numberOfVersions - The number of -- versions you created. newDocumentClassifierSummary :: DocumentClassifierSummary -- | The name that you assigned the document classifier. documentClassifierSummary_documentClassifierName :: Lens' DocumentClassifierSummary (Maybe Text) -- | The time that the latest document classifier version was submitted for -- processing. documentClassifierSummary_latestVersionCreatedAt :: Lens' DocumentClassifierSummary (Maybe UTCTime) -- | The version name you assigned to the latest document classifier -- version. documentClassifierSummary_latestVersionName :: Lens' DocumentClassifierSummary (Maybe Text) -- | Provides the status of the latest document classifier version. documentClassifierSummary_latestVersionStatus :: Lens' DocumentClassifierSummary (Maybe ModelStatus) -- | The number of versions you created. documentClassifierSummary_numberOfVersions :: Lens' DocumentClassifierSummary (Maybe Int) instance GHC.Generics.Generic Amazonka.Comprehend.Types.DocumentClassifierSummary.DocumentClassifierSummary instance GHC.Show.Show Amazonka.Comprehend.Types.DocumentClassifierSummary.DocumentClassifierSummary instance GHC.Read.Read Amazonka.Comprehend.Types.DocumentClassifierSummary.DocumentClassifierSummary instance GHC.Classes.Eq Amazonka.Comprehend.Types.DocumentClassifierSummary.DocumentClassifierSummary instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.DocumentClassifierSummary.DocumentClassifierSummary instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.DocumentClassifierSummary.DocumentClassifierSummary instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.DocumentClassifierSummary.DocumentClassifierSummary module Amazonka.Comprehend.Types.DocumentClassifierFilter -- | Provides information for filtering a list of document classifiers. You -- can only specify one filtering parameter in a request. For more -- information, see the operation. -- -- See: newDocumentClassifierFilter smart constructor. data DocumentClassifierFilter DocumentClassifierFilter' :: Maybe Text -> Maybe ModelStatus -> Maybe POSIX -> Maybe POSIX -> DocumentClassifierFilter -- | The name that you assigned to the document classifier [$sel:documentClassifierName:DocumentClassifierFilter'] :: DocumentClassifierFilter -> Maybe Text -- | Filters the list of classifiers based on status. [$sel:status:DocumentClassifierFilter'] :: DocumentClassifierFilter -> Maybe ModelStatus -- | Filters the list of classifiers based on the time that the classifier -- was submitted for processing. Returns only classifiers submitted after -- the specified time. Classifiers are returned in descending order, -- newest to oldest. [$sel:submitTimeAfter:DocumentClassifierFilter'] :: DocumentClassifierFilter -> Maybe POSIX -- | Filters the list of classifiers based on the time that the classifier -- was submitted for processing. Returns only classifiers submitted -- before the specified time. Classifiers are returned in ascending -- order, oldest to newest. [$sel:submitTimeBefore:DocumentClassifierFilter'] :: DocumentClassifierFilter -> Maybe POSIX -- | Create a value of DocumentClassifierFilter with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:documentClassifierName:DocumentClassifierFilter', -- documentClassifierFilter_documentClassifierName - The name that -- you assigned to the document classifier -- -- $sel:status:DocumentClassifierFilter', -- documentClassifierFilter_status - Filters the list of -- classifiers based on status. -- -- $sel:submitTimeAfter:DocumentClassifierFilter', -- documentClassifierFilter_submitTimeAfter - Filters the list of -- classifiers based on the time that the classifier was submitted for -- processing. Returns only classifiers submitted after the specified -- time. Classifiers are returned in descending order, newest to oldest. -- -- $sel:submitTimeBefore:DocumentClassifierFilter', -- documentClassifierFilter_submitTimeBefore - Filters the list of -- classifiers based on the time that the classifier was submitted for -- processing. Returns only classifiers submitted before the specified -- time. Classifiers are returned in ascending order, oldest to newest. newDocumentClassifierFilter :: DocumentClassifierFilter -- | The name that you assigned to the document classifier documentClassifierFilter_documentClassifierName :: Lens' DocumentClassifierFilter (Maybe Text) -- | Filters the list of classifiers based on status. documentClassifierFilter_status :: Lens' DocumentClassifierFilter (Maybe ModelStatus) -- | Filters the list of classifiers based on the time that the classifier -- was submitted for processing. Returns only classifiers submitted after -- the specified time. Classifiers are returned in descending order, -- newest to oldest. documentClassifierFilter_submitTimeAfter :: Lens' DocumentClassifierFilter (Maybe UTCTime) -- | Filters the list of classifiers based on the time that the classifier -- was submitted for processing. Returns only classifiers submitted -- before the specified time. Classifiers are returned in ascending -- order, oldest to newest. documentClassifierFilter_submitTimeBefore :: Lens' DocumentClassifierFilter (Maybe UTCTime) instance GHC.Generics.Generic Amazonka.Comprehend.Types.DocumentClassifierFilter.DocumentClassifierFilter instance GHC.Show.Show Amazonka.Comprehend.Types.DocumentClassifierFilter.DocumentClassifierFilter instance GHC.Read.Read Amazonka.Comprehend.Types.DocumentClassifierFilter.DocumentClassifierFilter instance GHC.Classes.Eq Amazonka.Comprehend.Types.DocumentClassifierFilter.DocumentClassifierFilter instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.DocumentClassifierFilter.DocumentClassifierFilter instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.DocumentClassifierFilter.DocumentClassifierFilter instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.DocumentClassifierFilter.DocumentClassifierFilter module Amazonka.Comprehend.Types.OutputDataConfig -- | Provides configuration parameters for the output of inference jobs. -- -- See: newOutputDataConfig smart constructor. data OutputDataConfig OutputDataConfig' :: Maybe Text -> Text -> OutputDataConfig -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt the output results from an analysis job. The KmsKeyId -- can be one of the following formats: -- -- [$sel:kmsKeyId:OutputDataConfig'] :: OutputDataConfig -> Maybe Text -- | When you use the OutputDataConfig object with asynchronous -- operations, you specify the Amazon S3 location where you want to write -- the output data. The URI must be in the same region as the API -- endpoint that you are calling. The location is used as the prefix for -- the actual location of the output file. -- -- When the topic detection job is finished, the service creates an -- output file in a directory specific to the job. The S3Uri -- field contains the location of the output file, called -- output.tar.gz. It is a compressed archive that contains the -- ouput of the operation. -- -- For a PII entity detection job, the output file is plain text, not a -- compressed archive. The output file name is the same as the input -- file, with .out appended at the end. [$sel:s3Uri:OutputDataConfig'] :: OutputDataConfig -> Text -- | Create a value of OutputDataConfig with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:kmsKeyId:OutputDataConfig', -- outputDataConfig_kmsKeyId - ID for the AWS Key Management -- Service (KMS) key that Amazon Comprehend uses to encrypt the output -- results from an analysis job. The KmsKeyId can be one of the following -- formats: -- -- -- -- $sel:s3Uri:OutputDataConfig', outputDataConfig_s3Uri - -- When you use the OutputDataConfig object with asynchronous -- operations, you specify the Amazon S3 location where you want to write -- the output data. The URI must be in the same region as the API -- endpoint that you are calling. The location is used as the prefix for -- the actual location of the output file. -- -- When the topic detection job is finished, the service creates an -- output file in a directory specific to the job. The S3Uri -- field contains the location of the output file, called -- output.tar.gz. It is a compressed archive that contains the -- ouput of the operation. -- -- For a PII entity detection job, the output file is plain text, not a -- compressed archive. The output file name is the same as the input -- file, with .out appended at the end. newOutputDataConfig :: Text -> OutputDataConfig -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt the output results from an analysis job. The KmsKeyId -- can be one of the following formats: -- -- outputDataConfig_kmsKeyId :: Lens' OutputDataConfig (Maybe Text) -- | When you use the OutputDataConfig object with asynchronous -- operations, you specify the Amazon S3 location where you want to write -- the output data. The URI must be in the same region as the API -- endpoint that you are calling. The location is used as the prefix for -- the actual location of the output file. -- -- When the topic detection job is finished, the service creates an -- output file in a directory specific to the job. The S3Uri -- field contains the location of the output file, called -- output.tar.gz. It is a compressed archive that contains the -- ouput of the operation. -- -- For a PII entity detection job, the output file is plain text, not a -- compressed archive. The output file name is the same as the input -- file, with .out appended at the end. outputDataConfig_s3Uri :: Lens' OutputDataConfig Text instance GHC.Generics.Generic Amazonka.Comprehend.Types.OutputDataConfig.OutputDataConfig instance GHC.Show.Show Amazonka.Comprehend.Types.OutputDataConfig.OutputDataConfig instance GHC.Read.Read Amazonka.Comprehend.Types.OutputDataConfig.OutputDataConfig instance GHC.Classes.Eq Amazonka.Comprehend.Types.OutputDataConfig.OutputDataConfig instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.OutputDataConfig.OutputDataConfig instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.OutputDataConfig.OutputDataConfig instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.OutputDataConfig.OutputDataConfig instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.OutputDataConfig.OutputDataConfig module Amazonka.Comprehend.Types.EventsDetectionJobProperties -- | Provides information about an events detection job. -- -- See: newEventsDetectionJobProperties smart constructor. data EventsDetectionJobProperties EventsDetectionJobProperties' :: Maybe Text -> Maybe POSIX -> Maybe InputDataConfig -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe JobStatus -> Maybe LanguageCode -> Maybe Text -> Maybe OutputDataConfig -> Maybe POSIX -> Maybe (NonEmpty Text) -> EventsDetectionJobProperties -- | The Amazon Resource Name (ARN) of the AWS Identify and Access -- Management (IAM) role that grants Amazon Comprehend read access to -- your input data. [$sel:dataAccessRoleArn:EventsDetectionJobProperties'] :: EventsDetectionJobProperties -> Maybe Text -- | The time that the events detection job completed. [$sel:endTime:EventsDetectionJobProperties'] :: EventsDetectionJobProperties -> Maybe POSIX -- | The input data configuration that you supplied when you created the -- events detection job. [$sel:inputDataConfig:EventsDetectionJobProperties'] :: EventsDetectionJobProperties -> Maybe InputDataConfig -- | The Amazon Resource Name (ARN) of the events detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
--
[$sel:jobArn:EventsDetectionJobProperties'] :: EventsDetectionJobProperties -> Maybe Text -- | The identifier assigned to the events detection job. [$sel:jobId:EventsDetectionJobProperties'] :: EventsDetectionJobProperties -> Maybe Text -- | The name you assigned the events detection job. [$sel:jobName:EventsDetectionJobProperties'] :: EventsDetectionJobProperties -> Maybe Text -- | The current status of the events detection job. [$sel:jobStatus:EventsDetectionJobProperties'] :: EventsDetectionJobProperties -> Maybe JobStatus -- | The language code of the input documents. [$sel:languageCode:EventsDetectionJobProperties'] :: EventsDetectionJobProperties -> Maybe LanguageCode -- | A description of the status of the events detection job. [$sel:message:EventsDetectionJobProperties'] :: EventsDetectionJobProperties -> Maybe Text -- | The output data configuration that you supplied when you created the -- events detection job. [$sel:outputDataConfig:EventsDetectionJobProperties'] :: EventsDetectionJobProperties -> Maybe OutputDataConfig -- | The time that the events detection job was submitted for processing. [$sel:submitTime:EventsDetectionJobProperties'] :: EventsDetectionJobProperties -> Maybe POSIX -- | The types of events that are detected by the job. [$sel:targetEventTypes:EventsDetectionJobProperties'] :: EventsDetectionJobProperties -> Maybe (NonEmpty Text) -- | Create a value of EventsDetectionJobProperties with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:dataAccessRoleArn:EventsDetectionJobProperties', -- eventsDetectionJobProperties_dataAccessRoleArn - The Amazon -- Resource Name (ARN) of the AWS Identify and Access Management (IAM) -- role that grants Amazon Comprehend read access to your input data. -- -- $sel:endTime:EventsDetectionJobProperties', -- eventsDetectionJobProperties_endTime - The time that the events -- detection job completed. -- -- $sel:inputDataConfig:EventsDetectionJobProperties', -- eventsDetectionJobProperties_inputDataConfig - The input data -- configuration that you supplied when you created the events detection -- job. -- -- $sel:jobArn:EventsDetectionJobProperties', -- eventsDetectionJobProperties_jobArn - The Amazon Resource Name -- (ARN) of the events detection job. It is a unique, fully qualified -- identifier for the job. It includes the AWS account, Region, and the -- job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- $sel:jobId:EventsDetectionJobProperties', -- eventsDetectionJobProperties_jobId - The identifier assigned to -- the events detection job. -- -- $sel:jobName:EventsDetectionJobProperties', -- eventsDetectionJobProperties_jobName - The name you assigned -- the events detection job. -- -- $sel:jobStatus:EventsDetectionJobProperties', -- eventsDetectionJobProperties_jobStatus - The current status of -- the events detection job. -- -- $sel:languageCode:EventsDetectionJobProperties', -- eventsDetectionJobProperties_languageCode - The language code -- of the input documents. -- -- $sel:message:EventsDetectionJobProperties', -- eventsDetectionJobProperties_message - A description of the -- status of the events detection job. -- -- $sel:outputDataConfig:EventsDetectionJobProperties', -- eventsDetectionJobProperties_outputDataConfig - The output data -- configuration that you supplied when you created the events detection -- job. -- -- $sel:submitTime:EventsDetectionJobProperties', -- eventsDetectionJobProperties_submitTime - The time that the -- events detection job was submitted for processing. -- -- $sel:targetEventTypes:EventsDetectionJobProperties', -- eventsDetectionJobProperties_targetEventTypes - The types of -- events that are detected by the job. newEventsDetectionJobProperties :: EventsDetectionJobProperties -- | The Amazon Resource Name (ARN) of the AWS Identify and Access -- Management (IAM) role that grants Amazon Comprehend read access to -- your input data. eventsDetectionJobProperties_dataAccessRoleArn :: Lens' EventsDetectionJobProperties (Maybe Text) -- | The time that the events detection job completed. eventsDetectionJobProperties_endTime :: Lens' EventsDetectionJobProperties (Maybe UTCTime) -- | The input data configuration that you supplied when you created the -- events detection job. eventsDetectionJobProperties_inputDataConfig :: Lens' EventsDetectionJobProperties (Maybe InputDataConfig) -- | The Amazon Resource Name (ARN) of the events detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
--
eventsDetectionJobProperties_jobArn :: Lens' EventsDetectionJobProperties (Maybe Text) -- | The identifier assigned to the events detection job. eventsDetectionJobProperties_jobId :: Lens' EventsDetectionJobProperties (Maybe Text) -- | The name you assigned the events detection job. eventsDetectionJobProperties_jobName :: Lens' EventsDetectionJobProperties (Maybe Text) -- | The current status of the events detection job. eventsDetectionJobProperties_jobStatus :: Lens' EventsDetectionJobProperties (Maybe JobStatus) -- | The language code of the input documents. eventsDetectionJobProperties_languageCode :: Lens' EventsDetectionJobProperties (Maybe LanguageCode) -- | A description of the status of the events detection job. eventsDetectionJobProperties_message :: Lens' EventsDetectionJobProperties (Maybe Text) -- | The output data configuration that you supplied when you created the -- events detection job. eventsDetectionJobProperties_outputDataConfig :: Lens' EventsDetectionJobProperties (Maybe OutputDataConfig) -- | The time that the events detection job was submitted for processing. eventsDetectionJobProperties_submitTime :: Lens' EventsDetectionJobProperties (Maybe UTCTime) -- | The types of events that are detected by the job. eventsDetectionJobProperties_targetEventTypes :: Lens' EventsDetectionJobProperties (Maybe (NonEmpty Text)) instance GHC.Generics.Generic Amazonka.Comprehend.Types.EventsDetectionJobProperties.EventsDetectionJobProperties instance GHC.Show.Show Amazonka.Comprehend.Types.EventsDetectionJobProperties.EventsDetectionJobProperties instance GHC.Read.Read Amazonka.Comprehend.Types.EventsDetectionJobProperties.EventsDetectionJobProperties instance GHC.Classes.Eq Amazonka.Comprehend.Types.EventsDetectionJobProperties.EventsDetectionJobProperties instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.EventsDetectionJobProperties.EventsDetectionJobProperties instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.EventsDetectionJobProperties.EventsDetectionJobProperties instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.EventsDetectionJobProperties.EventsDetectionJobProperties module Amazonka.Comprehend.Types.PageBasedErrorCode newtype PageBasedErrorCode PageBasedErrorCode' :: Text -> PageBasedErrorCode [fromPageBasedErrorCode] :: PageBasedErrorCode -> Text pattern PageBasedErrorCode_INTERNAL_SERVER_ERROR :: PageBasedErrorCode pattern PageBasedErrorCode_PAGE_CHARACTERS_EXCEEDED :: PageBasedErrorCode pattern PageBasedErrorCode_PAGE_SIZE_EXCEEDED :: PageBasedErrorCode pattern PageBasedErrorCode_TEXTRACT_BAD_PAGE :: PageBasedErrorCode pattern PageBasedErrorCode_TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED :: PageBasedErrorCode instance Amazonka.Data.XML.ToXML Amazonka.Comprehend.Types.PageBasedErrorCode.PageBasedErrorCode instance Amazonka.Data.XML.FromXML Amazonka.Comprehend.Types.PageBasedErrorCode.PageBasedErrorCode instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.Comprehend.Types.PageBasedErrorCode.PageBasedErrorCode instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.PageBasedErrorCode.PageBasedErrorCode instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.Comprehend.Types.PageBasedErrorCode.PageBasedErrorCode instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.PageBasedErrorCode.PageBasedErrorCode instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.Types.PageBasedErrorCode.PageBasedErrorCode instance Amazonka.Data.Headers.ToHeader Amazonka.Comprehend.Types.PageBasedErrorCode.PageBasedErrorCode instance Amazonka.Data.Log.ToLog Amazonka.Comprehend.Types.PageBasedErrorCode.PageBasedErrorCode instance Amazonka.Data.ByteString.ToByteString Amazonka.Comprehend.Types.PageBasedErrorCode.PageBasedErrorCode instance Amazonka.Data.Text.ToText Amazonka.Comprehend.Types.PageBasedErrorCode.PageBasedErrorCode instance Amazonka.Data.Text.FromText Amazonka.Comprehend.Types.PageBasedErrorCode.PageBasedErrorCode instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.PageBasedErrorCode.PageBasedErrorCode instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.PageBasedErrorCode.PageBasedErrorCode instance GHC.Generics.Generic Amazonka.Comprehend.Types.PageBasedErrorCode.PageBasedErrorCode instance GHC.Classes.Ord Amazonka.Comprehend.Types.PageBasedErrorCode.PageBasedErrorCode instance GHC.Classes.Eq Amazonka.Comprehend.Types.PageBasedErrorCode.PageBasedErrorCode instance GHC.Read.Read Amazonka.Comprehend.Types.PageBasedErrorCode.PageBasedErrorCode instance GHC.Show.Show Amazonka.Comprehend.Types.PageBasedErrorCode.PageBasedErrorCode module Amazonka.Comprehend.Types.ErrorsListItem -- | Text extraction encountered one or more page-level errors in the input -- document. -- -- The ErrorCode contains one of the following values: -- -- -- -- See: newErrorsListItem smart constructor. data ErrorsListItem ErrorsListItem' :: Maybe PageBasedErrorCode -> Maybe Text -> Maybe Int -> ErrorsListItem -- | Error code for the cause of the error. [$sel:errorCode:ErrorsListItem'] :: ErrorsListItem -> Maybe PageBasedErrorCode -- | Text message explaining the reason for the error. [$sel:errorMessage:ErrorsListItem'] :: ErrorsListItem -> Maybe Text -- | Page number where the error occurred. [$sel:page:ErrorsListItem'] :: ErrorsListItem -> Maybe Int -- | Create a value of ErrorsListItem with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:errorCode:ErrorsListItem', errorsListItem_errorCode -- - Error code for the cause of the error. -- -- $sel:errorMessage:ErrorsListItem', -- errorsListItem_errorMessage - Text message explaining the -- reason for the error. -- -- $sel:page:ErrorsListItem', errorsListItem_page - Page -- number where the error occurred. newErrorsListItem :: ErrorsListItem -- | Error code for the cause of the error. errorsListItem_errorCode :: Lens' ErrorsListItem (Maybe PageBasedErrorCode) -- | Text message explaining the reason for the error. errorsListItem_errorMessage :: Lens' ErrorsListItem (Maybe Text) -- | Page number where the error occurred. errorsListItem_page :: Lens' ErrorsListItem (Maybe Int) instance GHC.Generics.Generic Amazonka.Comprehend.Types.ErrorsListItem.ErrorsListItem instance GHC.Show.Show Amazonka.Comprehend.Types.ErrorsListItem.ErrorsListItem instance GHC.Read.Read Amazonka.Comprehend.Types.ErrorsListItem.ErrorsListItem instance GHC.Classes.Eq Amazonka.Comprehend.Types.ErrorsListItem.ErrorsListItem instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.ErrorsListItem.ErrorsListItem instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.ErrorsListItem.ErrorsListItem instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.ErrorsListItem.ErrorsListItem module Amazonka.Comprehend.Types.PartOfSpeechTagType newtype PartOfSpeechTagType PartOfSpeechTagType' :: Text -> PartOfSpeechTagType [fromPartOfSpeechTagType] :: PartOfSpeechTagType -> Text pattern PartOfSpeechTagType_ADJ :: PartOfSpeechTagType pattern PartOfSpeechTagType_ADP :: PartOfSpeechTagType pattern PartOfSpeechTagType_ADV :: PartOfSpeechTagType pattern PartOfSpeechTagType_AUX :: PartOfSpeechTagType pattern PartOfSpeechTagType_CCONJ :: PartOfSpeechTagType pattern PartOfSpeechTagType_CONJ :: PartOfSpeechTagType pattern PartOfSpeechTagType_DET :: PartOfSpeechTagType pattern PartOfSpeechTagType_INTJ :: PartOfSpeechTagType pattern PartOfSpeechTagType_NOUN :: PartOfSpeechTagType pattern PartOfSpeechTagType_NUM :: PartOfSpeechTagType pattern PartOfSpeechTagType_O :: PartOfSpeechTagType pattern PartOfSpeechTagType_PART :: PartOfSpeechTagType pattern PartOfSpeechTagType_PRON :: PartOfSpeechTagType pattern PartOfSpeechTagType_PROPN :: PartOfSpeechTagType pattern PartOfSpeechTagType_PUNCT :: PartOfSpeechTagType pattern PartOfSpeechTagType_SCONJ :: PartOfSpeechTagType pattern PartOfSpeechTagType_SYM :: PartOfSpeechTagType pattern PartOfSpeechTagType_VERB :: PartOfSpeechTagType instance Amazonka.Data.XML.ToXML Amazonka.Comprehend.Types.PartOfSpeechTagType.PartOfSpeechTagType instance Amazonka.Data.XML.FromXML Amazonka.Comprehend.Types.PartOfSpeechTagType.PartOfSpeechTagType instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.Comprehend.Types.PartOfSpeechTagType.PartOfSpeechTagType instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.PartOfSpeechTagType.PartOfSpeechTagType instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.Comprehend.Types.PartOfSpeechTagType.PartOfSpeechTagType instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.PartOfSpeechTagType.PartOfSpeechTagType instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.Types.PartOfSpeechTagType.PartOfSpeechTagType instance Amazonka.Data.Headers.ToHeader Amazonka.Comprehend.Types.PartOfSpeechTagType.PartOfSpeechTagType instance Amazonka.Data.Log.ToLog Amazonka.Comprehend.Types.PartOfSpeechTagType.PartOfSpeechTagType instance Amazonka.Data.ByteString.ToByteString Amazonka.Comprehend.Types.PartOfSpeechTagType.PartOfSpeechTagType instance Amazonka.Data.Text.ToText Amazonka.Comprehend.Types.PartOfSpeechTagType.PartOfSpeechTagType instance Amazonka.Data.Text.FromText Amazonka.Comprehend.Types.PartOfSpeechTagType.PartOfSpeechTagType instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.PartOfSpeechTagType.PartOfSpeechTagType instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.PartOfSpeechTagType.PartOfSpeechTagType instance GHC.Generics.Generic Amazonka.Comprehend.Types.PartOfSpeechTagType.PartOfSpeechTagType instance GHC.Classes.Ord Amazonka.Comprehend.Types.PartOfSpeechTagType.PartOfSpeechTagType instance GHC.Classes.Eq Amazonka.Comprehend.Types.PartOfSpeechTagType.PartOfSpeechTagType instance GHC.Read.Read Amazonka.Comprehend.Types.PartOfSpeechTagType.PartOfSpeechTagType instance GHC.Show.Show Amazonka.Comprehend.Types.PartOfSpeechTagType.PartOfSpeechTagType module Amazonka.Comprehend.Types.PartOfSpeechTag -- | Identifies the part of speech represented by the token and gives the -- confidence that Amazon Comprehend has that the part of speech was -- correctly identified. For more information about the parts of speech -- that Amazon Comprehend can identify, see Syntax in the -- Comprehend Developer Guide. -- -- See: newPartOfSpeechTag smart constructor. data PartOfSpeechTag PartOfSpeechTag' :: Maybe Double -> Maybe PartOfSpeechTagType -> PartOfSpeechTag -- | The confidence that Amazon Comprehend has that the part of speech was -- correctly identified. [$sel:score:PartOfSpeechTag'] :: PartOfSpeechTag -> Maybe Double -- | Identifies the part of speech that the token represents. [$sel:tag:PartOfSpeechTag'] :: PartOfSpeechTag -> Maybe PartOfSpeechTagType -- | Create a value of PartOfSpeechTag with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:score:PartOfSpeechTag', partOfSpeechTag_score - The -- confidence that Amazon Comprehend has that the part of speech was -- correctly identified. -- -- $sel:tag:PartOfSpeechTag', partOfSpeechTag_tag - -- Identifies the part of speech that the token represents. newPartOfSpeechTag :: PartOfSpeechTag -- | The confidence that Amazon Comprehend has that the part of speech was -- correctly identified. partOfSpeechTag_score :: Lens' PartOfSpeechTag (Maybe Double) -- | Identifies the part of speech that the token represents. partOfSpeechTag_tag :: Lens' PartOfSpeechTag (Maybe PartOfSpeechTagType) instance GHC.Generics.Generic Amazonka.Comprehend.Types.PartOfSpeechTag.PartOfSpeechTag instance GHC.Show.Show Amazonka.Comprehend.Types.PartOfSpeechTag.PartOfSpeechTag instance GHC.Read.Read Amazonka.Comprehend.Types.PartOfSpeechTag.PartOfSpeechTag instance GHC.Classes.Eq Amazonka.Comprehend.Types.PartOfSpeechTag.PartOfSpeechTag instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.PartOfSpeechTag.PartOfSpeechTag instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.PartOfSpeechTag.PartOfSpeechTag instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.PartOfSpeechTag.PartOfSpeechTag module Amazonka.Comprehend.Types.PiiEntitiesDetectionJobFilter -- | Provides information for filtering a list of PII entity detection -- jobs. -- -- See: newPiiEntitiesDetectionJobFilter smart constructor. data PiiEntitiesDetectionJobFilter PiiEntitiesDetectionJobFilter' :: Maybe Text -> Maybe JobStatus -> Maybe POSIX -> Maybe POSIX -> PiiEntitiesDetectionJobFilter -- | Filters on the name of the job. [$sel:jobName:PiiEntitiesDetectionJobFilter'] :: PiiEntitiesDetectionJobFilter -> Maybe Text -- | Filters the list of jobs based on job status. Returns only jobs with -- the specified status. [$sel:jobStatus:PiiEntitiesDetectionJobFilter'] :: PiiEntitiesDetectionJobFilter -> Maybe JobStatus -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. [$sel:submitTimeAfter:PiiEntitiesDetectionJobFilter'] :: PiiEntitiesDetectionJobFilter -> Maybe POSIX -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. [$sel:submitTimeBefore:PiiEntitiesDetectionJobFilter'] :: PiiEntitiesDetectionJobFilter -> Maybe POSIX -- | Create a value of PiiEntitiesDetectionJobFilter with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:jobName:PiiEntitiesDetectionJobFilter', -- piiEntitiesDetectionJobFilter_jobName - Filters on the name of -- the job. -- -- $sel:jobStatus:PiiEntitiesDetectionJobFilter', -- piiEntitiesDetectionJobFilter_jobStatus - Filters the list of -- jobs based on job status. Returns only jobs with the specified status. -- -- $sel:submitTimeAfter:PiiEntitiesDetectionJobFilter', -- piiEntitiesDetectionJobFilter_submitTimeAfter - Filters the -- list of jobs based on the time that the job was submitted for -- processing. Returns only jobs submitted after the specified time. Jobs -- are returned in descending order, newest to oldest. -- -- $sel:submitTimeBefore:PiiEntitiesDetectionJobFilter', -- piiEntitiesDetectionJobFilter_submitTimeBefore - Filters the -- list of jobs based on the time that the job was submitted for -- processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. newPiiEntitiesDetectionJobFilter :: PiiEntitiesDetectionJobFilter -- | Filters on the name of the job. piiEntitiesDetectionJobFilter_jobName :: Lens' PiiEntitiesDetectionJobFilter (Maybe Text) -- | Filters the list of jobs based on job status. Returns only jobs with -- the specified status. piiEntitiesDetectionJobFilter_jobStatus :: Lens' PiiEntitiesDetectionJobFilter (Maybe JobStatus) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. piiEntitiesDetectionJobFilter_submitTimeAfter :: Lens' PiiEntitiesDetectionJobFilter (Maybe UTCTime) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. piiEntitiesDetectionJobFilter_submitTimeBefore :: Lens' PiiEntitiesDetectionJobFilter (Maybe UTCTime) instance GHC.Generics.Generic Amazonka.Comprehend.Types.PiiEntitiesDetectionJobFilter.PiiEntitiesDetectionJobFilter instance GHC.Show.Show Amazonka.Comprehend.Types.PiiEntitiesDetectionJobFilter.PiiEntitiesDetectionJobFilter instance GHC.Read.Read Amazonka.Comprehend.Types.PiiEntitiesDetectionJobFilter.PiiEntitiesDetectionJobFilter instance GHC.Classes.Eq Amazonka.Comprehend.Types.PiiEntitiesDetectionJobFilter.PiiEntitiesDetectionJobFilter instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.PiiEntitiesDetectionJobFilter.PiiEntitiesDetectionJobFilter instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.PiiEntitiesDetectionJobFilter.PiiEntitiesDetectionJobFilter instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.PiiEntitiesDetectionJobFilter.PiiEntitiesDetectionJobFilter module Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode newtype PiiEntitiesDetectionMaskMode PiiEntitiesDetectionMaskMode' :: Text -> PiiEntitiesDetectionMaskMode [fromPiiEntitiesDetectionMaskMode] :: PiiEntitiesDetectionMaskMode -> Text pattern PiiEntitiesDetectionMaskMode_MASK :: PiiEntitiesDetectionMaskMode pattern PiiEntitiesDetectionMaskMode_REPLACE_WITH_PII_ENTITY_TYPE :: PiiEntitiesDetectionMaskMode instance Amazonka.Data.XML.ToXML Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode.PiiEntitiesDetectionMaskMode instance Amazonka.Data.XML.FromXML Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode.PiiEntitiesDetectionMaskMode instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode.PiiEntitiesDetectionMaskMode instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode.PiiEntitiesDetectionMaskMode instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode.PiiEntitiesDetectionMaskMode instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode.PiiEntitiesDetectionMaskMode instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode.PiiEntitiesDetectionMaskMode instance Amazonka.Data.Headers.ToHeader Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode.PiiEntitiesDetectionMaskMode instance Amazonka.Data.Log.ToLog Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode.PiiEntitiesDetectionMaskMode instance Amazonka.Data.ByteString.ToByteString Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode.PiiEntitiesDetectionMaskMode instance Amazonka.Data.Text.ToText Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode.PiiEntitiesDetectionMaskMode instance Amazonka.Data.Text.FromText Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode.PiiEntitiesDetectionMaskMode instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode.PiiEntitiesDetectionMaskMode instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode.PiiEntitiesDetectionMaskMode instance GHC.Generics.Generic Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode.PiiEntitiesDetectionMaskMode instance GHC.Classes.Ord Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode.PiiEntitiesDetectionMaskMode instance GHC.Classes.Eq Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode.PiiEntitiesDetectionMaskMode instance GHC.Read.Read Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode.PiiEntitiesDetectionMaskMode instance GHC.Show.Show Amazonka.Comprehend.Types.PiiEntitiesDetectionMaskMode.PiiEntitiesDetectionMaskMode module Amazonka.Comprehend.Types.PiiEntitiesDetectionMode newtype PiiEntitiesDetectionMode PiiEntitiesDetectionMode' :: Text -> PiiEntitiesDetectionMode [fromPiiEntitiesDetectionMode] :: PiiEntitiesDetectionMode -> Text pattern PiiEntitiesDetectionMode_ONLY_OFFSETS :: PiiEntitiesDetectionMode pattern PiiEntitiesDetectionMode_ONLY_REDACTION :: PiiEntitiesDetectionMode instance Amazonka.Data.XML.ToXML Amazonka.Comprehend.Types.PiiEntitiesDetectionMode.PiiEntitiesDetectionMode instance Amazonka.Data.XML.FromXML Amazonka.Comprehend.Types.PiiEntitiesDetectionMode.PiiEntitiesDetectionMode instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.Comprehend.Types.PiiEntitiesDetectionMode.PiiEntitiesDetectionMode instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.PiiEntitiesDetectionMode.PiiEntitiesDetectionMode instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.Comprehend.Types.PiiEntitiesDetectionMode.PiiEntitiesDetectionMode instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.PiiEntitiesDetectionMode.PiiEntitiesDetectionMode instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.Types.PiiEntitiesDetectionMode.PiiEntitiesDetectionMode instance Amazonka.Data.Headers.ToHeader Amazonka.Comprehend.Types.PiiEntitiesDetectionMode.PiiEntitiesDetectionMode instance Amazonka.Data.Log.ToLog Amazonka.Comprehend.Types.PiiEntitiesDetectionMode.PiiEntitiesDetectionMode instance Amazonka.Data.ByteString.ToByteString Amazonka.Comprehend.Types.PiiEntitiesDetectionMode.PiiEntitiesDetectionMode instance Amazonka.Data.Text.ToText Amazonka.Comprehend.Types.PiiEntitiesDetectionMode.PiiEntitiesDetectionMode instance Amazonka.Data.Text.FromText Amazonka.Comprehend.Types.PiiEntitiesDetectionMode.PiiEntitiesDetectionMode instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.PiiEntitiesDetectionMode.PiiEntitiesDetectionMode instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.PiiEntitiesDetectionMode.PiiEntitiesDetectionMode instance GHC.Generics.Generic Amazonka.Comprehend.Types.PiiEntitiesDetectionMode.PiiEntitiesDetectionMode instance GHC.Classes.Ord Amazonka.Comprehend.Types.PiiEntitiesDetectionMode.PiiEntitiesDetectionMode instance GHC.Classes.Eq Amazonka.Comprehend.Types.PiiEntitiesDetectionMode.PiiEntitiesDetectionMode instance GHC.Read.Read Amazonka.Comprehend.Types.PiiEntitiesDetectionMode.PiiEntitiesDetectionMode instance GHC.Show.Show Amazonka.Comprehend.Types.PiiEntitiesDetectionMode.PiiEntitiesDetectionMode module Amazonka.Comprehend.Types.PiiEntityType newtype PiiEntityType PiiEntityType' :: Text -> PiiEntityType [fromPiiEntityType] :: PiiEntityType -> Text pattern PiiEntityType_ADDRESS :: PiiEntityType pattern PiiEntityType_AGE :: PiiEntityType pattern PiiEntityType_ALL :: PiiEntityType pattern PiiEntityType_AWS_ACCESS_KEY :: PiiEntityType pattern PiiEntityType_AWS_SECRET_KEY :: PiiEntityType pattern PiiEntityType_BANK_ACCOUNT_NUMBER :: PiiEntityType pattern PiiEntityType_BANK_ROUTING :: PiiEntityType pattern PiiEntityType_CA_HEALTH_NUMBER :: PiiEntityType pattern PiiEntityType_CA_SOCIAL_INSURANCE_NUMBER :: PiiEntityType pattern PiiEntityType_CREDIT_DEBIT_CVV :: PiiEntityType pattern PiiEntityType_CREDIT_DEBIT_EXPIRY :: PiiEntityType pattern PiiEntityType_CREDIT_DEBIT_NUMBER :: PiiEntityType pattern PiiEntityType_DATE_TIME :: PiiEntityType pattern PiiEntityType_DRIVER_ID :: PiiEntityType pattern PiiEntityType_EMAIL :: PiiEntityType pattern PiiEntityType_INTERNATIONAL_BANK_ACCOUNT_NUMBER :: PiiEntityType pattern PiiEntityType_IN_AADHAAR :: PiiEntityType pattern PiiEntityType_IN_NREGA :: PiiEntityType pattern PiiEntityType_IN_PERMANENT_ACCOUNT_NUMBER :: PiiEntityType pattern PiiEntityType_IN_VOTER_NUMBER :: PiiEntityType pattern PiiEntityType_IP_ADDRESS :: PiiEntityType pattern PiiEntityType_LICENSE_PLATE :: PiiEntityType pattern PiiEntityType_MAC_ADDRESS :: PiiEntityType pattern PiiEntityType_NAME :: PiiEntityType pattern PiiEntityType_PASSPORT_NUMBER :: PiiEntityType pattern PiiEntityType_PASSWORD :: PiiEntityType pattern PiiEntityType_PHONE :: PiiEntityType pattern PiiEntityType_PIN :: PiiEntityType pattern PiiEntityType_SSN :: PiiEntityType pattern PiiEntityType_SWIFT_CODE :: PiiEntityType pattern PiiEntityType_UK_NATIONAL_HEALTH_SERVICE_NUMBER :: PiiEntityType pattern PiiEntityType_UK_NATIONAL_INSURANCE_NUMBER :: PiiEntityType pattern PiiEntityType_UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER :: PiiEntityType pattern PiiEntityType_URL :: PiiEntityType pattern PiiEntityType_USERNAME :: PiiEntityType pattern PiiEntityType_US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER :: PiiEntityType pattern PiiEntityType_VEHICLE_IDENTIFICATION_NUMBER :: PiiEntityType instance Amazonka.Data.XML.ToXML Amazonka.Comprehend.Types.PiiEntityType.PiiEntityType instance Amazonka.Data.XML.FromXML Amazonka.Comprehend.Types.PiiEntityType.PiiEntityType instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.Comprehend.Types.PiiEntityType.PiiEntityType instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.PiiEntityType.PiiEntityType instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.Comprehend.Types.PiiEntityType.PiiEntityType instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.PiiEntityType.PiiEntityType instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.Types.PiiEntityType.PiiEntityType instance Amazonka.Data.Headers.ToHeader Amazonka.Comprehend.Types.PiiEntityType.PiiEntityType instance Amazonka.Data.Log.ToLog Amazonka.Comprehend.Types.PiiEntityType.PiiEntityType instance Amazonka.Data.ByteString.ToByteString Amazonka.Comprehend.Types.PiiEntityType.PiiEntityType instance Amazonka.Data.Text.ToText Amazonka.Comprehend.Types.PiiEntityType.PiiEntityType instance Amazonka.Data.Text.FromText Amazonka.Comprehend.Types.PiiEntityType.PiiEntityType instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.PiiEntityType.PiiEntityType instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.PiiEntityType.PiiEntityType instance GHC.Generics.Generic Amazonka.Comprehend.Types.PiiEntityType.PiiEntityType instance GHC.Classes.Ord Amazonka.Comprehend.Types.PiiEntityType.PiiEntityType instance GHC.Classes.Eq Amazonka.Comprehend.Types.PiiEntityType.PiiEntityType instance GHC.Read.Read Amazonka.Comprehend.Types.PiiEntityType.PiiEntityType instance GHC.Show.Show Amazonka.Comprehend.Types.PiiEntityType.PiiEntityType module Amazonka.Comprehend.Types.PiiEntity -- | Provides information about a PII entity. -- -- See: newPiiEntity smart constructor. data PiiEntity PiiEntity' :: Maybe Int -> Maybe Int -> Maybe Double -> Maybe PiiEntityType -> PiiEntity -- | The zero-based offset from the beginning of the source text to the -- first character in the entity. [$sel:beginOffset:PiiEntity'] :: PiiEntity -> Maybe Int -- | The zero-based offset from the beginning of the source text to the -- last character in the entity. [$sel:endOffset:PiiEntity'] :: PiiEntity -> Maybe Int -- | The level of confidence that Amazon Comprehend has in the accuracy of -- the detection. [$sel:score:PiiEntity'] :: PiiEntity -> Maybe Double -- | The entity's type. [$sel:type':PiiEntity'] :: PiiEntity -> Maybe PiiEntityType -- | Create a value of PiiEntity with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:beginOffset:PiiEntity', piiEntity_beginOffset - The -- zero-based offset from the beginning of the source text to the first -- character in the entity. -- -- $sel:endOffset:PiiEntity', piiEntity_endOffset - The -- zero-based offset from the beginning of the source text to the last -- character in the entity. -- -- $sel:score:PiiEntity', piiEntity_score - The level of -- confidence that Amazon Comprehend has in the accuracy of the -- detection. -- -- $sel:type':PiiEntity', piiEntity_type - The entity's -- type. newPiiEntity :: PiiEntity -- | The zero-based offset from the beginning of the source text to the -- first character in the entity. piiEntity_beginOffset :: Lens' PiiEntity (Maybe Int) -- | The zero-based offset from the beginning of the source text to the -- last character in the entity. piiEntity_endOffset :: Lens' PiiEntity (Maybe Int) -- | The level of confidence that Amazon Comprehend has in the accuracy of -- the detection. piiEntity_score :: Lens' PiiEntity (Maybe Double) -- | The entity's type. piiEntity_type :: Lens' PiiEntity (Maybe PiiEntityType) instance GHC.Generics.Generic Amazonka.Comprehend.Types.PiiEntity.PiiEntity instance GHC.Show.Show Amazonka.Comprehend.Types.PiiEntity.PiiEntity instance GHC.Read.Read Amazonka.Comprehend.Types.PiiEntity.PiiEntity instance GHC.Classes.Eq Amazonka.Comprehend.Types.PiiEntity.PiiEntity instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.PiiEntity.PiiEntity instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.PiiEntity.PiiEntity instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.PiiEntity.PiiEntity module Amazonka.Comprehend.Types.EntityLabel -- | Specifies one of the label or labels that categorize the personally -- identifiable information (PII) entity being analyzed. -- -- See: newEntityLabel smart constructor. data EntityLabel EntityLabel' :: Maybe PiiEntityType -> Maybe Double -> EntityLabel -- | The name of the label. [$sel:name:EntityLabel'] :: EntityLabel -> Maybe PiiEntityType -- | The level of confidence that Amazon Comprehend has in the accuracy of -- the detection. [$sel:score:EntityLabel'] :: EntityLabel -> Maybe Double -- | Create a value of EntityLabel with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:name:EntityLabel', entityLabel_name - The name of -- the label. -- -- $sel:score:EntityLabel', entityLabel_score - The level -- of confidence that Amazon Comprehend has in the accuracy of the -- detection. newEntityLabel :: EntityLabel -- | The name of the label. entityLabel_name :: Lens' EntityLabel (Maybe PiiEntityType) -- | The level of confidence that Amazon Comprehend has in the accuracy of -- the detection. entityLabel_score :: Lens' EntityLabel (Maybe Double) instance GHC.Generics.Generic Amazonka.Comprehend.Types.EntityLabel.EntityLabel instance GHC.Show.Show Amazonka.Comprehend.Types.EntityLabel.EntityLabel instance GHC.Read.Read Amazonka.Comprehend.Types.EntityLabel.EntityLabel instance GHC.Classes.Eq Amazonka.Comprehend.Types.EntityLabel.EntityLabel instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.EntityLabel.EntityLabel instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.EntityLabel.EntityLabel instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.EntityLabel.EntityLabel module Amazonka.Comprehend.Types.PiiOutputDataConfig -- | Provides configuration parameters for the output of PII entity -- detection jobs. -- -- See: newPiiOutputDataConfig smart constructor. data PiiOutputDataConfig PiiOutputDataConfig' :: Maybe Text -> Text -> PiiOutputDataConfig -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt the output results from an analysis job. [$sel:kmsKeyId:PiiOutputDataConfig'] :: PiiOutputDataConfig -> Maybe Text -- | When you use the PiiOutputDataConfig object with asynchronous -- operations, you specify the Amazon S3 location where you want to write -- the output data. -- -- For a PII entity detection job, the output file is plain text, not a -- compressed archive. The output file name is the same as the input -- file, with .out appended at the end. [$sel:s3Uri:PiiOutputDataConfig'] :: PiiOutputDataConfig -> Text -- | Create a value of PiiOutputDataConfig with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:kmsKeyId:PiiOutputDataConfig', -- piiOutputDataConfig_kmsKeyId - ID for the AWS Key Management -- Service (KMS) key that Amazon Comprehend uses to encrypt the output -- results from an analysis job. -- -- $sel:s3Uri:PiiOutputDataConfig', -- piiOutputDataConfig_s3Uri - When you use the -- PiiOutputDataConfig object with asynchronous operations, you -- specify the Amazon S3 location where you want to write the output -- data. -- -- For a PII entity detection job, the output file is plain text, not a -- compressed archive. The output file name is the same as the input -- file, with .out appended at the end. newPiiOutputDataConfig :: Text -> PiiOutputDataConfig -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt the output results from an analysis job. piiOutputDataConfig_kmsKeyId :: Lens' PiiOutputDataConfig (Maybe Text) -- | When you use the PiiOutputDataConfig object with asynchronous -- operations, you specify the Amazon S3 location where you want to write -- the output data. -- -- For a PII entity detection job, the output file is plain text, not a -- compressed archive. The output file name is the same as the input -- file, with .out appended at the end. piiOutputDataConfig_s3Uri :: Lens' PiiOutputDataConfig Text instance GHC.Generics.Generic Amazonka.Comprehend.Types.PiiOutputDataConfig.PiiOutputDataConfig instance GHC.Show.Show Amazonka.Comprehend.Types.PiiOutputDataConfig.PiiOutputDataConfig instance GHC.Read.Read Amazonka.Comprehend.Types.PiiOutputDataConfig.PiiOutputDataConfig instance GHC.Classes.Eq Amazonka.Comprehend.Types.PiiOutputDataConfig.PiiOutputDataConfig instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.PiiOutputDataConfig.PiiOutputDataConfig instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.PiiOutputDataConfig.PiiOutputDataConfig instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.PiiOutputDataConfig.PiiOutputDataConfig module Amazonka.Comprehend.Types.Point -- | The X and Y coordinates of a point on a document page. -- -- For additional information, see Point in the Amazon Textract -- API reference. -- -- See: newPoint smart constructor. data Point Point' :: Maybe Double -> Maybe Double -> Point -- | The value of the X coordinate for a point on a polygon [$sel:x:Point'] :: Point -> Maybe Double -- | The value of the Y coordinate for a point on a polygon [$sel:y:Point'] :: Point -> Maybe Double -- | Create a value of Point with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:x:Point', point_x - The value of the X coordinate -- for a point on a polygon -- -- $sel:y:Point', point_y - The value of the Y coordinate -- for a point on a polygon newPoint :: Point -- | The value of the X coordinate for a point on a polygon point_x :: Lens' Point (Maybe Double) -- | The value of the Y coordinate for a point on a polygon point_y :: Lens' Point (Maybe Double) instance GHC.Generics.Generic Amazonka.Comprehend.Types.Point.Point instance GHC.Show.Show Amazonka.Comprehend.Types.Point.Point instance GHC.Read.Read Amazonka.Comprehend.Types.Point.Point instance GHC.Classes.Eq Amazonka.Comprehend.Types.Point.Point instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.Point.Point instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.Point.Point instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.Point.Point module Amazonka.Comprehend.Types.Geometry -- | Information about the location of items on a document page. -- -- For additional information, see Geometry in the Amazon Textract -- API reference. -- -- See: newGeometry smart constructor. data Geometry Geometry' :: Maybe BoundingBox -> Maybe [Point] -> Geometry -- | An axis-aligned coarse representation of the location of the -- recognized item on the document page. [$sel:boundingBox:Geometry'] :: Geometry -> Maybe BoundingBox -- | Within the bounding box, a fine-grained polygon around the recognized -- item. [$sel:polygon:Geometry'] :: Geometry -> Maybe [Point] -- | Create a value of Geometry with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:boundingBox:Geometry', geometry_boundingBox - An -- axis-aligned coarse representation of the location of the recognized -- item on the document page. -- -- $sel:polygon:Geometry', geometry_polygon - Within the -- bounding box, a fine-grained polygon around the recognized item. newGeometry :: Geometry -- | An axis-aligned coarse representation of the location of the -- recognized item on the document page. geometry_boundingBox :: Lens' Geometry (Maybe BoundingBox) -- | Within the bounding box, a fine-grained polygon around the recognized -- item. geometry_polygon :: Lens' Geometry (Maybe [Point]) instance GHC.Generics.Generic Amazonka.Comprehend.Types.Geometry.Geometry instance GHC.Show.Show Amazonka.Comprehend.Types.Geometry.Geometry instance GHC.Read.Read Amazonka.Comprehend.Types.Geometry.Geometry instance GHC.Classes.Eq Amazonka.Comprehend.Types.Geometry.Geometry instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.Geometry.Geometry instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.Geometry.Geometry instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.Geometry.Geometry module Amazonka.Comprehend.Types.RedactionConfig -- | Provides configuration parameters for PII entity redaction. -- -- See: newRedactionConfig smart constructor. data RedactionConfig RedactionConfig' :: Maybe Text -> Maybe PiiEntitiesDetectionMaskMode -> Maybe [PiiEntityType] -> RedactionConfig -- | A character that replaces each character in the redacted PII entity. [$sel:maskCharacter:RedactionConfig'] :: RedactionConfig -> Maybe Text -- | Specifies whether the PII entity is redacted with the mask character -- or the entity type. [$sel:maskMode:RedactionConfig'] :: RedactionConfig -> Maybe PiiEntitiesDetectionMaskMode -- | An array of the types of PII entities that Amazon Comprehend detects -- in the input text for your request. [$sel:piiEntityTypes:RedactionConfig'] :: RedactionConfig -> Maybe [PiiEntityType] -- | Create a value of RedactionConfig with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:maskCharacter:RedactionConfig', -- redactionConfig_maskCharacter - A character that replaces each -- character in the redacted PII entity. -- -- $sel:maskMode:RedactionConfig', redactionConfig_maskMode -- - Specifies whether the PII entity is redacted with the mask character -- or the entity type. -- -- $sel:piiEntityTypes:RedactionConfig', -- redactionConfig_piiEntityTypes - An array of the types of PII -- entities that Amazon Comprehend detects in the input text for your -- request. newRedactionConfig :: RedactionConfig -- | A character that replaces each character in the redacted PII entity. redactionConfig_maskCharacter :: Lens' RedactionConfig (Maybe Text) -- | Specifies whether the PII entity is redacted with the mask character -- or the entity type. redactionConfig_maskMode :: Lens' RedactionConfig (Maybe PiiEntitiesDetectionMaskMode) -- | An array of the types of PII entities that Amazon Comprehend detects -- in the input text for your request. redactionConfig_piiEntityTypes :: Lens' RedactionConfig (Maybe [PiiEntityType]) instance GHC.Generics.Generic Amazonka.Comprehend.Types.RedactionConfig.RedactionConfig instance GHC.Show.Show Amazonka.Comprehend.Types.RedactionConfig.RedactionConfig instance GHC.Read.Read Amazonka.Comprehend.Types.RedactionConfig.RedactionConfig instance GHC.Classes.Eq Amazonka.Comprehend.Types.RedactionConfig.RedactionConfig instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.RedactionConfig.RedactionConfig instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.RedactionConfig.RedactionConfig instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.RedactionConfig.RedactionConfig instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.RedactionConfig.RedactionConfig module Amazonka.Comprehend.Types.PiiEntitiesDetectionJobProperties -- | Provides information about a PII entities detection job. -- -- See: newPiiEntitiesDetectionJobProperties smart -- constructor. data PiiEntitiesDetectionJobProperties PiiEntitiesDetectionJobProperties' :: Maybe Text -> Maybe POSIX -> Maybe InputDataConfig -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe JobStatus -> Maybe LanguageCode -> Maybe Text -> Maybe PiiEntitiesDetectionMode -> Maybe PiiOutputDataConfig -> Maybe RedactionConfig -> Maybe POSIX -> PiiEntitiesDetectionJobProperties -- | The Amazon Resource Name (ARN) that gives Amazon Comprehend read -- access to your input data. [$sel:dataAccessRoleArn:PiiEntitiesDetectionJobProperties'] :: PiiEntitiesDetectionJobProperties -> Maybe Text -- | The time that the PII entities detection job completed. [$sel:endTime:PiiEntitiesDetectionJobProperties'] :: PiiEntitiesDetectionJobProperties -> Maybe POSIX -- | The input properties for a PII entities detection job. [$sel:inputDataConfig:PiiEntitiesDetectionJobProperties'] :: PiiEntitiesDetectionJobProperties -> Maybe InputDataConfig -- | The Amazon Resource Name (ARN) of the PII entities detection job. It -- is a unique, fully qualified identifier for the job. It includes the -- AWS account, Region, and the job ID. The format of the ARN is as -- follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
--
[$sel:jobArn:PiiEntitiesDetectionJobProperties'] :: PiiEntitiesDetectionJobProperties -> Maybe Text -- | The identifier assigned to the PII entities detection job. [$sel:jobId:PiiEntitiesDetectionJobProperties'] :: PiiEntitiesDetectionJobProperties -> Maybe Text -- | The name that you assigned the PII entities detection job. [$sel:jobName:PiiEntitiesDetectionJobProperties'] :: PiiEntitiesDetectionJobProperties -> Maybe Text -- | The current status of the PII entities detection job. If the status is -- FAILED, the Message field shows the reason for the -- failure. [$sel:jobStatus:PiiEntitiesDetectionJobProperties'] :: PiiEntitiesDetectionJobProperties -> Maybe JobStatus -- | The language code of the input documents [$sel:languageCode:PiiEntitiesDetectionJobProperties'] :: PiiEntitiesDetectionJobProperties -> Maybe LanguageCode -- | A description of the status of a job. [$sel:message:PiiEntitiesDetectionJobProperties'] :: PiiEntitiesDetectionJobProperties -> Maybe Text -- | Specifies whether the output provides the locations (offsets) of PII -- entities or a file in which PII entities are redacted. [$sel:mode:PiiEntitiesDetectionJobProperties'] :: PiiEntitiesDetectionJobProperties -> Maybe PiiEntitiesDetectionMode -- | The output data configuration that you supplied when you created the -- PII entities detection job. [$sel:outputDataConfig:PiiEntitiesDetectionJobProperties'] :: PiiEntitiesDetectionJobProperties -> Maybe PiiOutputDataConfig -- | Provides configuration parameters for PII entity redaction. -- -- This parameter is required if you set the Mode parameter to -- ONLY_REDACTION. In that case, you must provide a -- RedactionConfig definition that includes the -- PiiEntityTypes parameter. [$sel:redactionConfig:PiiEntitiesDetectionJobProperties'] :: PiiEntitiesDetectionJobProperties -> Maybe RedactionConfig -- | The time that the PII entities detection job was submitted for -- processing. [$sel:submitTime:PiiEntitiesDetectionJobProperties'] :: PiiEntitiesDetectionJobProperties -> Maybe POSIX -- | Create a value of PiiEntitiesDetectionJobProperties with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:dataAccessRoleArn:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_dataAccessRoleArn - The -- Amazon Resource Name (ARN) that gives Amazon Comprehend read access to -- your input data. -- -- $sel:endTime:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_endTime - The time that the -- PII entities detection job completed. -- -- $sel:inputDataConfig:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_inputDataConfig - The input -- properties for a PII entities detection job. -- -- $sel:jobArn:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_jobArn - The Amazon Resource -- Name (ARN) of the PII entities detection job. It is a unique, fully -- qualified identifier for the job. It includes the AWS account, Region, -- and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- $sel:jobId:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_jobId - The identifier -- assigned to the PII entities detection job. -- -- $sel:jobName:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_jobName - The name that you -- assigned the PII entities detection job. -- -- $sel:jobStatus:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_jobStatus - The current -- status of the PII entities detection job. If the status is -- FAILED, the Message field shows the reason for the -- failure. -- -- $sel:languageCode:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_languageCode - The language -- code of the input documents -- -- $sel:message:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_message - A description of -- the status of a job. -- -- $sel:mode:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_mode - Specifies whether the -- output provides the locations (offsets) of PII entities or a file in -- which PII entities are redacted. -- -- $sel:outputDataConfig:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_outputDataConfig - The output -- data configuration that you supplied when you created the PII entities -- detection job. -- -- $sel:redactionConfig:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_redactionConfig - Provides -- configuration parameters for PII entity redaction. -- -- This parameter is required if you set the Mode parameter to -- ONLY_REDACTION. In that case, you must provide a -- RedactionConfig definition that includes the -- PiiEntityTypes parameter. -- -- $sel:submitTime:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_submitTime - The time that -- the PII entities detection job was submitted for processing. newPiiEntitiesDetectionJobProperties :: PiiEntitiesDetectionJobProperties -- | The Amazon Resource Name (ARN) that gives Amazon Comprehend read -- access to your input data. piiEntitiesDetectionJobProperties_dataAccessRoleArn :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text) -- | The time that the PII entities detection job completed. piiEntitiesDetectionJobProperties_endTime :: Lens' PiiEntitiesDetectionJobProperties (Maybe UTCTime) -- | The input properties for a PII entities detection job. piiEntitiesDetectionJobProperties_inputDataConfig :: Lens' PiiEntitiesDetectionJobProperties (Maybe InputDataConfig) -- | The Amazon Resource Name (ARN) of the PII entities detection job. It -- is a unique, fully qualified identifier for the job. It includes the -- AWS account, Region, and the job ID. The format of the ARN is as -- follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
--
piiEntitiesDetectionJobProperties_jobArn :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text) -- | The identifier assigned to the PII entities detection job. piiEntitiesDetectionJobProperties_jobId :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text) -- | The name that you assigned the PII entities detection job. piiEntitiesDetectionJobProperties_jobName :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text) -- | The current status of the PII entities detection job. If the status is -- FAILED, the Message field shows the reason for the -- failure. piiEntitiesDetectionJobProperties_jobStatus :: Lens' PiiEntitiesDetectionJobProperties (Maybe JobStatus) -- | The language code of the input documents piiEntitiesDetectionJobProperties_languageCode :: Lens' PiiEntitiesDetectionJobProperties (Maybe LanguageCode) -- | A description of the status of a job. piiEntitiesDetectionJobProperties_message :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text) -- | Specifies whether the output provides the locations (offsets) of PII -- entities or a file in which PII entities are redacted. piiEntitiesDetectionJobProperties_mode :: Lens' PiiEntitiesDetectionJobProperties (Maybe PiiEntitiesDetectionMode) -- | The output data configuration that you supplied when you created the -- PII entities detection job. piiEntitiesDetectionJobProperties_outputDataConfig :: Lens' PiiEntitiesDetectionJobProperties (Maybe PiiOutputDataConfig) -- | Provides configuration parameters for PII entity redaction. -- -- This parameter is required if you set the Mode parameter to -- ONLY_REDACTION. In that case, you must provide a -- RedactionConfig definition that includes the -- PiiEntityTypes parameter. piiEntitiesDetectionJobProperties_redactionConfig :: Lens' PiiEntitiesDetectionJobProperties (Maybe RedactionConfig) -- | The time that the PII entities detection job was submitted for -- processing. piiEntitiesDetectionJobProperties_submitTime :: Lens' PiiEntitiesDetectionJobProperties (Maybe UTCTime) instance GHC.Generics.Generic Amazonka.Comprehend.Types.PiiEntitiesDetectionJobProperties.PiiEntitiesDetectionJobProperties instance GHC.Show.Show Amazonka.Comprehend.Types.PiiEntitiesDetectionJobProperties.PiiEntitiesDetectionJobProperties instance GHC.Read.Read Amazonka.Comprehend.Types.PiiEntitiesDetectionJobProperties.PiiEntitiesDetectionJobProperties instance GHC.Classes.Eq Amazonka.Comprehend.Types.PiiEntitiesDetectionJobProperties.PiiEntitiesDetectionJobProperties instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.PiiEntitiesDetectionJobProperties.PiiEntitiesDetectionJobProperties instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.PiiEntitiesDetectionJobProperties.PiiEntitiesDetectionJobProperties instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.PiiEntitiesDetectionJobProperties.PiiEntitiesDetectionJobProperties module Amazonka.Comprehend.Types.RelationshipType newtype RelationshipType RelationshipType' :: Text -> RelationshipType [fromRelationshipType] :: RelationshipType -> Text pattern RelationshipType_CHILD :: RelationshipType instance Amazonka.Data.XML.ToXML Amazonka.Comprehend.Types.RelationshipType.RelationshipType instance Amazonka.Data.XML.FromXML Amazonka.Comprehend.Types.RelationshipType.RelationshipType instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.Comprehend.Types.RelationshipType.RelationshipType instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.RelationshipType.RelationshipType instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.Comprehend.Types.RelationshipType.RelationshipType instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.RelationshipType.RelationshipType instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.Types.RelationshipType.RelationshipType instance Amazonka.Data.Headers.ToHeader Amazonka.Comprehend.Types.RelationshipType.RelationshipType instance Amazonka.Data.Log.ToLog Amazonka.Comprehend.Types.RelationshipType.RelationshipType instance Amazonka.Data.ByteString.ToByteString Amazonka.Comprehend.Types.RelationshipType.RelationshipType instance Amazonka.Data.Text.ToText Amazonka.Comprehend.Types.RelationshipType.RelationshipType instance Amazonka.Data.Text.FromText Amazonka.Comprehend.Types.RelationshipType.RelationshipType instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.RelationshipType.RelationshipType instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.RelationshipType.RelationshipType instance GHC.Generics.Generic Amazonka.Comprehend.Types.RelationshipType.RelationshipType instance GHC.Classes.Ord Amazonka.Comprehend.Types.RelationshipType.RelationshipType instance GHC.Classes.Eq Amazonka.Comprehend.Types.RelationshipType.RelationshipType instance GHC.Read.Read Amazonka.Comprehend.Types.RelationshipType.RelationshipType instance GHC.Show.Show Amazonka.Comprehend.Types.RelationshipType.RelationshipType module Amazonka.Comprehend.Types.RelationshipsListItem -- | List of child blocks for the current block. -- -- See: newRelationshipsListItem smart constructor. data RelationshipsListItem RelationshipsListItem' :: Maybe [Text] -> Maybe RelationshipType -> RelationshipsListItem -- | Identifers of the child blocks. [$sel:ids:RelationshipsListItem'] :: RelationshipsListItem -> Maybe [Text] -- | Only supported relationship is a child relationship. [$sel:type':RelationshipsListItem'] :: RelationshipsListItem -> Maybe RelationshipType -- | Create a value of RelationshipsListItem with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:ids:RelationshipsListItem', -- relationshipsListItem_ids - Identifers of the child blocks. -- -- $sel:type':RelationshipsListItem', -- relationshipsListItem_type - Only supported relationship is a -- child relationship. newRelationshipsListItem :: RelationshipsListItem -- | Identifers of the child blocks. relationshipsListItem_ids :: Lens' RelationshipsListItem (Maybe [Text]) -- | Only supported relationship is a child relationship. relationshipsListItem_type :: Lens' RelationshipsListItem (Maybe RelationshipType) instance GHC.Generics.Generic Amazonka.Comprehend.Types.RelationshipsListItem.RelationshipsListItem instance GHC.Show.Show Amazonka.Comprehend.Types.RelationshipsListItem.RelationshipsListItem instance GHC.Read.Read Amazonka.Comprehend.Types.RelationshipsListItem.RelationshipsListItem instance GHC.Classes.Eq Amazonka.Comprehend.Types.RelationshipsListItem.RelationshipsListItem instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.RelationshipsListItem.RelationshipsListItem instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.RelationshipsListItem.RelationshipsListItem instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.RelationshipsListItem.RelationshipsListItem module Amazonka.Comprehend.Types.Block -- | Information about each word or line of text in the input document. -- -- For additional information, see Block in the Amazon Textract -- API reference. -- -- See: newBlock smart constructor. data Block Block' :: Maybe BlockType -> Maybe Geometry -> Maybe Text -> Maybe Int -> Maybe [RelationshipsListItem] -> Maybe Text -> Block -- | The block represents a line of text or one word of text. -- -- [$sel:blockType:Block'] :: Block -> Maybe BlockType -- | Co-ordinates of the rectangle or polygon that contains the text. [$sel:geometry:Block'] :: Block -> Maybe Geometry -- | Unique identifier for the block. [$sel:id:Block'] :: Block -> Maybe Text -- | Page number where the block appears. [$sel:page:Block'] :: Block -> Maybe Int -- | A list of child blocks of the current block. For example, a LINE -- object has child blocks for each WORD block that's part of the line of -- text. [$sel:relationships:Block'] :: Block -> Maybe [RelationshipsListItem] -- | The word or line of text extracted from the block. [$sel:text:Block'] :: Block -> Maybe Text -- | Create a value of Block with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:blockType:Block', block_blockType - The block -- represents a line of text or one word of text. -- -- -- -- $sel:geometry:Block', block_geometry - Co-ordinates of -- the rectangle or polygon that contains the text. -- -- $sel:id:Block', block_id - Unique identifier for the -- block. -- -- $sel:page:Block', block_page - Page number where the -- block appears. -- -- $sel:relationships:Block', block_relationships - A list -- of child blocks of the current block. For example, a LINE object has -- child blocks for each WORD block that's part of the line of text. -- -- $sel:text:Block', block_text - The word or line of text -- extracted from the block. newBlock :: Block -- | The block represents a line of text or one word of text. -- -- block_blockType :: Lens' Block (Maybe BlockType) -- | Co-ordinates of the rectangle or polygon that contains the text. block_geometry :: Lens' Block (Maybe Geometry) -- | Unique identifier for the block. block_id :: Lens' Block (Maybe Text) -- | Page number where the block appears. block_page :: Lens' Block (Maybe Int) -- | A list of child blocks of the current block. For example, a LINE -- object has child blocks for each WORD block that's part of the line of -- text. block_relationships :: Lens' Block (Maybe [RelationshipsListItem]) -- | The word or line of text extracted from the block. block_text :: Lens' Block (Maybe Text) instance GHC.Generics.Generic Amazonka.Comprehend.Types.Block.Block instance GHC.Show.Show Amazonka.Comprehend.Types.Block.Block instance GHC.Read.Read Amazonka.Comprehend.Types.Block.Block instance GHC.Classes.Eq Amazonka.Comprehend.Types.Block.Block instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.Block.Block instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.Block.Block instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.Block.Block module Amazonka.Comprehend.Types.SentimentDetectionJobFilter -- | Provides information for filtering a list of dominant language -- detection jobs. For more information, see the operation. -- -- See: newSentimentDetectionJobFilter smart constructor. data SentimentDetectionJobFilter SentimentDetectionJobFilter' :: Maybe Text -> Maybe JobStatus -> Maybe POSIX -> Maybe POSIX -> SentimentDetectionJobFilter -- | Filters on the name of the job. [$sel:jobName:SentimentDetectionJobFilter'] :: SentimentDetectionJobFilter -> Maybe Text -- | Filters the list of jobs based on job status. Returns only jobs with -- the specified status. [$sel:jobStatus:SentimentDetectionJobFilter'] :: SentimentDetectionJobFilter -> Maybe JobStatus -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. [$sel:submitTimeAfter:SentimentDetectionJobFilter'] :: SentimentDetectionJobFilter -> Maybe POSIX -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. [$sel:submitTimeBefore:SentimentDetectionJobFilter'] :: SentimentDetectionJobFilter -> Maybe POSIX -- | Create a value of SentimentDetectionJobFilter with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:jobName:SentimentDetectionJobFilter', -- sentimentDetectionJobFilter_jobName - Filters on the name of -- the job. -- -- $sel:jobStatus:SentimentDetectionJobFilter', -- sentimentDetectionJobFilter_jobStatus - Filters the list of -- jobs based on job status. Returns only jobs with the specified status. -- -- $sel:submitTimeAfter:SentimentDetectionJobFilter', -- sentimentDetectionJobFilter_submitTimeAfter - Filters the list -- of jobs based on the time that the job was submitted for processing. -- Returns only jobs submitted after the specified time. Jobs are -- returned in descending order, newest to oldest. -- -- $sel:submitTimeBefore:SentimentDetectionJobFilter', -- sentimentDetectionJobFilter_submitTimeBefore - Filters the list -- of jobs based on the time that the job was submitted for processing. -- Returns only jobs submitted before the specified time. Jobs are -- returned in ascending order, oldest to newest. newSentimentDetectionJobFilter :: SentimentDetectionJobFilter -- | Filters on the name of the job. sentimentDetectionJobFilter_jobName :: Lens' SentimentDetectionJobFilter (Maybe Text) -- | Filters the list of jobs based on job status. Returns only jobs with -- the specified status. sentimentDetectionJobFilter_jobStatus :: Lens' SentimentDetectionJobFilter (Maybe JobStatus) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. sentimentDetectionJobFilter_submitTimeAfter :: Lens' SentimentDetectionJobFilter (Maybe UTCTime) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. sentimentDetectionJobFilter_submitTimeBefore :: Lens' SentimentDetectionJobFilter (Maybe UTCTime) instance GHC.Generics.Generic Amazonka.Comprehend.Types.SentimentDetectionJobFilter.SentimentDetectionJobFilter instance GHC.Show.Show Amazonka.Comprehend.Types.SentimentDetectionJobFilter.SentimentDetectionJobFilter instance GHC.Read.Read Amazonka.Comprehend.Types.SentimentDetectionJobFilter.SentimentDetectionJobFilter instance GHC.Classes.Eq Amazonka.Comprehend.Types.SentimentDetectionJobFilter.SentimentDetectionJobFilter instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.SentimentDetectionJobFilter.SentimentDetectionJobFilter instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.SentimentDetectionJobFilter.SentimentDetectionJobFilter instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.SentimentDetectionJobFilter.SentimentDetectionJobFilter module Amazonka.Comprehend.Types.SentimentScore -- | Describes the level of confidence that Amazon Comprehend has in the -- accuracy of its detection of sentiments. -- -- See: newSentimentScore smart constructor. data SentimentScore SentimentScore' :: Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> SentimentScore -- | The level of confidence that Amazon Comprehend has in the accuracy of -- its detection of the MIXED sentiment. [$sel:mixed:SentimentScore'] :: SentimentScore -> Maybe Double -- | The level of confidence that Amazon Comprehend has in the accuracy of -- its detection of the NEGATIVE sentiment. [$sel:negative:SentimentScore'] :: SentimentScore -> Maybe Double -- | The level of confidence that Amazon Comprehend has in the accuracy of -- its detection of the NEUTRAL sentiment. [$sel:neutral:SentimentScore'] :: SentimentScore -> Maybe Double -- | The level of confidence that Amazon Comprehend has in the accuracy of -- its detection of the POSITIVE sentiment. [$sel:positive:SentimentScore'] :: SentimentScore -> Maybe Double -- | Create a value of SentimentScore with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:mixed:SentimentScore', sentimentScore_mixed - The -- level of confidence that Amazon Comprehend has in the accuracy of its -- detection of the MIXED sentiment. -- -- $sel:negative:SentimentScore', sentimentScore_negative - -- The level of confidence that Amazon Comprehend has in the accuracy of -- its detection of the NEGATIVE sentiment. -- -- $sel:neutral:SentimentScore', sentimentScore_neutral - -- The level of confidence that Amazon Comprehend has in the accuracy of -- its detection of the NEUTRAL sentiment. -- -- $sel:positive:SentimentScore', sentimentScore_positive - -- The level of confidence that Amazon Comprehend has in the accuracy of -- its detection of the POSITIVE sentiment. newSentimentScore :: SentimentScore -- | The level of confidence that Amazon Comprehend has in the accuracy of -- its detection of the MIXED sentiment. sentimentScore_mixed :: Lens' SentimentScore (Maybe Double) -- | The level of confidence that Amazon Comprehend has in the accuracy of -- its detection of the NEGATIVE sentiment. sentimentScore_negative :: Lens' SentimentScore (Maybe Double) -- | The level of confidence that Amazon Comprehend has in the accuracy of -- its detection of the NEUTRAL sentiment. sentimentScore_neutral :: Lens' SentimentScore (Maybe Double) -- | The level of confidence that Amazon Comprehend has in the accuracy of -- its detection of the POSITIVE sentiment. sentimentScore_positive :: Lens' SentimentScore (Maybe Double) instance GHC.Generics.Generic Amazonka.Comprehend.Types.SentimentScore.SentimentScore instance GHC.Show.Show Amazonka.Comprehend.Types.SentimentScore.SentimentScore instance GHC.Read.Read Amazonka.Comprehend.Types.SentimentScore.SentimentScore instance GHC.Classes.Eq Amazonka.Comprehend.Types.SentimentScore.SentimentScore instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.SentimentScore.SentimentScore instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.SentimentScore.SentimentScore instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.SentimentScore.SentimentScore module Amazonka.Comprehend.Types.SentimentType newtype SentimentType SentimentType' :: Text -> SentimentType [fromSentimentType] :: SentimentType -> Text pattern SentimentType_MIXED :: SentimentType pattern SentimentType_NEGATIVE :: SentimentType pattern SentimentType_NEUTRAL :: SentimentType pattern SentimentType_POSITIVE :: SentimentType instance Amazonka.Data.XML.ToXML Amazonka.Comprehend.Types.SentimentType.SentimentType instance Amazonka.Data.XML.FromXML Amazonka.Comprehend.Types.SentimentType.SentimentType instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.Comprehend.Types.SentimentType.SentimentType instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.SentimentType.SentimentType instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.Comprehend.Types.SentimentType.SentimentType instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.SentimentType.SentimentType instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.Types.SentimentType.SentimentType instance Amazonka.Data.Headers.ToHeader Amazonka.Comprehend.Types.SentimentType.SentimentType instance Amazonka.Data.Log.ToLog Amazonka.Comprehend.Types.SentimentType.SentimentType instance Amazonka.Data.ByteString.ToByteString Amazonka.Comprehend.Types.SentimentType.SentimentType instance Amazonka.Data.Text.ToText Amazonka.Comprehend.Types.SentimentType.SentimentType instance Amazonka.Data.Text.FromText Amazonka.Comprehend.Types.SentimentType.SentimentType instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.SentimentType.SentimentType instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.SentimentType.SentimentType instance GHC.Generics.Generic Amazonka.Comprehend.Types.SentimentType.SentimentType instance GHC.Classes.Ord Amazonka.Comprehend.Types.SentimentType.SentimentType instance GHC.Classes.Eq Amazonka.Comprehend.Types.SentimentType.SentimentType instance GHC.Read.Read Amazonka.Comprehend.Types.SentimentType.SentimentType instance GHC.Show.Show Amazonka.Comprehend.Types.SentimentType.SentimentType module Amazonka.Comprehend.Types.MentionSentiment -- | Contains the sentiment and sentiment score for one mention of an -- entity. -- -- For more information about targeted sentiment, see Targeted -- sentiment. -- -- See: newMentionSentiment smart constructor. data MentionSentiment MentionSentiment' :: Maybe SentimentType -> Maybe SentimentScore -> MentionSentiment -- | The sentiment of the mention. [$sel:sentiment:MentionSentiment'] :: MentionSentiment -> Maybe SentimentType [$sel:sentimentScore:MentionSentiment'] :: MentionSentiment -> Maybe SentimentScore -- | Create a value of MentionSentiment with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:sentiment:MentionSentiment', -- mentionSentiment_sentiment - The sentiment of the mention. -- -- $sel:sentimentScore:MentionSentiment', -- mentionSentiment_sentimentScore - Undocumented member. newMentionSentiment :: MentionSentiment -- | The sentiment of the mention. mentionSentiment_sentiment :: Lens' MentionSentiment (Maybe SentimentType) -- | Undocumented member. mentionSentiment_sentimentScore :: Lens' MentionSentiment (Maybe SentimentScore) instance GHC.Generics.Generic Amazonka.Comprehend.Types.MentionSentiment.MentionSentiment instance GHC.Show.Show Amazonka.Comprehend.Types.MentionSentiment.MentionSentiment instance GHC.Read.Read Amazonka.Comprehend.Types.MentionSentiment.MentionSentiment instance GHC.Classes.Eq Amazonka.Comprehend.Types.MentionSentiment.MentionSentiment instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.MentionSentiment.MentionSentiment instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.MentionSentiment.MentionSentiment instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.MentionSentiment.MentionSentiment module Amazonka.Comprehend.Types.BatchDetectSentimentItemResult -- | The result of calling the operation. The operation returns one object -- for each document that is successfully processed by the operation. -- -- See: newBatchDetectSentimentItemResult smart -- constructor. data BatchDetectSentimentItemResult BatchDetectSentimentItemResult' :: Maybe Int -> Maybe SentimentType -> Maybe SentimentScore -> BatchDetectSentimentItemResult -- | The zero-based index of the document in the input list. [$sel:index:BatchDetectSentimentItemResult'] :: BatchDetectSentimentItemResult -> Maybe Int -- | The sentiment detected in the document. [$sel:sentiment:BatchDetectSentimentItemResult'] :: BatchDetectSentimentItemResult -> Maybe SentimentType -- | The level of confidence that Amazon Comprehend has in the accuracy of -- its sentiment detection. [$sel:sentimentScore:BatchDetectSentimentItemResult'] :: BatchDetectSentimentItemResult -> Maybe SentimentScore -- | Create a value of BatchDetectSentimentItemResult with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:index:BatchDetectSentimentItemResult', -- batchDetectSentimentItemResult_index - The zero-based index of -- the document in the input list. -- -- $sel:sentiment:BatchDetectSentimentItemResult', -- batchDetectSentimentItemResult_sentiment - The sentiment -- detected in the document. -- -- $sel:sentimentScore:BatchDetectSentimentItemResult', -- batchDetectSentimentItemResult_sentimentScore - The level of -- confidence that Amazon Comprehend has in the accuracy of its sentiment -- detection. newBatchDetectSentimentItemResult :: BatchDetectSentimentItemResult -- | The zero-based index of the document in the input list. batchDetectSentimentItemResult_index :: Lens' BatchDetectSentimentItemResult (Maybe Int) -- | The sentiment detected in the document. batchDetectSentimentItemResult_sentiment :: Lens' BatchDetectSentimentItemResult (Maybe SentimentType) -- | The level of confidence that Amazon Comprehend has in the accuracy of -- its sentiment detection. batchDetectSentimentItemResult_sentimentScore :: Lens' BatchDetectSentimentItemResult (Maybe SentimentScore) instance GHC.Generics.Generic Amazonka.Comprehend.Types.BatchDetectSentimentItemResult.BatchDetectSentimentItemResult instance GHC.Show.Show Amazonka.Comprehend.Types.BatchDetectSentimentItemResult.BatchDetectSentimentItemResult instance GHC.Read.Read Amazonka.Comprehend.Types.BatchDetectSentimentItemResult.BatchDetectSentimentItemResult instance GHC.Classes.Eq Amazonka.Comprehend.Types.BatchDetectSentimentItemResult.BatchDetectSentimentItemResult instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.BatchDetectSentimentItemResult.BatchDetectSentimentItemResult instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.BatchDetectSentimentItemResult.BatchDetectSentimentItemResult instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.BatchDetectSentimentItemResult.BatchDetectSentimentItemResult module Amazonka.Comprehend.Types.Split newtype Split Split' :: Text -> Split [fromSplit] :: Split -> Text pattern Split_TEST :: Split pattern Split_TRAIN :: Split instance Amazonka.Data.XML.ToXML Amazonka.Comprehend.Types.Split.Split instance Amazonka.Data.XML.FromXML Amazonka.Comprehend.Types.Split.Split instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.Comprehend.Types.Split.Split instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.Split.Split instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.Comprehend.Types.Split.Split instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.Split.Split instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.Types.Split.Split instance Amazonka.Data.Headers.ToHeader Amazonka.Comprehend.Types.Split.Split instance Amazonka.Data.Log.ToLog Amazonka.Comprehend.Types.Split.Split instance Amazonka.Data.ByteString.ToByteString Amazonka.Comprehend.Types.Split.Split instance Amazonka.Data.Text.ToText Amazonka.Comprehend.Types.Split.Split instance Amazonka.Data.Text.FromText Amazonka.Comprehend.Types.Split.Split instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.Split.Split instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.Split.Split instance GHC.Generics.Generic Amazonka.Comprehend.Types.Split.Split instance GHC.Classes.Ord Amazonka.Comprehend.Types.Split.Split instance GHC.Classes.Eq Amazonka.Comprehend.Types.Split.Split instance GHC.Read.Read Amazonka.Comprehend.Types.Split.Split instance GHC.Show.Show Amazonka.Comprehend.Types.Split.Split module Amazonka.Comprehend.Types.AugmentedManifestsListItem -- | An augmented manifest file that provides training data for your custom -- model. An augmented manifest file is a labeled dataset that is -- produced by Amazon SageMaker Ground Truth. -- -- See: newAugmentedManifestsListItem smart constructor. data AugmentedManifestsListItem AugmentedManifestsListItem' :: Maybe Text -> Maybe AugmentedManifestsDocumentTypeFormat -> Maybe Text -> Maybe Split -> Text -> [Text] -> AugmentedManifestsListItem -- | The S3 prefix to the annotation files that are referred in the -- augmented manifest file. [$sel:annotationDataS3Uri:AugmentedManifestsListItem'] :: AugmentedManifestsListItem -> Maybe Text -- | The type of augmented manifest. PlainTextDocument or -- SemiStructuredDocument. If you don't specify, the default is -- PlainTextDocument. -- -- [$sel:documentType:AugmentedManifestsListItem'] :: AugmentedManifestsListItem -> Maybe AugmentedManifestsDocumentTypeFormat -- | The S3 prefix to the source files (PDFs) that are referred to in the -- augmented manifest file. [$sel:sourceDocumentsS3Uri:AugmentedManifestsListItem'] :: AugmentedManifestsListItem -> Maybe Text -- | The purpose of the data you've provided in the augmented manifest. You -- can either train or test this data. If you don't specify, the default -- is train. -- -- TRAIN - all of the documents in the manifest will be used for -- training. If no test documents are provided, Amazon Comprehend will -- automatically reserve a portion of the training documents for testing. -- -- TEST - all of the documents in the manifest will be used for testing. [$sel:split:AugmentedManifestsListItem'] :: AugmentedManifestsListItem -> Maybe Split -- | The Amazon S3 location of the augmented manifest file. [$sel:s3Uri:AugmentedManifestsListItem'] :: AugmentedManifestsListItem -> Text -- | The JSON attribute that contains the annotations for your training -- documents. The number of attribute names that you specify depends on -- whether your augmented manifest file is the output of a single -- labeling job or a chained labeling job. -- -- If your file is the output of a single labeling job, specify the -- LabelAttributeName key that was used when the job was created in -- Ground Truth. -- -- If your file is the output of a chained labeling job, specify the -- LabelAttributeName key for one or more jobs in the chain. Each -- LabelAttributeName key provides the annotations from an individual -- job. [$sel:attributeNames:AugmentedManifestsListItem'] :: AugmentedManifestsListItem -> [Text] -- | Create a value of AugmentedManifestsListItem with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:annotationDataS3Uri:AugmentedManifestsListItem', -- augmentedManifestsListItem_annotationDataS3Uri - The S3 prefix -- to the annotation files that are referred in the augmented manifest -- file. -- -- $sel:documentType:AugmentedManifestsListItem', -- augmentedManifestsListItem_documentType - The type of augmented -- manifest. PlainTextDocument or SemiStructuredDocument. If you don't -- specify, the default is PlainTextDocument. -- -- -- -- $sel:sourceDocumentsS3Uri:AugmentedManifestsListItem', -- augmentedManifestsListItem_sourceDocumentsS3Uri - The S3 prefix -- to the source files (PDFs) that are referred to in the augmented -- manifest file. -- -- $sel:split:AugmentedManifestsListItem', -- augmentedManifestsListItem_split - The purpose of the data -- you've provided in the augmented manifest. You can either train or -- test this data. If you don't specify, the default is train. -- -- TRAIN - all of the documents in the manifest will be used for -- training. If no test documents are provided, Amazon Comprehend will -- automatically reserve a portion of the training documents for testing. -- -- TEST - all of the documents in the manifest will be used for testing. -- -- $sel:s3Uri:AugmentedManifestsListItem', -- augmentedManifestsListItem_s3Uri - The Amazon S3 location of -- the augmented manifest file. -- -- $sel:attributeNames:AugmentedManifestsListItem', -- augmentedManifestsListItem_attributeNames - The JSON attribute -- that contains the annotations for your training documents. The number -- of attribute names that you specify depends on whether your augmented -- manifest file is the output of a single labeling job or a chained -- labeling job. -- -- If your file is the output of a single labeling job, specify the -- LabelAttributeName key that was used when the job was created in -- Ground Truth. -- -- If your file is the output of a chained labeling job, specify the -- LabelAttributeName key for one or more jobs in the chain. Each -- LabelAttributeName key provides the annotations from an individual -- job. newAugmentedManifestsListItem :: Text -> AugmentedManifestsListItem -- | The S3 prefix to the annotation files that are referred in the -- augmented manifest file. augmentedManifestsListItem_annotationDataS3Uri :: Lens' AugmentedManifestsListItem (Maybe Text) -- | The type of augmented manifest. PlainTextDocument or -- SemiStructuredDocument. If you don't specify, the default is -- PlainTextDocument. -- -- augmentedManifestsListItem_documentType :: Lens' AugmentedManifestsListItem (Maybe AugmentedManifestsDocumentTypeFormat) -- | The S3 prefix to the source files (PDFs) that are referred to in the -- augmented manifest file. augmentedManifestsListItem_sourceDocumentsS3Uri :: Lens' AugmentedManifestsListItem (Maybe Text) -- | The purpose of the data you've provided in the augmented manifest. You -- can either train or test this data. If you don't specify, the default -- is train. -- -- TRAIN - all of the documents in the manifest will be used for -- training. If no test documents are provided, Amazon Comprehend will -- automatically reserve a portion of the training documents for testing. -- -- TEST - all of the documents in the manifest will be used for testing. augmentedManifestsListItem_split :: Lens' AugmentedManifestsListItem (Maybe Split) -- | The Amazon S3 location of the augmented manifest file. augmentedManifestsListItem_s3Uri :: Lens' AugmentedManifestsListItem Text -- | The JSON attribute that contains the annotations for your training -- documents. The number of attribute names that you specify depends on -- whether your augmented manifest file is the output of a single -- labeling job or a chained labeling job. -- -- If your file is the output of a single labeling job, specify the -- LabelAttributeName key that was used when the job was created in -- Ground Truth. -- -- If your file is the output of a chained labeling job, specify the -- LabelAttributeName key for one or more jobs in the chain. Each -- LabelAttributeName key provides the annotations from an individual -- job. augmentedManifestsListItem_attributeNames :: Lens' AugmentedManifestsListItem [Text] instance GHC.Generics.Generic Amazonka.Comprehend.Types.AugmentedManifestsListItem.AugmentedManifestsListItem instance GHC.Show.Show Amazonka.Comprehend.Types.AugmentedManifestsListItem.AugmentedManifestsListItem instance GHC.Read.Read Amazonka.Comprehend.Types.AugmentedManifestsListItem.AugmentedManifestsListItem instance GHC.Classes.Eq Amazonka.Comprehend.Types.AugmentedManifestsListItem.AugmentedManifestsListItem instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.AugmentedManifestsListItem.AugmentedManifestsListItem instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.AugmentedManifestsListItem.AugmentedManifestsListItem instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.AugmentedManifestsListItem.AugmentedManifestsListItem instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.AugmentedManifestsListItem.AugmentedManifestsListItem module Amazonka.Comprehend.Types.EntityRecognizerInputDataConfig -- | Specifies the format and location of the input data. -- -- See: newEntityRecognizerInputDataConfig smart -- constructor. data EntityRecognizerInputDataConfig EntityRecognizerInputDataConfig' :: Maybe EntityRecognizerAnnotations -> Maybe [AugmentedManifestsListItem] -> Maybe EntityRecognizerDataFormat -> Maybe EntityRecognizerDocuments -> Maybe EntityRecognizerEntityList -> [EntityTypesListItem] -> EntityRecognizerInputDataConfig -- | The S3 location of the CSV file that annotates your training -- documents. [$sel:annotations:EntityRecognizerInputDataConfig'] :: EntityRecognizerInputDataConfig -> Maybe EntityRecognizerAnnotations -- | A list of augmented manifest files that provide training data for your -- custom model. An augmented manifest file is a labeled dataset that is -- produced by Amazon SageMaker Ground Truth. -- -- This parameter is required if you set DataFormat to -- AUGMENTED_MANIFEST. [$sel:augmentedManifests:EntityRecognizerInputDataConfig'] :: EntityRecognizerInputDataConfig -> Maybe [AugmentedManifestsListItem] -- | The format of your training data: -- -- -- -- If you don't specify a value, Amazon Comprehend uses -- COMPREHEND_CSV as the default. [$sel:dataFormat:EntityRecognizerInputDataConfig'] :: EntityRecognizerInputDataConfig -> Maybe EntityRecognizerDataFormat -- | The S3 location of the folder that contains the training documents for -- your custom entity recognizer. -- -- This parameter is required if you set DataFormat to -- COMPREHEND_CSV. [$sel:documents:EntityRecognizerInputDataConfig'] :: EntityRecognizerInputDataConfig -> Maybe EntityRecognizerDocuments -- | The S3 location of the CSV file that has the entity list for your -- custom entity recognizer. [$sel:entityList:EntityRecognizerInputDataConfig'] :: EntityRecognizerInputDataConfig -> Maybe EntityRecognizerEntityList -- | The entity types in the labeled training data that Amazon Comprehend -- uses to train the custom entity recognizer. Any entity types that you -- don't specify are ignored. -- -- A maximum of 25 entity types can be used at one time to train an -- entity recognizer. Entity types must not contain the following invalid -- characters: \n (line break), \\n (escaped line break), \r (carriage -- return), \\r (escaped carriage return), \t (tab), \\t (escaped tab), -- space, and , (comma). [$sel:entityTypes:EntityRecognizerInputDataConfig'] :: EntityRecognizerInputDataConfig -> [EntityTypesListItem] -- | Create a value of EntityRecognizerInputDataConfig with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:annotations:EntityRecognizerInputDataConfig', -- entityRecognizerInputDataConfig_annotations - The S3 location -- of the CSV file that annotates your training documents. -- -- $sel:augmentedManifests:EntityRecognizerInputDataConfig', -- entityRecognizerInputDataConfig_augmentedManifests - A list of -- augmented manifest files that provide training data for your custom -- model. An augmented manifest file is a labeled dataset that is -- produced by Amazon SageMaker Ground Truth. -- -- This parameter is required if you set DataFormat to -- AUGMENTED_MANIFEST. -- -- $sel:dataFormat:EntityRecognizerInputDataConfig', -- entityRecognizerInputDataConfig_dataFormat - The format of your -- training data: -- -- -- -- If you don't specify a value, Amazon Comprehend uses -- COMPREHEND_CSV as the default. -- -- $sel:documents:EntityRecognizerInputDataConfig', -- entityRecognizerInputDataConfig_documents - The S3 location of -- the folder that contains the training documents for your custom entity -- recognizer. -- -- This parameter is required if you set DataFormat to -- COMPREHEND_CSV. -- -- $sel:entityList:EntityRecognizerInputDataConfig', -- entityRecognizerInputDataConfig_entityList - The S3 location of -- the CSV file that has the entity list for your custom entity -- recognizer. -- -- $sel:entityTypes:EntityRecognizerInputDataConfig', -- entityRecognizerInputDataConfig_entityTypes - The entity types -- in the labeled training data that Amazon Comprehend uses to train the -- custom entity recognizer. Any entity types that you don't specify are -- ignored. -- -- A maximum of 25 entity types can be used at one time to train an -- entity recognizer. Entity types must not contain the following invalid -- characters: \n (line break), \\n (escaped line break), \r (carriage -- return), \\r (escaped carriage return), \t (tab), \\t (escaped tab), -- space, and , (comma). newEntityRecognizerInputDataConfig :: EntityRecognizerInputDataConfig -- | The S3 location of the CSV file that annotates your training -- documents. entityRecognizerInputDataConfig_annotations :: Lens' EntityRecognizerInputDataConfig (Maybe EntityRecognizerAnnotations) -- | A list of augmented manifest files that provide training data for your -- custom model. An augmented manifest file is a labeled dataset that is -- produced by Amazon SageMaker Ground Truth. -- -- This parameter is required if you set DataFormat to -- AUGMENTED_MANIFEST. entityRecognizerInputDataConfig_augmentedManifests :: Lens' EntityRecognizerInputDataConfig (Maybe [AugmentedManifestsListItem]) -- | The format of your training data: -- -- -- -- If you don't specify a value, Amazon Comprehend uses -- COMPREHEND_CSV as the default. entityRecognizerInputDataConfig_dataFormat :: Lens' EntityRecognizerInputDataConfig (Maybe EntityRecognizerDataFormat) -- | The S3 location of the folder that contains the training documents for -- your custom entity recognizer. -- -- This parameter is required if you set DataFormat to -- COMPREHEND_CSV. entityRecognizerInputDataConfig_documents :: Lens' EntityRecognizerInputDataConfig (Maybe EntityRecognizerDocuments) -- | The S3 location of the CSV file that has the entity list for your -- custom entity recognizer. entityRecognizerInputDataConfig_entityList :: Lens' EntityRecognizerInputDataConfig (Maybe EntityRecognizerEntityList) -- | The entity types in the labeled training data that Amazon Comprehend -- uses to train the custom entity recognizer. Any entity types that you -- don't specify are ignored. -- -- A maximum of 25 entity types can be used at one time to train an -- entity recognizer. Entity types must not contain the following invalid -- characters: \n (line break), \\n (escaped line break), \r (carriage -- return), \\r (escaped carriage return), \t (tab), \\t (escaped tab), -- space, and , (comma). entityRecognizerInputDataConfig_entityTypes :: Lens' EntityRecognizerInputDataConfig [EntityTypesListItem] instance GHC.Generics.Generic Amazonka.Comprehend.Types.EntityRecognizerInputDataConfig.EntityRecognizerInputDataConfig instance GHC.Show.Show Amazonka.Comprehend.Types.EntityRecognizerInputDataConfig.EntityRecognizerInputDataConfig instance GHC.Read.Read Amazonka.Comprehend.Types.EntityRecognizerInputDataConfig.EntityRecognizerInputDataConfig instance GHC.Classes.Eq Amazonka.Comprehend.Types.EntityRecognizerInputDataConfig.EntityRecognizerInputDataConfig instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.EntityRecognizerInputDataConfig.EntityRecognizerInputDataConfig instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.EntityRecognizerInputDataConfig.EntityRecognizerInputDataConfig instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.EntityRecognizerInputDataConfig.EntityRecognizerInputDataConfig instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.EntityRecognizerInputDataConfig.EntityRecognizerInputDataConfig module Amazonka.Comprehend.Types.DocumentClassifierInputDataConfig -- | The input properties for training a document classifier. -- -- For more information on how the input file is formatted, see -- Preparing training data in the Comprehend Developer Guide. -- -- See: newDocumentClassifierInputDataConfig smart -- constructor. data DocumentClassifierInputDataConfig DocumentClassifierInputDataConfig' :: Maybe [AugmentedManifestsListItem] -> Maybe DocumentClassifierDataFormat -> Maybe Text -> Maybe Text -> Maybe Text -> DocumentClassifierInputDataConfig -- | A list of augmented manifest files that provide training data for your -- custom model. An augmented manifest file is a labeled dataset that is -- produced by Amazon SageMaker Ground Truth. -- -- This parameter is required if you set DataFormat to -- AUGMENTED_MANIFEST. [$sel:augmentedManifests:DocumentClassifierInputDataConfig'] :: DocumentClassifierInputDataConfig -> Maybe [AugmentedManifestsListItem] -- | The format of your training data: -- -- -- -- If you don't specify a value, Amazon Comprehend uses -- COMPREHEND_CSV as the default. [$sel:dataFormat:DocumentClassifierInputDataConfig'] :: DocumentClassifierInputDataConfig -> Maybe DocumentClassifierDataFormat -- | Indicates the delimiter used to separate each label for training a -- multi-label classifier. The default delimiter between labels is a pipe -- (|). You can use a different character as a delimiter (if it's an -- allowed character) by specifying it under Delimiter for labels. If the -- training documents use a delimiter other than the default or the -- delimiter you specify, the labels on that line will be combined to -- make a single unique label, such as LABELLABELLABEL. [$sel:labelDelimiter:DocumentClassifierInputDataConfig'] :: DocumentClassifierInputDataConfig -> Maybe Text -- | The Amazon S3 URI for the input data. The S3 bucket must be in the -- same region as the API endpoint that you are calling. The URI can -- point to a single input file or it can provide the prefix for a -- collection of input files. -- -- For example, if you use the URI S3://bucketName/prefix, if -- the prefix is a single file, Amazon Comprehend uses that file as -- input. If more than one file begins with the prefix, Amazon Comprehend -- uses all of them as input. -- -- This parameter is required if you set DataFormat to -- COMPREHEND_CSV. [$sel:s3Uri:DocumentClassifierInputDataConfig'] :: DocumentClassifierInputDataConfig -> Maybe Text -- | This specifies the Amazon S3 location where the test annotations for -- an entity recognizer are located. The URI must be in the same AWS -- Region as the API endpoint that you are calling. [$sel:testS3Uri:DocumentClassifierInputDataConfig'] :: DocumentClassifierInputDataConfig -> Maybe Text -- | Create a value of DocumentClassifierInputDataConfig with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:augmentedManifests:DocumentClassifierInputDataConfig', -- documentClassifierInputDataConfig_augmentedManifests - A list -- of augmented manifest files that provide training data for your custom -- model. An augmented manifest file is a labeled dataset that is -- produced by Amazon SageMaker Ground Truth. -- -- This parameter is required if you set DataFormat to -- AUGMENTED_MANIFEST. -- -- $sel:dataFormat:DocumentClassifierInputDataConfig', -- documentClassifierInputDataConfig_dataFormat - The format of -- your training data: -- -- -- -- If you don't specify a value, Amazon Comprehend uses -- COMPREHEND_CSV as the default. -- -- $sel:labelDelimiter:DocumentClassifierInputDataConfig', -- documentClassifierInputDataConfig_labelDelimiter - Indicates -- the delimiter used to separate each label for training a multi-label -- classifier. The default delimiter between labels is a pipe (|). You -- can use a different character as a delimiter (if it's an allowed -- character) by specifying it under Delimiter for labels. If the -- training documents use a delimiter other than the default or the -- delimiter you specify, the labels on that line will be combined to -- make a single unique label, such as LABELLABELLABEL. -- -- DocumentClassifierInputDataConfig, -- documentClassifierInputDataConfig_s3Uri - The Amazon S3 URI for -- the input data. The S3 bucket must be in the same region as the API -- endpoint that you are calling. The URI can point to a single input -- file or it can provide the prefix for a collection of input files. -- -- For example, if you use the URI S3://bucketName/prefix, if -- the prefix is a single file, Amazon Comprehend uses that file as -- input. If more than one file begins with the prefix, Amazon Comprehend -- uses all of them as input. -- -- This parameter is required if you set DataFormat to -- COMPREHEND_CSV. -- -- $sel:testS3Uri:DocumentClassifierInputDataConfig', -- documentClassifierInputDataConfig_testS3Uri - This specifies -- the Amazon S3 location where the test annotations for an entity -- recognizer are located. The URI must be in the same AWS Region as the -- API endpoint that you are calling. newDocumentClassifierInputDataConfig :: DocumentClassifierInputDataConfig -- | A list of augmented manifest files that provide training data for your -- custom model. An augmented manifest file is a labeled dataset that is -- produced by Amazon SageMaker Ground Truth. -- -- This parameter is required if you set DataFormat to -- AUGMENTED_MANIFEST. documentClassifierInputDataConfig_augmentedManifests :: Lens' DocumentClassifierInputDataConfig (Maybe [AugmentedManifestsListItem]) -- | The format of your training data: -- -- -- -- If you don't specify a value, Amazon Comprehend uses -- COMPREHEND_CSV as the default. documentClassifierInputDataConfig_dataFormat :: Lens' DocumentClassifierInputDataConfig (Maybe DocumentClassifierDataFormat) -- | Indicates the delimiter used to separate each label for training a -- multi-label classifier. The default delimiter between labels is a pipe -- (|). You can use a different character as a delimiter (if it's an -- allowed character) by specifying it under Delimiter for labels. If the -- training documents use a delimiter other than the default or the -- delimiter you specify, the labels on that line will be combined to -- make a single unique label, such as LABELLABELLABEL. documentClassifierInputDataConfig_labelDelimiter :: Lens' DocumentClassifierInputDataConfig (Maybe Text) -- | The Amazon S3 URI for the input data. The S3 bucket must be in the -- same region as the API endpoint that you are calling. The URI can -- point to a single input file or it can provide the prefix for a -- collection of input files. -- -- For example, if you use the URI S3://bucketName/prefix, if -- the prefix is a single file, Amazon Comprehend uses that file as -- input. If more than one file begins with the prefix, Amazon Comprehend -- uses all of them as input. -- -- This parameter is required if you set DataFormat to -- COMPREHEND_CSV. documentClassifierInputDataConfig_s3Uri :: Lens' DocumentClassifierInputDataConfig (Maybe Text) -- | This specifies the Amazon S3 location where the test annotations for -- an entity recognizer are located. The URI must be in the same AWS -- Region as the API endpoint that you are calling. documentClassifierInputDataConfig_testS3Uri :: Lens' DocumentClassifierInputDataConfig (Maybe Text) instance GHC.Generics.Generic Amazonka.Comprehend.Types.DocumentClassifierInputDataConfig.DocumentClassifierInputDataConfig instance GHC.Show.Show Amazonka.Comprehend.Types.DocumentClassifierInputDataConfig.DocumentClassifierInputDataConfig instance GHC.Read.Read Amazonka.Comprehend.Types.DocumentClassifierInputDataConfig.DocumentClassifierInputDataConfig instance GHC.Classes.Eq Amazonka.Comprehend.Types.DocumentClassifierInputDataConfig.DocumentClassifierInputDataConfig instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.DocumentClassifierInputDataConfig.DocumentClassifierInputDataConfig instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.DocumentClassifierInputDataConfig.DocumentClassifierInputDataConfig instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.DocumentClassifierInputDataConfig.DocumentClassifierInputDataConfig instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.DocumentClassifierInputDataConfig.DocumentClassifierInputDataConfig module Amazonka.Comprehend.Types.SyntaxLanguageCode newtype SyntaxLanguageCode SyntaxLanguageCode' :: Text -> SyntaxLanguageCode [fromSyntaxLanguageCode] :: SyntaxLanguageCode -> Text pattern SyntaxLanguageCode_De :: SyntaxLanguageCode pattern SyntaxLanguageCode_En :: SyntaxLanguageCode pattern SyntaxLanguageCode_Es :: SyntaxLanguageCode pattern SyntaxLanguageCode_Fr :: SyntaxLanguageCode pattern SyntaxLanguageCode_It :: SyntaxLanguageCode pattern SyntaxLanguageCode_Pt :: SyntaxLanguageCode instance Amazonka.Data.XML.ToXML Amazonka.Comprehend.Types.SyntaxLanguageCode.SyntaxLanguageCode instance Amazonka.Data.XML.FromXML Amazonka.Comprehend.Types.SyntaxLanguageCode.SyntaxLanguageCode instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.Comprehend.Types.SyntaxLanguageCode.SyntaxLanguageCode instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.SyntaxLanguageCode.SyntaxLanguageCode instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.Comprehend.Types.SyntaxLanguageCode.SyntaxLanguageCode instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.SyntaxLanguageCode.SyntaxLanguageCode instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.Types.SyntaxLanguageCode.SyntaxLanguageCode instance Amazonka.Data.Headers.ToHeader Amazonka.Comprehend.Types.SyntaxLanguageCode.SyntaxLanguageCode instance Amazonka.Data.Log.ToLog Amazonka.Comprehend.Types.SyntaxLanguageCode.SyntaxLanguageCode instance Amazonka.Data.ByteString.ToByteString Amazonka.Comprehend.Types.SyntaxLanguageCode.SyntaxLanguageCode instance Amazonka.Data.Text.ToText Amazonka.Comprehend.Types.SyntaxLanguageCode.SyntaxLanguageCode instance Amazonka.Data.Text.FromText Amazonka.Comprehend.Types.SyntaxLanguageCode.SyntaxLanguageCode instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.SyntaxLanguageCode.SyntaxLanguageCode instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.SyntaxLanguageCode.SyntaxLanguageCode instance GHC.Generics.Generic Amazonka.Comprehend.Types.SyntaxLanguageCode.SyntaxLanguageCode instance GHC.Classes.Ord Amazonka.Comprehend.Types.SyntaxLanguageCode.SyntaxLanguageCode instance GHC.Classes.Eq Amazonka.Comprehend.Types.SyntaxLanguageCode.SyntaxLanguageCode instance GHC.Read.Read Amazonka.Comprehend.Types.SyntaxLanguageCode.SyntaxLanguageCode instance GHC.Show.Show Amazonka.Comprehend.Types.SyntaxLanguageCode.SyntaxLanguageCode module Amazonka.Comprehend.Types.SyntaxToken -- | Represents a work in the input text that was recognized and assigned a -- part of speech. There is one syntax token record for each word in the -- source text. -- -- See: newSyntaxToken smart constructor. data SyntaxToken SyntaxToken' :: Maybe Int -> Maybe Int -> Maybe PartOfSpeechTag -> Maybe Text -> Maybe Int -> SyntaxToken -- | The zero-based offset from the beginning of the source text to the -- first character in the word. [$sel:beginOffset:SyntaxToken'] :: SyntaxToken -> Maybe Int -- | The zero-based offset from the beginning of the source text to the -- last character in the word. [$sel:endOffset:SyntaxToken'] :: SyntaxToken -> Maybe Int -- | Provides the part of speech label and the confidence level that Amazon -- Comprehend has that the part of speech was correctly identified. For -- more information, see Syntax in the Comprehend Developer Guide. [$sel:partOfSpeech:SyntaxToken'] :: SyntaxToken -> Maybe PartOfSpeechTag -- | The word that was recognized in the source text. [$sel:text:SyntaxToken'] :: SyntaxToken -> Maybe Text -- | A unique identifier for a token. [$sel:tokenId:SyntaxToken'] :: SyntaxToken -> Maybe Int -- | Create a value of SyntaxToken with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:beginOffset:SyntaxToken', syntaxToken_beginOffset - -- The zero-based offset from the beginning of the source text to the -- first character in the word. -- -- $sel:endOffset:SyntaxToken', syntaxToken_endOffset - The -- zero-based offset from the beginning of the source text to the last -- character in the word. -- -- $sel:partOfSpeech:SyntaxToken', syntaxToken_partOfSpeech -- - Provides the part of speech label and the confidence level that -- Amazon Comprehend has that the part of speech was correctly -- identified. For more information, see Syntax in the Comprehend -- Developer Guide. -- -- $sel:text:SyntaxToken', syntaxToken_text - The word that -- was recognized in the source text. -- -- $sel:tokenId:SyntaxToken', syntaxToken_tokenId - A -- unique identifier for a token. newSyntaxToken :: SyntaxToken -- | The zero-based offset from the beginning of the source text to the -- first character in the word. syntaxToken_beginOffset :: Lens' SyntaxToken (Maybe Int) -- | The zero-based offset from the beginning of the source text to the -- last character in the word. syntaxToken_endOffset :: Lens' SyntaxToken (Maybe Int) -- | Provides the part of speech label and the confidence level that Amazon -- Comprehend has that the part of speech was correctly identified. For -- more information, see Syntax in the Comprehend Developer Guide. syntaxToken_partOfSpeech :: Lens' SyntaxToken (Maybe PartOfSpeechTag) -- | The word that was recognized in the source text. syntaxToken_text :: Lens' SyntaxToken (Maybe Text) -- | A unique identifier for a token. syntaxToken_tokenId :: Lens' SyntaxToken (Maybe Int) instance GHC.Generics.Generic Amazonka.Comprehend.Types.SyntaxToken.SyntaxToken instance GHC.Show.Show Amazonka.Comprehend.Types.SyntaxToken.SyntaxToken instance GHC.Read.Read Amazonka.Comprehend.Types.SyntaxToken.SyntaxToken instance GHC.Classes.Eq Amazonka.Comprehend.Types.SyntaxToken.SyntaxToken instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.SyntaxToken.SyntaxToken instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.SyntaxToken.SyntaxToken instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.SyntaxToken.SyntaxToken module Amazonka.Comprehend.Types.BatchDetectSyntaxItemResult -- | The result of calling the operation. The operation returns one object -- that is successfully processed by the operation. -- -- See: newBatchDetectSyntaxItemResult smart constructor. data BatchDetectSyntaxItemResult BatchDetectSyntaxItemResult' :: Maybe Int -> Maybe [SyntaxToken] -> BatchDetectSyntaxItemResult -- | The zero-based index of the document in the input list. [$sel:index:BatchDetectSyntaxItemResult'] :: BatchDetectSyntaxItemResult -> Maybe Int -- | The syntax tokens for the words in the document, one token for each -- word. [$sel:syntaxTokens:BatchDetectSyntaxItemResult'] :: BatchDetectSyntaxItemResult -> Maybe [SyntaxToken] -- | Create a value of BatchDetectSyntaxItemResult with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:index:BatchDetectSyntaxItemResult', -- batchDetectSyntaxItemResult_index - The zero-based index of the -- document in the input list. -- -- $sel:syntaxTokens:BatchDetectSyntaxItemResult', -- batchDetectSyntaxItemResult_syntaxTokens - The syntax tokens -- for the words in the document, one token for each word. newBatchDetectSyntaxItemResult :: BatchDetectSyntaxItemResult -- | The zero-based index of the document in the input list. batchDetectSyntaxItemResult_index :: Lens' BatchDetectSyntaxItemResult (Maybe Int) -- | The syntax tokens for the words in the document, one token for each -- word. batchDetectSyntaxItemResult_syntaxTokens :: Lens' BatchDetectSyntaxItemResult (Maybe [SyntaxToken]) instance GHC.Generics.Generic Amazonka.Comprehend.Types.BatchDetectSyntaxItemResult.BatchDetectSyntaxItemResult instance GHC.Show.Show Amazonka.Comprehend.Types.BatchDetectSyntaxItemResult.BatchDetectSyntaxItemResult instance GHC.Read.Read Amazonka.Comprehend.Types.BatchDetectSyntaxItemResult.BatchDetectSyntaxItemResult instance GHC.Classes.Eq Amazonka.Comprehend.Types.BatchDetectSyntaxItemResult.BatchDetectSyntaxItemResult instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.BatchDetectSyntaxItemResult.BatchDetectSyntaxItemResult instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.BatchDetectSyntaxItemResult.BatchDetectSyntaxItemResult instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.BatchDetectSyntaxItemResult.BatchDetectSyntaxItemResult module Amazonka.Comprehend.Types.Tag -- | A key-value pair that adds as a metadata to a resource used by Amazon -- Comprehend. For example, a tag with the key-value pair -- ‘Department’:’Sales’ might be added to a resource to indicate its use -- by a particular department. -- -- See: newTag smart constructor. data Tag Tag' :: Maybe Text -> Text -> Tag -- | The second part of a key-value pair that forms a tag associated with a -- given resource. For instance, if you want to show which resources are -- used by which departments, you might use “Department” as the initial -- (key) portion of the pair, with a value of “sales” to indicate the -- sales department. [$sel:value:Tag'] :: Tag -> Maybe Text -- | The initial part of a key-value pair that forms a tag associated with -- a given resource. For instance, if you want to show which resources -- are used by which departments, you might use “Department” as the key -- portion of the pair, with multiple possible values such as “sales,” -- “legal,” and “administration.” [$sel:key:Tag'] :: Tag -> Text -- | Create a value of Tag with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:value:Tag', tag_value - The second part of a -- key-value pair that forms a tag associated with a given resource. For -- instance, if you want to show which resources are used by which -- departments, you might use “Department” as the initial (key) portion -- of the pair, with a value of “sales” to indicate the sales department. -- -- $sel:key:Tag', tag_key - The initial part of a key-value -- pair that forms a tag associated with a given resource. For instance, -- if you want to show which resources are used by which departments, you -- might use “Department” as the key portion of the pair, with multiple -- possible values such as “sales,” “legal,” and “administration.” newTag :: Text -> Tag -- | The second part of a key-value pair that forms a tag associated with a -- given resource. For instance, if you want to show which resources are -- used by which departments, you might use “Department” as the initial -- (key) portion of the pair, with a value of “sales” to indicate the -- sales department. tag_value :: Lens' Tag (Maybe Text) -- | The initial part of a key-value pair that forms a tag associated with -- a given resource. For instance, if you want to show which resources -- are used by which departments, you might use “Department” as the key -- portion of the pair, with multiple possible values such as “sales,” -- “legal,” and “administration.” tag_key :: Lens' Tag Text instance GHC.Generics.Generic Amazonka.Comprehend.Types.Tag.Tag instance GHC.Show.Show Amazonka.Comprehend.Types.Tag.Tag instance GHC.Read.Read Amazonka.Comprehend.Types.Tag.Tag instance GHC.Classes.Eq Amazonka.Comprehend.Types.Tag.Tag instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.Tag.Tag instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.Tag.Tag instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.Tag.Tag instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.Tag.Tag module Amazonka.Comprehend.Types.TargetedSentimentDetectionJobFilter -- | Provides information for filtering a list of dominant language -- detection jobs. For more information, see the operation. -- -- See: newTargetedSentimentDetectionJobFilter smart -- constructor. data TargetedSentimentDetectionJobFilter TargetedSentimentDetectionJobFilter' :: Maybe Text -> Maybe JobStatus -> Maybe POSIX -> Maybe POSIX -> TargetedSentimentDetectionJobFilter -- | Filters on the name of the job. [$sel:jobName:TargetedSentimentDetectionJobFilter'] :: TargetedSentimentDetectionJobFilter -> Maybe Text -- | Filters the list of jobs based on job status. Returns only jobs with -- the specified status. [$sel:jobStatus:TargetedSentimentDetectionJobFilter'] :: TargetedSentimentDetectionJobFilter -> Maybe JobStatus -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. [$sel:submitTimeAfter:TargetedSentimentDetectionJobFilter'] :: TargetedSentimentDetectionJobFilter -> Maybe POSIX -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. [$sel:submitTimeBefore:TargetedSentimentDetectionJobFilter'] :: TargetedSentimentDetectionJobFilter -> Maybe POSIX -- | Create a value of TargetedSentimentDetectionJobFilter with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:jobName:TargetedSentimentDetectionJobFilter', -- targetedSentimentDetectionJobFilter_jobName - Filters on the -- name of the job. -- -- $sel:jobStatus:TargetedSentimentDetectionJobFilter', -- targetedSentimentDetectionJobFilter_jobStatus - Filters the -- list of jobs based on job status. Returns only jobs with the specified -- status. -- -- $sel:submitTimeAfter:TargetedSentimentDetectionJobFilter', -- targetedSentimentDetectionJobFilter_submitTimeAfter - Filters -- the list of jobs based on the time that the job was submitted for -- processing. Returns only jobs submitted after the specified time. Jobs -- are returned in descending order, newest to oldest. -- -- $sel:submitTimeBefore:TargetedSentimentDetectionJobFilter', -- targetedSentimentDetectionJobFilter_submitTimeBefore - Filters -- the list of jobs based on the time that the job was submitted for -- processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. newTargetedSentimentDetectionJobFilter :: TargetedSentimentDetectionJobFilter -- | Filters on the name of the job. targetedSentimentDetectionJobFilter_jobName :: Lens' TargetedSentimentDetectionJobFilter (Maybe Text) -- | Filters the list of jobs based on job status. Returns only jobs with -- the specified status. targetedSentimentDetectionJobFilter_jobStatus :: Lens' TargetedSentimentDetectionJobFilter (Maybe JobStatus) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. targetedSentimentDetectionJobFilter_submitTimeAfter :: Lens' TargetedSentimentDetectionJobFilter (Maybe UTCTime) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. targetedSentimentDetectionJobFilter_submitTimeBefore :: Lens' TargetedSentimentDetectionJobFilter (Maybe UTCTime) instance GHC.Generics.Generic Amazonka.Comprehend.Types.TargetedSentimentDetectionJobFilter.TargetedSentimentDetectionJobFilter instance GHC.Show.Show Amazonka.Comprehend.Types.TargetedSentimentDetectionJobFilter.TargetedSentimentDetectionJobFilter instance GHC.Read.Read Amazonka.Comprehend.Types.TargetedSentimentDetectionJobFilter.TargetedSentimentDetectionJobFilter instance GHC.Classes.Eq Amazonka.Comprehend.Types.TargetedSentimentDetectionJobFilter.TargetedSentimentDetectionJobFilter instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.TargetedSentimentDetectionJobFilter.TargetedSentimentDetectionJobFilter instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.TargetedSentimentDetectionJobFilter.TargetedSentimentDetectionJobFilter instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.TargetedSentimentDetectionJobFilter.TargetedSentimentDetectionJobFilter module Amazonka.Comprehend.Types.TargetedSentimentEntityType newtype TargetedSentimentEntityType TargetedSentimentEntityType' :: Text -> TargetedSentimentEntityType [fromTargetedSentimentEntityType] :: TargetedSentimentEntityType -> Text pattern TargetedSentimentEntityType_ATTRIBUTE :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_BOOK :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_BRAND :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_COMMERCIAL_ITEM :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_DATE :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_EVENT :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_FACILITY :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_GAME :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_LOCATION :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_MOVIE :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_MUSIC :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_ORGANIZATION :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_OTHER :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_PERSON :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_PERSONAL_TITLE :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_QUANTITY :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_SOFTWARE :: TargetedSentimentEntityType instance Amazonka.Data.XML.ToXML Amazonka.Comprehend.Types.TargetedSentimentEntityType.TargetedSentimentEntityType instance Amazonka.Data.XML.FromXML Amazonka.Comprehend.Types.TargetedSentimentEntityType.TargetedSentimentEntityType instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.Comprehend.Types.TargetedSentimentEntityType.TargetedSentimentEntityType instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.TargetedSentimentEntityType.TargetedSentimentEntityType instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.Comprehend.Types.TargetedSentimentEntityType.TargetedSentimentEntityType instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.TargetedSentimentEntityType.TargetedSentimentEntityType instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.Types.TargetedSentimentEntityType.TargetedSentimentEntityType instance Amazonka.Data.Headers.ToHeader Amazonka.Comprehend.Types.TargetedSentimentEntityType.TargetedSentimentEntityType instance Amazonka.Data.Log.ToLog Amazonka.Comprehend.Types.TargetedSentimentEntityType.TargetedSentimentEntityType instance Amazonka.Data.ByteString.ToByteString Amazonka.Comprehend.Types.TargetedSentimentEntityType.TargetedSentimentEntityType instance Amazonka.Data.Text.ToText Amazonka.Comprehend.Types.TargetedSentimentEntityType.TargetedSentimentEntityType instance Amazonka.Data.Text.FromText Amazonka.Comprehend.Types.TargetedSentimentEntityType.TargetedSentimentEntityType instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.TargetedSentimentEntityType.TargetedSentimentEntityType instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.TargetedSentimentEntityType.TargetedSentimentEntityType instance GHC.Generics.Generic Amazonka.Comprehend.Types.TargetedSentimentEntityType.TargetedSentimentEntityType instance GHC.Classes.Ord Amazonka.Comprehend.Types.TargetedSentimentEntityType.TargetedSentimentEntityType instance GHC.Classes.Eq Amazonka.Comprehend.Types.TargetedSentimentEntityType.TargetedSentimentEntityType instance GHC.Read.Read Amazonka.Comprehend.Types.TargetedSentimentEntityType.TargetedSentimentEntityType instance GHC.Show.Show Amazonka.Comprehend.Types.TargetedSentimentEntityType.TargetedSentimentEntityType module Amazonka.Comprehend.Types.TargetedSentimentMention -- | Information about one mention of an entity. The mention information -- includes the location of the mention in the text and the sentiment of -- the mention. -- -- For more information about targeted sentiment, see Targeted -- sentiment. -- -- See: newTargetedSentimentMention smart constructor. data TargetedSentimentMention TargetedSentimentMention' :: Maybe Int -> Maybe Int -> Maybe Double -> Maybe MentionSentiment -> Maybe Double -> Maybe Text -> Maybe TargetedSentimentEntityType -> TargetedSentimentMention -- | The offset into the document text where the mention begins. [$sel:beginOffset:TargetedSentimentMention'] :: TargetedSentimentMention -> Maybe Int -- | The offset into the document text where the mention ends. [$sel:endOffset:TargetedSentimentMention'] :: TargetedSentimentMention -> Maybe Int -- | The confidence that all the entities mentioned in the group relate to -- the same entity. [$sel:groupScore:TargetedSentimentMention'] :: TargetedSentimentMention -> Maybe Double -- | Contains the sentiment and sentiment score for the mention. [$sel:mentionSentiment:TargetedSentimentMention'] :: TargetedSentimentMention -> Maybe MentionSentiment -- | Model confidence that the entity is relevant. Value range is zero to -- one, where one is highest confidence. [$sel:score:TargetedSentimentMention'] :: TargetedSentimentMention -> Maybe Double -- | The text in the document that identifies the entity. [$sel:text:TargetedSentimentMention'] :: TargetedSentimentMention -> Maybe Text -- | The type of the entity. Amazon Comprehend supports a variety of -- entity types. [$sel:type':TargetedSentimentMention'] :: TargetedSentimentMention -> Maybe TargetedSentimentEntityType -- | Create a value of TargetedSentimentMention with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:beginOffset:TargetedSentimentMention', -- targetedSentimentMention_beginOffset - The offset into the -- document text where the mention begins. -- -- $sel:endOffset:TargetedSentimentMention', -- targetedSentimentMention_endOffset - The offset into the -- document text where the mention ends. -- -- $sel:groupScore:TargetedSentimentMention', -- targetedSentimentMention_groupScore - The confidence that all -- the entities mentioned in the group relate to the same entity. -- -- $sel:mentionSentiment:TargetedSentimentMention', -- targetedSentimentMention_mentionSentiment - Contains the -- sentiment and sentiment score for the mention. -- -- $sel:score:TargetedSentimentMention', -- targetedSentimentMention_score - Model confidence that the -- entity is relevant. Value range is zero to one, where one is highest -- confidence. -- -- $sel:text:TargetedSentimentMention', -- targetedSentimentMention_text - The text in the document that -- identifies the entity. -- -- $sel:type':TargetedSentimentMention', -- targetedSentimentMention_type - The type of the entity. Amazon -- Comprehend supports a variety of entity types. newTargetedSentimentMention :: TargetedSentimentMention -- | The offset into the document text where the mention begins. targetedSentimentMention_beginOffset :: Lens' TargetedSentimentMention (Maybe Int) -- | The offset into the document text where the mention ends. targetedSentimentMention_endOffset :: Lens' TargetedSentimentMention (Maybe Int) -- | The confidence that all the entities mentioned in the group relate to -- the same entity. targetedSentimentMention_groupScore :: Lens' TargetedSentimentMention (Maybe Double) -- | Contains the sentiment and sentiment score for the mention. targetedSentimentMention_mentionSentiment :: Lens' TargetedSentimentMention (Maybe MentionSentiment) -- | Model confidence that the entity is relevant. Value range is zero to -- one, where one is highest confidence. targetedSentimentMention_score :: Lens' TargetedSentimentMention (Maybe Double) -- | The text in the document that identifies the entity. targetedSentimentMention_text :: Lens' TargetedSentimentMention (Maybe Text) -- | The type of the entity. Amazon Comprehend supports a variety of -- entity types. targetedSentimentMention_type :: Lens' TargetedSentimentMention (Maybe TargetedSentimentEntityType) instance GHC.Generics.Generic Amazonka.Comprehend.Types.TargetedSentimentMention.TargetedSentimentMention instance GHC.Show.Show Amazonka.Comprehend.Types.TargetedSentimentMention.TargetedSentimentMention instance GHC.Read.Read Amazonka.Comprehend.Types.TargetedSentimentMention.TargetedSentimentMention instance GHC.Classes.Eq Amazonka.Comprehend.Types.TargetedSentimentMention.TargetedSentimentMention instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.TargetedSentimentMention.TargetedSentimentMention instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.TargetedSentimentMention.TargetedSentimentMention instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.TargetedSentimentMention.TargetedSentimentMention module Amazonka.Comprehend.Types.TargetedSentimentEntity -- | Information about one of the entities found by targeted sentiment -- analysis. -- -- For more information about targeted sentiment, see Targeted -- sentiment. -- -- See: newTargetedSentimentEntity smart constructor. data TargetedSentimentEntity TargetedSentimentEntity' :: Maybe [Int] -> Maybe [TargetedSentimentMention] -> TargetedSentimentEntity -- | One or more index into the Mentions array that provides the best name -- for the entity group. [$sel:descriptiveMentionIndex:TargetedSentimentEntity'] :: TargetedSentimentEntity -> Maybe [Int] -- | An array of mentions of the entity in the document. The array -- represents a co-reference group. See Co-reference group for an -- example. [$sel:mentions:TargetedSentimentEntity'] :: TargetedSentimentEntity -> Maybe [TargetedSentimentMention] -- | Create a value of TargetedSentimentEntity with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:descriptiveMentionIndex:TargetedSentimentEntity', -- targetedSentimentEntity_descriptiveMentionIndex - One or more -- index into the Mentions array that provides the best name for the -- entity group. -- -- $sel:mentions:TargetedSentimentEntity', -- targetedSentimentEntity_mentions - An array of mentions of the -- entity in the document. The array represents a co-reference group. See -- Co-reference group for an example. newTargetedSentimentEntity :: TargetedSentimentEntity -- | One or more index into the Mentions array that provides the best name -- for the entity group. targetedSentimentEntity_descriptiveMentionIndex :: Lens' TargetedSentimentEntity (Maybe [Int]) -- | An array of mentions of the entity in the document. The array -- represents a co-reference group. See Co-reference group for an -- example. targetedSentimentEntity_mentions :: Lens' TargetedSentimentEntity (Maybe [TargetedSentimentMention]) instance GHC.Generics.Generic Amazonka.Comprehend.Types.TargetedSentimentEntity.TargetedSentimentEntity instance GHC.Show.Show Amazonka.Comprehend.Types.TargetedSentimentEntity.TargetedSentimentEntity instance GHC.Read.Read Amazonka.Comprehend.Types.TargetedSentimentEntity.TargetedSentimentEntity instance GHC.Classes.Eq Amazonka.Comprehend.Types.TargetedSentimentEntity.TargetedSentimentEntity instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.TargetedSentimentEntity.TargetedSentimentEntity instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.TargetedSentimentEntity.TargetedSentimentEntity instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.TargetedSentimentEntity.TargetedSentimentEntity module Amazonka.Comprehend.Types.BatchDetectTargetedSentimentItemResult -- | Analysis results for one of the documents in the batch. -- -- See: newBatchDetectTargetedSentimentItemResult smart -- constructor. data BatchDetectTargetedSentimentItemResult BatchDetectTargetedSentimentItemResult' :: Maybe [TargetedSentimentEntity] -> Maybe Int -> BatchDetectTargetedSentimentItemResult -- | An array of targeted sentiment entities. [$sel:entities:BatchDetectTargetedSentimentItemResult'] :: BatchDetectTargetedSentimentItemResult -> Maybe [TargetedSentimentEntity] -- | The zero-based index of this result in the input list. [$sel:index:BatchDetectTargetedSentimentItemResult'] :: BatchDetectTargetedSentimentItemResult -> Maybe Int -- | Create a value of BatchDetectTargetedSentimentItemResult with -- all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:entities:BatchDetectTargetedSentimentItemResult', -- batchDetectTargetedSentimentItemResult_entities - An array of -- targeted sentiment entities. -- -- $sel:index:BatchDetectTargetedSentimentItemResult', -- batchDetectTargetedSentimentItemResult_index - The zero-based -- index of this result in the input list. newBatchDetectTargetedSentimentItemResult :: BatchDetectTargetedSentimentItemResult -- | An array of targeted sentiment entities. batchDetectTargetedSentimentItemResult_entities :: Lens' BatchDetectTargetedSentimentItemResult (Maybe [TargetedSentimentEntity]) -- | The zero-based index of this result in the input list. batchDetectTargetedSentimentItemResult_index :: Lens' BatchDetectTargetedSentimentItemResult (Maybe Int) instance GHC.Generics.Generic Amazonka.Comprehend.Types.BatchDetectTargetedSentimentItemResult.BatchDetectTargetedSentimentItemResult instance GHC.Show.Show Amazonka.Comprehend.Types.BatchDetectTargetedSentimentItemResult.BatchDetectTargetedSentimentItemResult instance GHC.Read.Read Amazonka.Comprehend.Types.BatchDetectTargetedSentimentItemResult.BatchDetectTargetedSentimentItemResult instance GHC.Classes.Eq Amazonka.Comprehend.Types.BatchDetectTargetedSentimentItemResult.BatchDetectTargetedSentimentItemResult instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.BatchDetectTargetedSentimentItemResult.BatchDetectTargetedSentimentItemResult instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.BatchDetectTargetedSentimentItemResult.BatchDetectTargetedSentimentItemResult instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.BatchDetectTargetedSentimentItemResult.BatchDetectTargetedSentimentItemResult module Amazonka.Comprehend.Types.TopicsDetectionJobFilter -- | Provides information for filtering topic detection jobs. For more -- information, see . -- -- See: newTopicsDetectionJobFilter smart constructor. data TopicsDetectionJobFilter TopicsDetectionJobFilter' :: Maybe Text -> Maybe JobStatus -> Maybe POSIX -> Maybe POSIX -> TopicsDetectionJobFilter [$sel:jobName:TopicsDetectionJobFilter'] :: TopicsDetectionJobFilter -> Maybe Text -- | Filters the list of topic detection jobs based on job status. Returns -- only jobs with the specified status. [$sel:jobStatus:TopicsDetectionJobFilter'] :: TopicsDetectionJobFilter -> Maybe JobStatus -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Only returns jobs submitted after the specified time. -- Jobs are returned in ascending order, oldest to newest. [$sel:submitTimeAfter:TopicsDetectionJobFilter'] :: TopicsDetectionJobFilter -> Maybe POSIX -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Only returns jobs submitted before the specified time. -- Jobs are returned in descending order, newest to oldest. [$sel:submitTimeBefore:TopicsDetectionJobFilter'] :: TopicsDetectionJobFilter -> Maybe POSIX -- | Create a value of TopicsDetectionJobFilter with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:jobName:TopicsDetectionJobFilter', -- topicsDetectionJobFilter_jobName - -- -- $sel:jobStatus:TopicsDetectionJobFilter', -- topicsDetectionJobFilter_jobStatus - Filters the list of topic -- detection jobs based on job status. Returns only jobs with the -- specified status. -- -- $sel:submitTimeAfter:TopicsDetectionJobFilter', -- topicsDetectionJobFilter_submitTimeAfter - Filters the list of -- jobs based on the time that the job was submitted for processing. Only -- returns jobs submitted after the specified time. Jobs are returned in -- ascending order, oldest to newest. -- -- $sel:submitTimeBefore:TopicsDetectionJobFilter', -- topicsDetectionJobFilter_submitTimeBefore - Filters the list of -- jobs based on the time that the job was submitted for processing. Only -- returns jobs submitted before the specified time. Jobs are returned in -- descending order, newest to oldest. newTopicsDetectionJobFilter :: TopicsDetectionJobFilter topicsDetectionJobFilter_jobName :: Lens' TopicsDetectionJobFilter (Maybe Text) -- | Filters the list of topic detection jobs based on job status. Returns -- only jobs with the specified status. topicsDetectionJobFilter_jobStatus :: Lens' TopicsDetectionJobFilter (Maybe JobStatus) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Only returns jobs submitted after the specified time. -- Jobs are returned in ascending order, oldest to newest. topicsDetectionJobFilter_submitTimeAfter :: Lens' TopicsDetectionJobFilter (Maybe UTCTime) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Only returns jobs submitted before the specified time. -- Jobs are returned in descending order, newest to oldest. topicsDetectionJobFilter_submitTimeBefore :: Lens' TopicsDetectionJobFilter (Maybe UTCTime) instance GHC.Generics.Generic Amazonka.Comprehend.Types.TopicsDetectionJobFilter.TopicsDetectionJobFilter instance GHC.Show.Show Amazonka.Comprehend.Types.TopicsDetectionJobFilter.TopicsDetectionJobFilter instance GHC.Read.Read Amazonka.Comprehend.Types.TopicsDetectionJobFilter.TopicsDetectionJobFilter instance GHC.Classes.Eq Amazonka.Comprehend.Types.TopicsDetectionJobFilter.TopicsDetectionJobFilter instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.TopicsDetectionJobFilter.TopicsDetectionJobFilter instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.TopicsDetectionJobFilter.TopicsDetectionJobFilter instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.TopicsDetectionJobFilter.TopicsDetectionJobFilter module Amazonka.Comprehend.Types.VpcConfig -- | Configuration parameters for an optional private Virtual Private Cloud -- (VPC) containing the resources you are using for the job. For more -- information, see Amazon VPC. -- -- See: newVpcConfig smart constructor. data VpcConfig VpcConfig' :: NonEmpty Text -> NonEmpty Text -> VpcConfig -- | The ID number for a security group on an instance of your private VPC. -- Security groups on your VPC function serve as a virtual firewall to -- control inbound and outbound traffic and provides security for the -- resources that you’ll be accessing on the VPC. This ID number is -- preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more -- information, see Security Groups for your VPC. [$sel:securityGroupIds:VpcConfig'] :: VpcConfig -> NonEmpty Text -- | The ID for each subnet being used in your private VPC. This subnet is -- a subset of the a range of IPv4 addresses used by the VPC and is -- specific to a given availability zone in the VPC’s region. This ID -- number is preceded by "subnet-", for instance: -- "subnet-04ccf456919e69055". For more information, see VPCs and -- Subnets. [$sel:subnets:VpcConfig'] :: VpcConfig -> NonEmpty Text -- | Create a value of VpcConfig with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:securityGroupIds:VpcConfig', -- vpcConfig_securityGroupIds - The ID number for a security group -- on an instance of your private VPC. Security groups on your VPC -- function serve as a virtual firewall to control inbound and outbound -- traffic and provides security for the resources that you’ll be -- accessing on the VPC. This ID number is preceded by "sg-", for -- instance: "sg-03b388029b0a285ea". For more information, see -- Security Groups for your VPC. -- -- $sel:subnets:VpcConfig', vpcConfig_subnets - The ID for -- each subnet being used in your private VPC. This subnet is a subset of -- the a range of IPv4 addresses used by the VPC and is specific to a -- given availability zone in the VPC’s region. This ID number is -- preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For -- more information, see VPCs and Subnets. newVpcConfig :: NonEmpty Text -> NonEmpty Text -> VpcConfig -- | The ID number for a security group on an instance of your private VPC. -- Security groups on your VPC function serve as a virtual firewall to -- control inbound and outbound traffic and provides security for the -- resources that you’ll be accessing on the VPC. This ID number is -- preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more -- information, see Security Groups for your VPC. vpcConfig_securityGroupIds :: Lens' VpcConfig (NonEmpty Text) -- | The ID for each subnet being used in your private VPC. This subnet is -- a subset of the a range of IPv4 addresses used by the VPC and is -- specific to a given availability zone in the VPC’s region. This ID -- number is preceded by "subnet-", for instance: -- "subnet-04ccf456919e69055". For more information, see VPCs and -- Subnets. vpcConfig_subnets :: Lens' VpcConfig (NonEmpty Text) instance GHC.Generics.Generic Amazonka.Comprehend.Types.VpcConfig.VpcConfig instance GHC.Show.Show Amazonka.Comprehend.Types.VpcConfig.VpcConfig instance GHC.Read.Read Amazonka.Comprehend.Types.VpcConfig.VpcConfig instance GHC.Classes.Eq Amazonka.Comprehend.Types.VpcConfig.VpcConfig instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.VpcConfig.VpcConfig instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.VpcConfig.VpcConfig instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.VpcConfig.VpcConfig instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.Types.VpcConfig.VpcConfig module Amazonka.Comprehend.Types.TopicsDetectionJobProperties -- | Provides information about a topic detection job. -- -- See: newTopicsDetectionJobProperties smart constructor. data TopicsDetectionJobProperties TopicsDetectionJobProperties' :: Maybe Text -> Maybe POSIX -> Maybe InputDataConfig -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe JobStatus -> Maybe Text -> Maybe Int -> Maybe OutputDataConfig -> Maybe POSIX -> Maybe Text -> Maybe VpcConfig -> TopicsDetectionJobProperties -- | The Amazon Resource Name (ARN) of the AWS Identity and Management -- (IAM) role that grants Amazon Comprehend read access to your job data. [$sel:dataAccessRoleArn:TopicsDetectionJobProperties'] :: TopicsDetectionJobProperties -> Maybe Text -- | The time that the topic detection job was completed. [$sel:endTime:TopicsDetectionJobProperties'] :: TopicsDetectionJobProperties -> Maybe POSIX -- | The input data configuration supplied when you created the topic -- detection job. [$sel:inputDataConfig:TopicsDetectionJobProperties'] :: TopicsDetectionJobProperties -> Maybe InputDataConfig -- | The Amazon Resource Name (ARN) of the topics detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab
--
[$sel:jobArn:TopicsDetectionJobProperties'] :: TopicsDetectionJobProperties -> Maybe Text -- | The identifier assigned to the topic detection job. [$sel:jobId:TopicsDetectionJobProperties'] :: TopicsDetectionJobProperties -> Maybe Text -- | The name of the topic detection job. [$sel:jobName:TopicsDetectionJobProperties'] :: TopicsDetectionJobProperties -> Maybe Text -- | The current status of the topic detection job. If the status is -- Failed, the reason for the failure is shown in the -- Message field. [$sel:jobStatus:TopicsDetectionJobProperties'] :: TopicsDetectionJobProperties -> Maybe JobStatus -- | A description for the status of a job. [$sel:message:TopicsDetectionJobProperties'] :: TopicsDetectionJobProperties -> Maybe Text -- | The number of topics to detect supplied when you created the topic -- detection job. The default is 10. [$sel:numberOfTopics:TopicsDetectionJobProperties'] :: TopicsDetectionJobProperties -> Maybe Int -- | The output data configuration supplied when you created the topic -- detection job. [$sel:outputDataConfig:TopicsDetectionJobProperties'] :: TopicsDetectionJobProperties -> Maybe OutputDataConfig -- | The time that the topic detection job was submitted for processing. [$sel:submitTime:TopicsDetectionJobProperties'] :: TopicsDetectionJobProperties -> Maybe POSIX -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- [$sel:volumeKmsKeyId:TopicsDetectionJobProperties'] :: TopicsDetectionJobProperties -> Maybe Text -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your topic detection job. -- For more information, see Amazon VPC. [$sel:vpcConfig:TopicsDetectionJobProperties'] :: TopicsDetectionJobProperties -> Maybe VpcConfig -- | Create a value of TopicsDetectionJobProperties with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:dataAccessRoleArn:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_dataAccessRoleArn - The Amazon -- Resource Name (ARN) of the AWS Identity and Management (IAM) role that -- grants Amazon Comprehend read access to your job data. -- -- $sel:endTime:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_endTime - The time that the topic -- detection job was completed. -- -- $sel:inputDataConfig:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_inputDataConfig - The input data -- configuration supplied when you created the topic detection job. -- -- $sel:jobArn:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_jobArn - The Amazon Resource Name -- (ARN) of the topics detection job. It is a unique, fully qualified -- identifier for the job. It includes the AWS account, Region, and the -- job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- $sel:jobId:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_jobId - The identifier assigned to -- the topic detection job. -- -- $sel:jobName:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_jobName - The name of the topic -- detection job. -- -- $sel:jobStatus:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_jobStatus - The current status of -- the topic detection job. If the status is Failed, the reason -- for the failure is shown in the Message field. -- -- $sel:message:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_message - A description for the -- status of a job. -- -- $sel:numberOfTopics:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_numberOfTopics - The number of -- topics to detect supplied when you created the topic detection job. -- The default is 10. -- -- $sel:outputDataConfig:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_outputDataConfig - The output data -- configuration supplied when you created the topic detection job. -- -- $sel:submitTime:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_submitTime - The time that the -- topic detection job was submitted for processing. -- -- $sel:volumeKmsKeyId:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_volumeKmsKeyId - ID for the AWS -- Key Management Service (KMS) key that Amazon Comprehend uses to -- encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- -- -- $sel:vpcConfig:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_vpcConfig - Configuration -- parameters for a private Virtual Private Cloud (VPC) containing the -- resources you are using for your topic detection job. For more -- information, see Amazon VPC. newTopicsDetectionJobProperties :: TopicsDetectionJobProperties -- | The Amazon Resource Name (ARN) of the AWS Identity and Management -- (IAM) role that grants Amazon Comprehend read access to your job data. topicsDetectionJobProperties_dataAccessRoleArn :: Lens' TopicsDetectionJobProperties (Maybe Text) -- | The time that the topic detection job was completed. topicsDetectionJobProperties_endTime :: Lens' TopicsDetectionJobProperties (Maybe UTCTime) -- | The input data configuration supplied when you created the topic -- detection job. topicsDetectionJobProperties_inputDataConfig :: Lens' TopicsDetectionJobProperties (Maybe InputDataConfig) -- | The Amazon Resource Name (ARN) of the topics detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab
--
topicsDetectionJobProperties_jobArn :: Lens' TopicsDetectionJobProperties (Maybe Text) -- | The identifier assigned to the topic detection job. topicsDetectionJobProperties_jobId :: Lens' TopicsDetectionJobProperties (Maybe Text) -- | The name of the topic detection job. topicsDetectionJobProperties_jobName :: Lens' TopicsDetectionJobProperties (Maybe Text) -- | The current status of the topic detection job. If the status is -- Failed, the reason for the failure is shown in the -- Message field. topicsDetectionJobProperties_jobStatus :: Lens' TopicsDetectionJobProperties (Maybe JobStatus) -- | A description for the status of a job. topicsDetectionJobProperties_message :: Lens' TopicsDetectionJobProperties (Maybe Text) -- | The number of topics to detect supplied when you created the topic -- detection job. The default is 10. topicsDetectionJobProperties_numberOfTopics :: Lens' TopicsDetectionJobProperties (Maybe Int) -- | The output data configuration supplied when you created the topic -- detection job. topicsDetectionJobProperties_outputDataConfig :: Lens' TopicsDetectionJobProperties (Maybe OutputDataConfig) -- | The time that the topic detection job was submitted for processing. topicsDetectionJobProperties_submitTime :: Lens' TopicsDetectionJobProperties (Maybe UTCTime) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- topicsDetectionJobProperties_volumeKmsKeyId :: Lens' TopicsDetectionJobProperties (Maybe Text) -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your topic detection job. -- For more information, see Amazon VPC. topicsDetectionJobProperties_vpcConfig :: Lens' TopicsDetectionJobProperties (Maybe VpcConfig) instance GHC.Generics.Generic Amazonka.Comprehend.Types.TopicsDetectionJobProperties.TopicsDetectionJobProperties instance GHC.Show.Show Amazonka.Comprehend.Types.TopicsDetectionJobProperties.TopicsDetectionJobProperties instance GHC.Read.Read Amazonka.Comprehend.Types.TopicsDetectionJobProperties.TopicsDetectionJobProperties instance GHC.Classes.Eq Amazonka.Comprehend.Types.TopicsDetectionJobProperties.TopicsDetectionJobProperties instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.TopicsDetectionJobProperties.TopicsDetectionJobProperties instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.TopicsDetectionJobProperties.TopicsDetectionJobProperties instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.TopicsDetectionJobProperties.TopicsDetectionJobProperties module Amazonka.Comprehend.Types.TargetedSentimentDetectionJobProperties -- | Provides information about a targeted sentiment detection job. -- -- See: newTargetedSentimentDetectionJobProperties smart -- constructor. data TargetedSentimentDetectionJobProperties TargetedSentimentDetectionJobProperties' :: Maybe Text -> Maybe POSIX -> Maybe InputDataConfig -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe JobStatus -> Maybe LanguageCode -> Maybe Text -> Maybe OutputDataConfig -> Maybe POSIX -> Maybe Text -> Maybe VpcConfig -> TargetedSentimentDetectionJobProperties -- | The Amazon Resource Name (ARN) that gives Amazon Comprehend read -- access to your input data. [$sel:dataAccessRoleArn:TargetedSentimentDetectionJobProperties'] :: TargetedSentimentDetectionJobProperties -> Maybe Text -- | The time that the targeted sentiment detection job ended. [$sel:endTime:TargetedSentimentDetectionJobProperties'] :: TargetedSentimentDetectionJobProperties -> Maybe POSIX [$sel:inputDataConfig:TargetedSentimentDetectionJobProperties'] :: TargetedSentimentDetectionJobProperties -> Maybe InputDataConfig -- | The Amazon Resource Name (ARN) of the targeted sentiment detection -- job. It is a unique, fully qualified identifier for the job. It -- includes the AWS account, Region, and the job ID. The format of the -- ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
--
[$sel:jobArn:TargetedSentimentDetectionJobProperties'] :: TargetedSentimentDetectionJobProperties -> Maybe Text -- | The identifier assigned to the targeted sentiment detection job. [$sel:jobId:TargetedSentimentDetectionJobProperties'] :: TargetedSentimentDetectionJobProperties -> Maybe Text -- | The name that you assigned to the targeted sentiment detection job. [$sel:jobName:TargetedSentimentDetectionJobProperties'] :: TargetedSentimentDetectionJobProperties -> Maybe Text -- | The current status of the targeted sentiment detection job. If the -- status is FAILED, the Messages field shows the -- reason for the failure. [$sel:jobStatus:TargetedSentimentDetectionJobProperties'] :: TargetedSentimentDetectionJobProperties -> Maybe JobStatus -- | The language code of the input documents. [$sel:languageCode:TargetedSentimentDetectionJobProperties'] :: TargetedSentimentDetectionJobProperties -> Maybe LanguageCode -- | A description of the status of a job. [$sel:message:TargetedSentimentDetectionJobProperties'] :: TargetedSentimentDetectionJobProperties -> Maybe Text [$sel:outputDataConfig:TargetedSentimentDetectionJobProperties'] :: TargetedSentimentDetectionJobProperties -> Maybe OutputDataConfig -- | The time that the targeted sentiment detection job was submitted for -- processing. [$sel:submitTime:TargetedSentimentDetectionJobProperties'] :: TargetedSentimentDetectionJobProperties -> Maybe POSIX -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the targeted sentiment detection job. The -- VolumeKmsKeyId can be either of the following formats: -- -- [$sel:volumeKmsKeyId:TargetedSentimentDetectionJobProperties'] :: TargetedSentimentDetectionJobProperties -> Maybe Text [$sel:vpcConfig:TargetedSentimentDetectionJobProperties'] :: TargetedSentimentDetectionJobProperties -> Maybe VpcConfig -- | Create a value of TargetedSentimentDetectionJobProperties with -- all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:dataAccessRoleArn:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_dataAccessRoleArn - The -- Amazon Resource Name (ARN) that gives Amazon Comprehend read access to -- your input data. -- -- $sel:endTime:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_endTime - The time that -- the targeted sentiment detection job ended. -- -- $sel:inputDataConfig:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_inputDataConfig - -- Undocumented member. -- -- $sel:jobArn:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_jobArn - The Amazon -- Resource Name (ARN) of the targeted sentiment detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- $sel:jobId:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_jobId - The identifier -- assigned to the targeted sentiment detection job. -- -- $sel:jobName:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_jobName - The name that -- you assigned to the targeted sentiment detection job. -- -- $sel:jobStatus:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_jobStatus - The current -- status of the targeted sentiment detection job. If the status is -- FAILED, the Messages field shows the reason for the -- failure. -- -- $sel:languageCode:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_languageCode - The -- language code of the input documents. -- -- $sel:message:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_message - A description -- of the status of a job. -- -- $sel:outputDataConfig:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_outputDataConfig - -- Undocumented member. -- -- $sel:submitTime:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_submitTime - The time -- that the targeted sentiment detection job was submitted for -- processing. -- -- $sel:volumeKmsKeyId:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_volumeKmsKeyId - ID for -- the AWS Key Management Service (KMS) key that Amazon Comprehend uses -- to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the targeted sentiment detection job. The -- VolumeKmsKeyId can be either of the following formats: -- -- -- -- $sel:vpcConfig:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_vpcConfig - -- Undocumented member. newTargetedSentimentDetectionJobProperties :: TargetedSentimentDetectionJobProperties -- | The Amazon Resource Name (ARN) that gives Amazon Comprehend read -- access to your input data. targetedSentimentDetectionJobProperties_dataAccessRoleArn :: Lens' TargetedSentimentDetectionJobProperties (Maybe Text) -- | The time that the targeted sentiment detection job ended. targetedSentimentDetectionJobProperties_endTime :: Lens' TargetedSentimentDetectionJobProperties (Maybe UTCTime) -- | Undocumented member. targetedSentimentDetectionJobProperties_inputDataConfig :: Lens' TargetedSentimentDetectionJobProperties (Maybe InputDataConfig) -- | The Amazon Resource Name (ARN) of the targeted sentiment detection -- job. It is a unique, fully qualified identifier for the job. It -- includes the AWS account, Region, and the job ID. The format of the -- ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
--
targetedSentimentDetectionJobProperties_jobArn :: Lens' TargetedSentimentDetectionJobProperties (Maybe Text) -- | The identifier assigned to the targeted sentiment detection job. targetedSentimentDetectionJobProperties_jobId :: Lens' TargetedSentimentDetectionJobProperties (Maybe Text) -- | The name that you assigned to the targeted sentiment detection job. targetedSentimentDetectionJobProperties_jobName :: Lens' TargetedSentimentDetectionJobProperties (Maybe Text) -- | The current status of the targeted sentiment detection job. If the -- status is FAILED, the Messages field shows the -- reason for the failure. targetedSentimentDetectionJobProperties_jobStatus :: Lens' TargetedSentimentDetectionJobProperties (Maybe JobStatus) -- | The language code of the input documents. targetedSentimentDetectionJobProperties_languageCode :: Lens' TargetedSentimentDetectionJobProperties (Maybe LanguageCode) -- | A description of the status of a job. targetedSentimentDetectionJobProperties_message :: Lens' TargetedSentimentDetectionJobProperties (Maybe Text) -- | Undocumented member. targetedSentimentDetectionJobProperties_outputDataConfig :: Lens' TargetedSentimentDetectionJobProperties (Maybe OutputDataConfig) -- | The time that the targeted sentiment detection job was submitted for -- processing. targetedSentimentDetectionJobProperties_submitTime :: Lens' TargetedSentimentDetectionJobProperties (Maybe UTCTime) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the targeted sentiment detection job. The -- VolumeKmsKeyId can be either of the following formats: -- -- targetedSentimentDetectionJobProperties_volumeKmsKeyId :: Lens' TargetedSentimentDetectionJobProperties (Maybe Text) -- | Undocumented member. targetedSentimentDetectionJobProperties_vpcConfig :: Lens' TargetedSentimentDetectionJobProperties (Maybe VpcConfig) instance GHC.Generics.Generic Amazonka.Comprehend.Types.TargetedSentimentDetectionJobProperties.TargetedSentimentDetectionJobProperties instance GHC.Show.Show Amazonka.Comprehend.Types.TargetedSentimentDetectionJobProperties.TargetedSentimentDetectionJobProperties instance GHC.Read.Read Amazonka.Comprehend.Types.TargetedSentimentDetectionJobProperties.TargetedSentimentDetectionJobProperties instance GHC.Classes.Eq Amazonka.Comprehend.Types.TargetedSentimentDetectionJobProperties.TargetedSentimentDetectionJobProperties instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.TargetedSentimentDetectionJobProperties.TargetedSentimentDetectionJobProperties instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.TargetedSentimentDetectionJobProperties.TargetedSentimentDetectionJobProperties instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.TargetedSentimentDetectionJobProperties.TargetedSentimentDetectionJobProperties module Amazonka.Comprehend.Types.SentimentDetectionJobProperties -- | Provides information about a sentiment detection job. -- -- See: newSentimentDetectionJobProperties smart -- constructor. data SentimentDetectionJobProperties SentimentDetectionJobProperties' :: Maybe Text -> Maybe POSIX -> Maybe InputDataConfig -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe JobStatus -> Maybe LanguageCode -> Maybe Text -> Maybe OutputDataConfig -> Maybe POSIX -> Maybe Text -> Maybe VpcConfig -> SentimentDetectionJobProperties -- | The Amazon Resource Name (ARN) that gives Amazon Comprehend read -- access to your input data. [$sel:dataAccessRoleArn:SentimentDetectionJobProperties'] :: SentimentDetectionJobProperties -> Maybe Text -- | The time that the sentiment detection job ended. [$sel:endTime:SentimentDetectionJobProperties'] :: SentimentDetectionJobProperties -> Maybe POSIX -- | The input data configuration that you supplied when you created the -- sentiment detection job. [$sel:inputDataConfig:SentimentDetectionJobProperties'] :: SentimentDetectionJobProperties -> Maybe InputDataConfig -- | The Amazon Resource Name (ARN) of the sentiment detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
--
[$sel:jobArn:SentimentDetectionJobProperties'] :: SentimentDetectionJobProperties -> Maybe Text -- | The identifier assigned to the sentiment detection job. [$sel:jobId:SentimentDetectionJobProperties'] :: SentimentDetectionJobProperties -> Maybe Text -- | The name that you assigned to the sentiment detection job [$sel:jobName:SentimentDetectionJobProperties'] :: SentimentDetectionJobProperties -> Maybe Text -- | The current status of the sentiment detection job. If the status is -- FAILED, the Messages field shows the reason for the -- failure. [$sel:jobStatus:SentimentDetectionJobProperties'] :: SentimentDetectionJobProperties -> Maybe JobStatus -- | The language code of the input documents. [$sel:languageCode:SentimentDetectionJobProperties'] :: SentimentDetectionJobProperties -> Maybe LanguageCode -- | A description of the status of a job. [$sel:message:SentimentDetectionJobProperties'] :: SentimentDetectionJobProperties -> Maybe Text -- | The output data configuration that you supplied when you created the -- sentiment detection job. [$sel:outputDataConfig:SentimentDetectionJobProperties'] :: SentimentDetectionJobProperties -> Maybe OutputDataConfig -- | The time that the sentiment detection job was submitted for -- processing. [$sel:submitTime:SentimentDetectionJobProperties'] :: SentimentDetectionJobProperties -> Maybe POSIX -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- [$sel:volumeKmsKeyId:SentimentDetectionJobProperties'] :: SentimentDetectionJobProperties -> Maybe Text -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your sentiment detection -- job. For more information, see Amazon VPC. [$sel:vpcConfig:SentimentDetectionJobProperties'] :: SentimentDetectionJobProperties -> Maybe VpcConfig -- | Create a value of SentimentDetectionJobProperties with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:dataAccessRoleArn:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_dataAccessRoleArn - The Amazon -- Resource Name (ARN) that gives Amazon Comprehend read access to your -- input data. -- -- $sel:endTime:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_endTime - The time that the -- sentiment detection job ended. -- -- $sel:inputDataConfig:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_inputDataConfig - The input -- data configuration that you supplied when you created the sentiment -- detection job. -- -- $sel:jobArn:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_jobArn - The Amazon Resource -- Name (ARN) of the sentiment detection job. It is a unique, fully -- qualified identifier for the job. It includes the AWS account, Region, -- and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- $sel:jobId:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_jobId - The identifier assigned -- to the sentiment detection job. -- -- $sel:jobName:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_jobName - The name that you -- assigned to the sentiment detection job -- -- $sel:jobStatus:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_jobStatus - The current status -- of the sentiment detection job. If the status is FAILED, the -- Messages field shows the reason for the failure. -- -- $sel:languageCode:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_languageCode - The language -- code of the input documents. -- -- $sel:message:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_message - A description of the -- status of a job. -- -- $sel:outputDataConfig:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_outputDataConfig - The output -- data configuration that you supplied when you created the sentiment -- detection job. -- -- $sel:submitTime:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_submitTime - The time that the -- sentiment detection job was submitted for processing. -- -- $sel:volumeKmsKeyId:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_volumeKmsKeyId - ID for the AWS -- Key Management Service (KMS) key that Amazon Comprehend uses to -- encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- -- -- $sel:vpcConfig:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_vpcConfig - Configuration -- parameters for a private Virtual Private Cloud (VPC) containing the -- resources you are using for your sentiment detection job. For more -- information, see Amazon VPC. newSentimentDetectionJobProperties :: SentimentDetectionJobProperties -- | The Amazon Resource Name (ARN) that gives Amazon Comprehend read -- access to your input data. sentimentDetectionJobProperties_dataAccessRoleArn :: Lens' SentimentDetectionJobProperties (Maybe Text) -- | The time that the sentiment detection job ended. sentimentDetectionJobProperties_endTime :: Lens' SentimentDetectionJobProperties (Maybe UTCTime) -- | The input data configuration that you supplied when you created the -- sentiment detection job. sentimentDetectionJobProperties_inputDataConfig :: Lens' SentimentDetectionJobProperties (Maybe InputDataConfig) -- | The Amazon Resource Name (ARN) of the sentiment detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
--
sentimentDetectionJobProperties_jobArn :: Lens' SentimentDetectionJobProperties (Maybe Text) -- | The identifier assigned to the sentiment detection job. sentimentDetectionJobProperties_jobId :: Lens' SentimentDetectionJobProperties (Maybe Text) -- | The name that you assigned to the sentiment detection job sentimentDetectionJobProperties_jobName :: Lens' SentimentDetectionJobProperties (Maybe Text) -- | The current status of the sentiment detection job. If the status is -- FAILED, the Messages field shows the reason for the -- failure. sentimentDetectionJobProperties_jobStatus :: Lens' SentimentDetectionJobProperties (Maybe JobStatus) -- | The language code of the input documents. sentimentDetectionJobProperties_languageCode :: Lens' SentimentDetectionJobProperties (Maybe LanguageCode) -- | A description of the status of a job. sentimentDetectionJobProperties_message :: Lens' SentimentDetectionJobProperties (Maybe Text) -- | The output data configuration that you supplied when you created the -- sentiment detection job. sentimentDetectionJobProperties_outputDataConfig :: Lens' SentimentDetectionJobProperties (Maybe OutputDataConfig) -- | The time that the sentiment detection job was submitted for -- processing. sentimentDetectionJobProperties_submitTime :: Lens' SentimentDetectionJobProperties (Maybe UTCTime) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- sentimentDetectionJobProperties_volumeKmsKeyId :: Lens' SentimentDetectionJobProperties (Maybe Text) -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your sentiment detection -- job. For more information, see Amazon VPC. sentimentDetectionJobProperties_vpcConfig :: Lens' SentimentDetectionJobProperties (Maybe VpcConfig) instance GHC.Generics.Generic Amazonka.Comprehend.Types.SentimentDetectionJobProperties.SentimentDetectionJobProperties instance GHC.Show.Show Amazonka.Comprehend.Types.SentimentDetectionJobProperties.SentimentDetectionJobProperties instance GHC.Read.Read Amazonka.Comprehend.Types.SentimentDetectionJobProperties.SentimentDetectionJobProperties instance GHC.Classes.Eq Amazonka.Comprehend.Types.SentimentDetectionJobProperties.SentimentDetectionJobProperties instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.SentimentDetectionJobProperties.SentimentDetectionJobProperties instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.SentimentDetectionJobProperties.SentimentDetectionJobProperties instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.SentimentDetectionJobProperties.SentimentDetectionJobProperties module Amazonka.Comprehend.Types.KeyPhrasesDetectionJobProperties -- | Provides information about a key phrases detection job. -- -- See: newKeyPhrasesDetectionJobProperties smart -- constructor. data KeyPhrasesDetectionJobProperties KeyPhrasesDetectionJobProperties' :: Maybe Text -> Maybe POSIX -> Maybe InputDataConfig -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe JobStatus -> Maybe LanguageCode -> Maybe Text -> Maybe OutputDataConfig -> Maybe POSIX -> Maybe Text -> Maybe VpcConfig -> KeyPhrasesDetectionJobProperties -- | The Amazon Resource Name (ARN) that gives Amazon Comprehend read -- access to your input data. [$sel:dataAccessRoleArn:KeyPhrasesDetectionJobProperties'] :: KeyPhrasesDetectionJobProperties -> Maybe Text -- | The time that the key phrases detection job completed. [$sel:endTime:KeyPhrasesDetectionJobProperties'] :: KeyPhrasesDetectionJobProperties -> Maybe POSIX -- | The input data configuration that you supplied when you created the -- key phrases detection job. [$sel:inputDataConfig:KeyPhrasesDetectionJobProperties'] :: KeyPhrasesDetectionJobProperties -> Maybe InputDataConfig -- | The Amazon Resource Name (ARN) of the key phrases detection job. It is -- a unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
--
[$sel:jobArn:KeyPhrasesDetectionJobProperties'] :: KeyPhrasesDetectionJobProperties -> Maybe Text -- | The identifier assigned to the key phrases detection job. [$sel:jobId:KeyPhrasesDetectionJobProperties'] :: KeyPhrasesDetectionJobProperties -> Maybe Text -- | The name that you assigned the key phrases detection job. [$sel:jobName:KeyPhrasesDetectionJobProperties'] :: KeyPhrasesDetectionJobProperties -> Maybe Text -- | The current status of the key phrases detection job. If the status is -- FAILED, the Message field shows the reason for the -- failure. [$sel:jobStatus:KeyPhrasesDetectionJobProperties'] :: KeyPhrasesDetectionJobProperties -> Maybe JobStatus -- | The language code of the input documents. [$sel:languageCode:KeyPhrasesDetectionJobProperties'] :: KeyPhrasesDetectionJobProperties -> Maybe LanguageCode -- | A description of the status of a job. [$sel:message:KeyPhrasesDetectionJobProperties'] :: KeyPhrasesDetectionJobProperties -> Maybe Text -- | The output data configuration that you supplied when you created the -- key phrases detection job. [$sel:outputDataConfig:KeyPhrasesDetectionJobProperties'] :: KeyPhrasesDetectionJobProperties -> Maybe OutputDataConfig -- | The time that the key phrases detection job was submitted for -- processing. [$sel:submitTime:KeyPhrasesDetectionJobProperties'] :: KeyPhrasesDetectionJobProperties -> Maybe POSIX -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- [$sel:volumeKmsKeyId:KeyPhrasesDetectionJobProperties'] :: KeyPhrasesDetectionJobProperties -> Maybe Text -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your key phrases detection -- job. For more information, see Amazon VPC. [$sel:vpcConfig:KeyPhrasesDetectionJobProperties'] :: KeyPhrasesDetectionJobProperties -> Maybe VpcConfig -- | Create a value of KeyPhrasesDetectionJobProperties with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:dataAccessRoleArn:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_dataAccessRoleArn - The Amazon -- Resource Name (ARN) that gives Amazon Comprehend read access to your -- input data. -- -- $sel:endTime:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_endTime - The time that the -- key phrases detection job completed. -- -- $sel:inputDataConfig:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_inputDataConfig - The input -- data configuration that you supplied when you created the key phrases -- detection job. -- -- $sel:jobArn:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_jobArn - The Amazon Resource -- Name (ARN) of the key phrases detection job. It is a unique, fully -- qualified identifier for the job. It includes the AWS account, Region, -- and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- $sel:jobId:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_jobId - The identifier -- assigned to the key phrases detection job. -- -- $sel:jobName:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_jobName - The name that you -- assigned the key phrases detection job. -- -- $sel:jobStatus:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_jobStatus - The current status -- of the key phrases detection job. If the status is FAILED, -- the Message field shows the reason for the failure. -- -- $sel:languageCode:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_languageCode - The language -- code of the input documents. -- -- $sel:message:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_message - A description of the -- status of a job. -- -- $sel:outputDataConfig:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_outputDataConfig - The output -- data configuration that you supplied when you created the key phrases -- detection job. -- -- $sel:submitTime:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_submitTime - The time that the -- key phrases detection job was submitted for processing. -- -- $sel:volumeKmsKeyId:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_volumeKmsKeyId - ID for the -- AWS Key Management Service (KMS) key that Amazon Comprehend uses to -- encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- -- -- $sel:vpcConfig:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_vpcConfig - Configuration -- parameters for a private Virtual Private Cloud (VPC) containing the -- resources you are using for your key phrases detection job. For more -- information, see Amazon VPC. newKeyPhrasesDetectionJobProperties :: KeyPhrasesDetectionJobProperties -- | The Amazon Resource Name (ARN) that gives Amazon Comprehend read -- access to your input data. keyPhrasesDetectionJobProperties_dataAccessRoleArn :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text) -- | The time that the key phrases detection job completed. keyPhrasesDetectionJobProperties_endTime :: Lens' KeyPhrasesDetectionJobProperties (Maybe UTCTime) -- | The input data configuration that you supplied when you created the -- key phrases detection job. keyPhrasesDetectionJobProperties_inputDataConfig :: Lens' KeyPhrasesDetectionJobProperties (Maybe InputDataConfig) -- | The Amazon Resource Name (ARN) of the key phrases detection job. It is -- a unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
--
keyPhrasesDetectionJobProperties_jobArn :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text) -- | The identifier assigned to the key phrases detection job. keyPhrasesDetectionJobProperties_jobId :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text) -- | The name that you assigned the key phrases detection job. keyPhrasesDetectionJobProperties_jobName :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text) -- | The current status of the key phrases detection job. If the status is -- FAILED, the Message field shows the reason for the -- failure. keyPhrasesDetectionJobProperties_jobStatus :: Lens' KeyPhrasesDetectionJobProperties (Maybe JobStatus) -- | The language code of the input documents. keyPhrasesDetectionJobProperties_languageCode :: Lens' KeyPhrasesDetectionJobProperties (Maybe LanguageCode) -- | A description of the status of a job. keyPhrasesDetectionJobProperties_message :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text) -- | The output data configuration that you supplied when you created the -- key phrases detection job. keyPhrasesDetectionJobProperties_outputDataConfig :: Lens' KeyPhrasesDetectionJobProperties (Maybe OutputDataConfig) -- | The time that the key phrases detection job was submitted for -- processing. keyPhrasesDetectionJobProperties_submitTime :: Lens' KeyPhrasesDetectionJobProperties (Maybe UTCTime) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- keyPhrasesDetectionJobProperties_volumeKmsKeyId :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text) -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your key phrases detection -- job. For more information, see Amazon VPC. keyPhrasesDetectionJobProperties_vpcConfig :: Lens' KeyPhrasesDetectionJobProperties (Maybe VpcConfig) instance GHC.Generics.Generic Amazonka.Comprehend.Types.KeyPhrasesDetectionJobProperties.KeyPhrasesDetectionJobProperties instance GHC.Show.Show Amazonka.Comprehend.Types.KeyPhrasesDetectionJobProperties.KeyPhrasesDetectionJobProperties instance GHC.Read.Read Amazonka.Comprehend.Types.KeyPhrasesDetectionJobProperties.KeyPhrasesDetectionJobProperties instance GHC.Classes.Eq Amazonka.Comprehend.Types.KeyPhrasesDetectionJobProperties.KeyPhrasesDetectionJobProperties instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.KeyPhrasesDetectionJobProperties.KeyPhrasesDetectionJobProperties instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.KeyPhrasesDetectionJobProperties.KeyPhrasesDetectionJobProperties instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.KeyPhrasesDetectionJobProperties.KeyPhrasesDetectionJobProperties module Amazonka.Comprehend.Types.EntityRecognizerProperties -- | Describes information about an entity recognizer. -- -- See: newEntityRecognizerProperties smart constructor. data EntityRecognizerProperties EntityRecognizerProperties' :: Maybe Text -> Maybe POSIX -> Maybe Text -> Maybe EntityRecognizerInputDataConfig -> Maybe LanguageCode -> Maybe Text -> Maybe Text -> Maybe (Sensitive EntityRecognizerMetadata) -> Maybe Text -> Maybe ModelStatus -> Maybe POSIX -> Maybe POSIX -> Maybe POSIX -> Maybe Text -> Maybe Text -> Maybe VpcConfig -> EntityRecognizerProperties -- | The Amazon Resource Name (ARN) of the AWS Identity and Management -- (IAM) role that grants Amazon Comprehend read access to your input -- data. [$sel:dataAccessRoleArn:EntityRecognizerProperties'] :: EntityRecognizerProperties -> Maybe Text -- | The time that the recognizer creation completed. [$sel:endTime:EntityRecognizerProperties'] :: EntityRecognizerProperties -> Maybe POSIX -- | The Amazon Resource Name (ARN) that identifies the entity recognizer. [$sel:entityRecognizerArn:EntityRecognizerProperties'] :: EntityRecognizerProperties -> Maybe Text -- | The input data properties of an entity recognizer. [$sel:inputDataConfig:EntityRecognizerProperties'] :: EntityRecognizerProperties -> Maybe EntityRecognizerInputDataConfig -- | The language of the input documents. All documents must be in the same -- language. Only English ("en") is currently supported. [$sel:languageCode:EntityRecognizerProperties'] :: EntityRecognizerProperties -> Maybe LanguageCode -- | A description of the status of the recognizer. [$sel:message:EntityRecognizerProperties'] :: EntityRecognizerProperties -> Maybe Text -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt trained custom models. The ModelKmsKeyId can be either -- of the following formats: -- -- [$sel:modelKmsKeyId:EntityRecognizerProperties'] :: EntityRecognizerProperties -> Maybe Text -- | Provides information about an entity recognizer. [$sel:recognizerMetadata:EntityRecognizerProperties'] :: EntityRecognizerProperties -> Maybe (Sensitive EntityRecognizerMetadata) -- | The Amazon Resource Name (ARN) of the source model. This model was -- imported from a different AWS account to create the entity recognizer -- model in your AWS account. [$sel:sourceModelArn:EntityRecognizerProperties'] :: EntityRecognizerProperties -> Maybe Text -- | Provides the status of the entity recognizer. [$sel:status:EntityRecognizerProperties'] :: EntityRecognizerProperties -> Maybe ModelStatus -- | The time that the recognizer was submitted for processing. [$sel:submitTime:EntityRecognizerProperties'] :: EntityRecognizerProperties -> Maybe POSIX -- | The time that training of the entity recognizer was completed. [$sel:trainingEndTime:EntityRecognizerProperties'] :: EntityRecognizerProperties -> Maybe POSIX -- | The time that training of the entity recognizer started. [$sel:trainingStartTime:EntityRecognizerProperties'] :: EntityRecognizerProperties -> Maybe POSIX -- | The version name you assigned to the entity recognizer. [$sel:versionName:EntityRecognizerProperties'] :: EntityRecognizerProperties -> Maybe Text -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- [$sel:volumeKmsKeyId:EntityRecognizerProperties'] :: EntityRecognizerProperties -> Maybe Text -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your custom entity -- recognizer. For more information, see Amazon VPC. [$sel:vpcConfig:EntityRecognizerProperties'] :: EntityRecognizerProperties -> Maybe VpcConfig -- | Create a value of EntityRecognizerProperties with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:dataAccessRoleArn:EntityRecognizerProperties', -- entityRecognizerProperties_dataAccessRoleArn - The Amazon -- Resource Name (ARN) of the AWS Identity and Management (IAM) role that -- grants Amazon Comprehend read access to your input data. -- -- $sel:endTime:EntityRecognizerProperties', -- entityRecognizerProperties_endTime - The time that the -- recognizer creation completed. -- -- $sel:entityRecognizerArn:EntityRecognizerProperties', -- entityRecognizerProperties_entityRecognizerArn - The Amazon -- Resource Name (ARN) that identifies the entity recognizer. -- -- $sel:inputDataConfig:EntityRecognizerProperties', -- entityRecognizerProperties_inputDataConfig - The input data -- properties of an entity recognizer. -- -- $sel:languageCode:EntityRecognizerProperties', -- entityRecognizerProperties_languageCode - The language of the -- input documents. All documents must be in the same language. Only -- English ("en") is currently supported. -- -- $sel:message:EntityRecognizerProperties', -- entityRecognizerProperties_message - A description of the -- status of the recognizer. -- -- $sel:modelKmsKeyId:EntityRecognizerProperties', -- entityRecognizerProperties_modelKmsKeyId - ID for the AWS Key -- Management Service (KMS) key that Amazon Comprehend uses to encrypt -- trained custom models. The ModelKmsKeyId can be either of the -- following formats: -- -- -- -- $sel:recognizerMetadata:EntityRecognizerProperties', -- entityRecognizerProperties_recognizerMetadata - Provides -- information about an entity recognizer. -- -- $sel:sourceModelArn:EntityRecognizerProperties', -- entityRecognizerProperties_sourceModelArn - The Amazon Resource -- Name (ARN) of the source model. This model was imported from a -- different AWS account to create the entity recognizer model in your -- AWS account. -- -- $sel:status:EntityRecognizerProperties', -- entityRecognizerProperties_status - Provides the status of the -- entity recognizer. -- -- $sel:submitTime:EntityRecognizerProperties', -- entityRecognizerProperties_submitTime - The time that the -- recognizer was submitted for processing. -- -- $sel:trainingEndTime:EntityRecognizerProperties', -- entityRecognizerProperties_trainingEndTime - The time that -- training of the entity recognizer was completed. -- -- $sel:trainingStartTime:EntityRecognizerProperties', -- entityRecognizerProperties_trainingStartTime - The time that -- training of the entity recognizer started. -- -- $sel:versionName:EntityRecognizerProperties', -- entityRecognizerProperties_versionName - The version name you -- assigned to the entity recognizer. -- -- $sel:volumeKmsKeyId:EntityRecognizerProperties', -- entityRecognizerProperties_volumeKmsKeyId - ID for the AWS Key -- Management Service (KMS) key that Amazon Comprehend uses to encrypt -- data on the storage volume attached to the ML compute instance(s) that -- process the analysis job. The VolumeKmsKeyId can be either of the -- following formats: -- -- -- -- $sel:vpcConfig:EntityRecognizerProperties', -- entityRecognizerProperties_vpcConfig - Configuration parameters -- for a private Virtual Private Cloud (VPC) containing the resources you -- are using for your custom entity recognizer. For more information, see -- Amazon VPC. newEntityRecognizerProperties :: EntityRecognizerProperties -- | The Amazon Resource Name (ARN) of the AWS Identity and Management -- (IAM) role that grants Amazon Comprehend read access to your input -- data. entityRecognizerProperties_dataAccessRoleArn :: Lens' EntityRecognizerProperties (Maybe Text) -- | The time that the recognizer creation completed. entityRecognizerProperties_endTime :: Lens' EntityRecognizerProperties (Maybe UTCTime) -- | The Amazon Resource Name (ARN) that identifies the entity recognizer. entityRecognizerProperties_entityRecognizerArn :: Lens' EntityRecognizerProperties (Maybe Text) -- | The input data properties of an entity recognizer. entityRecognizerProperties_inputDataConfig :: Lens' EntityRecognizerProperties (Maybe EntityRecognizerInputDataConfig) -- | The language of the input documents. All documents must be in the same -- language. Only English ("en") is currently supported. entityRecognizerProperties_languageCode :: Lens' EntityRecognizerProperties (Maybe LanguageCode) -- | A description of the status of the recognizer. entityRecognizerProperties_message :: Lens' EntityRecognizerProperties (Maybe Text) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt trained custom models. The ModelKmsKeyId can be either -- of the following formats: -- -- entityRecognizerProperties_modelKmsKeyId :: Lens' EntityRecognizerProperties (Maybe Text) -- | Provides information about an entity recognizer. entityRecognizerProperties_recognizerMetadata :: Lens' EntityRecognizerProperties (Maybe EntityRecognizerMetadata) -- | The Amazon Resource Name (ARN) of the source model. This model was -- imported from a different AWS account to create the entity recognizer -- model in your AWS account. entityRecognizerProperties_sourceModelArn :: Lens' EntityRecognizerProperties (Maybe Text) -- | Provides the status of the entity recognizer. entityRecognizerProperties_status :: Lens' EntityRecognizerProperties (Maybe ModelStatus) -- | The time that the recognizer was submitted for processing. entityRecognizerProperties_submitTime :: Lens' EntityRecognizerProperties (Maybe UTCTime) -- | The time that training of the entity recognizer was completed. entityRecognizerProperties_trainingEndTime :: Lens' EntityRecognizerProperties (Maybe UTCTime) -- | The time that training of the entity recognizer started. entityRecognizerProperties_trainingStartTime :: Lens' EntityRecognizerProperties (Maybe UTCTime) -- | The version name you assigned to the entity recognizer. entityRecognizerProperties_versionName :: Lens' EntityRecognizerProperties (Maybe Text) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- entityRecognizerProperties_volumeKmsKeyId :: Lens' EntityRecognizerProperties (Maybe Text) -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your custom entity -- recognizer. For more information, see Amazon VPC. entityRecognizerProperties_vpcConfig :: Lens' EntityRecognizerProperties (Maybe VpcConfig) instance GHC.Generics.Generic Amazonka.Comprehend.Types.EntityRecognizerProperties.EntityRecognizerProperties instance GHC.Show.Show Amazonka.Comprehend.Types.EntityRecognizerProperties.EntityRecognizerProperties instance GHC.Classes.Eq Amazonka.Comprehend.Types.EntityRecognizerProperties.EntityRecognizerProperties instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.EntityRecognizerProperties.EntityRecognizerProperties instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.EntityRecognizerProperties.EntityRecognizerProperties instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.EntityRecognizerProperties.EntityRecognizerProperties module Amazonka.Comprehend.Types.EntitiesDetectionJobProperties -- | Provides information about an entities detection job. -- -- See: newEntitiesDetectionJobProperties smart -- constructor. data EntitiesDetectionJobProperties EntitiesDetectionJobProperties' :: Maybe Text -> Maybe POSIX -> Maybe Text -> Maybe InputDataConfig -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe JobStatus -> Maybe LanguageCode -> Maybe Text -> Maybe OutputDataConfig -> Maybe POSIX -> Maybe Text -> Maybe VpcConfig -> EntitiesDetectionJobProperties -- | The Amazon Resource Name (ARN) that gives Amazon Comprehend read -- access to your input data. [$sel:dataAccessRoleArn:EntitiesDetectionJobProperties'] :: EntitiesDetectionJobProperties -> Maybe Text -- | The time that the entities detection job completed [$sel:endTime:EntitiesDetectionJobProperties'] :: EntitiesDetectionJobProperties -> Maybe POSIX -- | The Amazon Resource Name (ARN) that identifies the entity recognizer. [$sel:entityRecognizerArn:EntitiesDetectionJobProperties'] :: EntitiesDetectionJobProperties -> Maybe Text -- | The input data configuration that you supplied when you created the -- entities detection job. [$sel:inputDataConfig:EntitiesDetectionJobProperties'] :: EntitiesDetectionJobProperties -> Maybe InputDataConfig -- | The Amazon Resource Name (ARN) of the entities detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
--
[$sel:jobArn:EntitiesDetectionJobProperties'] :: EntitiesDetectionJobProperties -> Maybe Text -- | The identifier assigned to the entities detection job. [$sel:jobId:EntitiesDetectionJobProperties'] :: EntitiesDetectionJobProperties -> Maybe Text -- | The name that you assigned the entities detection job. [$sel:jobName:EntitiesDetectionJobProperties'] :: EntitiesDetectionJobProperties -> Maybe Text -- | The current status of the entities detection job. If the status is -- FAILED, the Message field shows the reason for the -- failure. [$sel:jobStatus:EntitiesDetectionJobProperties'] :: EntitiesDetectionJobProperties -> Maybe JobStatus -- | The language code of the input documents. [$sel:languageCode:EntitiesDetectionJobProperties'] :: EntitiesDetectionJobProperties -> Maybe LanguageCode -- | A description of the status of a job. [$sel:message:EntitiesDetectionJobProperties'] :: EntitiesDetectionJobProperties -> Maybe Text -- | The output data configuration that you supplied when you created the -- entities detection job. [$sel:outputDataConfig:EntitiesDetectionJobProperties'] :: EntitiesDetectionJobProperties -> Maybe OutputDataConfig -- | The time that the entities detection job was submitted for processing. [$sel:submitTime:EntitiesDetectionJobProperties'] :: EntitiesDetectionJobProperties -> Maybe POSIX -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- [$sel:volumeKmsKeyId:EntitiesDetectionJobProperties'] :: EntitiesDetectionJobProperties -> Maybe Text -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your entity detection job. -- For more information, see Amazon VPC. [$sel:vpcConfig:EntitiesDetectionJobProperties'] :: EntitiesDetectionJobProperties -> Maybe VpcConfig -- | Create a value of EntitiesDetectionJobProperties with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:dataAccessRoleArn:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_dataAccessRoleArn - The Amazon -- Resource Name (ARN) that gives Amazon Comprehend read access to your -- input data. -- -- $sel:endTime:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_endTime - The time that the -- entities detection job completed -- -- $sel:entityRecognizerArn:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_entityRecognizerArn - The Amazon -- Resource Name (ARN) that identifies the entity recognizer. -- -- $sel:inputDataConfig:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_inputDataConfig - The input data -- configuration that you supplied when you created the entities -- detection job. -- -- $sel:jobArn:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_jobArn - The Amazon Resource -- Name (ARN) of the entities detection job. It is a unique, fully -- qualified identifier for the job. It includes the AWS account, Region, -- and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- $sel:jobId:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_jobId - The identifier assigned -- to the entities detection job. -- -- $sel:jobName:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_jobName - The name that you -- assigned the entities detection job. -- -- $sel:jobStatus:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_jobStatus - The current status -- of the entities detection job. If the status is FAILED, the -- Message field shows the reason for the failure. -- -- $sel:languageCode:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_languageCode - The language code -- of the input documents. -- -- $sel:message:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_message - A description of the -- status of a job. -- -- $sel:outputDataConfig:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_outputDataConfig - The output -- data configuration that you supplied when you created the entities -- detection job. -- -- $sel:submitTime:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_submitTime - The time that the -- entities detection job was submitted for processing. -- -- $sel:volumeKmsKeyId:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_volumeKmsKeyId - ID for the AWS -- Key Management Service (KMS) key that Amazon Comprehend uses to -- encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- -- -- $sel:vpcConfig:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_vpcConfig - Configuration -- parameters for a private Virtual Private Cloud (VPC) containing the -- resources you are using for your entity detection job. For more -- information, see Amazon VPC. newEntitiesDetectionJobProperties :: EntitiesDetectionJobProperties -- | The Amazon Resource Name (ARN) that gives Amazon Comprehend read -- access to your input data. entitiesDetectionJobProperties_dataAccessRoleArn :: Lens' EntitiesDetectionJobProperties (Maybe Text) -- | The time that the entities detection job completed entitiesDetectionJobProperties_endTime :: Lens' EntitiesDetectionJobProperties (Maybe UTCTime) -- | The Amazon Resource Name (ARN) that identifies the entity recognizer. entitiesDetectionJobProperties_entityRecognizerArn :: Lens' EntitiesDetectionJobProperties (Maybe Text) -- | The input data configuration that you supplied when you created the -- entities detection job. entitiesDetectionJobProperties_inputDataConfig :: Lens' EntitiesDetectionJobProperties (Maybe InputDataConfig) -- | The Amazon Resource Name (ARN) of the entities detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
--
entitiesDetectionJobProperties_jobArn :: Lens' EntitiesDetectionJobProperties (Maybe Text) -- | The identifier assigned to the entities detection job. entitiesDetectionJobProperties_jobId :: Lens' EntitiesDetectionJobProperties (Maybe Text) -- | The name that you assigned the entities detection job. entitiesDetectionJobProperties_jobName :: Lens' EntitiesDetectionJobProperties (Maybe Text) -- | The current status of the entities detection job. If the status is -- FAILED, the Message field shows the reason for the -- failure. entitiesDetectionJobProperties_jobStatus :: Lens' EntitiesDetectionJobProperties (Maybe JobStatus) -- | The language code of the input documents. entitiesDetectionJobProperties_languageCode :: Lens' EntitiesDetectionJobProperties (Maybe LanguageCode) -- | A description of the status of a job. entitiesDetectionJobProperties_message :: Lens' EntitiesDetectionJobProperties (Maybe Text) -- | The output data configuration that you supplied when you created the -- entities detection job. entitiesDetectionJobProperties_outputDataConfig :: Lens' EntitiesDetectionJobProperties (Maybe OutputDataConfig) -- | The time that the entities detection job was submitted for processing. entitiesDetectionJobProperties_submitTime :: Lens' EntitiesDetectionJobProperties (Maybe UTCTime) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- entitiesDetectionJobProperties_volumeKmsKeyId :: Lens' EntitiesDetectionJobProperties (Maybe Text) -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your entity detection job. -- For more information, see Amazon VPC. entitiesDetectionJobProperties_vpcConfig :: Lens' EntitiesDetectionJobProperties (Maybe VpcConfig) instance GHC.Generics.Generic Amazonka.Comprehend.Types.EntitiesDetectionJobProperties.EntitiesDetectionJobProperties instance GHC.Show.Show Amazonka.Comprehend.Types.EntitiesDetectionJobProperties.EntitiesDetectionJobProperties instance GHC.Read.Read Amazonka.Comprehend.Types.EntitiesDetectionJobProperties.EntitiesDetectionJobProperties instance GHC.Classes.Eq Amazonka.Comprehend.Types.EntitiesDetectionJobProperties.EntitiesDetectionJobProperties instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.EntitiesDetectionJobProperties.EntitiesDetectionJobProperties instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.EntitiesDetectionJobProperties.EntitiesDetectionJobProperties instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.EntitiesDetectionJobProperties.EntitiesDetectionJobProperties module Amazonka.Comprehend.Types.DominantLanguageDetectionJobProperties -- | Provides information about a dominant language detection job. -- -- See: newDominantLanguageDetectionJobProperties smart -- constructor. data DominantLanguageDetectionJobProperties DominantLanguageDetectionJobProperties' :: Maybe Text -> Maybe POSIX -> Maybe InputDataConfig -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe JobStatus -> Maybe Text -> Maybe OutputDataConfig -> Maybe POSIX -> Maybe Text -> Maybe VpcConfig -> DominantLanguageDetectionJobProperties -- | The Amazon Resource Name (ARN) that gives Amazon Comprehend read -- access to your input data. [$sel:dataAccessRoleArn:DominantLanguageDetectionJobProperties'] :: DominantLanguageDetectionJobProperties -> Maybe Text -- | The time that the dominant language detection job completed. [$sel:endTime:DominantLanguageDetectionJobProperties'] :: DominantLanguageDetectionJobProperties -> Maybe POSIX -- | The input data configuration that you supplied when you created the -- dominant language detection job. [$sel:inputDataConfig:DominantLanguageDetectionJobProperties'] :: DominantLanguageDetectionJobProperties -> Maybe InputDataConfig -- | The Amazon Resource Name (ARN) of the dominant language detection job. -- It is a unique, fully qualified identifier for the job. It includes -- the AWS account, Region, and the job ID. The format of the ARN is as -- follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
--
[$sel:jobArn:DominantLanguageDetectionJobProperties'] :: DominantLanguageDetectionJobProperties -> Maybe Text -- | The identifier assigned to the dominant language detection job. [$sel:jobId:DominantLanguageDetectionJobProperties'] :: DominantLanguageDetectionJobProperties -> Maybe Text -- | The name that you assigned to the dominant language detection job. [$sel:jobName:DominantLanguageDetectionJobProperties'] :: DominantLanguageDetectionJobProperties -> Maybe Text -- | The current status of the dominant language detection job. If the -- status is FAILED, the Message field shows the reason -- for the failure. [$sel:jobStatus:DominantLanguageDetectionJobProperties'] :: DominantLanguageDetectionJobProperties -> Maybe JobStatus -- | A description for the status of a job. [$sel:message:DominantLanguageDetectionJobProperties'] :: DominantLanguageDetectionJobProperties -> Maybe Text -- | The output data configuration that you supplied when you created the -- dominant language detection job. [$sel:outputDataConfig:DominantLanguageDetectionJobProperties'] :: DominantLanguageDetectionJobProperties -> Maybe OutputDataConfig -- | The time that the dominant language detection job was submitted for -- processing. [$sel:submitTime:DominantLanguageDetectionJobProperties'] :: DominantLanguageDetectionJobProperties -> Maybe POSIX -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- [$sel:volumeKmsKeyId:DominantLanguageDetectionJobProperties'] :: DominantLanguageDetectionJobProperties -> Maybe Text -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your dominant language -- detection job. For more information, see Amazon VPC. [$sel:vpcConfig:DominantLanguageDetectionJobProperties'] :: DominantLanguageDetectionJobProperties -> Maybe VpcConfig -- | Create a value of DominantLanguageDetectionJobProperties with -- all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:dataAccessRoleArn:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_dataAccessRoleArn - The -- Amazon Resource Name (ARN) that gives Amazon Comprehend read access to -- your input data. -- -- $sel:endTime:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_endTime - The time that -- the dominant language detection job completed. -- -- $sel:inputDataConfig:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_inputDataConfig - The -- input data configuration that you supplied when you created the -- dominant language detection job. -- -- $sel:jobArn:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_jobArn - The Amazon -- Resource Name (ARN) of the dominant language detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- $sel:jobId:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_jobId - The identifier -- assigned to the dominant language detection job. -- -- $sel:jobName:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_jobName - The name that -- you assigned to the dominant language detection job. -- -- $sel:jobStatus:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_jobStatus - The current -- status of the dominant language detection job. If the status is -- FAILED, the Message field shows the reason for the -- failure. -- -- $sel:message:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_message - A description -- for the status of a job. -- -- $sel:outputDataConfig:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_outputDataConfig - The -- output data configuration that you supplied when you created the -- dominant language detection job. -- -- $sel:submitTime:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_submitTime - The time -- that the dominant language detection job was submitted for processing. -- -- $sel:volumeKmsKeyId:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_volumeKmsKeyId - ID for -- the AWS Key Management Service (KMS) key that Amazon Comprehend uses -- to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- -- -- $sel:vpcConfig:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_vpcConfig - -- Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your dominant language -- detection job. For more information, see Amazon VPC. newDominantLanguageDetectionJobProperties :: DominantLanguageDetectionJobProperties -- | The Amazon Resource Name (ARN) that gives Amazon Comprehend read -- access to your input data. dominantLanguageDetectionJobProperties_dataAccessRoleArn :: Lens' DominantLanguageDetectionJobProperties (Maybe Text) -- | The time that the dominant language detection job completed. dominantLanguageDetectionJobProperties_endTime :: Lens' DominantLanguageDetectionJobProperties (Maybe UTCTime) -- | The input data configuration that you supplied when you created the -- dominant language detection job. dominantLanguageDetectionJobProperties_inputDataConfig :: Lens' DominantLanguageDetectionJobProperties (Maybe InputDataConfig) -- | The Amazon Resource Name (ARN) of the dominant language detection job. -- It is a unique, fully qualified identifier for the job. It includes -- the AWS account, Region, and the job ID. The format of the ARN is as -- follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
--
dominantLanguageDetectionJobProperties_jobArn :: Lens' DominantLanguageDetectionJobProperties (Maybe Text) -- | The identifier assigned to the dominant language detection job. dominantLanguageDetectionJobProperties_jobId :: Lens' DominantLanguageDetectionJobProperties (Maybe Text) -- | The name that you assigned to the dominant language detection job. dominantLanguageDetectionJobProperties_jobName :: Lens' DominantLanguageDetectionJobProperties (Maybe Text) -- | The current status of the dominant language detection job. If the -- status is FAILED, the Message field shows the reason -- for the failure. dominantLanguageDetectionJobProperties_jobStatus :: Lens' DominantLanguageDetectionJobProperties (Maybe JobStatus) -- | A description for the status of a job. dominantLanguageDetectionJobProperties_message :: Lens' DominantLanguageDetectionJobProperties (Maybe Text) -- | The output data configuration that you supplied when you created the -- dominant language detection job. dominantLanguageDetectionJobProperties_outputDataConfig :: Lens' DominantLanguageDetectionJobProperties (Maybe OutputDataConfig) -- | The time that the dominant language detection job was submitted for -- processing. dominantLanguageDetectionJobProperties_submitTime :: Lens' DominantLanguageDetectionJobProperties (Maybe UTCTime) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- dominantLanguageDetectionJobProperties_volumeKmsKeyId :: Lens' DominantLanguageDetectionJobProperties (Maybe Text) -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your dominant language -- detection job. For more information, see Amazon VPC. dominantLanguageDetectionJobProperties_vpcConfig :: Lens' DominantLanguageDetectionJobProperties (Maybe VpcConfig) instance GHC.Generics.Generic Amazonka.Comprehend.Types.DominantLanguageDetectionJobProperties.DominantLanguageDetectionJobProperties instance GHC.Show.Show Amazonka.Comprehend.Types.DominantLanguageDetectionJobProperties.DominantLanguageDetectionJobProperties instance GHC.Read.Read Amazonka.Comprehend.Types.DominantLanguageDetectionJobProperties.DominantLanguageDetectionJobProperties instance GHC.Classes.Eq Amazonka.Comprehend.Types.DominantLanguageDetectionJobProperties.DominantLanguageDetectionJobProperties instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.DominantLanguageDetectionJobProperties.DominantLanguageDetectionJobProperties instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.DominantLanguageDetectionJobProperties.DominantLanguageDetectionJobProperties instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.DominantLanguageDetectionJobProperties.DominantLanguageDetectionJobProperties module Amazonka.Comprehend.Types.DocumentClassifierProperties -- | Provides information about a document classifier. -- -- See: newDocumentClassifierProperties smart constructor. data DocumentClassifierProperties DocumentClassifierProperties' :: Maybe (Sensitive ClassifierMetadata) -> Maybe Text -> Maybe Text -> Maybe POSIX -> Maybe DocumentClassifierInputDataConfig -> Maybe LanguageCode -> Maybe Text -> Maybe DocumentClassifierMode -> Maybe Text -> Maybe DocumentClassifierOutputDataConfig -> Maybe Text -> Maybe ModelStatus -> Maybe POSIX -> Maybe POSIX -> Maybe POSIX -> Maybe Text -> Maybe Text -> Maybe VpcConfig -> DocumentClassifierProperties -- | Information about the document classifier, including the number of -- documents used for training the classifier, the number of documents -- used for test the classifier, and an accuracy rating. [$sel:classifierMetadata:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe (Sensitive ClassifierMetadata) -- | The Amazon Resource Name (ARN) of the AWS Identity and Management -- (IAM) role that grants Amazon Comprehend read access to your input -- data. [$sel:dataAccessRoleArn:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe Text -- | The Amazon Resource Name (ARN) that identifies the document -- classifier. [$sel:documentClassifierArn:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe Text -- | The time that training the document classifier completed. [$sel:endTime:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe POSIX -- | The input data configuration that you supplied when you created the -- document classifier for training. [$sel:inputDataConfig:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe DocumentClassifierInputDataConfig -- | The language code for the language of the documents that the -- classifier was trained on. [$sel:languageCode:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe LanguageCode -- | Additional information about the status of the classifier. [$sel:message:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe Text -- | Indicates the mode in which the specific classifier was trained. This -- also indicates the format of input documents and the format of the -- confusion matrix. Each classifier can only be trained in one mode and -- this cannot be changed once the classifier is trained. [$sel:mode:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe DocumentClassifierMode -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt trained custom models. The ModelKmsKeyId can be either -- of the following formats: -- -- [$sel:modelKmsKeyId:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe Text -- | Provides output results configuration parameters for custom classifier -- jobs. [$sel:outputDataConfig:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe DocumentClassifierOutputDataConfig -- | The Amazon Resource Name (ARN) of the source model. This model was -- imported from a different AWS account to create the document -- classifier model in your AWS account. [$sel:sourceModelArn:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe Text -- | The status of the document classifier. If the status is -- TRAINED the classifier is ready to use. If the status is -- FAILED you can see additional information about why the -- classifier wasn't trained in the Message field. [$sel:status:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe ModelStatus -- | The time that the document classifier was submitted for training. [$sel:submitTime:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe POSIX -- | The time that training of the document classifier was completed. -- Indicates the time when the training completes on documentation -- classifiers. You are billed for the time interval between this time -- and the value of TrainingStartTime. [$sel:trainingEndTime:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe POSIX -- | Indicates the time when the training starts on documentation -- classifiers. You are billed for the time interval between this time -- and the value of TrainingEndTime. [$sel:trainingStartTime:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe POSIX -- | The version name that you assigned to the document classifier. [$sel:versionName:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe Text -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- [$sel:volumeKmsKeyId:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe Text -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your custom classifier. For -- more information, see Amazon VPC. [$sel:vpcConfig:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe VpcConfig -- | Create a value of DocumentClassifierProperties with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:classifierMetadata:DocumentClassifierProperties', -- documentClassifierProperties_classifierMetadata - Information -- about the document classifier, including the number of documents used -- for training the classifier, the number of documents used for test the -- classifier, and an accuracy rating. -- -- $sel:dataAccessRoleArn:DocumentClassifierProperties', -- documentClassifierProperties_dataAccessRoleArn - The Amazon -- Resource Name (ARN) of the AWS Identity and Management (IAM) role that -- grants Amazon Comprehend read access to your input data. -- -- $sel:documentClassifierArn:DocumentClassifierProperties', -- documentClassifierProperties_documentClassifierArn - The Amazon -- Resource Name (ARN) that identifies the document classifier. -- -- $sel:endTime:DocumentClassifierProperties', -- documentClassifierProperties_endTime - The time that training -- the document classifier completed. -- -- $sel:inputDataConfig:DocumentClassifierProperties', -- documentClassifierProperties_inputDataConfig - The input data -- configuration that you supplied when you created the document -- classifier for training. -- -- $sel:languageCode:DocumentClassifierProperties', -- documentClassifierProperties_languageCode - The language code -- for the language of the documents that the classifier was trained on. -- -- $sel:message:DocumentClassifierProperties', -- documentClassifierProperties_message - Additional information -- about the status of the classifier. -- -- $sel:mode:DocumentClassifierProperties', -- documentClassifierProperties_mode - Indicates the mode in which -- the specific classifier was trained. This also indicates the format of -- input documents and the format of the confusion matrix. Each -- classifier can only be trained in one mode and this cannot be changed -- once the classifier is trained. -- -- $sel:modelKmsKeyId:DocumentClassifierProperties', -- documentClassifierProperties_modelKmsKeyId - ID for the AWS Key -- Management Service (KMS) key that Amazon Comprehend uses to encrypt -- trained custom models. The ModelKmsKeyId can be either of the -- following formats: -- -- -- -- $sel:outputDataConfig:DocumentClassifierProperties', -- documentClassifierProperties_outputDataConfig - Provides output -- results configuration parameters for custom classifier jobs. -- -- $sel:sourceModelArn:DocumentClassifierProperties', -- documentClassifierProperties_sourceModelArn - The Amazon -- Resource Name (ARN) of the source model. This model was imported from -- a different AWS account to create the document classifier model in -- your AWS account. -- -- $sel:status:DocumentClassifierProperties', -- documentClassifierProperties_status - The status of the -- document classifier. If the status is TRAINED the classifier -- is ready to use. If the status is FAILED you can see -- additional information about why the classifier wasn't trained in the -- Message field. -- -- $sel:submitTime:DocumentClassifierProperties', -- documentClassifierProperties_submitTime - The time that the -- document classifier was submitted for training. -- -- $sel:trainingEndTime:DocumentClassifierProperties', -- documentClassifierProperties_trainingEndTime - The time that -- training of the document classifier was completed. Indicates the time -- when the training completes on documentation classifiers. You are -- billed for the time interval between this time and the value of -- TrainingStartTime. -- -- $sel:trainingStartTime:DocumentClassifierProperties', -- documentClassifierProperties_trainingStartTime - Indicates the -- time when the training starts on documentation classifiers. You are -- billed for the time interval between this time and the value of -- TrainingEndTime. -- -- $sel:versionName:DocumentClassifierProperties', -- documentClassifierProperties_versionName - The version name -- that you assigned to the document classifier. -- -- $sel:volumeKmsKeyId:DocumentClassifierProperties', -- documentClassifierProperties_volumeKmsKeyId - ID for the AWS -- Key Management Service (KMS) key that Amazon Comprehend uses to -- encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- -- -- $sel:vpcConfig:DocumentClassifierProperties', -- documentClassifierProperties_vpcConfig - Configuration -- parameters for a private Virtual Private Cloud (VPC) containing the -- resources you are using for your custom classifier. For more -- information, see Amazon VPC. newDocumentClassifierProperties :: DocumentClassifierProperties -- | Information about the document classifier, including the number of -- documents used for training the classifier, the number of documents -- used for test the classifier, and an accuracy rating. documentClassifierProperties_classifierMetadata :: Lens' DocumentClassifierProperties (Maybe ClassifierMetadata) -- | The Amazon Resource Name (ARN) of the AWS Identity and Management -- (IAM) role that grants Amazon Comprehend read access to your input -- data. documentClassifierProperties_dataAccessRoleArn :: Lens' DocumentClassifierProperties (Maybe Text) -- | The Amazon Resource Name (ARN) that identifies the document -- classifier. documentClassifierProperties_documentClassifierArn :: Lens' DocumentClassifierProperties (Maybe Text) -- | The time that training the document classifier completed. documentClassifierProperties_endTime :: Lens' DocumentClassifierProperties (Maybe UTCTime) -- | The input data configuration that you supplied when you created the -- document classifier for training. documentClassifierProperties_inputDataConfig :: Lens' DocumentClassifierProperties (Maybe DocumentClassifierInputDataConfig) -- | The language code for the language of the documents that the -- classifier was trained on. documentClassifierProperties_languageCode :: Lens' DocumentClassifierProperties (Maybe LanguageCode) -- | Additional information about the status of the classifier. documentClassifierProperties_message :: Lens' DocumentClassifierProperties (Maybe Text) -- | Indicates the mode in which the specific classifier was trained. This -- also indicates the format of input documents and the format of the -- confusion matrix. Each classifier can only be trained in one mode and -- this cannot be changed once the classifier is trained. documentClassifierProperties_mode :: Lens' DocumentClassifierProperties (Maybe DocumentClassifierMode) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt trained custom models. The ModelKmsKeyId can be either -- of the following formats: -- -- documentClassifierProperties_modelKmsKeyId :: Lens' DocumentClassifierProperties (Maybe Text) -- | Provides output results configuration parameters for custom classifier -- jobs. documentClassifierProperties_outputDataConfig :: Lens' DocumentClassifierProperties (Maybe DocumentClassifierOutputDataConfig) -- | The Amazon Resource Name (ARN) of the source model. This model was -- imported from a different AWS account to create the document -- classifier model in your AWS account. documentClassifierProperties_sourceModelArn :: Lens' DocumentClassifierProperties (Maybe Text) -- | The status of the document classifier. If the status is -- TRAINED the classifier is ready to use. If the status is -- FAILED you can see additional information about why the -- classifier wasn't trained in the Message field. documentClassifierProperties_status :: Lens' DocumentClassifierProperties (Maybe ModelStatus) -- | The time that the document classifier was submitted for training. documentClassifierProperties_submitTime :: Lens' DocumentClassifierProperties (Maybe UTCTime) -- | The time that training of the document classifier was completed. -- Indicates the time when the training completes on documentation -- classifiers. You are billed for the time interval between this time -- and the value of TrainingStartTime. documentClassifierProperties_trainingEndTime :: Lens' DocumentClassifierProperties (Maybe UTCTime) -- | Indicates the time when the training starts on documentation -- classifiers. You are billed for the time interval between this time -- and the value of TrainingEndTime. documentClassifierProperties_trainingStartTime :: Lens' DocumentClassifierProperties (Maybe UTCTime) -- | The version name that you assigned to the document classifier. documentClassifierProperties_versionName :: Lens' DocumentClassifierProperties (Maybe Text) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- documentClassifierProperties_volumeKmsKeyId :: Lens' DocumentClassifierProperties (Maybe Text) -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your custom classifier. For -- more information, see Amazon VPC. documentClassifierProperties_vpcConfig :: Lens' DocumentClassifierProperties (Maybe VpcConfig) instance GHC.Generics.Generic Amazonka.Comprehend.Types.DocumentClassifierProperties.DocumentClassifierProperties instance GHC.Show.Show Amazonka.Comprehend.Types.DocumentClassifierProperties.DocumentClassifierProperties instance GHC.Classes.Eq Amazonka.Comprehend.Types.DocumentClassifierProperties.DocumentClassifierProperties instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.DocumentClassifierProperties.DocumentClassifierProperties instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.DocumentClassifierProperties.DocumentClassifierProperties instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.DocumentClassifierProperties.DocumentClassifierProperties module Amazonka.Comprehend.Types.DocumentClassificationJobProperties -- | Provides information about a document classification job. -- -- See: newDocumentClassificationJobProperties smart -- constructor. data DocumentClassificationJobProperties DocumentClassificationJobProperties' :: Maybe Text -> Maybe Text -> Maybe POSIX -> Maybe InputDataConfig -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe JobStatus -> Maybe Text -> Maybe OutputDataConfig -> Maybe POSIX -> Maybe Text -> Maybe VpcConfig -> DocumentClassificationJobProperties -- | The Amazon Resource Name (ARN) of the AWS identity and Access -- Management (IAM) role that grants Amazon Comprehend read access to -- your input data. [$sel:dataAccessRoleArn:DocumentClassificationJobProperties'] :: DocumentClassificationJobProperties -> Maybe Text -- | The Amazon Resource Name (ARN) that identifies the document -- classifier. [$sel:documentClassifierArn:DocumentClassificationJobProperties'] :: DocumentClassificationJobProperties -> Maybe Text -- | The time that the document classification job completed. [$sel:endTime:DocumentClassificationJobProperties'] :: DocumentClassificationJobProperties -> Maybe POSIX -- | The input data configuration that you supplied when you created the -- document classification job. [$sel:inputDataConfig:DocumentClassificationJobProperties'] :: DocumentClassificationJobProperties -> Maybe InputDataConfig -- | The Amazon Resource Name (ARN) of the document classification job. It -- is a unique, fully qualified identifier for the job. It includes the -- AWS account, Region, and the job ID. The format of the ARN is as -- follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
--
[$sel:jobArn:DocumentClassificationJobProperties'] :: DocumentClassificationJobProperties -> Maybe Text -- | The identifier assigned to the document classification job. [$sel:jobId:DocumentClassificationJobProperties'] :: DocumentClassificationJobProperties -> Maybe Text -- | The name that you assigned to the document classification job. [$sel:jobName:DocumentClassificationJobProperties'] :: DocumentClassificationJobProperties -> Maybe Text -- | The current status of the document classification job. If the status -- is FAILED, the Message field shows the reason for -- the failure. [$sel:jobStatus:DocumentClassificationJobProperties'] :: DocumentClassificationJobProperties -> Maybe JobStatus -- | A description of the status of the job. [$sel:message:DocumentClassificationJobProperties'] :: DocumentClassificationJobProperties -> Maybe Text -- | The output data configuration that you supplied when you created the -- document classification job. [$sel:outputDataConfig:DocumentClassificationJobProperties'] :: DocumentClassificationJobProperties -> Maybe OutputDataConfig -- | The time that the document classification job was submitted for -- processing. [$sel:submitTime:DocumentClassificationJobProperties'] :: DocumentClassificationJobProperties -> Maybe POSIX -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- [$sel:volumeKmsKeyId:DocumentClassificationJobProperties'] :: DocumentClassificationJobProperties -> Maybe Text -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your document -- classification job. For more information, see Amazon VPC. [$sel:vpcConfig:DocumentClassificationJobProperties'] :: DocumentClassificationJobProperties -> Maybe VpcConfig -- | Create a value of DocumentClassificationJobProperties with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:dataAccessRoleArn:DocumentClassificationJobProperties', -- documentClassificationJobProperties_dataAccessRoleArn - The -- Amazon Resource Name (ARN) of the AWS identity and Access Management -- (IAM) role that grants Amazon Comprehend read access to your input -- data. -- -- -- $sel:documentClassifierArn:DocumentClassificationJobProperties', -- documentClassificationJobProperties_documentClassifierArn - The -- Amazon Resource Name (ARN) that identifies the document classifier. -- -- $sel:endTime:DocumentClassificationJobProperties', -- documentClassificationJobProperties_endTime - The time that the -- document classification job completed. -- -- $sel:inputDataConfig:DocumentClassificationJobProperties', -- documentClassificationJobProperties_inputDataConfig - The input -- data configuration that you supplied when you created the document -- classification job. -- -- $sel:jobArn:DocumentClassificationJobProperties', -- documentClassificationJobProperties_jobArn - The Amazon -- Resource Name (ARN) of the document classification job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- $sel:jobId:DocumentClassificationJobProperties', -- documentClassificationJobProperties_jobId - The identifier -- assigned to the document classification job. -- -- $sel:jobName:DocumentClassificationJobProperties', -- documentClassificationJobProperties_jobName - The name that you -- assigned to the document classification job. -- -- $sel:jobStatus:DocumentClassificationJobProperties', -- documentClassificationJobProperties_jobStatus - The current -- status of the document classification job. If the status is -- FAILED, the Message field shows the reason for the -- failure. -- -- $sel:message:DocumentClassificationJobProperties', -- documentClassificationJobProperties_message - A description of -- the status of the job. -- -- $sel:outputDataConfig:DocumentClassificationJobProperties', -- documentClassificationJobProperties_outputDataConfig - The -- output data configuration that you supplied when you created the -- document classification job. -- -- $sel:submitTime:DocumentClassificationJobProperties', -- documentClassificationJobProperties_submitTime - The time that -- the document classification job was submitted for processing. -- -- $sel:volumeKmsKeyId:DocumentClassificationJobProperties', -- documentClassificationJobProperties_volumeKmsKeyId - ID for the -- AWS Key Management Service (KMS) key that Amazon Comprehend uses to -- encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- -- -- $sel:vpcConfig:DocumentClassificationJobProperties', -- documentClassificationJobProperties_vpcConfig - Configuration -- parameters for a private Virtual Private Cloud (VPC) containing the -- resources you are using for your document classification job. For more -- information, see Amazon VPC. newDocumentClassificationJobProperties :: DocumentClassificationJobProperties -- | The Amazon Resource Name (ARN) of the AWS identity and Access -- Management (IAM) role that grants Amazon Comprehend read access to -- your input data. documentClassificationJobProperties_dataAccessRoleArn :: Lens' DocumentClassificationJobProperties (Maybe Text) -- | The Amazon Resource Name (ARN) that identifies the document -- classifier. documentClassificationJobProperties_documentClassifierArn :: Lens' DocumentClassificationJobProperties (Maybe Text) -- | The time that the document classification job completed. documentClassificationJobProperties_endTime :: Lens' DocumentClassificationJobProperties (Maybe UTCTime) -- | The input data configuration that you supplied when you created the -- document classification job. documentClassificationJobProperties_inputDataConfig :: Lens' DocumentClassificationJobProperties (Maybe InputDataConfig) -- | The Amazon Resource Name (ARN) of the document classification job. It -- is a unique, fully qualified identifier for the job. It includes the -- AWS account, Region, and the job ID. The format of the ARN is as -- follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
--
documentClassificationJobProperties_jobArn :: Lens' DocumentClassificationJobProperties (Maybe Text) -- | The identifier assigned to the document classification job. documentClassificationJobProperties_jobId :: Lens' DocumentClassificationJobProperties (Maybe Text) -- | The name that you assigned to the document classification job. documentClassificationJobProperties_jobName :: Lens' DocumentClassificationJobProperties (Maybe Text) -- | The current status of the document classification job. If the status -- is FAILED, the Message field shows the reason for -- the failure. documentClassificationJobProperties_jobStatus :: Lens' DocumentClassificationJobProperties (Maybe JobStatus) -- | A description of the status of the job. documentClassificationJobProperties_message :: Lens' DocumentClassificationJobProperties (Maybe Text) -- | The output data configuration that you supplied when you created the -- document classification job. documentClassificationJobProperties_outputDataConfig :: Lens' DocumentClassificationJobProperties (Maybe OutputDataConfig) -- | The time that the document classification job was submitted for -- processing. documentClassificationJobProperties_submitTime :: Lens' DocumentClassificationJobProperties (Maybe UTCTime) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- documentClassificationJobProperties_volumeKmsKeyId :: Lens' DocumentClassificationJobProperties (Maybe Text) -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your document -- classification job. For more information, see Amazon VPC. documentClassificationJobProperties_vpcConfig :: Lens' DocumentClassificationJobProperties (Maybe VpcConfig) instance GHC.Generics.Generic Amazonka.Comprehend.Types.DocumentClassificationJobProperties.DocumentClassificationJobProperties instance GHC.Show.Show Amazonka.Comprehend.Types.DocumentClassificationJobProperties.DocumentClassificationJobProperties instance GHC.Read.Read Amazonka.Comprehend.Types.DocumentClassificationJobProperties.DocumentClassificationJobProperties instance GHC.Classes.Eq Amazonka.Comprehend.Types.DocumentClassificationJobProperties.DocumentClassificationJobProperties instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.Comprehend.Types.DocumentClassificationJobProperties.DocumentClassificationJobProperties instance Data.Hashable.Class.Hashable Amazonka.Comprehend.Types.DocumentClassificationJobProperties.DocumentClassificationJobProperties instance Control.DeepSeq.NFData Amazonka.Comprehend.Types.DocumentClassificationJobProperties.DocumentClassificationJobProperties module Amazonka.Comprehend.Types -- | API version 2017-11-27 of the Amazon Comprehend SDK -- configuration. defaultService :: Service -- | The number of documents in the request exceeds the limit of 25. Try -- your request again with fewer documents. _BatchSizeLimitExceededException :: AsError a => Fold a ServiceError -- | Concurrent modification of the tags associated with an Amazon -- Comprehend resource is not supported. _ConcurrentModificationException :: AsError a => Fold a ServiceError -- | An internal server error occurred. Retry your request. _InternalServerException :: AsError a => Fold a ServiceError -- | The filter specified for the operation is invalid. Specify a different -- filter. _InvalidFilterException :: AsError a => Fold a ServiceError -- | The request is invalid. _InvalidRequestException :: AsError a => Fold a ServiceError -- | The specified job was not found. Check the job ID and try again. _JobNotFoundException :: AsError a => Fold a ServiceError -- | The KMS customer managed key (CMK) entered cannot be validated. Verify -- the key and re-enter it. _KmsKeyValidationException :: AsError a => Fold a ServiceError -- | The specified resource name is already in use. Use a different name -- and try your request again. _ResourceInUseException :: AsError a => Fold a ServiceError -- | The maximum number of resources per account has been exceeded. Review -- the resources, and then try your request again. _ResourceLimitExceededException :: AsError a => Fold a ServiceError -- | The specified resource ARN was not found. Check the ARN and try your -- request again. _ResourceNotFoundException :: AsError a => Fold a ServiceError -- | The specified resource is not available. Check the resource and try -- your request again. _ResourceUnavailableException :: AsError a => Fold a ServiceError -- | The size of the input text exceeds the limit. Use a smaller document. _TextSizeLimitExceededException :: AsError a => Fold a ServiceError -- | The number of requests exceeds the limit. Resubmit your request later. _TooManyRequestsException :: AsError a => Fold a ServiceError -- | The request contains more tag keys than can be associated with a -- resource (50 tag keys per resource). _TooManyTagKeysException :: AsError a => Fold a ServiceError -- | The request contains more tags than can be associated with a resource -- (50 tags per resource). The maximum number of tags includes both -- existing tags and those included in your current request. _TooManyTagsException :: AsError a => Fold a ServiceError -- | Amazon Comprehend can't process the language of the input text. For -- custom entity recognition APIs, only English, Spanish, French, -- Italian, German, or Portuguese are accepted. For a list of supported -- languages, Supported languages in the Comprehend Developer -- Guide. _UnsupportedLanguageException :: AsError a => Fold a ServiceError newtype AugmentedManifestsDocumentTypeFormat AugmentedManifestsDocumentTypeFormat' :: Text -> AugmentedManifestsDocumentTypeFormat [fromAugmentedManifestsDocumentTypeFormat] :: AugmentedManifestsDocumentTypeFormat -> Text pattern AugmentedManifestsDocumentTypeFormat_PLAIN_TEXT_DOCUMENT :: AugmentedManifestsDocumentTypeFormat pattern AugmentedManifestsDocumentTypeFormat_SEMI_STRUCTURED_DOCUMENT :: AugmentedManifestsDocumentTypeFormat newtype BlockType BlockType' :: Text -> BlockType [fromBlockType] :: BlockType -> Text pattern BlockType_LINE :: BlockType pattern BlockType_WORD :: BlockType newtype DocumentClassifierDataFormat DocumentClassifierDataFormat' :: Text -> DocumentClassifierDataFormat [fromDocumentClassifierDataFormat] :: DocumentClassifierDataFormat -> Text pattern DocumentClassifierDataFormat_AUGMENTED_MANIFEST :: DocumentClassifierDataFormat pattern DocumentClassifierDataFormat_COMPREHEND_CSV :: DocumentClassifierDataFormat newtype DocumentClassifierMode DocumentClassifierMode' :: Text -> DocumentClassifierMode [fromDocumentClassifierMode] :: DocumentClassifierMode -> Text pattern DocumentClassifierMode_MULTI_CLASS :: DocumentClassifierMode pattern DocumentClassifierMode_MULTI_LABEL :: DocumentClassifierMode newtype DocumentReadAction DocumentReadAction' :: Text -> DocumentReadAction [fromDocumentReadAction] :: DocumentReadAction -> Text pattern DocumentReadAction_TEXTRACT_ANALYZE_DOCUMENT :: DocumentReadAction pattern DocumentReadAction_TEXTRACT_DETECT_DOCUMENT_TEXT :: DocumentReadAction -- | Specifies the type of Amazon Textract features to apply. If you chose -- TEXTRACT_ANALYZE_DOCUMENT as the read action, you must -- specify one or both of the following values: -- -- newtype DocumentReadFeatureTypes DocumentReadFeatureTypes' :: Text -> DocumentReadFeatureTypes [fromDocumentReadFeatureTypes] :: DocumentReadFeatureTypes -> Text pattern DocumentReadFeatureTypes_FORMS :: DocumentReadFeatureTypes pattern DocumentReadFeatureTypes_TABLES :: DocumentReadFeatureTypes newtype DocumentReadMode DocumentReadMode' :: Text -> DocumentReadMode [fromDocumentReadMode] :: DocumentReadMode -> Text pattern DocumentReadMode_FORCE_DOCUMENT_READ_ACTION :: DocumentReadMode pattern DocumentReadMode_SERVICE_DEFAULT :: DocumentReadMode newtype DocumentType DocumentType' :: Text -> DocumentType [fromDocumentType] :: DocumentType -> Text pattern DocumentType_IMAGE :: DocumentType pattern DocumentType_MS_WORD :: DocumentType pattern DocumentType_NATIVE_PDF :: DocumentType pattern DocumentType_PLAIN_TEXT :: DocumentType pattern DocumentType_SCANNED_PDF :: DocumentType pattern DocumentType_TEXTRACT_ANALYZE_DOCUMENT_JSON :: DocumentType pattern DocumentType_TEXTRACT_DETECT_DOCUMENT_TEXT_JSON :: DocumentType newtype EndpointStatus EndpointStatus' :: Text -> EndpointStatus [fromEndpointStatus] :: EndpointStatus -> Text pattern EndpointStatus_CREATING :: EndpointStatus pattern EndpointStatus_DELETING :: EndpointStatus pattern EndpointStatus_FAILED :: EndpointStatus pattern EndpointStatus_IN_SERVICE :: EndpointStatus pattern EndpointStatus_UPDATING :: EndpointStatus newtype EntityRecognizerDataFormat EntityRecognizerDataFormat' :: Text -> EntityRecognizerDataFormat [fromEntityRecognizerDataFormat] :: EntityRecognizerDataFormat -> Text pattern EntityRecognizerDataFormat_AUGMENTED_MANIFEST :: EntityRecognizerDataFormat pattern EntityRecognizerDataFormat_COMPREHEND_CSV :: EntityRecognizerDataFormat newtype EntityType EntityType' :: Text -> EntityType [fromEntityType] :: EntityType -> Text pattern EntityType_COMMERCIAL_ITEM :: EntityType pattern EntityType_DATE :: EntityType pattern EntityType_EVENT :: EntityType pattern EntityType_LOCATION :: EntityType pattern EntityType_ORGANIZATION :: EntityType pattern EntityType_OTHER :: EntityType pattern EntityType_PERSON :: EntityType pattern EntityType_QUANTITY :: EntityType pattern EntityType_TITLE :: EntityType newtype InputFormat InputFormat' :: Text -> InputFormat [fromInputFormat] :: InputFormat -> Text pattern InputFormat_ONE_DOC_PER_FILE :: InputFormat pattern InputFormat_ONE_DOC_PER_LINE :: InputFormat newtype JobStatus JobStatus' :: Text -> JobStatus [fromJobStatus] :: JobStatus -> Text pattern JobStatus_COMPLETED :: JobStatus pattern JobStatus_FAILED :: JobStatus pattern JobStatus_IN_PROGRESS :: JobStatus pattern JobStatus_STOPPED :: JobStatus pattern JobStatus_STOP_REQUESTED :: JobStatus pattern JobStatus_SUBMITTED :: JobStatus newtype LanguageCode LanguageCode' :: Text -> LanguageCode [fromLanguageCode] :: LanguageCode -> Text pattern LanguageCode_Ar :: LanguageCode pattern LanguageCode_De :: LanguageCode pattern LanguageCode_En :: LanguageCode pattern LanguageCode_Es :: LanguageCode pattern LanguageCode_Fr :: LanguageCode pattern LanguageCode_Hi :: LanguageCode pattern LanguageCode_It :: LanguageCode pattern LanguageCode_Ja :: LanguageCode pattern LanguageCode_Ko :: LanguageCode pattern LanguageCode_Pt :: LanguageCode pattern LanguageCode_Zh :: LanguageCode pattern LanguageCode_Zh_TW :: LanguageCode newtype ModelStatus ModelStatus' :: Text -> ModelStatus [fromModelStatus] :: ModelStatus -> Text pattern ModelStatus_DELETING :: ModelStatus pattern ModelStatus_IN_ERROR :: ModelStatus pattern ModelStatus_STOPPED :: ModelStatus pattern ModelStatus_STOP_REQUESTED :: ModelStatus pattern ModelStatus_SUBMITTED :: ModelStatus pattern ModelStatus_TRAINED :: ModelStatus pattern ModelStatus_TRAINING :: ModelStatus newtype PageBasedErrorCode PageBasedErrorCode' :: Text -> PageBasedErrorCode [fromPageBasedErrorCode] :: PageBasedErrorCode -> Text pattern PageBasedErrorCode_INTERNAL_SERVER_ERROR :: PageBasedErrorCode pattern PageBasedErrorCode_PAGE_CHARACTERS_EXCEEDED :: PageBasedErrorCode pattern PageBasedErrorCode_PAGE_SIZE_EXCEEDED :: PageBasedErrorCode pattern PageBasedErrorCode_TEXTRACT_BAD_PAGE :: PageBasedErrorCode pattern PageBasedErrorCode_TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED :: PageBasedErrorCode newtype PartOfSpeechTagType PartOfSpeechTagType' :: Text -> PartOfSpeechTagType [fromPartOfSpeechTagType] :: PartOfSpeechTagType -> Text pattern PartOfSpeechTagType_ADJ :: PartOfSpeechTagType pattern PartOfSpeechTagType_ADP :: PartOfSpeechTagType pattern PartOfSpeechTagType_ADV :: PartOfSpeechTagType pattern PartOfSpeechTagType_AUX :: PartOfSpeechTagType pattern PartOfSpeechTagType_CCONJ :: PartOfSpeechTagType pattern PartOfSpeechTagType_CONJ :: PartOfSpeechTagType pattern PartOfSpeechTagType_DET :: PartOfSpeechTagType pattern PartOfSpeechTagType_INTJ :: PartOfSpeechTagType pattern PartOfSpeechTagType_NOUN :: PartOfSpeechTagType pattern PartOfSpeechTagType_NUM :: PartOfSpeechTagType pattern PartOfSpeechTagType_O :: PartOfSpeechTagType pattern PartOfSpeechTagType_PART :: PartOfSpeechTagType pattern PartOfSpeechTagType_PRON :: PartOfSpeechTagType pattern PartOfSpeechTagType_PROPN :: PartOfSpeechTagType pattern PartOfSpeechTagType_PUNCT :: PartOfSpeechTagType pattern PartOfSpeechTagType_SCONJ :: PartOfSpeechTagType pattern PartOfSpeechTagType_SYM :: PartOfSpeechTagType pattern PartOfSpeechTagType_VERB :: PartOfSpeechTagType newtype PiiEntitiesDetectionMaskMode PiiEntitiesDetectionMaskMode' :: Text -> PiiEntitiesDetectionMaskMode [fromPiiEntitiesDetectionMaskMode] :: PiiEntitiesDetectionMaskMode -> Text pattern PiiEntitiesDetectionMaskMode_MASK :: PiiEntitiesDetectionMaskMode pattern PiiEntitiesDetectionMaskMode_REPLACE_WITH_PII_ENTITY_TYPE :: PiiEntitiesDetectionMaskMode newtype PiiEntitiesDetectionMode PiiEntitiesDetectionMode' :: Text -> PiiEntitiesDetectionMode [fromPiiEntitiesDetectionMode] :: PiiEntitiesDetectionMode -> Text pattern PiiEntitiesDetectionMode_ONLY_OFFSETS :: PiiEntitiesDetectionMode pattern PiiEntitiesDetectionMode_ONLY_REDACTION :: PiiEntitiesDetectionMode newtype PiiEntityType PiiEntityType' :: Text -> PiiEntityType [fromPiiEntityType] :: PiiEntityType -> Text pattern PiiEntityType_ADDRESS :: PiiEntityType pattern PiiEntityType_AGE :: PiiEntityType pattern PiiEntityType_ALL :: PiiEntityType pattern PiiEntityType_AWS_ACCESS_KEY :: PiiEntityType pattern PiiEntityType_AWS_SECRET_KEY :: PiiEntityType pattern PiiEntityType_BANK_ACCOUNT_NUMBER :: PiiEntityType pattern PiiEntityType_BANK_ROUTING :: PiiEntityType pattern PiiEntityType_CA_HEALTH_NUMBER :: PiiEntityType pattern PiiEntityType_CA_SOCIAL_INSURANCE_NUMBER :: PiiEntityType pattern PiiEntityType_CREDIT_DEBIT_CVV :: PiiEntityType pattern PiiEntityType_CREDIT_DEBIT_EXPIRY :: PiiEntityType pattern PiiEntityType_CREDIT_DEBIT_NUMBER :: PiiEntityType pattern PiiEntityType_DATE_TIME :: PiiEntityType pattern PiiEntityType_DRIVER_ID :: PiiEntityType pattern PiiEntityType_EMAIL :: PiiEntityType pattern PiiEntityType_INTERNATIONAL_BANK_ACCOUNT_NUMBER :: PiiEntityType pattern PiiEntityType_IN_AADHAAR :: PiiEntityType pattern PiiEntityType_IN_NREGA :: PiiEntityType pattern PiiEntityType_IN_PERMANENT_ACCOUNT_NUMBER :: PiiEntityType pattern PiiEntityType_IN_VOTER_NUMBER :: PiiEntityType pattern PiiEntityType_IP_ADDRESS :: PiiEntityType pattern PiiEntityType_LICENSE_PLATE :: PiiEntityType pattern PiiEntityType_MAC_ADDRESS :: PiiEntityType pattern PiiEntityType_NAME :: PiiEntityType pattern PiiEntityType_PASSPORT_NUMBER :: PiiEntityType pattern PiiEntityType_PASSWORD :: PiiEntityType pattern PiiEntityType_PHONE :: PiiEntityType pattern PiiEntityType_PIN :: PiiEntityType pattern PiiEntityType_SSN :: PiiEntityType pattern PiiEntityType_SWIFT_CODE :: PiiEntityType pattern PiiEntityType_UK_NATIONAL_HEALTH_SERVICE_NUMBER :: PiiEntityType pattern PiiEntityType_UK_NATIONAL_INSURANCE_NUMBER :: PiiEntityType pattern PiiEntityType_UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER :: PiiEntityType pattern PiiEntityType_URL :: PiiEntityType pattern PiiEntityType_USERNAME :: PiiEntityType pattern PiiEntityType_US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER :: PiiEntityType pattern PiiEntityType_VEHICLE_IDENTIFICATION_NUMBER :: PiiEntityType newtype RelationshipType RelationshipType' :: Text -> RelationshipType [fromRelationshipType] :: RelationshipType -> Text pattern RelationshipType_CHILD :: RelationshipType newtype SentimentType SentimentType' :: Text -> SentimentType [fromSentimentType] :: SentimentType -> Text pattern SentimentType_MIXED :: SentimentType pattern SentimentType_NEGATIVE :: SentimentType pattern SentimentType_NEUTRAL :: SentimentType pattern SentimentType_POSITIVE :: SentimentType newtype Split Split' :: Text -> Split [fromSplit] :: Split -> Text pattern Split_TEST :: Split pattern Split_TRAIN :: Split newtype SyntaxLanguageCode SyntaxLanguageCode' :: Text -> SyntaxLanguageCode [fromSyntaxLanguageCode] :: SyntaxLanguageCode -> Text pattern SyntaxLanguageCode_De :: SyntaxLanguageCode pattern SyntaxLanguageCode_En :: SyntaxLanguageCode pattern SyntaxLanguageCode_Es :: SyntaxLanguageCode pattern SyntaxLanguageCode_Fr :: SyntaxLanguageCode pattern SyntaxLanguageCode_It :: SyntaxLanguageCode pattern SyntaxLanguageCode_Pt :: SyntaxLanguageCode newtype TargetedSentimentEntityType TargetedSentimentEntityType' :: Text -> TargetedSentimentEntityType [fromTargetedSentimentEntityType] :: TargetedSentimentEntityType -> Text pattern TargetedSentimentEntityType_ATTRIBUTE :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_BOOK :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_BRAND :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_COMMERCIAL_ITEM :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_DATE :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_EVENT :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_FACILITY :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_GAME :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_LOCATION :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_MOVIE :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_MUSIC :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_ORGANIZATION :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_OTHER :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_PERSON :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_PERSONAL_TITLE :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_QUANTITY :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_SOFTWARE :: TargetedSentimentEntityType -- | An augmented manifest file that provides training data for your custom -- model. An augmented manifest file is a labeled dataset that is -- produced by Amazon SageMaker Ground Truth. -- -- See: newAugmentedManifestsListItem smart constructor. data AugmentedManifestsListItem AugmentedManifestsListItem' :: Maybe Text -> Maybe AugmentedManifestsDocumentTypeFormat -> Maybe Text -> Maybe Split -> Text -> [Text] -> AugmentedManifestsListItem -- | The S3 prefix to the annotation files that are referred in the -- augmented manifest file. [$sel:annotationDataS3Uri:AugmentedManifestsListItem'] :: AugmentedManifestsListItem -> Maybe Text -- | The type of augmented manifest. PlainTextDocument or -- SemiStructuredDocument. If you don't specify, the default is -- PlainTextDocument. -- -- [$sel:documentType:AugmentedManifestsListItem'] :: AugmentedManifestsListItem -> Maybe AugmentedManifestsDocumentTypeFormat -- | The S3 prefix to the source files (PDFs) that are referred to in the -- augmented manifest file. [$sel:sourceDocumentsS3Uri:AugmentedManifestsListItem'] :: AugmentedManifestsListItem -> Maybe Text -- | The purpose of the data you've provided in the augmented manifest. You -- can either train or test this data. If you don't specify, the default -- is train. -- -- TRAIN - all of the documents in the manifest will be used for -- training. If no test documents are provided, Amazon Comprehend will -- automatically reserve a portion of the training documents for testing. -- -- TEST - all of the documents in the manifest will be used for testing. [$sel:split:AugmentedManifestsListItem'] :: AugmentedManifestsListItem -> Maybe Split -- | The Amazon S3 location of the augmented manifest file. [$sel:s3Uri:AugmentedManifestsListItem'] :: AugmentedManifestsListItem -> Text -- | The JSON attribute that contains the annotations for your training -- documents. The number of attribute names that you specify depends on -- whether your augmented manifest file is the output of a single -- labeling job or a chained labeling job. -- -- If your file is the output of a single labeling job, specify the -- LabelAttributeName key that was used when the job was created in -- Ground Truth. -- -- If your file is the output of a chained labeling job, specify the -- LabelAttributeName key for one or more jobs in the chain. Each -- LabelAttributeName key provides the annotations from an individual -- job. [$sel:attributeNames:AugmentedManifestsListItem'] :: AugmentedManifestsListItem -> [Text] -- | Create a value of AugmentedManifestsListItem with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:annotationDataS3Uri:AugmentedManifestsListItem', -- augmentedManifestsListItem_annotationDataS3Uri - The S3 prefix -- to the annotation files that are referred in the augmented manifest -- file. -- -- $sel:documentType:AugmentedManifestsListItem', -- augmentedManifestsListItem_documentType - The type of augmented -- manifest. PlainTextDocument or SemiStructuredDocument. If you don't -- specify, the default is PlainTextDocument. -- -- -- -- $sel:sourceDocumentsS3Uri:AugmentedManifestsListItem', -- augmentedManifestsListItem_sourceDocumentsS3Uri - The S3 prefix -- to the source files (PDFs) that are referred to in the augmented -- manifest file. -- -- $sel:split:AugmentedManifestsListItem', -- augmentedManifestsListItem_split - The purpose of the data -- you've provided in the augmented manifest. You can either train or -- test this data. If you don't specify, the default is train. -- -- TRAIN - all of the documents in the manifest will be used for -- training. If no test documents are provided, Amazon Comprehend will -- automatically reserve a portion of the training documents for testing. -- -- TEST - all of the documents in the manifest will be used for testing. -- -- $sel:s3Uri:AugmentedManifestsListItem', -- augmentedManifestsListItem_s3Uri - The Amazon S3 location of -- the augmented manifest file. -- -- $sel:attributeNames:AugmentedManifestsListItem', -- augmentedManifestsListItem_attributeNames - The JSON attribute -- that contains the annotations for your training documents. The number -- of attribute names that you specify depends on whether your augmented -- manifest file is the output of a single labeling job or a chained -- labeling job. -- -- If your file is the output of a single labeling job, specify the -- LabelAttributeName key that was used when the job was created in -- Ground Truth. -- -- If your file is the output of a chained labeling job, specify the -- LabelAttributeName key for one or more jobs in the chain. Each -- LabelAttributeName key provides the annotations from an individual -- job. newAugmentedManifestsListItem :: Text -> AugmentedManifestsListItem -- | The S3 prefix to the annotation files that are referred in the -- augmented manifest file. augmentedManifestsListItem_annotationDataS3Uri :: Lens' AugmentedManifestsListItem (Maybe Text) -- | The type of augmented manifest. PlainTextDocument or -- SemiStructuredDocument. If you don't specify, the default is -- PlainTextDocument. -- -- augmentedManifestsListItem_documentType :: Lens' AugmentedManifestsListItem (Maybe AugmentedManifestsDocumentTypeFormat) -- | The S3 prefix to the source files (PDFs) that are referred to in the -- augmented manifest file. augmentedManifestsListItem_sourceDocumentsS3Uri :: Lens' AugmentedManifestsListItem (Maybe Text) -- | The purpose of the data you've provided in the augmented manifest. You -- can either train or test this data. If you don't specify, the default -- is train. -- -- TRAIN - all of the documents in the manifest will be used for -- training. If no test documents are provided, Amazon Comprehend will -- automatically reserve a portion of the training documents for testing. -- -- TEST - all of the documents in the manifest will be used for testing. augmentedManifestsListItem_split :: Lens' AugmentedManifestsListItem (Maybe Split) -- | The Amazon S3 location of the augmented manifest file. augmentedManifestsListItem_s3Uri :: Lens' AugmentedManifestsListItem Text -- | The JSON attribute that contains the annotations for your training -- documents. The number of attribute names that you specify depends on -- whether your augmented manifest file is the output of a single -- labeling job or a chained labeling job. -- -- If your file is the output of a single labeling job, specify the -- LabelAttributeName key that was used when the job was created in -- Ground Truth. -- -- If your file is the output of a chained labeling job, specify the -- LabelAttributeName key for one or more jobs in the chain. Each -- LabelAttributeName key provides the annotations from an individual -- job. augmentedManifestsListItem_attributeNames :: Lens' AugmentedManifestsListItem [Text] -- | The result of calling the operation. The operation returns one object -- for each document that is successfully processed by the operation. -- -- See: newBatchDetectDominantLanguageItemResult smart -- constructor. data BatchDetectDominantLanguageItemResult BatchDetectDominantLanguageItemResult' :: Maybe Int -> Maybe [DominantLanguage] -> BatchDetectDominantLanguageItemResult -- | The zero-based index of the document in the input list. [$sel:index:BatchDetectDominantLanguageItemResult'] :: BatchDetectDominantLanguageItemResult -> Maybe Int -- | One or more DominantLanguage objects describing the dominant languages -- in the document. [$sel:languages:BatchDetectDominantLanguageItemResult'] :: BatchDetectDominantLanguageItemResult -> Maybe [DominantLanguage] -- | Create a value of BatchDetectDominantLanguageItemResult with -- all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:index:BatchDetectDominantLanguageItemResult', -- batchDetectDominantLanguageItemResult_index - The zero-based -- index of the document in the input list. -- -- $sel:languages:BatchDetectDominantLanguageItemResult', -- batchDetectDominantLanguageItemResult_languages - One or more -- DominantLanguage objects describing the dominant languages in the -- document. newBatchDetectDominantLanguageItemResult :: BatchDetectDominantLanguageItemResult -- | The zero-based index of the document in the input list. batchDetectDominantLanguageItemResult_index :: Lens' BatchDetectDominantLanguageItemResult (Maybe Int) -- | One or more DominantLanguage objects describing the dominant languages -- in the document. batchDetectDominantLanguageItemResult_languages :: Lens' BatchDetectDominantLanguageItemResult (Maybe [DominantLanguage]) -- | The result of calling the operation. The operation returns one object -- for each document that is successfully processed by the operation. -- -- See: newBatchDetectEntitiesItemResult smart constructor. data BatchDetectEntitiesItemResult BatchDetectEntitiesItemResult' :: Maybe [Entity] -> Maybe Int -> BatchDetectEntitiesItemResult -- | One or more Entity objects, one for each entity detected in the -- document. [$sel:entities:BatchDetectEntitiesItemResult'] :: BatchDetectEntitiesItemResult -> Maybe [Entity] -- | The zero-based index of the document in the input list. [$sel:index:BatchDetectEntitiesItemResult'] :: BatchDetectEntitiesItemResult -> Maybe Int -- | Create a value of BatchDetectEntitiesItemResult with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:entities:BatchDetectEntitiesItemResult', -- batchDetectEntitiesItemResult_entities - One or more Entity -- objects, one for each entity detected in the document. -- -- $sel:index:BatchDetectEntitiesItemResult', -- batchDetectEntitiesItemResult_index - The zero-based index of -- the document in the input list. newBatchDetectEntitiesItemResult :: BatchDetectEntitiesItemResult -- | One or more Entity objects, one for each entity detected in the -- document. batchDetectEntitiesItemResult_entities :: Lens' BatchDetectEntitiesItemResult (Maybe [Entity]) -- | The zero-based index of the document in the input list. batchDetectEntitiesItemResult_index :: Lens' BatchDetectEntitiesItemResult (Maybe Int) -- | The result of calling the operation. The operation returns one object -- for each document that is successfully processed by the operation. -- -- See: newBatchDetectKeyPhrasesItemResult smart -- constructor. data BatchDetectKeyPhrasesItemResult BatchDetectKeyPhrasesItemResult' :: Maybe Int -> Maybe [KeyPhrase] -> BatchDetectKeyPhrasesItemResult -- | The zero-based index of the document in the input list. [$sel:index:BatchDetectKeyPhrasesItemResult'] :: BatchDetectKeyPhrasesItemResult -> Maybe Int -- | One or more KeyPhrase objects, one for each key phrase detected in the -- document. [$sel:keyPhrases:BatchDetectKeyPhrasesItemResult'] :: BatchDetectKeyPhrasesItemResult -> Maybe [KeyPhrase] -- | Create a value of BatchDetectKeyPhrasesItemResult with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:index:BatchDetectKeyPhrasesItemResult', -- batchDetectKeyPhrasesItemResult_index - The zero-based index of -- the document in the input list. -- -- $sel:keyPhrases:BatchDetectKeyPhrasesItemResult', -- batchDetectKeyPhrasesItemResult_keyPhrases - One or more -- KeyPhrase objects, one for each key phrase detected in the document. newBatchDetectKeyPhrasesItemResult :: BatchDetectKeyPhrasesItemResult -- | The zero-based index of the document in the input list. batchDetectKeyPhrasesItemResult_index :: Lens' BatchDetectKeyPhrasesItemResult (Maybe Int) -- | One or more KeyPhrase objects, one for each key phrase detected in the -- document. batchDetectKeyPhrasesItemResult_keyPhrases :: Lens' BatchDetectKeyPhrasesItemResult (Maybe [KeyPhrase]) -- | The result of calling the operation. The operation returns one object -- for each document that is successfully processed by the operation. -- -- See: newBatchDetectSentimentItemResult smart -- constructor. data BatchDetectSentimentItemResult BatchDetectSentimentItemResult' :: Maybe Int -> Maybe SentimentType -> Maybe SentimentScore -> BatchDetectSentimentItemResult -- | The zero-based index of the document in the input list. [$sel:index:BatchDetectSentimentItemResult'] :: BatchDetectSentimentItemResult -> Maybe Int -- | The sentiment detected in the document. [$sel:sentiment:BatchDetectSentimentItemResult'] :: BatchDetectSentimentItemResult -> Maybe SentimentType -- | The level of confidence that Amazon Comprehend has in the accuracy of -- its sentiment detection. [$sel:sentimentScore:BatchDetectSentimentItemResult'] :: BatchDetectSentimentItemResult -> Maybe SentimentScore -- | Create a value of BatchDetectSentimentItemResult with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:index:BatchDetectSentimentItemResult', -- batchDetectSentimentItemResult_index - The zero-based index of -- the document in the input list. -- -- $sel:sentiment:BatchDetectSentimentItemResult', -- batchDetectSentimentItemResult_sentiment - The sentiment -- detected in the document. -- -- $sel:sentimentScore:BatchDetectSentimentItemResult', -- batchDetectSentimentItemResult_sentimentScore - The level of -- confidence that Amazon Comprehend has in the accuracy of its sentiment -- detection. newBatchDetectSentimentItemResult :: BatchDetectSentimentItemResult -- | The zero-based index of the document in the input list. batchDetectSentimentItemResult_index :: Lens' BatchDetectSentimentItemResult (Maybe Int) -- | The sentiment detected in the document. batchDetectSentimentItemResult_sentiment :: Lens' BatchDetectSentimentItemResult (Maybe SentimentType) -- | The level of confidence that Amazon Comprehend has in the accuracy of -- its sentiment detection. batchDetectSentimentItemResult_sentimentScore :: Lens' BatchDetectSentimentItemResult (Maybe SentimentScore) -- | The result of calling the operation. The operation returns one object -- that is successfully processed by the operation. -- -- See: newBatchDetectSyntaxItemResult smart constructor. data BatchDetectSyntaxItemResult BatchDetectSyntaxItemResult' :: Maybe Int -> Maybe [SyntaxToken] -> BatchDetectSyntaxItemResult -- | The zero-based index of the document in the input list. [$sel:index:BatchDetectSyntaxItemResult'] :: BatchDetectSyntaxItemResult -> Maybe Int -- | The syntax tokens for the words in the document, one token for each -- word. [$sel:syntaxTokens:BatchDetectSyntaxItemResult'] :: BatchDetectSyntaxItemResult -> Maybe [SyntaxToken] -- | Create a value of BatchDetectSyntaxItemResult with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:index:BatchDetectSyntaxItemResult', -- batchDetectSyntaxItemResult_index - The zero-based index of the -- document in the input list. -- -- $sel:syntaxTokens:BatchDetectSyntaxItemResult', -- batchDetectSyntaxItemResult_syntaxTokens - The syntax tokens -- for the words in the document, one token for each word. newBatchDetectSyntaxItemResult :: BatchDetectSyntaxItemResult -- | The zero-based index of the document in the input list. batchDetectSyntaxItemResult_index :: Lens' BatchDetectSyntaxItemResult (Maybe Int) -- | The syntax tokens for the words in the document, one token for each -- word. batchDetectSyntaxItemResult_syntaxTokens :: Lens' BatchDetectSyntaxItemResult (Maybe [SyntaxToken]) -- | Analysis results for one of the documents in the batch. -- -- See: newBatchDetectTargetedSentimentItemResult smart -- constructor. data BatchDetectTargetedSentimentItemResult BatchDetectTargetedSentimentItemResult' :: Maybe [TargetedSentimentEntity] -> Maybe Int -> BatchDetectTargetedSentimentItemResult -- | An array of targeted sentiment entities. [$sel:entities:BatchDetectTargetedSentimentItemResult'] :: BatchDetectTargetedSentimentItemResult -> Maybe [TargetedSentimentEntity] -- | The zero-based index of this result in the input list. [$sel:index:BatchDetectTargetedSentimentItemResult'] :: BatchDetectTargetedSentimentItemResult -> Maybe Int -- | Create a value of BatchDetectTargetedSentimentItemResult with -- all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:entities:BatchDetectTargetedSentimentItemResult', -- batchDetectTargetedSentimentItemResult_entities - An array of -- targeted sentiment entities. -- -- $sel:index:BatchDetectTargetedSentimentItemResult', -- batchDetectTargetedSentimentItemResult_index - The zero-based -- index of this result in the input list. newBatchDetectTargetedSentimentItemResult :: BatchDetectTargetedSentimentItemResult -- | An array of targeted sentiment entities. batchDetectTargetedSentimentItemResult_entities :: Lens' BatchDetectTargetedSentimentItemResult (Maybe [TargetedSentimentEntity]) -- | The zero-based index of this result in the input list. batchDetectTargetedSentimentItemResult_index :: Lens' BatchDetectTargetedSentimentItemResult (Maybe Int) -- | Describes an error that occurred while processing a document in a -- batch. The operation returns on BatchItemError object for -- each document that contained an error. -- -- See: newBatchItemError smart constructor. data BatchItemError BatchItemError' :: Maybe Text -> Maybe Text -> Maybe Int -> BatchItemError -- | The numeric error code of the error. [$sel:errorCode:BatchItemError'] :: BatchItemError -> Maybe Text -- | A text description of the error. [$sel:errorMessage:BatchItemError'] :: BatchItemError -> Maybe Text -- | The zero-based index of the document in the input list. [$sel:index:BatchItemError'] :: BatchItemError -> Maybe Int -- | Create a value of BatchItemError with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:errorCode:BatchItemError', batchItemError_errorCode -- - The numeric error code of the error. -- -- $sel:errorMessage:BatchItemError', -- batchItemError_errorMessage - A text description of the error. -- -- $sel:index:BatchItemError', batchItemError_index - The -- zero-based index of the document in the input list. newBatchItemError :: BatchItemError -- | The numeric error code of the error. batchItemError_errorCode :: Lens' BatchItemError (Maybe Text) -- | A text description of the error. batchItemError_errorMessage :: Lens' BatchItemError (Maybe Text) -- | The zero-based index of the document in the input list. batchItemError_index :: Lens' BatchItemError (Maybe Int) -- | Information about each word or line of text in the input document. -- -- For additional information, see Block in the Amazon Textract -- API reference. -- -- See: newBlock smart constructor. data Block Block' :: Maybe BlockType -> Maybe Geometry -> Maybe Text -> Maybe Int -> Maybe [RelationshipsListItem] -> Maybe Text -> Block -- | The block represents a line of text or one word of text. -- -- [$sel:blockType:Block'] :: Block -> Maybe BlockType -- | Co-ordinates of the rectangle or polygon that contains the text. [$sel:geometry:Block'] :: Block -> Maybe Geometry -- | Unique identifier for the block. [$sel:id:Block'] :: Block -> Maybe Text -- | Page number where the block appears. [$sel:page:Block'] :: Block -> Maybe Int -- | A list of child blocks of the current block. For example, a LINE -- object has child blocks for each WORD block that's part of the line of -- text. [$sel:relationships:Block'] :: Block -> Maybe [RelationshipsListItem] -- | The word or line of text extracted from the block. [$sel:text:Block'] :: Block -> Maybe Text -- | Create a value of Block with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:blockType:Block', block_blockType - The block -- represents a line of text or one word of text. -- -- -- -- $sel:geometry:Block', block_geometry - Co-ordinates of -- the rectangle or polygon that contains the text. -- -- $sel:id:Block', block_id - Unique identifier for the -- block. -- -- $sel:page:Block', block_page - Page number where the -- block appears. -- -- $sel:relationships:Block', block_relationships - A list -- of child blocks of the current block. For example, a LINE object has -- child blocks for each WORD block that's part of the line of text. -- -- $sel:text:Block', block_text - The word or line of text -- extracted from the block. newBlock :: Block -- | The block represents a line of text or one word of text. -- -- block_blockType :: Lens' Block (Maybe BlockType) -- | Co-ordinates of the rectangle or polygon that contains the text. block_geometry :: Lens' Block (Maybe Geometry) -- | Unique identifier for the block. block_id :: Lens' Block (Maybe Text) -- | Page number where the block appears. block_page :: Lens' Block (Maybe Int) -- | A list of child blocks of the current block. For example, a LINE -- object has child blocks for each WORD block that's part of the line of -- text. block_relationships :: Lens' Block (Maybe [RelationshipsListItem]) -- | The word or line of text extracted from the block. block_text :: Lens' Block (Maybe Text) -- | A reference to a block. -- -- See: newBlockReference smart constructor. data BlockReference BlockReference' :: Maybe Int -> Maybe Text -> Maybe [ChildBlock] -> Maybe Int -> BlockReference -- | Offset of the start of the block within its parent block. [$sel:beginOffset:BlockReference'] :: BlockReference -> Maybe Int -- | Unique identifier for the block. [$sel:blockId:BlockReference'] :: BlockReference -> Maybe Text -- | List of child blocks within this block. [$sel:childBlocks:BlockReference'] :: BlockReference -> Maybe [ChildBlock] -- | Offset of the end of the block within its parent block. [$sel:endOffset:BlockReference'] :: BlockReference -> Maybe Int -- | Create a value of BlockReference with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- BlockReference, blockReference_beginOffset - Offset of -- the start of the block within its parent block. -- -- $sel:blockId:BlockReference', blockReference_blockId - -- Unique identifier for the block. -- -- $sel:childBlocks:BlockReference', -- blockReference_childBlocks - List of child blocks within this -- block. -- -- BlockReference, blockReference_endOffset - Offset of the -- end of the block within its parent block. newBlockReference :: BlockReference -- | Offset of the start of the block within its parent block. blockReference_beginOffset :: Lens' BlockReference (Maybe Int) -- | Unique identifier for the block. blockReference_blockId :: Lens' BlockReference (Maybe Text) -- | List of child blocks within this block. blockReference_childBlocks :: Lens' BlockReference (Maybe [ChildBlock]) -- | Offset of the end of the block within its parent block. blockReference_endOffset :: Lens' BlockReference (Maybe Int) -- | The bounding box around the detected page or around an element on a -- document page. The left (x-coordinate) and top (y-coordinate) are -- coordinates that represent the top and left sides of the bounding box. -- Note that the upper-left corner of the image is the origin (0,0). -- -- For additional information, see BoundingBox in the Amazon -- Textract API reference. -- -- See: newBoundingBox smart constructor. data BoundingBox BoundingBox' :: Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> BoundingBox -- | The height of the bounding box as a ratio of the overall document page -- height. [$sel:height:BoundingBox'] :: BoundingBox -> Maybe Double -- | The left coordinate of the bounding box as a ratio of overall document -- page width. [$sel:left:BoundingBox'] :: BoundingBox -> Maybe Double -- | The top coordinate of the bounding box as a ratio of overall document -- page height. [$sel:top:BoundingBox'] :: BoundingBox -> Maybe Double -- | The width of the bounding box as a ratio of the overall document page -- width. [$sel:width:BoundingBox'] :: BoundingBox -> Maybe Double -- | Create a value of BoundingBox with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:height:BoundingBox', boundingBox_height - The -- height of the bounding box as a ratio of the overall document page -- height. -- -- $sel:left:BoundingBox', boundingBox_left - The left -- coordinate of the bounding box as a ratio of overall document page -- width. -- -- $sel:top:BoundingBox', boundingBox_top - The top -- coordinate of the bounding box as a ratio of overall document page -- height. -- -- $sel:width:BoundingBox', boundingBox_width - The width -- of the bounding box as a ratio of the overall document page width. newBoundingBox :: BoundingBox -- | The height of the bounding box as a ratio of the overall document page -- height. boundingBox_height :: Lens' BoundingBox (Maybe Double) -- | The left coordinate of the bounding box as a ratio of overall document -- page width. boundingBox_left :: Lens' BoundingBox (Maybe Double) -- | The top coordinate of the bounding box as a ratio of overall document -- page height. boundingBox_top :: Lens' BoundingBox (Maybe Double) -- | The width of the bounding box as a ratio of the overall document page -- width. boundingBox_width :: Lens' BoundingBox (Maybe Double) -- | Nested block contained within a block. -- -- See: newChildBlock smart constructor. data ChildBlock ChildBlock' :: Maybe Int -> Maybe Text -> Maybe Int -> ChildBlock -- | Offset of the start of the child block within its parent block. [$sel:beginOffset:ChildBlock'] :: ChildBlock -> Maybe Int -- | Unique identifier for the child block. [$sel:childBlockId:ChildBlock'] :: ChildBlock -> Maybe Text -- | Offset of the end of the child block within its parent block. [$sel:endOffset:ChildBlock'] :: ChildBlock -> Maybe Int -- | Create a value of ChildBlock with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:beginOffset:ChildBlock', childBlock_beginOffset - -- Offset of the start of the child block within its parent block. -- -- $sel:childBlockId:ChildBlock', childBlock_childBlockId - -- Unique identifier for the child block. -- -- $sel:endOffset:ChildBlock', childBlock_endOffset - -- Offset of the end of the child block within its parent block. newChildBlock :: ChildBlock -- | Offset of the start of the child block within its parent block. childBlock_beginOffset :: Lens' ChildBlock (Maybe Int) -- | Unique identifier for the child block. childBlock_childBlockId :: Lens' ChildBlock (Maybe Text) -- | Offset of the end of the child block within its parent block. childBlock_endOffset :: Lens' ChildBlock (Maybe Int) -- | Describes the result metrics for the test data associated with an -- documentation classifier. -- -- See: newClassifierEvaluationMetrics smart constructor. data ClassifierEvaluationMetrics ClassifierEvaluationMetrics' :: Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> ClassifierEvaluationMetrics -- | The fraction of the labels that were correct recognized. It is -- computed by dividing the number of labels in the test documents that -- were correctly recognized by the total number of labels in the test -- documents. [$sel:accuracy:ClassifierEvaluationMetrics'] :: ClassifierEvaluationMetrics -> Maybe Double -- | A measure of how accurate the classifier results are for the test -- data. It is derived from the Precision and Recall -- values. The F1Score is the harmonic average of the two -- scores. The highest score is 1, and the worst score is 0. [$sel:f1Score:ClassifierEvaluationMetrics'] :: ClassifierEvaluationMetrics -> Maybe Double -- | Indicates the fraction of labels that are incorrectly predicted. Also -- seen as the fraction of wrong labels compared to the total number of -- labels. Scores closer to zero are better. [$sel:hammingLoss:ClassifierEvaluationMetrics'] :: ClassifierEvaluationMetrics -> Maybe Double -- | A measure of how accurate the classifier results are for the test -- data. It is a combination of the Micro Precision and -- Micro Recall values. The Micro F1Score is the -- harmonic mean of the two scores. The highest score is 1, and the worst -- score is 0. [$sel:microF1Score:ClassifierEvaluationMetrics'] :: ClassifierEvaluationMetrics -> Maybe Double -- | A measure of the usefulness of the recognizer results in the test -- data. High precision means that the recognizer returned substantially -- more relevant results than irrelevant ones. Unlike the Precision -- metric which comes from averaging the precision of all available -- labels, this is based on the overall score of all precision scores -- added together. [$sel:microPrecision:ClassifierEvaluationMetrics'] :: ClassifierEvaluationMetrics -> Maybe Double -- | A measure of how complete the classifier results are for the test -- data. High recall means that the classifier returned most of the -- relevant results. Specifically, this indicates how many of the correct -- categories in the text that the model can predict. It is a percentage -- of correct categories in the text that can found. Instead of averaging -- the recall scores of all labels (as with Recall), micro Recall is -- based on the overall score of all recall scores added together. [$sel:microRecall:ClassifierEvaluationMetrics'] :: ClassifierEvaluationMetrics -> Maybe Double -- | A measure of the usefulness of the classifier results in the test -- data. High precision means that the classifier returned substantially -- more relevant results than irrelevant ones. [$sel:precision:ClassifierEvaluationMetrics'] :: ClassifierEvaluationMetrics -> Maybe Double -- | A measure of how complete the classifier results are for the test -- data. High recall means that the classifier returned most of the -- relevant results. [$sel:recall:ClassifierEvaluationMetrics'] :: ClassifierEvaluationMetrics -> Maybe Double -- | Create a value of ClassifierEvaluationMetrics with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:accuracy:ClassifierEvaluationMetrics', -- classifierEvaluationMetrics_accuracy - The fraction of the -- labels that were correct recognized. It is computed by dividing the -- number of labels in the test documents that were correctly recognized -- by the total number of labels in the test documents. -- -- $sel:f1Score:ClassifierEvaluationMetrics', -- classifierEvaluationMetrics_f1Score - A measure of how accurate -- the classifier results are for the test data. It is derived from the -- Precision and Recall values. The F1Score is -- the harmonic average of the two scores. The highest score is 1, and -- the worst score is 0. -- -- $sel:hammingLoss:ClassifierEvaluationMetrics', -- classifierEvaluationMetrics_hammingLoss - Indicates the -- fraction of labels that are incorrectly predicted. Also seen as the -- fraction of wrong labels compared to the total number of labels. -- Scores closer to zero are better. -- -- $sel:microF1Score:ClassifierEvaluationMetrics', -- classifierEvaluationMetrics_microF1Score - A measure of how -- accurate the classifier results are for the test data. It is a -- combination of the Micro Precision and Micro Recall -- values. The Micro F1Score is the harmonic mean of the two -- scores. The highest score is 1, and the worst score is 0. -- -- $sel:microPrecision:ClassifierEvaluationMetrics', -- classifierEvaluationMetrics_microPrecision - A measure of the -- usefulness of the recognizer results in the test data. High precision -- means that the recognizer returned substantially more relevant results -- than irrelevant ones. Unlike the Precision metric which comes from -- averaging the precision of all available labels, this is based on the -- overall score of all precision scores added together. -- -- $sel:microRecall:ClassifierEvaluationMetrics', -- classifierEvaluationMetrics_microRecall - A measure of how -- complete the classifier results are for the test data. High recall -- means that the classifier returned most of the relevant results. -- Specifically, this indicates how many of the correct categories in the -- text that the model can predict. It is a percentage of correct -- categories in the text that can found. Instead of averaging the recall -- scores of all labels (as with Recall), micro Recall is based on the -- overall score of all recall scores added together. -- -- $sel:precision:ClassifierEvaluationMetrics', -- classifierEvaluationMetrics_precision - A measure of the -- usefulness of the classifier results in the test data. High precision -- means that the classifier returned substantially more relevant results -- than irrelevant ones. -- -- $sel:recall:ClassifierEvaluationMetrics', -- classifierEvaluationMetrics_recall - A measure of how complete -- the classifier results are for the test data. High recall means that -- the classifier returned most of the relevant results. newClassifierEvaluationMetrics :: ClassifierEvaluationMetrics -- | The fraction of the labels that were correct recognized. It is -- computed by dividing the number of labels in the test documents that -- were correctly recognized by the total number of labels in the test -- documents. classifierEvaluationMetrics_accuracy :: Lens' ClassifierEvaluationMetrics (Maybe Double) -- | A measure of how accurate the classifier results are for the test -- data. It is derived from the Precision and Recall -- values. The F1Score is the harmonic average of the two -- scores. The highest score is 1, and the worst score is 0. classifierEvaluationMetrics_f1Score :: Lens' ClassifierEvaluationMetrics (Maybe Double) -- | Indicates the fraction of labels that are incorrectly predicted. Also -- seen as the fraction of wrong labels compared to the total number of -- labels. Scores closer to zero are better. classifierEvaluationMetrics_hammingLoss :: Lens' ClassifierEvaluationMetrics (Maybe Double) -- | A measure of how accurate the classifier results are for the test -- data. It is a combination of the Micro Precision and -- Micro Recall values. The Micro F1Score is the -- harmonic mean of the two scores. The highest score is 1, and the worst -- score is 0. classifierEvaluationMetrics_microF1Score :: Lens' ClassifierEvaluationMetrics (Maybe Double) -- | A measure of the usefulness of the recognizer results in the test -- data. High precision means that the recognizer returned substantially -- more relevant results than irrelevant ones. Unlike the Precision -- metric which comes from averaging the precision of all available -- labels, this is based on the overall score of all precision scores -- added together. classifierEvaluationMetrics_microPrecision :: Lens' ClassifierEvaluationMetrics (Maybe Double) -- | A measure of how complete the classifier results are for the test -- data. High recall means that the classifier returned most of the -- relevant results. Specifically, this indicates how many of the correct -- categories in the text that the model can predict. It is a percentage -- of correct categories in the text that can found. Instead of averaging -- the recall scores of all labels (as with Recall), micro Recall is -- based on the overall score of all recall scores added together. classifierEvaluationMetrics_microRecall :: Lens' ClassifierEvaluationMetrics (Maybe Double) -- | A measure of the usefulness of the classifier results in the test -- data. High precision means that the classifier returned substantially -- more relevant results than irrelevant ones. classifierEvaluationMetrics_precision :: Lens' ClassifierEvaluationMetrics (Maybe Double) -- | A measure of how complete the classifier results are for the test -- data. High recall means that the classifier returned most of the -- relevant results. classifierEvaluationMetrics_recall :: Lens' ClassifierEvaluationMetrics (Maybe Double) -- | Provides information about a document classifier. -- -- See: newClassifierMetadata smart constructor. data ClassifierMetadata ClassifierMetadata' :: Maybe ClassifierEvaluationMetrics -> Maybe Int -> Maybe Int -> Maybe Int -> ClassifierMetadata -- | Describes the result metrics for the test data associated with an -- documentation classifier. [$sel:evaluationMetrics:ClassifierMetadata'] :: ClassifierMetadata -> Maybe ClassifierEvaluationMetrics -- | The number of labels in the input data. [$sel:numberOfLabels:ClassifierMetadata'] :: ClassifierMetadata -> Maybe Int -- | The number of documents in the input data that were used to test the -- classifier. Typically this is 10 to 20 percent of the input documents, -- up to 10,000 documents. [$sel:numberOfTestDocuments:ClassifierMetadata'] :: ClassifierMetadata -> Maybe Int -- | The number of documents in the input data that were used to train the -- classifier. Typically this is 80 to 90 percent of the input documents. [$sel:numberOfTrainedDocuments:ClassifierMetadata'] :: ClassifierMetadata -> Maybe Int -- | Create a value of ClassifierMetadata with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:evaluationMetrics:ClassifierMetadata', -- classifierMetadata_evaluationMetrics - Describes the result -- metrics for the test data associated with an documentation classifier. -- -- $sel:numberOfLabels:ClassifierMetadata', -- classifierMetadata_numberOfLabels - The number of labels in the -- input data. -- -- $sel:numberOfTestDocuments:ClassifierMetadata', -- classifierMetadata_numberOfTestDocuments - The number of -- documents in the input data that were used to test the classifier. -- Typically this is 10 to 20 percent of the input documents, up to -- 10,000 documents. -- -- $sel:numberOfTrainedDocuments:ClassifierMetadata', -- classifierMetadata_numberOfTrainedDocuments - The number of -- documents in the input data that were used to train the classifier. -- Typically this is 80 to 90 percent of the input documents. newClassifierMetadata :: ClassifierMetadata -- | Describes the result metrics for the test data associated with an -- documentation classifier. classifierMetadata_evaluationMetrics :: Lens' ClassifierMetadata (Maybe ClassifierEvaluationMetrics) -- | The number of labels in the input data. classifierMetadata_numberOfLabels :: Lens' ClassifierMetadata (Maybe Int) -- | The number of documents in the input data that were used to test the -- classifier. Typically this is 10 to 20 percent of the input documents, -- up to 10,000 documents. classifierMetadata_numberOfTestDocuments :: Lens' ClassifierMetadata (Maybe Int) -- | The number of documents in the input data that were used to train the -- classifier. Typically this is 80 to 90 percent of the input documents. classifierMetadata_numberOfTrainedDocuments :: Lens' ClassifierMetadata (Maybe Int) -- | Specifies the class that categorizes the document being analyzed -- -- See: newDocumentClass smart constructor. data DocumentClass DocumentClass' :: Maybe Text -> Maybe Int -> Maybe Double -> DocumentClass -- | The name of the class. [$sel:name:DocumentClass'] :: DocumentClass -> Maybe Text -- | Page number in the input document. This field is present in the -- response only if your request includes the Byte parameter. [$sel:page:DocumentClass'] :: DocumentClass -> Maybe Int -- | The confidence score that Amazon Comprehend has this class correctly -- attributed. [$sel:score:DocumentClass'] :: DocumentClass -> Maybe Double -- | Create a value of DocumentClass with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:name:DocumentClass', documentClass_name - The name -- of the class. -- -- $sel:page:DocumentClass', documentClass_page - Page -- number in the input document. This field is present in the response -- only if your request includes the Byte parameter. -- -- $sel:score:DocumentClass', documentClass_score - The -- confidence score that Amazon Comprehend has this class correctly -- attributed. newDocumentClass :: DocumentClass -- | The name of the class. documentClass_name :: Lens' DocumentClass (Maybe Text) -- | Page number in the input document. This field is present in the -- response only if your request includes the Byte parameter. documentClass_page :: Lens' DocumentClass (Maybe Int) -- | The confidence score that Amazon Comprehend has this class correctly -- attributed. documentClass_score :: Lens' DocumentClass (Maybe Double) -- | Provides information for filtering a list of document classification -- jobs. For more information, see the operation. You can provide only -- one filter parameter in each request. -- -- See: newDocumentClassificationJobFilter smart -- constructor. data DocumentClassificationJobFilter DocumentClassificationJobFilter' :: Maybe Text -> Maybe JobStatus -> Maybe POSIX -> Maybe POSIX -> DocumentClassificationJobFilter -- | Filters on the name of the job. [$sel:jobName:DocumentClassificationJobFilter'] :: DocumentClassificationJobFilter -> Maybe Text -- | Filters the list based on job status. Returns only jobs with the -- specified status. [$sel:jobStatus:DocumentClassificationJobFilter'] :: DocumentClassificationJobFilter -> Maybe JobStatus -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. [$sel:submitTimeAfter:DocumentClassificationJobFilter'] :: DocumentClassificationJobFilter -> Maybe POSIX -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. [$sel:submitTimeBefore:DocumentClassificationJobFilter'] :: DocumentClassificationJobFilter -> Maybe POSIX -- | Create a value of DocumentClassificationJobFilter with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:jobName:DocumentClassificationJobFilter', -- documentClassificationJobFilter_jobName - Filters on the name -- of the job. -- -- $sel:jobStatus:DocumentClassificationJobFilter', -- documentClassificationJobFilter_jobStatus - Filters the list -- based on job status. Returns only jobs with the specified status. -- -- $sel:submitTimeAfter:DocumentClassificationJobFilter', -- documentClassificationJobFilter_submitTimeAfter - Filters the -- list of jobs based on the time that the job was submitted for -- processing. Returns only jobs submitted after the specified time. Jobs -- are returned in descending order, newest to oldest. -- -- $sel:submitTimeBefore:DocumentClassificationJobFilter', -- documentClassificationJobFilter_submitTimeBefore - Filters the -- list of jobs based on the time that the job was submitted for -- processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. newDocumentClassificationJobFilter :: DocumentClassificationJobFilter -- | Filters on the name of the job. documentClassificationJobFilter_jobName :: Lens' DocumentClassificationJobFilter (Maybe Text) -- | Filters the list based on job status. Returns only jobs with the -- specified status. documentClassificationJobFilter_jobStatus :: Lens' DocumentClassificationJobFilter (Maybe JobStatus) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. documentClassificationJobFilter_submitTimeAfter :: Lens' DocumentClassificationJobFilter (Maybe UTCTime) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. documentClassificationJobFilter_submitTimeBefore :: Lens' DocumentClassificationJobFilter (Maybe UTCTime) -- | Provides information about a document classification job. -- -- See: newDocumentClassificationJobProperties smart -- constructor. data DocumentClassificationJobProperties DocumentClassificationJobProperties' :: Maybe Text -> Maybe Text -> Maybe POSIX -> Maybe InputDataConfig -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe JobStatus -> Maybe Text -> Maybe OutputDataConfig -> Maybe POSIX -> Maybe Text -> Maybe VpcConfig -> DocumentClassificationJobProperties -- | The Amazon Resource Name (ARN) of the AWS identity and Access -- Management (IAM) role that grants Amazon Comprehend read access to -- your input data. [$sel:dataAccessRoleArn:DocumentClassificationJobProperties'] :: DocumentClassificationJobProperties -> Maybe Text -- | The Amazon Resource Name (ARN) that identifies the document -- classifier. [$sel:documentClassifierArn:DocumentClassificationJobProperties'] :: DocumentClassificationJobProperties -> Maybe Text -- | The time that the document classification job completed. [$sel:endTime:DocumentClassificationJobProperties'] :: DocumentClassificationJobProperties -> Maybe POSIX -- | The input data configuration that you supplied when you created the -- document classification job. [$sel:inputDataConfig:DocumentClassificationJobProperties'] :: DocumentClassificationJobProperties -> Maybe InputDataConfig -- | The Amazon Resource Name (ARN) of the document classification job. It -- is a unique, fully qualified identifier for the job. It includes the -- AWS account, Region, and the job ID. The format of the ARN is as -- follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
--
[$sel:jobArn:DocumentClassificationJobProperties'] :: DocumentClassificationJobProperties -> Maybe Text -- | The identifier assigned to the document classification job. [$sel:jobId:DocumentClassificationJobProperties'] :: DocumentClassificationJobProperties -> Maybe Text -- | The name that you assigned to the document classification job. [$sel:jobName:DocumentClassificationJobProperties'] :: DocumentClassificationJobProperties -> Maybe Text -- | The current status of the document classification job. If the status -- is FAILED, the Message field shows the reason for -- the failure. [$sel:jobStatus:DocumentClassificationJobProperties'] :: DocumentClassificationJobProperties -> Maybe JobStatus -- | A description of the status of the job. [$sel:message:DocumentClassificationJobProperties'] :: DocumentClassificationJobProperties -> Maybe Text -- | The output data configuration that you supplied when you created the -- document classification job. [$sel:outputDataConfig:DocumentClassificationJobProperties'] :: DocumentClassificationJobProperties -> Maybe OutputDataConfig -- | The time that the document classification job was submitted for -- processing. [$sel:submitTime:DocumentClassificationJobProperties'] :: DocumentClassificationJobProperties -> Maybe POSIX -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- [$sel:volumeKmsKeyId:DocumentClassificationJobProperties'] :: DocumentClassificationJobProperties -> Maybe Text -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your document -- classification job. For more information, see Amazon VPC. [$sel:vpcConfig:DocumentClassificationJobProperties'] :: DocumentClassificationJobProperties -> Maybe VpcConfig -- | Create a value of DocumentClassificationJobProperties with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:dataAccessRoleArn:DocumentClassificationJobProperties', -- documentClassificationJobProperties_dataAccessRoleArn - The -- Amazon Resource Name (ARN) of the AWS identity and Access Management -- (IAM) role that grants Amazon Comprehend read access to your input -- data. -- -- -- $sel:documentClassifierArn:DocumentClassificationJobProperties', -- documentClassificationJobProperties_documentClassifierArn - The -- Amazon Resource Name (ARN) that identifies the document classifier. -- -- $sel:endTime:DocumentClassificationJobProperties', -- documentClassificationJobProperties_endTime - The time that the -- document classification job completed. -- -- $sel:inputDataConfig:DocumentClassificationJobProperties', -- documentClassificationJobProperties_inputDataConfig - The input -- data configuration that you supplied when you created the document -- classification job. -- -- $sel:jobArn:DocumentClassificationJobProperties', -- documentClassificationJobProperties_jobArn - The Amazon -- Resource Name (ARN) of the document classification job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- $sel:jobId:DocumentClassificationJobProperties', -- documentClassificationJobProperties_jobId - The identifier -- assigned to the document classification job. -- -- $sel:jobName:DocumentClassificationJobProperties', -- documentClassificationJobProperties_jobName - The name that you -- assigned to the document classification job. -- -- $sel:jobStatus:DocumentClassificationJobProperties', -- documentClassificationJobProperties_jobStatus - The current -- status of the document classification job. If the status is -- FAILED, the Message field shows the reason for the -- failure. -- -- $sel:message:DocumentClassificationJobProperties', -- documentClassificationJobProperties_message - A description of -- the status of the job. -- -- $sel:outputDataConfig:DocumentClassificationJobProperties', -- documentClassificationJobProperties_outputDataConfig - The -- output data configuration that you supplied when you created the -- document classification job. -- -- $sel:submitTime:DocumentClassificationJobProperties', -- documentClassificationJobProperties_submitTime - The time that -- the document classification job was submitted for processing. -- -- $sel:volumeKmsKeyId:DocumentClassificationJobProperties', -- documentClassificationJobProperties_volumeKmsKeyId - ID for the -- AWS Key Management Service (KMS) key that Amazon Comprehend uses to -- encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- -- -- $sel:vpcConfig:DocumentClassificationJobProperties', -- documentClassificationJobProperties_vpcConfig - Configuration -- parameters for a private Virtual Private Cloud (VPC) containing the -- resources you are using for your document classification job. For more -- information, see Amazon VPC. newDocumentClassificationJobProperties :: DocumentClassificationJobProperties -- | The Amazon Resource Name (ARN) of the AWS identity and Access -- Management (IAM) role that grants Amazon Comprehend read access to -- your input data. documentClassificationJobProperties_dataAccessRoleArn :: Lens' DocumentClassificationJobProperties (Maybe Text) -- | The Amazon Resource Name (ARN) that identifies the document -- classifier. documentClassificationJobProperties_documentClassifierArn :: Lens' DocumentClassificationJobProperties (Maybe Text) -- | The time that the document classification job completed. documentClassificationJobProperties_endTime :: Lens' DocumentClassificationJobProperties (Maybe UTCTime) -- | The input data configuration that you supplied when you created the -- document classification job. documentClassificationJobProperties_inputDataConfig :: Lens' DocumentClassificationJobProperties (Maybe InputDataConfig) -- | The Amazon Resource Name (ARN) of the document classification job. It -- is a unique, fully qualified identifier for the job. It includes the -- AWS account, Region, and the job ID. The format of the ARN is as -- follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
--
documentClassificationJobProperties_jobArn :: Lens' DocumentClassificationJobProperties (Maybe Text) -- | The identifier assigned to the document classification job. documentClassificationJobProperties_jobId :: Lens' DocumentClassificationJobProperties (Maybe Text) -- | The name that you assigned to the document classification job. documentClassificationJobProperties_jobName :: Lens' DocumentClassificationJobProperties (Maybe Text) -- | The current status of the document classification job. If the status -- is FAILED, the Message field shows the reason for -- the failure. documentClassificationJobProperties_jobStatus :: Lens' DocumentClassificationJobProperties (Maybe JobStatus) -- | A description of the status of the job. documentClassificationJobProperties_message :: Lens' DocumentClassificationJobProperties (Maybe Text) -- | The output data configuration that you supplied when you created the -- document classification job. documentClassificationJobProperties_outputDataConfig :: Lens' DocumentClassificationJobProperties (Maybe OutputDataConfig) -- | The time that the document classification job was submitted for -- processing. documentClassificationJobProperties_submitTime :: Lens' DocumentClassificationJobProperties (Maybe UTCTime) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- documentClassificationJobProperties_volumeKmsKeyId :: Lens' DocumentClassificationJobProperties (Maybe Text) -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your document -- classification job. For more information, see Amazon VPC. documentClassificationJobProperties_vpcConfig :: Lens' DocumentClassificationJobProperties (Maybe VpcConfig) -- | Provides information for filtering a list of document classifiers. You -- can only specify one filtering parameter in a request. For more -- information, see the operation. -- -- See: newDocumentClassifierFilter smart constructor. data DocumentClassifierFilter DocumentClassifierFilter' :: Maybe Text -> Maybe ModelStatus -> Maybe POSIX -> Maybe POSIX -> DocumentClassifierFilter -- | The name that you assigned to the document classifier [$sel:documentClassifierName:DocumentClassifierFilter'] :: DocumentClassifierFilter -> Maybe Text -- | Filters the list of classifiers based on status. [$sel:status:DocumentClassifierFilter'] :: DocumentClassifierFilter -> Maybe ModelStatus -- | Filters the list of classifiers based on the time that the classifier -- was submitted for processing. Returns only classifiers submitted after -- the specified time. Classifiers are returned in descending order, -- newest to oldest. [$sel:submitTimeAfter:DocumentClassifierFilter'] :: DocumentClassifierFilter -> Maybe POSIX -- | Filters the list of classifiers based on the time that the classifier -- was submitted for processing. Returns only classifiers submitted -- before the specified time. Classifiers are returned in ascending -- order, oldest to newest. [$sel:submitTimeBefore:DocumentClassifierFilter'] :: DocumentClassifierFilter -> Maybe POSIX -- | Create a value of DocumentClassifierFilter with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:documentClassifierName:DocumentClassifierFilter', -- documentClassifierFilter_documentClassifierName - The name that -- you assigned to the document classifier -- -- $sel:status:DocumentClassifierFilter', -- documentClassifierFilter_status - Filters the list of -- classifiers based on status. -- -- $sel:submitTimeAfter:DocumentClassifierFilter', -- documentClassifierFilter_submitTimeAfter - Filters the list of -- classifiers based on the time that the classifier was submitted for -- processing. Returns only classifiers submitted after the specified -- time. Classifiers are returned in descending order, newest to oldest. -- -- $sel:submitTimeBefore:DocumentClassifierFilter', -- documentClassifierFilter_submitTimeBefore - Filters the list of -- classifiers based on the time that the classifier was submitted for -- processing. Returns only classifiers submitted before the specified -- time. Classifiers are returned in ascending order, oldest to newest. newDocumentClassifierFilter :: DocumentClassifierFilter -- | The name that you assigned to the document classifier documentClassifierFilter_documentClassifierName :: Lens' DocumentClassifierFilter (Maybe Text) -- | Filters the list of classifiers based on status. documentClassifierFilter_status :: Lens' DocumentClassifierFilter (Maybe ModelStatus) -- | Filters the list of classifiers based on the time that the classifier -- was submitted for processing. Returns only classifiers submitted after -- the specified time. Classifiers are returned in descending order, -- newest to oldest. documentClassifierFilter_submitTimeAfter :: Lens' DocumentClassifierFilter (Maybe UTCTime) -- | Filters the list of classifiers based on the time that the classifier -- was submitted for processing. Returns only classifiers submitted -- before the specified time. Classifiers are returned in ascending -- order, oldest to newest. documentClassifierFilter_submitTimeBefore :: Lens' DocumentClassifierFilter (Maybe UTCTime) -- | The input properties for training a document classifier. -- -- For more information on how the input file is formatted, see -- Preparing training data in the Comprehend Developer Guide. -- -- See: newDocumentClassifierInputDataConfig smart -- constructor. data DocumentClassifierInputDataConfig DocumentClassifierInputDataConfig' :: Maybe [AugmentedManifestsListItem] -> Maybe DocumentClassifierDataFormat -> Maybe Text -> Maybe Text -> Maybe Text -> DocumentClassifierInputDataConfig -- | A list of augmented manifest files that provide training data for your -- custom model. An augmented manifest file is a labeled dataset that is -- produced by Amazon SageMaker Ground Truth. -- -- This parameter is required if you set DataFormat to -- AUGMENTED_MANIFEST. [$sel:augmentedManifests:DocumentClassifierInputDataConfig'] :: DocumentClassifierInputDataConfig -> Maybe [AugmentedManifestsListItem] -- | The format of your training data: -- -- -- -- If you don't specify a value, Amazon Comprehend uses -- COMPREHEND_CSV as the default. [$sel:dataFormat:DocumentClassifierInputDataConfig'] :: DocumentClassifierInputDataConfig -> Maybe DocumentClassifierDataFormat -- | Indicates the delimiter used to separate each label for training a -- multi-label classifier. The default delimiter between labels is a pipe -- (|). You can use a different character as a delimiter (if it's an -- allowed character) by specifying it under Delimiter for labels. If the -- training documents use a delimiter other than the default or the -- delimiter you specify, the labels on that line will be combined to -- make a single unique label, such as LABELLABELLABEL. [$sel:labelDelimiter:DocumentClassifierInputDataConfig'] :: DocumentClassifierInputDataConfig -> Maybe Text -- | The Amazon S3 URI for the input data. The S3 bucket must be in the -- same region as the API endpoint that you are calling. The URI can -- point to a single input file or it can provide the prefix for a -- collection of input files. -- -- For example, if you use the URI S3://bucketName/prefix, if -- the prefix is a single file, Amazon Comprehend uses that file as -- input. If more than one file begins with the prefix, Amazon Comprehend -- uses all of them as input. -- -- This parameter is required if you set DataFormat to -- COMPREHEND_CSV. [$sel:s3Uri:DocumentClassifierInputDataConfig'] :: DocumentClassifierInputDataConfig -> Maybe Text -- | This specifies the Amazon S3 location where the test annotations for -- an entity recognizer are located. The URI must be in the same AWS -- Region as the API endpoint that you are calling. [$sel:testS3Uri:DocumentClassifierInputDataConfig'] :: DocumentClassifierInputDataConfig -> Maybe Text -- | Create a value of DocumentClassifierInputDataConfig with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:augmentedManifests:DocumentClassifierInputDataConfig', -- documentClassifierInputDataConfig_augmentedManifests - A list -- of augmented manifest files that provide training data for your custom -- model. An augmented manifest file is a labeled dataset that is -- produced by Amazon SageMaker Ground Truth. -- -- This parameter is required if you set DataFormat to -- AUGMENTED_MANIFEST. -- -- $sel:dataFormat:DocumentClassifierInputDataConfig', -- documentClassifierInputDataConfig_dataFormat - The format of -- your training data: -- -- -- -- If you don't specify a value, Amazon Comprehend uses -- COMPREHEND_CSV as the default. -- -- $sel:labelDelimiter:DocumentClassifierInputDataConfig', -- documentClassifierInputDataConfig_labelDelimiter - Indicates -- the delimiter used to separate each label for training a multi-label -- classifier. The default delimiter between labels is a pipe (|). You -- can use a different character as a delimiter (if it's an allowed -- character) by specifying it under Delimiter for labels. If the -- training documents use a delimiter other than the default or the -- delimiter you specify, the labels on that line will be combined to -- make a single unique label, such as LABELLABELLABEL. -- -- DocumentClassifierInputDataConfig, -- documentClassifierInputDataConfig_s3Uri - The Amazon S3 URI for -- the input data. The S3 bucket must be in the same region as the API -- endpoint that you are calling. The URI can point to a single input -- file or it can provide the prefix for a collection of input files. -- -- For example, if you use the URI S3://bucketName/prefix, if -- the prefix is a single file, Amazon Comprehend uses that file as -- input. If more than one file begins with the prefix, Amazon Comprehend -- uses all of them as input. -- -- This parameter is required if you set DataFormat to -- COMPREHEND_CSV. -- -- $sel:testS3Uri:DocumentClassifierInputDataConfig', -- documentClassifierInputDataConfig_testS3Uri - This specifies -- the Amazon S3 location where the test annotations for an entity -- recognizer are located. The URI must be in the same AWS Region as the -- API endpoint that you are calling. newDocumentClassifierInputDataConfig :: DocumentClassifierInputDataConfig -- | A list of augmented manifest files that provide training data for your -- custom model. An augmented manifest file is a labeled dataset that is -- produced by Amazon SageMaker Ground Truth. -- -- This parameter is required if you set DataFormat to -- AUGMENTED_MANIFEST. documentClassifierInputDataConfig_augmentedManifests :: Lens' DocumentClassifierInputDataConfig (Maybe [AugmentedManifestsListItem]) -- | The format of your training data: -- -- -- -- If you don't specify a value, Amazon Comprehend uses -- COMPREHEND_CSV as the default. documentClassifierInputDataConfig_dataFormat :: Lens' DocumentClassifierInputDataConfig (Maybe DocumentClassifierDataFormat) -- | Indicates the delimiter used to separate each label for training a -- multi-label classifier. The default delimiter between labels is a pipe -- (|). You can use a different character as a delimiter (if it's an -- allowed character) by specifying it under Delimiter for labels. If the -- training documents use a delimiter other than the default or the -- delimiter you specify, the labels on that line will be combined to -- make a single unique label, such as LABELLABELLABEL. documentClassifierInputDataConfig_labelDelimiter :: Lens' DocumentClassifierInputDataConfig (Maybe Text) -- | The Amazon S3 URI for the input data. The S3 bucket must be in the -- same region as the API endpoint that you are calling. The URI can -- point to a single input file or it can provide the prefix for a -- collection of input files. -- -- For example, if you use the URI S3://bucketName/prefix, if -- the prefix is a single file, Amazon Comprehend uses that file as -- input. If more than one file begins with the prefix, Amazon Comprehend -- uses all of them as input. -- -- This parameter is required if you set DataFormat to -- COMPREHEND_CSV. documentClassifierInputDataConfig_s3Uri :: Lens' DocumentClassifierInputDataConfig (Maybe Text) -- | This specifies the Amazon S3 location where the test annotations for -- an entity recognizer are located. The URI must be in the same AWS -- Region as the API endpoint that you are calling. documentClassifierInputDataConfig_testS3Uri :: Lens' DocumentClassifierInputDataConfig (Maybe Text) -- | Provides output results configuration parameters for custom classifier -- jobs. -- -- See: newDocumentClassifierOutputDataConfig smart -- constructor. data DocumentClassifierOutputDataConfig DocumentClassifierOutputDataConfig' :: Maybe Text -> Maybe Text -> DocumentClassifierOutputDataConfig -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt the output results from an analysis job. The KmsKeyId -- can be one of the following formats: -- -- [$sel:kmsKeyId:DocumentClassifierOutputDataConfig'] :: DocumentClassifierOutputDataConfig -> Maybe Text -- | When you use the OutputDataConfig object while creating a -- custom classifier, you specify the Amazon S3 location where you want -- to write the confusion matrix. The URI must be in the same region as -- the API endpoint that you are calling. The location is 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 directory specific to the job. The S3Uri -- field contains the location of the output file, called -- output.tar.gz. It is a compressed archive that contains the -- confusion matrix. [$sel:s3Uri:DocumentClassifierOutputDataConfig'] :: DocumentClassifierOutputDataConfig -> Maybe Text -- | Create a value of DocumentClassifierOutputDataConfig with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:kmsKeyId:DocumentClassifierOutputDataConfig', -- documentClassifierOutputDataConfig_kmsKeyId - ID for the AWS -- Key Management Service (KMS) key that Amazon Comprehend uses to -- encrypt the output results from an analysis job. The KmsKeyId can be -- one of the following formats: -- -- -- -- $sel:s3Uri:DocumentClassifierOutputDataConfig', -- documentClassifierOutputDataConfig_s3Uri - When you use the -- OutputDataConfig object while creating a custom classifier, -- you specify the Amazon S3 location where you want to write the -- confusion matrix. The URI must be in the same region as the API -- endpoint that you are calling. The location is 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 directory specific to the job. The S3Uri -- field contains the location of the output file, called -- output.tar.gz. It is a compressed archive that contains the -- confusion matrix. newDocumentClassifierOutputDataConfig :: DocumentClassifierOutputDataConfig -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt the output results from an analysis job. The KmsKeyId -- can be one of the following formats: -- -- documentClassifierOutputDataConfig_kmsKeyId :: Lens' DocumentClassifierOutputDataConfig (Maybe Text) -- | When you use the OutputDataConfig object while creating a -- custom classifier, you specify the Amazon S3 location where you want -- to write the confusion matrix. The URI must be in the same region as -- the API endpoint that you are calling. The location is 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 directory specific to the job. The S3Uri -- field contains the location of the output file, called -- output.tar.gz. It is a compressed archive that contains the -- confusion matrix. documentClassifierOutputDataConfig_s3Uri :: Lens' DocumentClassifierOutputDataConfig (Maybe Text) -- | Provides information about a document classifier. -- -- See: newDocumentClassifierProperties smart constructor. data DocumentClassifierProperties DocumentClassifierProperties' :: Maybe (Sensitive ClassifierMetadata) -> Maybe Text -> Maybe Text -> Maybe POSIX -> Maybe DocumentClassifierInputDataConfig -> Maybe LanguageCode -> Maybe Text -> Maybe DocumentClassifierMode -> Maybe Text -> Maybe DocumentClassifierOutputDataConfig -> Maybe Text -> Maybe ModelStatus -> Maybe POSIX -> Maybe POSIX -> Maybe POSIX -> Maybe Text -> Maybe Text -> Maybe VpcConfig -> DocumentClassifierProperties -- | Information about the document classifier, including the number of -- documents used for training the classifier, the number of documents -- used for test the classifier, and an accuracy rating. [$sel:classifierMetadata:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe (Sensitive ClassifierMetadata) -- | The Amazon Resource Name (ARN) of the AWS Identity and Management -- (IAM) role that grants Amazon Comprehend read access to your input -- data. [$sel:dataAccessRoleArn:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe Text -- | The Amazon Resource Name (ARN) that identifies the document -- classifier. [$sel:documentClassifierArn:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe Text -- | The time that training the document classifier completed. [$sel:endTime:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe POSIX -- | The input data configuration that you supplied when you created the -- document classifier for training. [$sel:inputDataConfig:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe DocumentClassifierInputDataConfig -- | The language code for the language of the documents that the -- classifier was trained on. [$sel:languageCode:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe LanguageCode -- | Additional information about the status of the classifier. [$sel:message:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe Text -- | Indicates the mode in which the specific classifier was trained. This -- also indicates the format of input documents and the format of the -- confusion matrix. Each classifier can only be trained in one mode and -- this cannot be changed once the classifier is trained. [$sel:mode:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe DocumentClassifierMode -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt trained custom models. The ModelKmsKeyId can be either -- of the following formats: -- -- [$sel:modelKmsKeyId:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe Text -- | Provides output results configuration parameters for custom classifier -- jobs. [$sel:outputDataConfig:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe DocumentClassifierOutputDataConfig -- | The Amazon Resource Name (ARN) of the source model. This model was -- imported from a different AWS account to create the document -- classifier model in your AWS account. [$sel:sourceModelArn:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe Text -- | The status of the document classifier. If the status is -- TRAINED the classifier is ready to use. If the status is -- FAILED you can see additional information about why the -- classifier wasn't trained in the Message field. [$sel:status:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe ModelStatus -- | The time that the document classifier was submitted for training. [$sel:submitTime:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe POSIX -- | The time that training of the document classifier was completed. -- Indicates the time when the training completes on documentation -- classifiers. You are billed for the time interval between this time -- and the value of TrainingStartTime. [$sel:trainingEndTime:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe POSIX -- | Indicates the time when the training starts on documentation -- classifiers. You are billed for the time interval between this time -- and the value of TrainingEndTime. [$sel:trainingStartTime:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe POSIX -- | The version name that you assigned to the document classifier. [$sel:versionName:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe Text -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- [$sel:volumeKmsKeyId:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe Text -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your custom classifier. For -- more information, see Amazon VPC. [$sel:vpcConfig:DocumentClassifierProperties'] :: DocumentClassifierProperties -> Maybe VpcConfig -- | Create a value of DocumentClassifierProperties with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:classifierMetadata:DocumentClassifierProperties', -- documentClassifierProperties_classifierMetadata - Information -- about the document classifier, including the number of documents used -- for training the classifier, the number of documents used for test the -- classifier, and an accuracy rating. -- -- $sel:dataAccessRoleArn:DocumentClassifierProperties', -- documentClassifierProperties_dataAccessRoleArn - The Amazon -- Resource Name (ARN) of the AWS Identity and Management (IAM) role that -- grants Amazon Comprehend read access to your input data. -- -- $sel:documentClassifierArn:DocumentClassifierProperties', -- documentClassifierProperties_documentClassifierArn - The Amazon -- Resource Name (ARN) that identifies the document classifier. -- -- $sel:endTime:DocumentClassifierProperties', -- documentClassifierProperties_endTime - The time that training -- the document classifier completed. -- -- $sel:inputDataConfig:DocumentClassifierProperties', -- documentClassifierProperties_inputDataConfig - The input data -- configuration that you supplied when you created the document -- classifier for training. -- -- $sel:languageCode:DocumentClassifierProperties', -- documentClassifierProperties_languageCode - The language code -- for the language of the documents that the classifier was trained on. -- -- $sel:message:DocumentClassifierProperties', -- documentClassifierProperties_message - Additional information -- about the status of the classifier. -- -- $sel:mode:DocumentClassifierProperties', -- documentClassifierProperties_mode - Indicates the mode in which -- the specific classifier was trained. This also indicates the format of -- input documents and the format of the confusion matrix. Each -- classifier can only be trained in one mode and this cannot be changed -- once the classifier is trained. -- -- $sel:modelKmsKeyId:DocumentClassifierProperties', -- documentClassifierProperties_modelKmsKeyId - ID for the AWS Key -- Management Service (KMS) key that Amazon Comprehend uses to encrypt -- trained custom models. The ModelKmsKeyId can be either of the -- following formats: -- -- -- -- $sel:outputDataConfig:DocumentClassifierProperties', -- documentClassifierProperties_outputDataConfig - Provides output -- results configuration parameters for custom classifier jobs. -- -- $sel:sourceModelArn:DocumentClassifierProperties', -- documentClassifierProperties_sourceModelArn - The Amazon -- Resource Name (ARN) of the source model. This model was imported from -- a different AWS account to create the document classifier model in -- your AWS account. -- -- $sel:status:DocumentClassifierProperties', -- documentClassifierProperties_status - The status of the -- document classifier. If the status is TRAINED the classifier -- is ready to use. If the status is FAILED you can see -- additional information about why the classifier wasn't trained in the -- Message field. -- -- $sel:submitTime:DocumentClassifierProperties', -- documentClassifierProperties_submitTime - The time that the -- document classifier was submitted for training. -- -- $sel:trainingEndTime:DocumentClassifierProperties', -- documentClassifierProperties_trainingEndTime - The time that -- training of the document classifier was completed. Indicates the time -- when the training completes on documentation classifiers. You are -- billed for the time interval between this time and the value of -- TrainingStartTime. -- -- $sel:trainingStartTime:DocumentClassifierProperties', -- documentClassifierProperties_trainingStartTime - Indicates the -- time when the training starts on documentation classifiers. You are -- billed for the time interval between this time and the value of -- TrainingEndTime. -- -- $sel:versionName:DocumentClassifierProperties', -- documentClassifierProperties_versionName - The version name -- that you assigned to the document classifier. -- -- $sel:volumeKmsKeyId:DocumentClassifierProperties', -- documentClassifierProperties_volumeKmsKeyId - ID for the AWS -- Key Management Service (KMS) key that Amazon Comprehend uses to -- encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- -- -- $sel:vpcConfig:DocumentClassifierProperties', -- documentClassifierProperties_vpcConfig - Configuration -- parameters for a private Virtual Private Cloud (VPC) containing the -- resources you are using for your custom classifier. For more -- information, see Amazon VPC. newDocumentClassifierProperties :: DocumentClassifierProperties -- | Information about the document classifier, including the number of -- documents used for training the classifier, the number of documents -- used for test the classifier, and an accuracy rating. documentClassifierProperties_classifierMetadata :: Lens' DocumentClassifierProperties (Maybe ClassifierMetadata) -- | The Amazon Resource Name (ARN) of the AWS Identity and Management -- (IAM) role that grants Amazon Comprehend read access to your input -- data. documentClassifierProperties_dataAccessRoleArn :: Lens' DocumentClassifierProperties (Maybe Text) -- | The Amazon Resource Name (ARN) that identifies the document -- classifier. documentClassifierProperties_documentClassifierArn :: Lens' DocumentClassifierProperties (Maybe Text) -- | The time that training the document classifier completed. documentClassifierProperties_endTime :: Lens' DocumentClassifierProperties (Maybe UTCTime) -- | The input data configuration that you supplied when you created the -- document classifier for training. documentClassifierProperties_inputDataConfig :: Lens' DocumentClassifierProperties (Maybe DocumentClassifierInputDataConfig) -- | The language code for the language of the documents that the -- classifier was trained on. documentClassifierProperties_languageCode :: Lens' DocumentClassifierProperties (Maybe LanguageCode) -- | Additional information about the status of the classifier. documentClassifierProperties_message :: Lens' DocumentClassifierProperties (Maybe Text) -- | Indicates the mode in which the specific classifier was trained. This -- also indicates the format of input documents and the format of the -- confusion matrix. Each classifier can only be trained in one mode and -- this cannot be changed once the classifier is trained. documentClassifierProperties_mode :: Lens' DocumentClassifierProperties (Maybe DocumentClassifierMode) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt trained custom models. The ModelKmsKeyId can be either -- of the following formats: -- -- documentClassifierProperties_modelKmsKeyId :: Lens' DocumentClassifierProperties (Maybe Text) -- | Provides output results configuration parameters for custom classifier -- jobs. documentClassifierProperties_outputDataConfig :: Lens' DocumentClassifierProperties (Maybe DocumentClassifierOutputDataConfig) -- | The Amazon Resource Name (ARN) of the source model. This model was -- imported from a different AWS account to create the document -- classifier model in your AWS account. documentClassifierProperties_sourceModelArn :: Lens' DocumentClassifierProperties (Maybe Text) -- | The status of the document classifier. If the status is -- TRAINED the classifier is ready to use. If the status is -- FAILED you can see additional information about why the -- classifier wasn't trained in the Message field. documentClassifierProperties_status :: Lens' DocumentClassifierProperties (Maybe ModelStatus) -- | The time that the document classifier was submitted for training. documentClassifierProperties_submitTime :: Lens' DocumentClassifierProperties (Maybe UTCTime) -- | The time that training of the document classifier was completed. -- Indicates the time when the training completes on documentation -- classifiers. You are billed for the time interval between this time -- and the value of TrainingStartTime. documentClassifierProperties_trainingEndTime :: Lens' DocumentClassifierProperties (Maybe UTCTime) -- | Indicates the time when the training starts on documentation -- classifiers. You are billed for the time interval between this time -- and the value of TrainingEndTime. documentClassifierProperties_trainingStartTime :: Lens' DocumentClassifierProperties (Maybe UTCTime) -- | The version name that you assigned to the document classifier. documentClassifierProperties_versionName :: Lens' DocumentClassifierProperties (Maybe Text) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- documentClassifierProperties_volumeKmsKeyId :: Lens' DocumentClassifierProperties (Maybe Text) -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your custom classifier. For -- more information, see Amazon VPC. documentClassifierProperties_vpcConfig :: Lens' DocumentClassifierProperties (Maybe VpcConfig) -- | Describes information about a document classifier and its versions. -- -- See: newDocumentClassifierSummary smart constructor. data DocumentClassifierSummary DocumentClassifierSummary' :: Maybe Text -> Maybe POSIX -> Maybe Text -> Maybe ModelStatus -> Maybe Int -> DocumentClassifierSummary -- | The name that you assigned the document classifier. [$sel:documentClassifierName:DocumentClassifierSummary'] :: DocumentClassifierSummary -> Maybe Text -- | The time that the latest document classifier version was submitted for -- processing. [$sel:latestVersionCreatedAt:DocumentClassifierSummary'] :: DocumentClassifierSummary -> Maybe POSIX -- | The version name you assigned to the latest document classifier -- version. [$sel:latestVersionName:DocumentClassifierSummary'] :: DocumentClassifierSummary -> Maybe Text -- | Provides the status of the latest document classifier version. [$sel:latestVersionStatus:DocumentClassifierSummary'] :: DocumentClassifierSummary -> Maybe ModelStatus -- | The number of versions you created. [$sel:numberOfVersions:DocumentClassifierSummary'] :: DocumentClassifierSummary -> Maybe Int -- | Create a value of DocumentClassifierSummary with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:documentClassifierName:DocumentClassifierSummary', -- documentClassifierSummary_documentClassifierName - The name -- that you assigned the document classifier. -- -- $sel:latestVersionCreatedAt:DocumentClassifierSummary', -- documentClassifierSummary_latestVersionCreatedAt - The time -- that the latest document classifier version was submitted for -- processing. -- -- $sel:latestVersionName:DocumentClassifierSummary', -- documentClassifierSummary_latestVersionName - The version name -- you assigned to the latest document classifier version. -- -- $sel:latestVersionStatus:DocumentClassifierSummary', -- documentClassifierSummary_latestVersionStatus - Provides the -- status of the latest document classifier version. -- -- $sel:numberOfVersions:DocumentClassifierSummary', -- documentClassifierSummary_numberOfVersions - The number of -- versions you created. newDocumentClassifierSummary :: DocumentClassifierSummary -- | The name that you assigned the document classifier. documentClassifierSummary_documentClassifierName :: Lens' DocumentClassifierSummary (Maybe Text) -- | The time that the latest document classifier version was submitted for -- processing. documentClassifierSummary_latestVersionCreatedAt :: Lens' DocumentClassifierSummary (Maybe UTCTime) -- | The version name you assigned to the latest document classifier -- version. documentClassifierSummary_latestVersionName :: Lens' DocumentClassifierSummary (Maybe Text) -- | Provides the status of the latest document classifier version. documentClassifierSummary_latestVersionStatus :: Lens' DocumentClassifierSummary (Maybe ModelStatus) -- | The number of versions you created. documentClassifierSummary_numberOfVersions :: Lens' DocumentClassifierSummary (Maybe Int) -- | Specifies one of the label or labels that categorize the document -- being analyzed. -- -- See: newDocumentLabel smart constructor. data DocumentLabel DocumentLabel' :: Maybe Text -> Maybe Int -> Maybe Double -> DocumentLabel -- | The name of the label. [$sel:name:DocumentLabel'] :: DocumentLabel -> Maybe Text -- | Page number where the label occurs. This field is present in the -- response only if your request includes the Byte parameter. [$sel:page:DocumentLabel'] :: DocumentLabel -> Maybe Int -- | The confidence score that Amazon Comprehend has this label correctly -- attributed. [$sel:score:DocumentLabel'] :: DocumentLabel -> Maybe Double -- | Create a value of DocumentLabel with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:name:DocumentLabel', documentLabel_name - The name -- of the label. -- -- $sel:page:DocumentLabel', documentLabel_page - Page -- number where the label occurs. This field is present in the response -- only if your request includes the Byte parameter. -- -- $sel:score:DocumentLabel', documentLabel_score - The -- confidence score that Amazon Comprehend has this label correctly -- attributed. newDocumentLabel :: DocumentLabel -- | The name of the label. documentLabel_name :: Lens' DocumentLabel (Maybe Text) -- | Page number where the label occurs. This field is present in the -- response only if your request includes the Byte parameter. documentLabel_page :: Lens' DocumentLabel (Maybe Int) -- | The confidence score that Amazon Comprehend has this label correctly -- attributed. documentLabel_score :: Lens' DocumentLabel (Maybe Double) -- | Information about the document, discovered during text extraction. -- -- See: newDocumentMetadata smart constructor. data DocumentMetadata DocumentMetadata' :: Maybe [ExtractedCharactersListItem] -> Maybe Int -> DocumentMetadata -- | List of pages in the document, with the number of characters extracted -- from each page. [$sel:extractedCharacters:DocumentMetadata'] :: DocumentMetadata -> Maybe [ExtractedCharactersListItem] -- | Number of pages in the document. [$sel:pages:DocumentMetadata'] :: DocumentMetadata -> Maybe Int -- | Create a value of DocumentMetadata with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:extractedCharacters:DocumentMetadata', -- documentMetadata_extractedCharacters - List of pages in the -- document, with the number of characters extracted from each page. -- -- $sel:pages:DocumentMetadata', documentMetadata_pages - -- Number of pages in the document. newDocumentMetadata :: DocumentMetadata -- | List of pages in the document, with the number of characters extracted -- from each page. documentMetadata_extractedCharacters :: Lens' DocumentMetadata (Maybe [ExtractedCharactersListItem]) -- | Number of pages in the document. documentMetadata_pages :: Lens' DocumentMetadata (Maybe Int) -- | Provides configuration parameters to override the default actions for -- extracting text from PDF documents and image files. -- -- By default, Amazon Comprehend performs the following actions to -- extract text from files, based on the input file type: -- -- -- -- DocumentReaderConfig does not apply to plain text files or -- Word files. -- -- For image files and PDF documents, you can override these default -- actions using the fields listed below. For more information, see -- Setting text extraction options. -- -- See: newDocumentReaderConfig smart constructor. data DocumentReaderConfig DocumentReaderConfig' :: Maybe DocumentReadMode -> Maybe (NonEmpty DocumentReadFeatureTypes) -> DocumentReadAction -> DocumentReaderConfig -- | Determines the text extraction actions for PDF files. Enter one of the -- following values: -- -- [$sel:documentReadMode:DocumentReaderConfig'] :: DocumentReaderConfig -> Maybe DocumentReadMode -- | Specifies the type of Amazon Textract features to apply. If you chose -- TEXTRACT_ANALYZE_DOCUMENT as the read action, you must -- specify one or both of the following values: -- -- [$sel:featureTypes:DocumentReaderConfig'] :: DocumentReaderConfig -> Maybe (NonEmpty DocumentReadFeatureTypes) -- | This field defines the Amazon Textract API operation that Amazon -- Comprehend uses to extract text from PDF files and image files. Enter -- one of the following values: -- -- [$sel:documentReadAction:DocumentReaderConfig'] :: DocumentReaderConfig -> DocumentReadAction -- | Create a value of DocumentReaderConfig with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:documentReadMode:DocumentReaderConfig', -- documentReaderConfig_documentReadMode - Determines the text -- extraction actions for PDF files. Enter one of the following values: -- -- -- -- $sel:featureTypes:DocumentReaderConfig', -- documentReaderConfig_featureTypes - Specifies the type of -- Amazon Textract features to apply. If you chose -- TEXTRACT_ANALYZE_DOCUMENT as the read action, you must -- specify one or both of the following values: -- -- -- -- $sel:documentReadAction:DocumentReaderConfig', -- documentReaderConfig_documentReadAction - This field defines -- the Amazon Textract API operation that Amazon Comprehend uses to -- extract text from PDF files and image files. Enter one of the -- following values: -- -- newDocumentReaderConfig :: DocumentReadAction -> DocumentReaderConfig -- | Determines the text extraction actions for PDF files. Enter one of the -- following values: -- -- documentReaderConfig_documentReadMode :: Lens' DocumentReaderConfig (Maybe DocumentReadMode) -- | Specifies the type of Amazon Textract features to apply. If you chose -- TEXTRACT_ANALYZE_DOCUMENT as the read action, you must -- specify one or both of the following values: -- -- documentReaderConfig_featureTypes :: Lens' DocumentReaderConfig (Maybe (NonEmpty DocumentReadFeatureTypes)) -- | This field defines the Amazon Textract API operation that Amazon -- Comprehend uses to extract text from PDF files and image files. Enter -- one of the following values: -- -- documentReaderConfig_documentReadAction :: Lens' DocumentReaderConfig DocumentReadAction -- | Document type for each page in the document. -- -- See: newDocumentTypeListItem smart constructor. data DocumentTypeListItem DocumentTypeListItem' :: Maybe Int -> Maybe DocumentType -> DocumentTypeListItem -- | Page number. [$sel:page:DocumentTypeListItem'] :: DocumentTypeListItem -> Maybe Int -- | Document type. [$sel:type':DocumentTypeListItem'] :: DocumentTypeListItem -> Maybe DocumentType -- | Create a value of DocumentTypeListItem with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:page:DocumentTypeListItem', -- documentTypeListItem_page - Page number. -- -- $sel:type':DocumentTypeListItem', -- documentTypeListItem_type - Document type. newDocumentTypeListItem :: DocumentTypeListItem -- | Page number. documentTypeListItem_page :: Lens' DocumentTypeListItem (Maybe Int) -- | Document type. documentTypeListItem_type :: Lens' DocumentTypeListItem (Maybe DocumentType) -- | Returns the code for the dominant language in the input text and the -- level of confidence that Amazon Comprehend has in the accuracy of the -- detection. -- -- See: newDominantLanguage smart constructor. data DominantLanguage DominantLanguage' :: Maybe Text -> Maybe Double -> DominantLanguage -- | The RFC 5646 language code for the dominant language. For more -- information about RFC 5646, see Tags for Identifying Languages -- on the IETF Tools web site. [$sel:languageCode:DominantLanguage'] :: DominantLanguage -> Maybe Text -- | The level of confidence that Amazon Comprehend has in the accuracy of -- the detection. [$sel:score:DominantLanguage'] :: DominantLanguage -> Maybe Double -- | Create a value of DominantLanguage with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:languageCode:DominantLanguage', -- dominantLanguage_languageCode - The RFC 5646 language code for -- the dominant language. For more information about RFC 5646, see -- Tags for Identifying Languages on the IETF Tools web -- site. -- -- $sel:score:DominantLanguage', dominantLanguage_score - -- The level of confidence that Amazon Comprehend has in the accuracy of -- the detection. newDominantLanguage :: DominantLanguage -- | The RFC 5646 language code for the dominant language. For more -- information about RFC 5646, see Tags for Identifying Languages -- on the IETF Tools web site. dominantLanguage_languageCode :: Lens' DominantLanguage (Maybe Text) -- | The level of confidence that Amazon Comprehend has in the accuracy of -- the detection. dominantLanguage_score :: Lens' DominantLanguage (Maybe Double) -- | Provides information for filtering a list of dominant language -- detection jobs. For more information, see the operation. -- -- See: newDominantLanguageDetectionJobFilter smart -- constructor. data DominantLanguageDetectionJobFilter DominantLanguageDetectionJobFilter' :: Maybe Text -> Maybe JobStatus -> Maybe POSIX -> Maybe POSIX -> DominantLanguageDetectionJobFilter -- | Filters on the name of the job. [$sel:jobName:DominantLanguageDetectionJobFilter'] :: DominantLanguageDetectionJobFilter -> Maybe Text -- | Filters the list of jobs based on job status. Returns only jobs with -- the specified status. [$sel:jobStatus:DominantLanguageDetectionJobFilter'] :: DominantLanguageDetectionJobFilter -> Maybe JobStatus -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. [$sel:submitTimeAfter:DominantLanguageDetectionJobFilter'] :: DominantLanguageDetectionJobFilter -> Maybe POSIX -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. [$sel:submitTimeBefore:DominantLanguageDetectionJobFilter'] :: DominantLanguageDetectionJobFilter -> Maybe POSIX -- | Create a value of DominantLanguageDetectionJobFilter with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:jobName:DominantLanguageDetectionJobFilter', -- dominantLanguageDetectionJobFilter_jobName - Filters on the -- name of the job. -- -- $sel:jobStatus:DominantLanguageDetectionJobFilter', -- dominantLanguageDetectionJobFilter_jobStatus - Filters the list -- of jobs based on job status. Returns only jobs with the specified -- status. -- -- $sel:submitTimeAfter:DominantLanguageDetectionJobFilter', -- dominantLanguageDetectionJobFilter_submitTimeAfter - Filters -- the list of jobs based on the time that the job was submitted for -- processing. Returns only jobs submitted after the specified time. Jobs -- are returned in descending order, newest to oldest. -- -- $sel:submitTimeBefore:DominantLanguageDetectionJobFilter', -- dominantLanguageDetectionJobFilter_submitTimeBefore - Filters -- the list of jobs based on the time that the job was submitted for -- processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. newDominantLanguageDetectionJobFilter :: DominantLanguageDetectionJobFilter -- | Filters on the name of the job. dominantLanguageDetectionJobFilter_jobName :: Lens' DominantLanguageDetectionJobFilter (Maybe Text) -- | Filters the list of jobs based on job status. Returns only jobs with -- the specified status. dominantLanguageDetectionJobFilter_jobStatus :: Lens' DominantLanguageDetectionJobFilter (Maybe JobStatus) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. dominantLanguageDetectionJobFilter_submitTimeAfter :: Lens' DominantLanguageDetectionJobFilter (Maybe UTCTime) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. dominantLanguageDetectionJobFilter_submitTimeBefore :: Lens' DominantLanguageDetectionJobFilter (Maybe UTCTime) -- | Provides information about a dominant language detection job. -- -- See: newDominantLanguageDetectionJobProperties smart -- constructor. data DominantLanguageDetectionJobProperties DominantLanguageDetectionJobProperties' :: Maybe Text -> Maybe POSIX -> Maybe InputDataConfig -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe JobStatus -> Maybe Text -> Maybe OutputDataConfig -> Maybe POSIX -> Maybe Text -> Maybe VpcConfig -> DominantLanguageDetectionJobProperties -- | The Amazon Resource Name (ARN) that gives Amazon Comprehend read -- access to your input data. [$sel:dataAccessRoleArn:DominantLanguageDetectionJobProperties'] :: DominantLanguageDetectionJobProperties -> Maybe Text -- | The time that the dominant language detection job completed. [$sel:endTime:DominantLanguageDetectionJobProperties'] :: DominantLanguageDetectionJobProperties -> Maybe POSIX -- | The input data configuration that you supplied when you created the -- dominant language detection job. [$sel:inputDataConfig:DominantLanguageDetectionJobProperties'] :: DominantLanguageDetectionJobProperties -> Maybe InputDataConfig -- | The Amazon Resource Name (ARN) of the dominant language detection job. -- It is a unique, fully qualified identifier for the job. It includes -- the AWS account, Region, and the job ID. The format of the ARN is as -- follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
--
[$sel:jobArn:DominantLanguageDetectionJobProperties'] :: DominantLanguageDetectionJobProperties -> Maybe Text -- | The identifier assigned to the dominant language detection job. [$sel:jobId:DominantLanguageDetectionJobProperties'] :: DominantLanguageDetectionJobProperties -> Maybe Text -- | The name that you assigned to the dominant language detection job. [$sel:jobName:DominantLanguageDetectionJobProperties'] :: DominantLanguageDetectionJobProperties -> Maybe Text -- | The current status of the dominant language detection job. If the -- status is FAILED, the Message field shows the reason -- for the failure. [$sel:jobStatus:DominantLanguageDetectionJobProperties'] :: DominantLanguageDetectionJobProperties -> Maybe JobStatus -- | A description for the status of a job. [$sel:message:DominantLanguageDetectionJobProperties'] :: DominantLanguageDetectionJobProperties -> Maybe Text -- | The output data configuration that you supplied when you created the -- dominant language detection job. [$sel:outputDataConfig:DominantLanguageDetectionJobProperties'] :: DominantLanguageDetectionJobProperties -> Maybe OutputDataConfig -- | The time that the dominant language detection job was submitted for -- processing. [$sel:submitTime:DominantLanguageDetectionJobProperties'] :: DominantLanguageDetectionJobProperties -> Maybe POSIX -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- [$sel:volumeKmsKeyId:DominantLanguageDetectionJobProperties'] :: DominantLanguageDetectionJobProperties -> Maybe Text -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your dominant language -- detection job. For more information, see Amazon VPC. [$sel:vpcConfig:DominantLanguageDetectionJobProperties'] :: DominantLanguageDetectionJobProperties -> Maybe VpcConfig -- | Create a value of DominantLanguageDetectionJobProperties with -- all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:dataAccessRoleArn:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_dataAccessRoleArn - The -- Amazon Resource Name (ARN) that gives Amazon Comprehend read access to -- your input data. -- -- $sel:endTime:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_endTime - The time that -- the dominant language detection job completed. -- -- $sel:inputDataConfig:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_inputDataConfig - The -- input data configuration that you supplied when you created the -- dominant language detection job. -- -- $sel:jobArn:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_jobArn - The Amazon -- Resource Name (ARN) of the dominant language detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- $sel:jobId:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_jobId - The identifier -- assigned to the dominant language detection job. -- -- $sel:jobName:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_jobName - The name that -- you assigned to the dominant language detection job. -- -- $sel:jobStatus:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_jobStatus - The current -- status of the dominant language detection job. If the status is -- FAILED, the Message field shows the reason for the -- failure. -- -- $sel:message:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_message - A description -- for the status of a job. -- -- $sel:outputDataConfig:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_outputDataConfig - The -- output data configuration that you supplied when you created the -- dominant language detection job. -- -- $sel:submitTime:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_submitTime - The time -- that the dominant language detection job was submitted for processing. -- -- $sel:volumeKmsKeyId:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_volumeKmsKeyId - ID for -- the AWS Key Management Service (KMS) key that Amazon Comprehend uses -- to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- -- -- $sel:vpcConfig:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_vpcConfig - -- Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your dominant language -- detection job. For more information, see Amazon VPC. newDominantLanguageDetectionJobProperties :: DominantLanguageDetectionJobProperties -- | The Amazon Resource Name (ARN) that gives Amazon Comprehend read -- access to your input data. dominantLanguageDetectionJobProperties_dataAccessRoleArn :: Lens' DominantLanguageDetectionJobProperties (Maybe Text) -- | The time that the dominant language detection job completed. dominantLanguageDetectionJobProperties_endTime :: Lens' DominantLanguageDetectionJobProperties (Maybe UTCTime) -- | The input data configuration that you supplied when you created the -- dominant language detection job. dominantLanguageDetectionJobProperties_inputDataConfig :: Lens' DominantLanguageDetectionJobProperties (Maybe InputDataConfig) -- | The Amazon Resource Name (ARN) of the dominant language detection job. -- It is a unique, fully qualified identifier for the job. It includes -- the AWS account, Region, and the job ID. The format of the ARN is as -- follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
--
dominantLanguageDetectionJobProperties_jobArn :: Lens' DominantLanguageDetectionJobProperties (Maybe Text) -- | The identifier assigned to the dominant language detection job. dominantLanguageDetectionJobProperties_jobId :: Lens' DominantLanguageDetectionJobProperties (Maybe Text) -- | The name that you assigned to the dominant language detection job. dominantLanguageDetectionJobProperties_jobName :: Lens' DominantLanguageDetectionJobProperties (Maybe Text) -- | The current status of the dominant language detection job. If the -- status is FAILED, the Message field shows the reason -- for the failure. dominantLanguageDetectionJobProperties_jobStatus :: Lens' DominantLanguageDetectionJobProperties (Maybe JobStatus) -- | A description for the status of a job. dominantLanguageDetectionJobProperties_message :: Lens' DominantLanguageDetectionJobProperties (Maybe Text) -- | The output data configuration that you supplied when you created the -- dominant language detection job. dominantLanguageDetectionJobProperties_outputDataConfig :: Lens' DominantLanguageDetectionJobProperties (Maybe OutputDataConfig) -- | The time that the dominant language detection job was submitted for -- processing. dominantLanguageDetectionJobProperties_submitTime :: Lens' DominantLanguageDetectionJobProperties (Maybe UTCTime) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- dominantLanguageDetectionJobProperties_volumeKmsKeyId :: Lens' DominantLanguageDetectionJobProperties (Maybe Text) -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your dominant language -- detection job. For more information, see Amazon VPC. dominantLanguageDetectionJobProperties_vpcConfig :: Lens' DominantLanguageDetectionJobProperties (Maybe VpcConfig) -- | The filter used to determine which endpoints are returned. You can -- filter jobs on their name, model, status, or the date and time that -- they were created. You can only set one filter at a time. -- -- See: newEndpointFilter smart constructor. data EndpointFilter EndpointFilter' :: Maybe POSIX -> Maybe POSIX -> Maybe Text -> Maybe EndpointStatus -> EndpointFilter -- | Specifies a date after which the returned endpoint or endpoints were -- created. [$sel:creationTimeAfter:EndpointFilter'] :: EndpointFilter -> Maybe POSIX -- | Specifies a date before which the returned endpoint or endpoints were -- created. [$sel:creationTimeBefore:EndpointFilter'] :: EndpointFilter -> Maybe POSIX -- | The Amazon Resource Number (ARN) of the model to which the endpoint is -- attached. [$sel:modelArn:EndpointFilter'] :: EndpointFilter -> Maybe Text -- | Specifies the status of the endpoint being returned. Possible values -- are: Creating, Ready, Updating, Deleting, Failed. [$sel:status:EndpointFilter'] :: EndpointFilter -> Maybe EndpointStatus -- | Create a value of EndpointFilter with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:creationTimeAfter:EndpointFilter', -- endpointFilter_creationTimeAfter - Specifies a date after which -- the returned endpoint or endpoints were created. -- -- $sel:creationTimeBefore:EndpointFilter', -- endpointFilter_creationTimeBefore - Specifies a date before -- which the returned endpoint or endpoints were created. -- -- $sel:modelArn:EndpointFilter', endpointFilter_modelArn - -- The Amazon Resource Number (ARN) of the model to which the endpoint is -- attached. -- -- $sel:status:EndpointFilter', endpointFilter_status - -- Specifies the status of the endpoint being returned. Possible values -- are: Creating, Ready, Updating, Deleting, Failed. newEndpointFilter :: EndpointFilter -- | Specifies a date after which the returned endpoint or endpoints were -- created. endpointFilter_creationTimeAfter :: Lens' EndpointFilter (Maybe UTCTime) -- | Specifies a date before which the returned endpoint or endpoints were -- created. endpointFilter_creationTimeBefore :: Lens' EndpointFilter (Maybe UTCTime) -- | The Amazon Resource Number (ARN) of the model to which the endpoint is -- attached. endpointFilter_modelArn :: Lens' EndpointFilter (Maybe Text) -- | Specifies the status of the endpoint being returned. Possible values -- are: Creating, Ready, Updating, Deleting, Failed. endpointFilter_status :: Lens' EndpointFilter (Maybe EndpointStatus) -- | Specifies information about the specified endpoint. For information -- about endpoints, see Managing endpoints. -- -- See: newEndpointProperties smart constructor. data EndpointProperties EndpointProperties' :: Maybe POSIX -> Maybe Natural -> Maybe Text -> Maybe Text -> Maybe Natural -> Maybe Text -> Maybe Text -> Maybe POSIX -> Maybe Text -> Maybe Text -> Maybe EndpointStatus -> EndpointProperties -- | The creation date and time of the endpoint. [$sel:creationTime:EndpointProperties'] :: EndpointProperties -> Maybe POSIX -- | The number of inference units currently used by the model using this -- endpoint. [$sel:currentInferenceUnits:EndpointProperties'] :: EndpointProperties -> Maybe Natural -- | The Amazon Resource Name (ARN) of the AWS identity and Access -- Management (IAM) role that grants Amazon Comprehend read access to -- trained custom models encrypted with a customer managed key -- (ModelKmsKeyId). [$sel:dataAccessRoleArn:EndpointProperties'] :: EndpointProperties -> Maybe Text -- | Data access role ARN to use in case the new model is encrypted with a -- customer KMS key. [$sel:desiredDataAccessRoleArn:EndpointProperties'] :: EndpointProperties -> Maybe Text -- | The desired number of inference units to be used by the model using -- this endpoint. Each inference unit represents of a throughput of 100 -- characters per second. [$sel:desiredInferenceUnits:EndpointProperties'] :: EndpointProperties -> Maybe Natural -- | ARN of the new model to use for updating an existing endpoint. This -- ARN is going to be different from the model ARN when the update is in -- progress [$sel:desiredModelArn:EndpointProperties'] :: EndpointProperties -> Maybe Text -- | The Amazon Resource Number (ARN) of the endpoint. [$sel:endpointArn:EndpointProperties'] :: EndpointProperties -> Maybe Text -- | The date and time that the endpoint was last modified. [$sel:lastModifiedTime:EndpointProperties'] :: EndpointProperties -> Maybe POSIX -- | Specifies a reason for failure in cases of Failed status. [$sel:message:EndpointProperties'] :: EndpointProperties -> Maybe Text -- | The Amazon Resource Number (ARN) of the model to which the endpoint is -- attached. [$sel:modelArn:EndpointProperties'] :: EndpointProperties -> Maybe Text -- | Specifies the status of the endpoint. Because the endpoint updates and -- creation are asynchronous, so customers will need to wait for the -- endpoint to be Ready status before making inference requests. [$sel:status:EndpointProperties'] :: EndpointProperties -> Maybe EndpointStatus -- | Create a value of EndpointProperties with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:creationTime:EndpointProperties', -- endpointProperties_creationTime - The creation date and time of -- the endpoint. -- -- $sel:currentInferenceUnits:EndpointProperties', -- endpointProperties_currentInferenceUnits - The number of -- inference units currently used by the model using this endpoint. -- -- $sel:dataAccessRoleArn:EndpointProperties', -- endpointProperties_dataAccessRoleArn - The Amazon Resource Name -- (ARN) of the AWS identity and Access Management (IAM) role that grants -- Amazon Comprehend read access to trained custom models encrypted with -- a customer managed key (ModelKmsKeyId). -- -- $sel:desiredDataAccessRoleArn:EndpointProperties', -- endpointProperties_desiredDataAccessRoleArn - Data access role -- ARN to use in case the new model is encrypted with a customer KMS key. -- -- $sel:desiredInferenceUnits:EndpointProperties', -- endpointProperties_desiredInferenceUnits - The desired number -- of inference units to be used by the model using this endpoint. Each -- inference unit represents of a throughput of 100 characters per -- second. -- -- $sel:desiredModelArn:EndpointProperties', -- endpointProperties_desiredModelArn - ARN of the new model to -- use for updating an existing endpoint. This ARN is going to be -- different from the model ARN when the update is in progress -- -- $sel:endpointArn:EndpointProperties', -- endpointProperties_endpointArn - The Amazon Resource Number -- (ARN) of the endpoint. -- -- $sel:lastModifiedTime:EndpointProperties', -- endpointProperties_lastModifiedTime - The date and time that -- the endpoint was last modified. -- -- $sel:message:EndpointProperties', -- endpointProperties_message - Specifies a reason for failure in -- cases of Failed status. -- -- $sel:modelArn:EndpointProperties', -- endpointProperties_modelArn - The Amazon Resource Number (ARN) -- of the model to which the endpoint is attached. -- -- $sel:status:EndpointProperties', -- endpointProperties_status - Specifies the status of the -- endpoint. Because the endpoint updates and creation are asynchronous, -- so customers will need to wait for the endpoint to be Ready -- status before making inference requests. newEndpointProperties :: EndpointProperties -- | The creation date and time of the endpoint. endpointProperties_creationTime :: Lens' EndpointProperties (Maybe UTCTime) -- | The number of inference units currently used by the model using this -- endpoint. endpointProperties_currentInferenceUnits :: Lens' EndpointProperties (Maybe Natural) -- | The Amazon Resource Name (ARN) of the AWS identity and Access -- Management (IAM) role that grants Amazon Comprehend read access to -- trained custom models encrypted with a customer managed key -- (ModelKmsKeyId). endpointProperties_dataAccessRoleArn :: Lens' EndpointProperties (Maybe Text) -- | Data access role ARN to use in case the new model is encrypted with a -- customer KMS key. endpointProperties_desiredDataAccessRoleArn :: Lens' EndpointProperties (Maybe Text) -- | The desired number of inference units to be used by the model using -- this endpoint. Each inference unit represents of a throughput of 100 -- characters per second. endpointProperties_desiredInferenceUnits :: Lens' EndpointProperties (Maybe Natural) -- | ARN of the new model to use for updating an existing endpoint. This -- ARN is going to be different from the model ARN when the update is in -- progress endpointProperties_desiredModelArn :: Lens' EndpointProperties (Maybe Text) -- | The Amazon Resource Number (ARN) of the endpoint. endpointProperties_endpointArn :: Lens' EndpointProperties (Maybe Text) -- | The date and time that the endpoint was last modified. endpointProperties_lastModifiedTime :: Lens' EndpointProperties (Maybe UTCTime) -- | Specifies a reason for failure in cases of Failed status. endpointProperties_message :: Lens' EndpointProperties (Maybe Text) -- | The Amazon Resource Number (ARN) of the model to which the endpoint is -- attached. endpointProperties_modelArn :: Lens' EndpointProperties (Maybe Text) -- | Specifies the status of the endpoint. Because the endpoint updates and -- creation are asynchronous, so customers will need to wait for the -- endpoint to be Ready status before making inference requests. endpointProperties_status :: Lens' EndpointProperties (Maybe EndpointStatus) -- | Provides information for filtering a list of dominant language -- detection jobs. For more information, see the operation. -- -- See: newEntitiesDetectionJobFilter smart constructor. data EntitiesDetectionJobFilter EntitiesDetectionJobFilter' :: Maybe Text -> Maybe JobStatus -> Maybe POSIX -> Maybe POSIX -> EntitiesDetectionJobFilter -- | Filters on the name of the job. [$sel:jobName:EntitiesDetectionJobFilter'] :: EntitiesDetectionJobFilter -> Maybe Text -- | Filters the list of jobs based on job status. Returns only jobs with -- the specified status. [$sel:jobStatus:EntitiesDetectionJobFilter'] :: EntitiesDetectionJobFilter -> Maybe JobStatus -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. [$sel:submitTimeAfter:EntitiesDetectionJobFilter'] :: EntitiesDetectionJobFilter -> Maybe POSIX -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. [$sel:submitTimeBefore:EntitiesDetectionJobFilter'] :: EntitiesDetectionJobFilter -> Maybe POSIX -- | Create a value of EntitiesDetectionJobFilter with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:jobName:EntitiesDetectionJobFilter', -- entitiesDetectionJobFilter_jobName - Filters on the name of the -- job. -- -- $sel:jobStatus:EntitiesDetectionJobFilter', -- entitiesDetectionJobFilter_jobStatus - Filters the list of jobs -- based on job status. Returns only jobs with the specified status. -- -- $sel:submitTimeAfter:EntitiesDetectionJobFilter', -- entitiesDetectionJobFilter_submitTimeAfter - Filters the list -- of jobs based on the time that the job was submitted for processing. -- Returns only jobs submitted after the specified time. Jobs are -- returned in descending order, newest to oldest. -- -- $sel:submitTimeBefore:EntitiesDetectionJobFilter', -- entitiesDetectionJobFilter_submitTimeBefore - Filters the list -- of jobs based on the time that the job was submitted for processing. -- Returns only jobs submitted before the specified time. Jobs are -- returned in ascending order, oldest to newest. newEntitiesDetectionJobFilter :: EntitiesDetectionJobFilter -- | Filters on the name of the job. entitiesDetectionJobFilter_jobName :: Lens' EntitiesDetectionJobFilter (Maybe Text) -- | Filters the list of jobs based on job status. Returns only jobs with -- the specified status. entitiesDetectionJobFilter_jobStatus :: Lens' EntitiesDetectionJobFilter (Maybe JobStatus) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. entitiesDetectionJobFilter_submitTimeAfter :: Lens' EntitiesDetectionJobFilter (Maybe UTCTime) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. entitiesDetectionJobFilter_submitTimeBefore :: Lens' EntitiesDetectionJobFilter (Maybe UTCTime) -- | Provides information about an entities detection job. -- -- See: newEntitiesDetectionJobProperties smart -- constructor. data EntitiesDetectionJobProperties EntitiesDetectionJobProperties' :: Maybe Text -> Maybe POSIX -> Maybe Text -> Maybe InputDataConfig -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe JobStatus -> Maybe LanguageCode -> Maybe Text -> Maybe OutputDataConfig -> Maybe POSIX -> Maybe Text -> Maybe VpcConfig -> EntitiesDetectionJobProperties -- | The Amazon Resource Name (ARN) that gives Amazon Comprehend read -- access to your input data. [$sel:dataAccessRoleArn:EntitiesDetectionJobProperties'] :: EntitiesDetectionJobProperties -> Maybe Text -- | The time that the entities detection job completed [$sel:endTime:EntitiesDetectionJobProperties'] :: EntitiesDetectionJobProperties -> Maybe POSIX -- | The Amazon Resource Name (ARN) that identifies the entity recognizer. [$sel:entityRecognizerArn:EntitiesDetectionJobProperties'] :: EntitiesDetectionJobProperties -> Maybe Text -- | The input data configuration that you supplied when you created the -- entities detection job. [$sel:inputDataConfig:EntitiesDetectionJobProperties'] :: EntitiesDetectionJobProperties -> Maybe InputDataConfig -- | The Amazon Resource Name (ARN) of the entities detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
--
[$sel:jobArn:EntitiesDetectionJobProperties'] :: EntitiesDetectionJobProperties -> Maybe Text -- | The identifier assigned to the entities detection job. [$sel:jobId:EntitiesDetectionJobProperties'] :: EntitiesDetectionJobProperties -> Maybe Text -- | The name that you assigned the entities detection job. [$sel:jobName:EntitiesDetectionJobProperties'] :: EntitiesDetectionJobProperties -> Maybe Text -- | The current status of the entities detection job. If the status is -- FAILED, the Message field shows the reason for the -- failure. [$sel:jobStatus:EntitiesDetectionJobProperties'] :: EntitiesDetectionJobProperties -> Maybe JobStatus -- | The language code of the input documents. [$sel:languageCode:EntitiesDetectionJobProperties'] :: EntitiesDetectionJobProperties -> Maybe LanguageCode -- | A description of the status of a job. [$sel:message:EntitiesDetectionJobProperties'] :: EntitiesDetectionJobProperties -> Maybe Text -- | The output data configuration that you supplied when you created the -- entities detection job. [$sel:outputDataConfig:EntitiesDetectionJobProperties'] :: EntitiesDetectionJobProperties -> Maybe OutputDataConfig -- | The time that the entities detection job was submitted for processing. [$sel:submitTime:EntitiesDetectionJobProperties'] :: EntitiesDetectionJobProperties -> Maybe POSIX -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- [$sel:volumeKmsKeyId:EntitiesDetectionJobProperties'] :: EntitiesDetectionJobProperties -> Maybe Text -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your entity detection job. -- For more information, see Amazon VPC. [$sel:vpcConfig:EntitiesDetectionJobProperties'] :: EntitiesDetectionJobProperties -> Maybe VpcConfig -- | Create a value of EntitiesDetectionJobProperties with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:dataAccessRoleArn:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_dataAccessRoleArn - The Amazon -- Resource Name (ARN) that gives Amazon Comprehend read access to your -- input data. -- -- $sel:endTime:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_endTime - The time that the -- entities detection job completed -- -- $sel:entityRecognizerArn:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_entityRecognizerArn - The Amazon -- Resource Name (ARN) that identifies the entity recognizer. -- -- $sel:inputDataConfig:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_inputDataConfig - The input data -- configuration that you supplied when you created the entities -- detection job. -- -- $sel:jobArn:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_jobArn - The Amazon Resource -- Name (ARN) of the entities detection job. It is a unique, fully -- qualified identifier for the job. It includes the AWS account, Region, -- and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- $sel:jobId:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_jobId - The identifier assigned -- to the entities detection job. -- -- $sel:jobName:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_jobName - The name that you -- assigned the entities detection job. -- -- $sel:jobStatus:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_jobStatus - The current status -- of the entities detection job. If the status is FAILED, the -- Message field shows the reason for the failure. -- -- $sel:languageCode:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_languageCode - The language code -- of the input documents. -- -- $sel:message:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_message - A description of the -- status of a job. -- -- $sel:outputDataConfig:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_outputDataConfig - The output -- data configuration that you supplied when you created the entities -- detection job. -- -- $sel:submitTime:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_submitTime - The time that the -- entities detection job was submitted for processing. -- -- $sel:volumeKmsKeyId:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_volumeKmsKeyId - ID for the AWS -- Key Management Service (KMS) key that Amazon Comprehend uses to -- encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- -- -- $sel:vpcConfig:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_vpcConfig - Configuration -- parameters for a private Virtual Private Cloud (VPC) containing the -- resources you are using for your entity detection job. For more -- information, see Amazon VPC. newEntitiesDetectionJobProperties :: EntitiesDetectionJobProperties -- | The Amazon Resource Name (ARN) that gives Amazon Comprehend read -- access to your input data. entitiesDetectionJobProperties_dataAccessRoleArn :: Lens' EntitiesDetectionJobProperties (Maybe Text) -- | The time that the entities detection job completed entitiesDetectionJobProperties_endTime :: Lens' EntitiesDetectionJobProperties (Maybe UTCTime) -- | The Amazon Resource Name (ARN) that identifies the entity recognizer. entitiesDetectionJobProperties_entityRecognizerArn :: Lens' EntitiesDetectionJobProperties (Maybe Text) -- | The input data configuration that you supplied when you created the -- entities detection job. entitiesDetectionJobProperties_inputDataConfig :: Lens' EntitiesDetectionJobProperties (Maybe InputDataConfig) -- | The Amazon Resource Name (ARN) of the entities detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
--
entitiesDetectionJobProperties_jobArn :: Lens' EntitiesDetectionJobProperties (Maybe Text) -- | The identifier assigned to the entities detection job. entitiesDetectionJobProperties_jobId :: Lens' EntitiesDetectionJobProperties (Maybe Text) -- | The name that you assigned the entities detection job. entitiesDetectionJobProperties_jobName :: Lens' EntitiesDetectionJobProperties (Maybe Text) -- | The current status of the entities detection job. If the status is -- FAILED, the Message field shows the reason for the -- failure. entitiesDetectionJobProperties_jobStatus :: Lens' EntitiesDetectionJobProperties (Maybe JobStatus) -- | The language code of the input documents. entitiesDetectionJobProperties_languageCode :: Lens' EntitiesDetectionJobProperties (Maybe LanguageCode) -- | A description of the status of a job. entitiesDetectionJobProperties_message :: Lens' EntitiesDetectionJobProperties (Maybe Text) -- | The output data configuration that you supplied when you created the -- entities detection job. entitiesDetectionJobProperties_outputDataConfig :: Lens' EntitiesDetectionJobProperties (Maybe OutputDataConfig) -- | The time that the entities detection job was submitted for processing. entitiesDetectionJobProperties_submitTime :: Lens' EntitiesDetectionJobProperties (Maybe UTCTime) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- entitiesDetectionJobProperties_volumeKmsKeyId :: Lens' EntitiesDetectionJobProperties (Maybe Text) -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your entity detection job. -- For more information, see Amazon VPC. entitiesDetectionJobProperties_vpcConfig :: Lens' EntitiesDetectionJobProperties (Maybe VpcConfig) -- | Provides information about an entity. -- -- See: newEntity smart constructor. data Entity Entity' :: Maybe Int -> Maybe [BlockReference] -> Maybe Int -> Maybe Double -> Maybe Text -> Maybe EntityType -> Entity -- | The zero-based offset from the beginning of the source text to the -- first character in the entity. -- -- This field is empty for non-text input. [$sel:beginOffset:Entity'] :: Entity -> Maybe Int -- | A reference to each block for this entity. This field is empty for -- plain-text input. [$sel:blockReferences:Entity'] :: Entity -> Maybe [BlockReference] -- | The zero-based offset from the beginning of the source text to the -- last character in the entity. -- -- This field is empty for non-text input. [$sel:endOffset:Entity'] :: Entity -> Maybe Int -- | The level of confidence that Amazon Comprehend has in the accuracy of -- the detection. [$sel:score:Entity'] :: Entity -> Maybe Double -- | The text of the entity. [$sel:text:Entity'] :: Entity -> Maybe Text -- | The entity type. For entity detection using the built-in model, this -- field contains one of the standard entity types listed below. -- -- For custom entity detection, this field contains one of the entity -- types that you specified when you trained your custom model. [$sel:type':Entity'] :: Entity -> Maybe EntityType -- | Create a value of Entity with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- Entity, entity_beginOffset - The zero-based offset from -- the beginning of the source text to the first character in the entity. -- -- This field is empty for non-text input. -- -- $sel:blockReferences:Entity', entity_blockReferences - A -- reference to each block for this entity. This field is empty for -- plain-text input. -- -- Entity, entity_endOffset - The zero-based offset from -- the beginning of the source text to the last character in the entity. -- -- This field is empty for non-text input. -- -- $sel:score:Entity', entity_score - The level of -- confidence that Amazon Comprehend has in the accuracy of the -- detection. -- -- $sel:text:Entity', entity_text - The text of the entity. -- -- $sel:type':Entity', entity_type - The entity type. For -- entity detection using the built-in model, this field contains one of -- the standard entity types listed below. -- -- For custom entity detection, this field contains one of the entity -- types that you specified when you trained your custom model. newEntity :: Entity -- | The zero-based offset from the beginning of the source text to the -- first character in the entity. -- -- This field is empty for non-text input. entity_beginOffset :: Lens' Entity (Maybe Int) -- | A reference to each block for this entity. This field is empty for -- plain-text input. entity_blockReferences :: Lens' Entity (Maybe [BlockReference]) -- | The zero-based offset from the beginning of the source text to the -- last character in the entity. -- -- This field is empty for non-text input. entity_endOffset :: Lens' Entity (Maybe Int) -- | The level of confidence that Amazon Comprehend has in the accuracy of -- the detection. entity_score :: Lens' Entity (Maybe Double) -- | The text of the entity. entity_text :: Lens' Entity (Maybe Text) -- | The entity type. For entity detection using the built-in model, this -- field contains one of the standard entity types listed below. -- -- For custom entity detection, this field contains one of the entity -- types that you specified when you trained your custom model. entity_type :: Lens' Entity (Maybe EntityType) -- | Specifies one of the label or labels that categorize the personally -- identifiable information (PII) entity being analyzed. -- -- See: newEntityLabel smart constructor. data EntityLabel EntityLabel' :: Maybe PiiEntityType -> Maybe Double -> EntityLabel -- | The name of the label. [$sel:name:EntityLabel'] :: EntityLabel -> Maybe PiiEntityType -- | The level of confidence that Amazon Comprehend has in the accuracy of -- the detection. [$sel:score:EntityLabel'] :: EntityLabel -> Maybe Double -- | Create a value of EntityLabel with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:name:EntityLabel', entityLabel_name - The name of -- the label. -- -- $sel:score:EntityLabel', entityLabel_score - The level -- of confidence that Amazon Comprehend has in the accuracy of the -- detection. newEntityLabel :: EntityLabel -- | The name of the label. entityLabel_name :: Lens' EntityLabel (Maybe PiiEntityType) -- | The level of confidence that Amazon Comprehend has in the accuracy of -- the detection. entityLabel_score :: Lens' EntityLabel (Maybe Double) -- | Describes the annotations associated with a entity recognizer. -- -- See: newEntityRecognizerAnnotations smart constructor. data EntityRecognizerAnnotations EntityRecognizerAnnotations' :: Maybe Text -> Text -> EntityRecognizerAnnotations -- | Specifies the Amazon S3 location where the test annotations for an -- entity recognizer are located. The URI must be in the same region as -- the API endpoint that you are calling. [$sel:testS3Uri:EntityRecognizerAnnotations'] :: EntityRecognizerAnnotations -> Maybe Text -- | Specifies the Amazon S3 location where the annotations for an entity -- recognizer are located. The URI must be in the same region as the API -- endpoint that you are calling. [$sel:s3Uri:EntityRecognizerAnnotations'] :: EntityRecognizerAnnotations -> Text -- | Create a value of EntityRecognizerAnnotations with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:testS3Uri:EntityRecognizerAnnotations', -- entityRecognizerAnnotations_testS3Uri - Specifies the Amazon S3 -- location where the test annotations for an entity recognizer are -- located. The URI must be in the same region as the API endpoint that -- you are calling. -- -- $sel:s3Uri:EntityRecognizerAnnotations', -- entityRecognizerAnnotations_s3Uri - Specifies the Amazon S3 -- location where the annotations for an entity recognizer are located. -- The URI must be in the same region as the API endpoint that you are -- calling. newEntityRecognizerAnnotations :: Text -> EntityRecognizerAnnotations -- | Specifies the Amazon S3 location where the test annotations for an -- entity recognizer are located. The URI must be in the same region as -- the API endpoint that you are calling. entityRecognizerAnnotations_testS3Uri :: Lens' EntityRecognizerAnnotations (Maybe Text) -- | Specifies the Amazon S3 location where the annotations for an entity -- recognizer are located. The URI must be in the same region as the API -- endpoint that you are calling. entityRecognizerAnnotations_s3Uri :: Lens' EntityRecognizerAnnotations Text -- | Describes the training documents submitted with an entity recognizer. -- -- See: newEntityRecognizerDocuments smart constructor. data EntityRecognizerDocuments EntityRecognizerDocuments' :: Maybe InputFormat -> Maybe Text -> Text -> EntityRecognizerDocuments -- | Specifies how the text in an input file should be processed. This is -- optional, and the default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each -- file is considered a separate document. Use this option when you are -- processing large documents, such as newspaper articles or scientific -- papers. ONE_DOC_PER_LINE - Each line in a file is considered a -- separate document. Use this option when you are processing many short -- documents, such as text messages. [$sel:inputFormat:EntityRecognizerDocuments'] :: EntityRecognizerDocuments -> Maybe InputFormat -- | Specifies the Amazon S3 location where the test documents for an -- entity recognizer are located. The URI must be in the same AWS Region -- as the API endpoint that you are calling. [$sel:testS3Uri:EntityRecognizerDocuments'] :: EntityRecognizerDocuments -> Maybe Text -- | Specifies the Amazon S3 location where the training documents for an -- entity recognizer are located. The URI must be in the same region as -- the API endpoint that you are calling. [$sel:s3Uri:EntityRecognizerDocuments'] :: EntityRecognizerDocuments -> Text -- | Create a value of EntityRecognizerDocuments with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:inputFormat:EntityRecognizerDocuments', -- entityRecognizerDocuments_inputFormat - Specifies how the text -- in an input file should be processed. This is optional, and the -- default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is -- considered a separate document. Use this option when you are -- processing large documents, such as newspaper articles or scientific -- papers. ONE_DOC_PER_LINE - Each line in a file is considered a -- separate document. Use this option when you are processing many short -- documents, such as text messages. -- -- $sel:testS3Uri:EntityRecognizerDocuments', -- entityRecognizerDocuments_testS3Uri - Specifies the Amazon S3 -- location where the test documents for an entity recognizer are -- located. The URI must be in the same AWS Region as the API endpoint -- that you are calling. -- -- $sel:s3Uri:EntityRecognizerDocuments', -- entityRecognizerDocuments_s3Uri - Specifies the Amazon S3 -- location where the training documents for an entity recognizer are -- located. The URI must be in the same region as the API endpoint that -- you are calling. newEntityRecognizerDocuments :: Text -> EntityRecognizerDocuments -- | Specifies how the text in an input file should be processed. This is -- optional, and the default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each -- file is considered a separate document. Use this option when you are -- processing large documents, such as newspaper articles or scientific -- papers. ONE_DOC_PER_LINE - Each line in a file is considered a -- separate document. Use this option when you are processing many short -- documents, such as text messages. entityRecognizerDocuments_inputFormat :: Lens' EntityRecognizerDocuments (Maybe InputFormat) -- | Specifies the Amazon S3 location where the test documents for an -- entity recognizer are located. The URI must be in the same AWS Region -- as the API endpoint that you are calling. entityRecognizerDocuments_testS3Uri :: Lens' EntityRecognizerDocuments (Maybe Text) -- | Specifies the Amazon S3 location where the training documents for an -- entity recognizer are located. The URI must be in the same region as -- the API endpoint that you are calling. entityRecognizerDocuments_s3Uri :: Lens' EntityRecognizerDocuments Text -- | Describes the entity recognizer submitted with an entity recognizer. -- -- See: newEntityRecognizerEntityList smart constructor. data EntityRecognizerEntityList EntityRecognizerEntityList' :: Text -> EntityRecognizerEntityList -- | Specifies the Amazon S3 location where the entity list is located. The -- URI must be in the same region as the API endpoint that you are -- calling. [$sel:s3Uri:EntityRecognizerEntityList'] :: EntityRecognizerEntityList -> Text -- | Create a value of EntityRecognizerEntityList with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:s3Uri:EntityRecognizerEntityList', -- entityRecognizerEntityList_s3Uri - Specifies the Amazon S3 -- location where the entity list is located. The URI must be in the same -- region as the API endpoint that you are calling. newEntityRecognizerEntityList :: Text -> EntityRecognizerEntityList -- | Specifies the Amazon S3 location where the entity list is located. The -- URI must be in the same region as the API endpoint that you are -- calling. entityRecognizerEntityList_s3Uri :: Lens' EntityRecognizerEntityList Text -- | Detailed information about the accuracy of an entity recognizer. -- -- See: newEntityRecognizerEvaluationMetrics smart -- constructor. data EntityRecognizerEvaluationMetrics EntityRecognizerEvaluationMetrics' :: Maybe Double -> Maybe Double -> Maybe Double -> EntityRecognizerEvaluationMetrics -- | A measure of how accurate the recognizer results are for the test -- data. It is derived from the Precision and Recall -- values. The F1Score is the harmonic average of the two -- scores. For plain text entity recognizer models, the range is 0 to -- 100, where 100 is the best score. For PDF/Word entity recognizer -- models, the range is 0 to 1, where 1 is the best score. [$sel:f1Score:EntityRecognizerEvaluationMetrics'] :: EntityRecognizerEvaluationMetrics -> Maybe Double -- | A measure of the usefulness of the recognizer results in the test -- data. High precision means that the recognizer returned substantially -- more relevant results than irrelevant ones. [$sel:precision:EntityRecognizerEvaluationMetrics'] :: EntityRecognizerEvaluationMetrics -> Maybe Double -- | A measure of how complete the recognizer results are for the test -- data. High recall means that the recognizer returned most of the -- relevant results. [$sel:recall:EntityRecognizerEvaluationMetrics'] :: EntityRecognizerEvaluationMetrics -> Maybe Double -- | Create a value of EntityRecognizerEvaluationMetrics with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:f1Score:EntityRecognizerEvaluationMetrics', -- entityRecognizerEvaluationMetrics_f1Score - A measure of how -- accurate the recognizer results are for the test data. It is derived -- from the Precision and Recall values. The -- F1Score is the harmonic average of the two scores. For plain -- text entity recognizer models, the range is 0 to 100, where 100 is the -- best score. For PDF/Word entity recognizer models, the range is 0 to -- 1, where 1 is the best score. -- -- $sel:precision:EntityRecognizerEvaluationMetrics', -- entityRecognizerEvaluationMetrics_precision - A measure of the -- usefulness of the recognizer results in the test data. High precision -- means that the recognizer returned substantially more relevant results -- than irrelevant ones. -- -- $sel:recall:EntityRecognizerEvaluationMetrics', -- entityRecognizerEvaluationMetrics_recall - A measure of how -- complete the recognizer results are for the test data. High recall -- means that the recognizer returned most of the relevant results. newEntityRecognizerEvaluationMetrics :: EntityRecognizerEvaluationMetrics -- | A measure of how accurate the recognizer results are for the test -- data. It is derived from the Precision and Recall -- values. The F1Score is the harmonic average of the two -- scores. For plain text entity recognizer models, the range is 0 to -- 100, where 100 is the best score. For PDF/Word entity recognizer -- models, the range is 0 to 1, where 1 is the best score. entityRecognizerEvaluationMetrics_f1Score :: Lens' EntityRecognizerEvaluationMetrics (Maybe Double) -- | A measure of the usefulness of the recognizer results in the test -- data. High precision means that the recognizer returned substantially -- more relevant results than irrelevant ones. entityRecognizerEvaluationMetrics_precision :: Lens' EntityRecognizerEvaluationMetrics (Maybe Double) -- | A measure of how complete the recognizer results are for the test -- data. High recall means that the recognizer returned most of the -- relevant results. entityRecognizerEvaluationMetrics_recall :: Lens' EntityRecognizerEvaluationMetrics (Maybe Double) -- | Provides information for filtering a list of entity recognizers. You -- can only specify one filtering parameter in a request. For more -- information, see the operation./> -- -- See: newEntityRecognizerFilter smart constructor. data EntityRecognizerFilter EntityRecognizerFilter' :: Maybe Text -> Maybe ModelStatus -> Maybe POSIX -> Maybe POSIX -> EntityRecognizerFilter -- | The name that you assigned the entity recognizer. [$sel:recognizerName:EntityRecognizerFilter'] :: EntityRecognizerFilter -> Maybe Text -- | The status of an entity recognizer. [$sel:status:EntityRecognizerFilter'] :: EntityRecognizerFilter -> Maybe ModelStatus -- | Filters the list of entities based on the time that the list was -- submitted for processing. Returns only jobs submitted after the -- specified time. Jobs are returned in ascending order, oldest to -- newest. [$sel:submitTimeAfter:EntityRecognizerFilter'] :: EntityRecognizerFilter -> Maybe POSIX -- | Filters the list of entities based on the time that the list was -- submitted for processing. Returns only jobs submitted before the -- specified time. Jobs are returned in descending order, newest to -- oldest. [$sel:submitTimeBefore:EntityRecognizerFilter'] :: EntityRecognizerFilter -> Maybe POSIX -- | Create a value of EntityRecognizerFilter with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:recognizerName:EntityRecognizerFilter', -- entityRecognizerFilter_recognizerName - The name that you -- assigned the entity recognizer. -- -- $sel:status:EntityRecognizerFilter', -- entityRecognizerFilter_status - The status of an entity -- recognizer. -- -- $sel:submitTimeAfter:EntityRecognizerFilter', -- entityRecognizerFilter_submitTimeAfter - Filters the list of -- entities based on the time that the list was submitted for processing. -- Returns only jobs submitted after the specified time. Jobs are -- returned in ascending order, oldest to newest. -- -- $sel:submitTimeBefore:EntityRecognizerFilter', -- entityRecognizerFilter_submitTimeBefore - Filters the list of -- entities based on the time that the list was submitted for processing. -- Returns only jobs submitted before the specified time. Jobs are -- returned in descending order, newest to oldest. newEntityRecognizerFilter :: EntityRecognizerFilter -- | The name that you assigned the entity recognizer. entityRecognizerFilter_recognizerName :: Lens' EntityRecognizerFilter (Maybe Text) -- | The status of an entity recognizer. entityRecognizerFilter_status :: Lens' EntityRecognizerFilter (Maybe ModelStatus) -- | Filters the list of entities based on the time that the list was -- submitted for processing. Returns only jobs submitted after the -- specified time. Jobs are returned in ascending order, oldest to -- newest. entityRecognizerFilter_submitTimeAfter :: Lens' EntityRecognizerFilter (Maybe UTCTime) -- | Filters the list of entities based on the time that the list was -- submitted for processing. Returns only jobs submitted before the -- specified time. Jobs are returned in descending order, newest to -- oldest. entityRecognizerFilter_submitTimeBefore :: Lens' EntityRecognizerFilter (Maybe UTCTime) -- | Specifies the format and location of the input data. -- -- See: newEntityRecognizerInputDataConfig smart -- constructor. data EntityRecognizerInputDataConfig EntityRecognizerInputDataConfig' :: Maybe EntityRecognizerAnnotations -> Maybe [AugmentedManifestsListItem] -> Maybe EntityRecognizerDataFormat -> Maybe EntityRecognizerDocuments -> Maybe EntityRecognizerEntityList -> [EntityTypesListItem] -> EntityRecognizerInputDataConfig -- | The S3 location of the CSV file that annotates your training -- documents. [$sel:annotations:EntityRecognizerInputDataConfig'] :: EntityRecognizerInputDataConfig -> Maybe EntityRecognizerAnnotations -- | A list of augmented manifest files that provide training data for your -- custom model. An augmented manifest file is a labeled dataset that is -- produced by Amazon SageMaker Ground Truth. -- -- This parameter is required if you set DataFormat to -- AUGMENTED_MANIFEST. [$sel:augmentedManifests:EntityRecognizerInputDataConfig'] :: EntityRecognizerInputDataConfig -> Maybe [AugmentedManifestsListItem] -- | The format of your training data: -- -- -- -- If you don't specify a value, Amazon Comprehend uses -- COMPREHEND_CSV as the default. [$sel:dataFormat:EntityRecognizerInputDataConfig'] :: EntityRecognizerInputDataConfig -> Maybe EntityRecognizerDataFormat -- | The S3 location of the folder that contains the training documents for -- your custom entity recognizer. -- -- This parameter is required if you set DataFormat to -- COMPREHEND_CSV. [$sel:documents:EntityRecognizerInputDataConfig'] :: EntityRecognizerInputDataConfig -> Maybe EntityRecognizerDocuments -- | The S3 location of the CSV file that has the entity list for your -- custom entity recognizer. [$sel:entityList:EntityRecognizerInputDataConfig'] :: EntityRecognizerInputDataConfig -> Maybe EntityRecognizerEntityList -- | The entity types in the labeled training data that Amazon Comprehend -- uses to train the custom entity recognizer. Any entity types that you -- don't specify are ignored. -- -- A maximum of 25 entity types can be used at one time to train an -- entity recognizer. Entity types must not contain the following invalid -- characters: \n (line break), \\n (escaped line break), \r (carriage -- return), \\r (escaped carriage return), \t (tab), \\t (escaped tab), -- space, and , (comma). [$sel:entityTypes:EntityRecognizerInputDataConfig'] :: EntityRecognizerInputDataConfig -> [EntityTypesListItem] -- | Create a value of EntityRecognizerInputDataConfig with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:annotations:EntityRecognizerInputDataConfig', -- entityRecognizerInputDataConfig_annotations - The S3 location -- of the CSV file that annotates your training documents. -- -- $sel:augmentedManifests:EntityRecognizerInputDataConfig', -- entityRecognizerInputDataConfig_augmentedManifests - A list of -- augmented manifest files that provide training data for your custom -- model. An augmented manifest file is a labeled dataset that is -- produced by Amazon SageMaker Ground Truth. -- -- This parameter is required if you set DataFormat to -- AUGMENTED_MANIFEST. -- -- $sel:dataFormat:EntityRecognizerInputDataConfig', -- entityRecognizerInputDataConfig_dataFormat - The format of your -- training data: -- -- -- -- If you don't specify a value, Amazon Comprehend uses -- COMPREHEND_CSV as the default. -- -- $sel:documents:EntityRecognizerInputDataConfig', -- entityRecognizerInputDataConfig_documents - The S3 location of -- the folder that contains the training documents for your custom entity -- recognizer. -- -- This parameter is required if you set DataFormat to -- COMPREHEND_CSV. -- -- $sel:entityList:EntityRecognizerInputDataConfig', -- entityRecognizerInputDataConfig_entityList - The S3 location of -- the CSV file that has the entity list for your custom entity -- recognizer. -- -- $sel:entityTypes:EntityRecognizerInputDataConfig', -- entityRecognizerInputDataConfig_entityTypes - The entity types -- in the labeled training data that Amazon Comprehend uses to train the -- custom entity recognizer. Any entity types that you don't specify are -- ignored. -- -- A maximum of 25 entity types can be used at one time to train an -- entity recognizer. Entity types must not contain the following invalid -- characters: \n (line break), \\n (escaped line break), \r (carriage -- return), \\r (escaped carriage return), \t (tab), \\t (escaped tab), -- space, and , (comma). newEntityRecognizerInputDataConfig :: EntityRecognizerInputDataConfig -- | The S3 location of the CSV file that annotates your training -- documents. entityRecognizerInputDataConfig_annotations :: Lens' EntityRecognizerInputDataConfig (Maybe EntityRecognizerAnnotations) -- | A list of augmented manifest files that provide training data for your -- custom model. An augmented manifest file is a labeled dataset that is -- produced by Amazon SageMaker Ground Truth. -- -- This parameter is required if you set DataFormat to -- AUGMENTED_MANIFEST. entityRecognizerInputDataConfig_augmentedManifests :: Lens' EntityRecognizerInputDataConfig (Maybe [AugmentedManifestsListItem]) -- | The format of your training data: -- -- -- -- If you don't specify a value, Amazon Comprehend uses -- COMPREHEND_CSV as the default. entityRecognizerInputDataConfig_dataFormat :: Lens' EntityRecognizerInputDataConfig (Maybe EntityRecognizerDataFormat) -- | The S3 location of the folder that contains the training documents for -- your custom entity recognizer. -- -- This parameter is required if you set DataFormat to -- COMPREHEND_CSV. entityRecognizerInputDataConfig_documents :: Lens' EntityRecognizerInputDataConfig (Maybe EntityRecognizerDocuments) -- | The S3 location of the CSV file that has the entity list for your -- custom entity recognizer. entityRecognizerInputDataConfig_entityList :: Lens' EntityRecognizerInputDataConfig (Maybe EntityRecognizerEntityList) -- | The entity types in the labeled training data that Amazon Comprehend -- uses to train the custom entity recognizer. Any entity types that you -- don't specify are ignored. -- -- A maximum of 25 entity types can be used at one time to train an -- entity recognizer. Entity types must not contain the following invalid -- characters: \n (line break), \\n (escaped line break), \r (carriage -- return), \\r (escaped carriage return), \t (tab), \\t (escaped tab), -- space, and , (comma). entityRecognizerInputDataConfig_entityTypes :: Lens' EntityRecognizerInputDataConfig [EntityTypesListItem] -- | Detailed information about an entity recognizer. -- -- See: newEntityRecognizerMetadata smart constructor. data EntityRecognizerMetadata EntityRecognizerMetadata' :: Maybe [EntityRecognizerMetadataEntityTypesListItem] -> Maybe EntityRecognizerEvaluationMetrics -> Maybe Int -> Maybe Int -> EntityRecognizerMetadata -- | Entity types from the metadata of an entity recognizer. [$sel:entityTypes:EntityRecognizerMetadata'] :: EntityRecognizerMetadata -> Maybe [EntityRecognizerMetadataEntityTypesListItem] -- | Detailed information about the accuracy of an entity recognizer. [$sel:evaluationMetrics:EntityRecognizerMetadata'] :: EntityRecognizerMetadata -> Maybe EntityRecognizerEvaluationMetrics -- | The number of documents in the input data that were used to test the -- entity recognizer. Typically this is 10 to 20 percent of the input -- documents. [$sel:numberOfTestDocuments:EntityRecognizerMetadata'] :: EntityRecognizerMetadata -> Maybe Int -- | The number of documents in the input data that were used to train the -- entity recognizer. Typically this is 80 to 90 percent of the input -- documents. [$sel:numberOfTrainedDocuments:EntityRecognizerMetadata'] :: EntityRecognizerMetadata -> Maybe Int -- | Create a value of EntityRecognizerMetadata with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:entityTypes:EntityRecognizerMetadata', -- entityRecognizerMetadata_entityTypes - Entity types from the -- metadata of an entity recognizer. -- -- EntityRecognizerMetadata, -- entityRecognizerMetadata_evaluationMetrics - Detailed -- information about the accuracy of an entity recognizer. -- -- $sel:numberOfTestDocuments:EntityRecognizerMetadata', -- entityRecognizerMetadata_numberOfTestDocuments - The number of -- documents in the input data that were used to test the entity -- recognizer. Typically this is 10 to 20 percent of the input documents. -- -- $sel:numberOfTrainedDocuments:EntityRecognizerMetadata', -- entityRecognizerMetadata_numberOfTrainedDocuments - The number -- of documents in the input data that were used to train the entity -- recognizer. Typically this is 80 to 90 percent of the input documents. newEntityRecognizerMetadata :: EntityRecognizerMetadata -- | Entity types from the metadata of an entity recognizer. entityRecognizerMetadata_entityTypes :: Lens' EntityRecognizerMetadata (Maybe [EntityRecognizerMetadataEntityTypesListItem]) -- | Detailed information about the accuracy of an entity recognizer. entityRecognizerMetadata_evaluationMetrics :: Lens' EntityRecognizerMetadata (Maybe EntityRecognizerEvaluationMetrics) -- | The number of documents in the input data that were used to test the -- entity recognizer. Typically this is 10 to 20 percent of the input -- documents. entityRecognizerMetadata_numberOfTestDocuments :: Lens' EntityRecognizerMetadata (Maybe Int) -- | The number of documents in the input data that were used to train the -- entity recognizer. Typically this is 80 to 90 percent of the input -- documents. entityRecognizerMetadata_numberOfTrainedDocuments :: Lens' EntityRecognizerMetadata (Maybe Int) -- | Individual item from the list of entity types in the metadata of an -- entity recognizer. -- -- See: newEntityRecognizerMetadataEntityTypesListItem -- smart constructor. data EntityRecognizerMetadataEntityTypesListItem EntityRecognizerMetadataEntityTypesListItem' :: Maybe EntityTypesEvaluationMetrics -> Maybe Int -> Maybe Text -> EntityRecognizerMetadataEntityTypesListItem -- | Detailed information about the accuracy of the entity recognizer for a -- specific item on the list of entity types. [$sel:evaluationMetrics:EntityRecognizerMetadataEntityTypesListItem'] :: EntityRecognizerMetadataEntityTypesListItem -> Maybe EntityTypesEvaluationMetrics -- | Indicates the number of times the given entity type was seen in the -- training data. [$sel:numberOfTrainMentions:EntityRecognizerMetadataEntityTypesListItem'] :: EntityRecognizerMetadataEntityTypesListItem -> Maybe Int -- | Type of entity from the list of entity types in the metadata of an -- entity recognizer. [$sel:type':EntityRecognizerMetadataEntityTypesListItem'] :: EntityRecognizerMetadataEntityTypesListItem -> Maybe Text -- | Create a value of EntityRecognizerMetadataEntityTypesListItem -- with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:evaluationMetrics:EntityRecognizerMetadataEntityTypesListItem', -- entityRecognizerMetadataEntityTypesListItem_evaluationMetrics - -- Detailed information about the accuracy of the entity recognizer for a -- specific item on the list of entity types. -- -- -- $sel:numberOfTrainMentions:EntityRecognizerMetadataEntityTypesListItem', -- entityRecognizerMetadataEntityTypesListItem_numberOfTrainMentions -- - Indicates the number of times the given entity type was seen in the -- training data. -- -- $sel:type':EntityRecognizerMetadataEntityTypesListItem', -- entityRecognizerMetadataEntityTypesListItem_type - Type of -- entity from the list of entity types in the metadata of an entity -- recognizer. newEntityRecognizerMetadataEntityTypesListItem :: EntityRecognizerMetadataEntityTypesListItem -- | Detailed information about the accuracy of the entity recognizer for a -- specific item on the list of entity types. entityRecognizerMetadataEntityTypesListItem_evaluationMetrics :: Lens' EntityRecognizerMetadataEntityTypesListItem (Maybe EntityTypesEvaluationMetrics) -- | Indicates the number of times the given entity type was seen in the -- training data. entityRecognizerMetadataEntityTypesListItem_numberOfTrainMentions :: Lens' EntityRecognizerMetadataEntityTypesListItem (Maybe Int) -- | Type of entity from the list of entity types in the metadata of an -- entity recognizer. entityRecognizerMetadataEntityTypesListItem_type :: Lens' EntityRecognizerMetadataEntityTypesListItem (Maybe Text) -- | Describes information about an entity recognizer. -- -- See: newEntityRecognizerProperties smart constructor. data EntityRecognizerProperties EntityRecognizerProperties' :: Maybe Text -> Maybe POSIX -> Maybe Text -> Maybe EntityRecognizerInputDataConfig -> Maybe LanguageCode -> Maybe Text -> Maybe Text -> Maybe (Sensitive EntityRecognizerMetadata) -> Maybe Text -> Maybe ModelStatus -> Maybe POSIX -> Maybe POSIX -> Maybe POSIX -> Maybe Text -> Maybe Text -> Maybe VpcConfig -> EntityRecognizerProperties -- | The Amazon Resource Name (ARN) of the AWS Identity and Management -- (IAM) role that grants Amazon Comprehend read access to your input -- data. [$sel:dataAccessRoleArn:EntityRecognizerProperties'] :: EntityRecognizerProperties -> Maybe Text -- | The time that the recognizer creation completed. [$sel:endTime:EntityRecognizerProperties'] :: EntityRecognizerProperties -> Maybe POSIX -- | The Amazon Resource Name (ARN) that identifies the entity recognizer. [$sel:entityRecognizerArn:EntityRecognizerProperties'] :: EntityRecognizerProperties -> Maybe Text -- | The input data properties of an entity recognizer. [$sel:inputDataConfig:EntityRecognizerProperties'] :: EntityRecognizerProperties -> Maybe EntityRecognizerInputDataConfig -- | The language of the input documents. All documents must be in the same -- language. Only English ("en") is currently supported. [$sel:languageCode:EntityRecognizerProperties'] :: EntityRecognizerProperties -> Maybe LanguageCode -- | A description of the status of the recognizer. [$sel:message:EntityRecognizerProperties'] :: EntityRecognizerProperties -> Maybe Text -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt trained custom models. The ModelKmsKeyId can be either -- of the following formats: -- -- [$sel:modelKmsKeyId:EntityRecognizerProperties'] :: EntityRecognizerProperties -> Maybe Text -- | Provides information about an entity recognizer. [$sel:recognizerMetadata:EntityRecognizerProperties'] :: EntityRecognizerProperties -> Maybe (Sensitive EntityRecognizerMetadata) -- | The Amazon Resource Name (ARN) of the source model. This model was -- imported from a different AWS account to create the entity recognizer -- model in your AWS account. [$sel:sourceModelArn:EntityRecognizerProperties'] :: EntityRecognizerProperties -> Maybe Text -- | Provides the status of the entity recognizer. [$sel:status:EntityRecognizerProperties'] :: EntityRecognizerProperties -> Maybe ModelStatus -- | The time that the recognizer was submitted for processing. [$sel:submitTime:EntityRecognizerProperties'] :: EntityRecognizerProperties -> Maybe POSIX -- | The time that training of the entity recognizer was completed. [$sel:trainingEndTime:EntityRecognizerProperties'] :: EntityRecognizerProperties -> Maybe POSIX -- | The time that training of the entity recognizer started. [$sel:trainingStartTime:EntityRecognizerProperties'] :: EntityRecognizerProperties -> Maybe POSIX -- | The version name you assigned to the entity recognizer. [$sel:versionName:EntityRecognizerProperties'] :: EntityRecognizerProperties -> Maybe Text -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- [$sel:volumeKmsKeyId:EntityRecognizerProperties'] :: EntityRecognizerProperties -> Maybe Text -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your custom entity -- recognizer. For more information, see Amazon VPC. [$sel:vpcConfig:EntityRecognizerProperties'] :: EntityRecognizerProperties -> Maybe VpcConfig -- | Create a value of EntityRecognizerProperties with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:dataAccessRoleArn:EntityRecognizerProperties', -- entityRecognizerProperties_dataAccessRoleArn - The Amazon -- Resource Name (ARN) of the AWS Identity and Management (IAM) role that -- grants Amazon Comprehend read access to your input data. -- -- $sel:endTime:EntityRecognizerProperties', -- entityRecognizerProperties_endTime - The time that the -- recognizer creation completed. -- -- $sel:entityRecognizerArn:EntityRecognizerProperties', -- entityRecognizerProperties_entityRecognizerArn - The Amazon -- Resource Name (ARN) that identifies the entity recognizer. -- -- $sel:inputDataConfig:EntityRecognizerProperties', -- entityRecognizerProperties_inputDataConfig - The input data -- properties of an entity recognizer. -- -- $sel:languageCode:EntityRecognizerProperties', -- entityRecognizerProperties_languageCode - The language of the -- input documents. All documents must be in the same language. Only -- English ("en") is currently supported. -- -- $sel:message:EntityRecognizerProperties', -- entityRecognizerProperties_message - A description of the -- status of the recognizer. -- -- $sel:modelKmsKeyId:EntityRecognizerProperties', -- entityRecognizerProperties_modelKmsKeyId - ID for the AWS Key -- Management Service (KMS) key that Amazon Comprehend uses to encrypt -- trained custom models. The ModelKmsKeyId can be either of the -- following formats: -- -- -- -- $sel:recognizerMetadata:EntityRecognizerProperties', -- entityRecognizerProperties_recognizerMetadata - Provides -- information about an entity recognizer. -- -- $sel:sourceModelArn:EntityRecognizerProperties', -- entityRecognizerProperties_sourceModelArn - The Amazon Resource -- Name (ARN) of the source model. This model was imported from a -- different AWS account to create the entity recognizer model in your -- AWS account. -- -- $sel:status:EntityRecognizerProperties', -- entityRecognizerProperties_status - Provides the status of the -- entity recognizer. -- -- $sel:submitTime:EntityRecognizerProperties', -- entityRecognizerProperties_submitTime - The time that the -- recognizer was submitted for processing. -- -- $sel:trainingEndTime:EntityRecognizerProperties', -- entityRecognizerProperties_trainingEndTime - The time that -- training of the entity recognizer was completed. -- -- $sel:trainingStartTime:EntityRecognizerProperties', -- entityRecognizerProperties_trainingStartTime - The time that -- training of the entity recognizer started. -- -- $sel:versionName:EntityRecognizerProperties', -- entityRecognizerProperties_versionName - The version name you -- assigned to the entity recognizer. -- -- $sel:volumeKmsKeyId:EntityRecognizerProperties', -- entityRecognizerProperties_volumeKmsKeyId - ID for the AWS Key -- Management Service (KMS) key that Amazon Comprehend uses to encrypt -- data on the storage volume attached to the ML compute instance(s) that -- process the analysis job. The VolumeKmsKeyId can be either of the -- following formats: -- -- -- -- $sel:vpcConfig:EntityRecognizerProperties', -- entityRecognizerProperties_vpcConfig - Configuration parameters -- for a private Virtual Private Cloud (VPC) containing the resources you -- are using for your custom entity recognizer. For more information, see -- Amazon VPC. newEntityRecognizerProperties :: EntityRecognizerProperties -- | The Amazon Resource Name (ARN) of the AWS Identity and Management -- (IAM) role that grants Amazon Comprehend read access to your input -- data. entityRecognizerProperties_dataAccessRoleArn :: Lens' EntityRecognizerProperties (Maybe Text) -- | The time that the recognizer creation completed. entityRecognizerProperties_endTime :: Lens' EntityRecognizerProperties (Maybe UTCTime) -- | The Amazon Resource Name (ARN) that identifies the entity recognizer. entityRecognizerProperties_entityRecognizerArn :: Lens' EntityRecognizerProperties (Maybe Text) -- | The input data properties of an entity recognizer. entityRecognizerProperties_inputDataConfig :: Lens' EntityRecognizerProperties (Maybe EntityRecognizerInputDataConfig) -- | The language of the input documents. All documents must be in the same -- language. Only English ("en") is currently supported. entityRecognizerProperties_languageCode :: Lens' EntityRecognizerProperties (Maybe LanguageCode) -- | A description of the status of the recognizer. entityRecognizerProperties_message :: Lens' EntityRecognizerProperties (Maybe Text) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt trained custom models. The ModelKmsKeyId can be either -- of the following formats: -- -- entityRecognizerProperties_modelKmsKeyId :: Lens' EntityRecognizerProperties (Maybe Text) -- | Provides information about an entity recognizer. entityRecognizerProperties_recognizerMetadata :: Lens' EntityRecognizerProperties (Maybe EntityRecognizerMetadata) -- | The Amazon Resource Name (ARN) of the source model. This model was -- imported from a different AWS account to create the entity recognizer -- model in your AWS account. entityRecognizerProperties_sourceModelArn :: Lens' EntityRecognizerProperties (Maybe Text) -- | Provides the status of the entity recognizer. entityRecognizerProperties_status :: Lens' EntityRecognizerProperties (Maybe ModelStatus) -- | The time that the recognizer was submitted for processing. entityRecognizerProperties_submitTime :: Lens' EntityRecognizerProperties (Maybe UTCTime) -- | The time that training of the entity recognizer was completed. entityRecognizerProperties_trainingEndTime :: Lens' EntityRecognizerProperties (Maybe UTCTime) -- | The time that training of the entity recognizer started. entityRecognizerProperties_trainingStartTime :: Lens' EntityRecognizerProperties (Maybe UTCTime) -- | The version name you assigned to the entity recognizer. entityRecognizerProperties_versionName :: Lens' EntityRecognizerProperties (Maybe Text) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- entityRecognizerProperties_volumeKmsKeyId :: Lens' EntityRecognizerProperties (Maybe Text) -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your custom entity -- recognizer. For more information, see Amazon VPC. entityRecognizerProperties_vpcConfig :: Lens' EntityRecognizerProperties (Maybe VpcConfig) -- | Describes the information about an entity recognizer and its versions. -- -- See: newEntityRecognizerSummary smart constructor. data EntityRecognizerSummary EntityRecognizerSummary' :: Maybe POSIX -> Maybe Text -> Maybe ModelStatus -> Maybe Int -> Maybe Text -> EntityRecognizerSummary -- | The time that the latest entity recognizer version was submitted for -- processing. [$sel:latestVersionCreatedAt:EntityRecognizerSummary'] :: EntityRecognizerSummary -> Maybe POSIX -- | The version name you assigned to the latest entity recognizer version. [$sel:latestVersionName:EntityRecognizerSummary'] :: EntityRecognizerSummary -> Maybe Text -- | Provides the status of the latest entity recognizer version. [$sel:latestVersionStatus:EntityRecognizerSummary'] :: EntityRecognizerSummary -> Maybe ModelStatus -- | The number of versions you created. [$sel:numberOfVersions:EntityRecognizerSummary'] :: EntityRecognizerSummary -> Maybe Int -- | The name that you assigned the entity recognizer. [$sel:recognizerName:EntityRecognizerSummary'] :: EntityRecognizerSummary -> Maybe Text -- | Create a value of EntityRecognizerSummary with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:latestVersionCreatedAt:EntityRecognizerSummary', -- entityRecognizerSummary_latestVersionCreatedAt - The time that -- the latest entity recognizer version was submitted for processing. -- -- $sel:latestVersionName:EntityRecognizerSummary', -- entityRecognizerSummary_latestVersionName - The version name -- you assigned to the latest entity recognizer version. -- -- $sel:latestVersionStatus:EntityRecognizerSummary', -- entityRecognizerSummary_latestVersionStatus - Provides the -- status of the latest entity recognizer version. -- -- $sel:numberOfVersions:EntityRecognizerSummary', -- entityRecognizerSummary_numberOfVersions - The number of -- versions you created. -- -- $sel:recognizerName:EntityRecognizerSummary', -- entityRecognizerSummary_recognizerName - The name that you -- assigned the entity recognizer. newEntityRecognizerSummary :: EntityRecognizerSummary -- | The time that the latest entity recognizer version was submitted for -- processing. entityRecognizerSummary_latestVersionCreatedAt :: Lens' EntityRecognizerSummary (Maybe UTCTime) -- | The version name you assigned to the latest entity recognizer version. entityRecognizerSummary_latestVersionName :: Lens' EntityRecognizerSummary (Maybe Text) -- | Provides the status of the latest entity recognizer version. entityRecognizerSummary_latestVersionStatus :: Lens' EntityRecognizerSummary (Maybe ModelStatus) -- | The number of versions you created. entityRecognizerSummary_numberOfVersions :: Lens' EntityRecognizerSummary (Maybe Int) -- | The name that you assigned the entity recognizer. entityRecognizerSummary_recognizerName :: Lens' EntityRecognizerSummary (Maybe Text) -- | Detailed information about the accuracy of an entity recognizer for a -- specific entity type. -- -- See: newEntityTypesEvaluationMetrics smart constructor. data EntityTypesEvaluationMetrics EntityTypesEvaluationMetrics' :: Maybe Double -> Maybe Double -> Maybe Double -> EntityTypesEvaluationMetrics -- | A measure of how accurate the recognizer results are for a specific -- entity type in the test data. It is derived from the -- Precision and Recall values. The F1Score is -- the harmonic average of the two scores. The highest score is 1, and -- the worst score is 0. [$sel:f1Score:EntityTypesEvaluationMetrics'] :: EntityTypesEvaluationMetrics -> Maybe Double -- | A measure of the usefulness of the recognizer results for a specific -- entity type in the test data. High precision means that the recognizer -- returned substantially more relevant results than irrelevant ones. [$sel:precision:EntityTypesEvaluationMetrics'] :: EntityTypesEvaluationMetrics -> Maybe Double -- | A measure of how complete the recognizer results are for a specific -- entity type in the test data. High recall means that the recognizer -- returned most of the relevant results. [$sel:recall:EntityTypesEvaluationMetrics'] :: EntityTypesEvaluationMetrics -> Maybe Double -- | Create a value of EntityTypesEvaluationMetrics with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:f1Score:EntityTypesEvaluationMetrics', -- entityTypesEvaluationMetrics_f1Score - A measure of how -- accurate the recognizer results are for a specific entity type in the -- test data. It is derived from the Precision and -- Recall values. The F1Score is the harmonic average -- of the two scores. The highest score is 1, and the worst score is 0. -- -- $sel:precision:EntityTypesEvaluationMetrics', -- entityTypesEvaluationMetrics_precision - A measure of the -- usefulness of the recognizer results for a specific entity type in the -- test data. High precision means that the recognizer returned -- substantially more relevant results than irrelevant ones. -- -- $sel:recall:EntityTypesEvaluationMetrics', -- entityTypesEvaluationMetrics_recall - A measure of how complete -- the recognizer results are for a specific entity type in the test -- data. High recall means that the recognizer returned most of the -- relevant results. newEntityTypesEvaluationMetrics :: EntityTypesEvaluationMetrics -- | A measure of how accurate the recognizer results are for a specific -- entity type in the test data. It is derived from the -- Precision and Recall values. The F1Score is -- the harmonic average of the two scores. The highest score is 1, and -- the worst score is 0. entityTypesEvaluationMetrics_f1Score :: Lens' EntityTypesEvaluationMetrics (Maybe Double) -- | A measure of the usefulness of the recognizer results for a specific -- entity type in the test data. High precision means that the recognizer -- returned substantially more relevant results than irrelevant ones. entityTypesEvaluationMetrics_precision :: Lens' EntityTypesEvaluationMetrics (Maybe Double) -- | A measure of how complete the recognizer results are for a specific -- entity type in the test data. High recall means that the recognizer -- returned most of the relevant results. entityTypesEvaluationMetrics_recall :: Lens' EntityTypesEvaluationMetrics (Maybe Double) -- | An entity type within a labeled training dataset that Amazon -- Comprehend uses to train a custom entity recognizer. -- -- See: newEntityTypesListItem smart constructor. data EntityTypesListItem EntityTypesListItem' :: Text -> EntityTypesListItem -- | An entity type within a labeled training dataset that Amazon -- Comprehend uses to train a custom entity recognizer. -- -- Entity types must not contain the following invalid characters: \n -- (line break), \\n (escaped line break, \r (carriage return), \\r -- (escaped carriage return), \t (tab), \\t (escaped tab), space, and , -- (comma). [$sel:type':EntityTypesListItem'] :: EntityTypesListItem -> Text -- | Create a value of EntityTypesListItem with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:type':EntityTypesListItem', -- entityTypesListItem_type - An entity type within a labeled -- training dataset that Amazon Comprehend uses to train a custom entity -- recognizer. -- -- Entity types must not contain the following invalid characters: \n -- (line break), \\n (escaped line break, \r (carriage return), \\r -- (escaped carriage return), \t (tab), \\t (escaped tab), space, and , -- (comma). newEntityTypesListItem :: Text -> EntityTypesListItem -- | An entity type within a labeled training dataset that Amazon -- Comprehend uses to train a custom entity recognizer. -- -- Entity types must not contain the following invalid characters: \n -- (line break), \\n (escaped line break, \r (carriage return), \\r -- (escaped carriage return), \t (tab), \\t (escaped tab), space, and , -- (comma). entityTypesListItem_type :: Lens' EntityTypesListItem Text -- | Text extraction encountered one or more page-level errors in the input -- document. -- -- The ErrorCode contains one of the following values: -- -- -- -- See: newErrorsListItem smart constructor. data ErrorsListItem ErrorsListItem' :: Maybe PageBasedErrorCode -> Maybe Text -> Maybe Int -> ErrorsListItem -- | Error code for the cause of the error. [$sel:errorCode:ErrorsListItem'] :: ErrorsListItem -> Maybe PageBasedErrorCode -- | Text message explaining the reason for the error. [$sel:errorMessage:ErrorsListItem'] :: ErrorsListItem -> Maybe Text -- | Page number where the error occurred. [$sel:page:ErrorsListItem'] :: ErrorsListItem -> Maybe Int -- | Create a value of ErrorsListItem with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:errorCode:ErrorsListItem', errorsListItem_errorCode -- - Error code for the cause of the error. -- -- $sel:errorMessage:ErrorsListItem', -- errorsListItem_errorMessage - Text message explaining the -- reason for the error. -- -- $sel:page:ErrorsListItem', errorsListItem_page - Page -- number where the error occurred. newErrorsListItem :: ErrorsListItem -- | Error code for the cause of the error. errorsListItem_errorCode :: Lens' ErrorsListItem (Maybe PageBasedErrorCode) -- | Text message explaining the reason for the error. errorsListItem_errorMessage :: Lens' ErrorsListItem (Maybe Text) -- | Page number where the error occurred. errorsListItem_page :: Lens' ErrorsListItem (Maybe Int) -- | Provides information for filtering a list of event detection jobs. -- -- See: newEventsDetectionJobFilter smart constructor. data EventsDetectionJobFilter EventsDetectionJobFilter' :: Maybe Text -> Maybe JobStatus -> Maybe POSIX -> Maybe POSIX -> EventsDetectionJobFilter -- | Filters on the name of the events detection job. [$sel:jobName:EventsDetectionJobFilter'] :: EventsDetectionJobFilter -> Maybe Text -- | Filters the list of jobs based on job status. Returns only jobs with -- the specified status. [$sel:jobStatus:EventsDetectionJobFilter'] :: EventsDetectionJobFilter -> Maybe JobStatus -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. [$sel:submitTimeAfter:EventsDetectionJobFilter'] :: EventsDetectionJobFilter -> Maybe POSIX -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. [$sel:submitTimeBefore:EventsDetectionJobFilter'] :: EventsDetectionJobFilter -> Maybe POSIX -- | Create a value of EventsDetectionJobFilter with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:jobName:EventsDetectionJobFilter', -- eventsDetectionJobFilter_jobName - Filters on the name of the -- events detection job. -- -- $sel:jobStatus:EventsDetectionJobFilter', -- eventsDetectionJobFilter_jobStatus - Filters the list of jobs -- based on job status. Returns only jobs with the specified status. -- -- $sel:submitTimeAfter:EventsDetectionJobFilter', -- eventsDetectionJobFilter_submitTimeAfter - Filters the list of -- jobs based on the time that the job was submitted for processing. -- Returns only jobs submitted after the specified time. Jobs are -- returned in descending order, newest to oldest. -- -- $sel:submitTimeBefore:EventsDetectionJobFilter', -- eventsDetectionJobFilter_submitTimeBefore - Filters the list of -- jobs based on the time that the job was submitted for processing. -- Returns only jobs submitted before the specified time. Jobs are -- returned in ascending order, oldest to newest. newEventsDetectionJobFilter :: EventsDetectionJobFilter -- | Filters on the name of the events detection job. eventsDetectionJobFilter_jobName :: Lens' EventsDetectionJobFilter (Maybe Text) -- | Filters the list of jobs based on job status. Returns only jobs with -- the specified status. eventsDetectionJobFilter_jobStatus :: Lens' EventsDetectionJobFilter (Maybe JobStatus) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. eventsDetectionJobFilter_submitTimeAfter :: Lens' EventsDetectionJobFilter (Maybe UTCTime) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. eventsDetectionJobFilter_submitTimeBefore :: Lens' EventsDetectionJobFilter (Maybe UTCTime) -- | Provides information about an events detection job. -- -- See: newEventsDetectionJobProperties smart constructor. data EventsDetectionJobProperties EventsDetectionJobProperties' :: Maybe Text -> Maybe POSIX -> Maybe InputDataConfig -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe JobStatus -> Maybe LanguageCode -> Maybe Text -> Maybe OutputDataConfig -> Maybe POSIX -> Maybe (NonEmpty Text) -> EventsDetectionJobProperties -- | The Amazon Resource Name (ARN) of the AWS Identify and Access -- Management (IAM) role that grants Amazon Comprehend read access to -- your input data. [$sel:dataAccessRoleArn:EventsDetectionJobProperties'] :: EventsDetectionJobProperties -> Maybe Text -- | The time that the events detection job completed. [$sel:endTime:EventsDetectionJobProperties'] :: EventsDetectionJobProperties -> Maybe POSIX -- | The input data configuration that you supplied when you created the -- events detection job. [$sel:inputDataConfig:EventsDetectionJobProperties'] :: EventsDetectionJobProperties -> Maybe InputDataConfig -- | The Amazon Resource Name (ARN) of the events detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
--
[$sel:jobArn:EventsDetectionJobProperties'] :: EventsDetectionJobProperties -> Maybe Text -- | The identifier assigned to the events detection job. [$sel:jobId:EventsDetectionJobProperties'] :: EventsDetectionJobProperties -> Maybe Text -- | The name you assigned the events detection job. [$sel:jobName:EventsDetectionJobProperties'] :: EventsDetectionJobProperties -> Maybe Text -- | The current status of the events detection job. [$sel:jobStatus:EventsDetectionJobProperties'] :: EventsDetectionJobProperties -> Maybe JobStatus -- | The language code of the input documents. [$sel:languageCode:EventsDetectionJobProperties'] :: EventsDetectionJobProperties -> Maybe LanguageCode -- | A description of the status of the events detection job. [$sel:message:EventsDetectionJobProperties'] :: EventsDetectionJobProperties -> Maybe Text -- | The output data configuration that you supplied when you created the -- events detection job. [$sel:outputDataConfig:EventsDetectionJobProperties'] :: EventsDetectionJobProperties -> Maybe OutputDataConfig -- | The time that the events detection job was submitted for processing. [$sel:submitTime:EventsDetectionJobProperties'] :: EventsDetectionJobProperties -> Maybe POSIX -- | The types of events that are detected by the job. [$sel:targetEventTypes:EventsDetectionJobProperties'] :: EventsDetectionJobProperties -> Maybe (NonEmpty Text) -- | Create a value of EventsDetectionJobProperties with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:dataAccessRoleArn:EventsDetectionJobProperties', -- eventsDetectionJobProperties_dataAccessRoleArn - The Amazon -- Resource Name (ARN) of the AWS Identify and Access Management (IAM) -- role that grants Amazon Comprehend read access to your input data. -- -- $sel:endTime:EventsDetectionJobProperties', -- eventsDetectionJobProperties_endTime - The time that the events -- detection job completed. -- -- $sel:inputDataConfig:EventsDetectionJobProperties', -- eventsDetectionJobProperties_inputDataConfig - The input data -- configuration that you supplied when you created the events detection -- job. -- -- $sel:jobArn:EventsDetectionJobProperties', -- eventsDetectionJobProperties_jobArn - The Amazon Resource Name -- (ARN) of the events detection job. It is a unique, fully qualified -- identifier for the job. It includes the AWS account, Region, and the -- job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- $sel:jobId:EventsDetectionJobProperties', -- eventsDetectionJobProperties_jobId - The identifier assigned to -- the events detection job. -- -- $sel:jobName:EventsDetectionJobProperties', -- eventsDetectionJobProperties_jobName - The name you assigned -- the events detection job. -- -- $sel:jobStatus:EventsDetectionJobProperties', -- eventsDetectionJobProperties_jobStatus - The current status of -- the events detection job. -- -- $sel:languageCode:EventsDetectionJobProperties', -- eventsDetectionJobProperties_languageCode - The language code -- of the input documents. -- -- $sel:message:EventsDetectionJobProperties', -- eventsDetectionJobProperties_message - A description of the -- status of the events detection job. -- -- $sel:outputDataConfig:EventsDetectionJobProperties', -- eventsDetectionJobProperties_outputDataConfig - The output data -- configuration that you supplied when you created the events detection -- job. -- -- $sel:submitTime:EventsDetectionJobProperties', -- eventsDetectionJobProperties_submitTime - The time that the -- events detection job was submitted for processing. -- -- $sel:targetEventTypes:EventsDetectionJobProperties', -- eventsDetectionJobProperties_targetEventTypes - The types of -- events that are detected by the job. newEventsDetectionJobProperties :: EventsDetectionJobProperties -- | The Amazon Resource Name (ARN) of the AWS Identify and Access -- Management (IAM) role that grants Amazon Comprehend read access to -- your input data. eventsDetectionJobProperties_dataAccessRoleArn :: Lens' EventsDetectionJobProperties (Maybe Text) -- | The time that the events detection job completed. eventsDetectionJobProperties_endTime :: Lens' EventsDetectionJobProperties (Maybe UTCTime) -- | The input data configuration that you supplied when you created the -- events detection job. eventsDetectionJobProperties_inputDataConfig :: Lens' EventsDetectionJobProperties (Maybe InputDataConfig) -- | The Amazon Resource Name (ARN) of the events detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
--
eventsDetectionJobProperties_jobArn :: Lens' EventsDetectionJobProperties (Maybe Text) -- | The identifier assigned to the events detection job. eventsDetectionJobProperties_jobId :: Lens' EventsDetectionJobProperties (Maybe Text) -- | The name you assigned the events detection job. eventsDetectionJobProperties_jobName :: Lens' EventsDetectionJobProperties (Maybe Text) -- | The current status of the events detection job. eventsDetectionJobProperties_jobStatus :: Lens' EventsDetectionJobProperties (Maybe JobStatus) -- | The language code of the input documents. eventsDetectionJobProperties_languageCode :: Lens' EventsDetectionJobProperties (Maybe LanguageCode) -- | A description of the status of the events detection job. eventsDetectionJobProperties_message :: Lens' EventsDetectionJobProperties (Maybe Text) -- | The output data configuration that you supplied when you created the -- events detection job. eventsDetectionJobProperties_outputDataConfig :: Lens' EventsDetectionJobProperties (Maybe OutputDataConfig) -- | The time that the events detection job was submitted for processing. eventsDetectionJobProperties_submitTime :: Lens' EventsDetectionJobProperties (Maybe UTCTime) -- | The types of events that are detected by the job. eventsDetectionJobProperties_targetEventTypes :: Lens' EventsDetectionJobProperties (Maybe (NonEmpty Text)) -- | Array of the number of characters extracted from each page. -- -- See: newExtractedCharactersListItem smart constructor. data ExtractedCharactersListItem ExtractedCharactersListItem' :: Maybe Int -> Maybe Int -> ExtractedCharactersListItem -- | Number of characters extracted from each page. [$sel:count:ExtractedCharactersListItem'] :: ExtractedCharactersListItem -> Maybe Int -- | Page number. [$sel:page:ExtractedCharactersListItem'] :: ExtractedCharactersListItem -> Maybe Int -- | Create a value of ExtractedCharactersListItem with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:count:ExtractedCharactersListItem', -- extractedCharactersListItem_count - Number of characters -- extracted from each page. -- -- $sel:page:ExtractedCharactersListItem', -- extractedCharactersListItem_page - Page number. newExtractedCharactersListItem :: ExtractedCharactersListItem -- | Number of characters extracted from each page. extractedCharactersListItem_count :: Lens' ExtractedCharactersListItem (Maybe Int) -- | Page number. extractedCharactersListItem_page :: Lens' ExtractedCharactersListItem (Maybe Int) -- | Information about the location of items on a document page. -- -- For additional information, see Geometry in the Amazon Textract -- API reference. -- -- See: newGeometry smart constructor. data Geometry Geometry' :: Maybe BoundingBox -> Maybe [Point] -> Geometry -- | An axis-aligned coarse representation of the location of the -- recognized item on the document page. [$sel:boundingBox:Geometry'] :: Geometry -> Maybe BoundingBox -- | Within the bounding box, a fine-grained polygon around the recognized -- item. [$sel:polygon:Geometry'] :: Geometry -> Maybe [Point] -- | Create a value of Geometry with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:boundingBox:Geometry', geometry_boundingBox - An -- axis-aligned coarse representation of the location of the recognized -- item on the document page. -- -- $sel:polygon:Geometry', geometry_polygon - Within the -- bounding box, a fine-grained polygon around the recognized item. newGeometry :: Geometry -- | An axis-aligned coarse representation of the location of the -- recognized item on the document page. geometry_boundingBox :: Lens' Geometry (Maybe BoundingBox) -- | Within the bounding box, a fine-grained polygon around the recognized -- item. geometry_polygon :: Lens' Geometry (Maybe [Point]) -- | The input properties for an inference job. The document reader config -- field applies only to non-text inputs for custom analysis. -- -- See: newInputDataConfig smart constructor. data InputDataConfig InputDataConfig' :: Maybe DocumentReaderConfig -> Maybe InputFormat -> Text -> InputDataConfig -- | Provides configuration parameters to override the default actions for -- extracting text from PDF documents and image files. [$sel:documentReaderConfig:InputDataConfig'] :: InputDataConfig -> Maybe DocumentReaderConfig -- | Specifies how the text in an input file should be processed: -- -- [$sel:inputFormat:InputDataConfig'] :: InputDataConfig -> Maybe InputFormat -- | The Amazon S3 URI for the input data. The URI must be in same region -- as the API endpoint that you are calling. The URI can point to a -- single input file or it can provide the prefix for a collection of -- data files. -- -- For example, if you use the URI S3://bucketName/prefix, if -- the prefix is a single file, Amazon Comprehend uses that file as -- input. If more than one file begins with the prefix, Amazon Comprehend -- uses all of them as input. [$sel:s3Uri:InputDataConfig'] :: InputDataConfig -> Text -- | Create a value of InputDataConfig with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:documentReaderConfig:InputDataConfig', -- inputDataConfig_documentReaderConfig - Provides configuration -- parameters to override the default actions for extracting text from -- PDF documents and image files. -- -- $sel:inputFormat:InputDataConfig', -- inputDataConfig_inputFormat - Specifies how the text in an -- input file should be processed: -- -- -- -- $sel:s3Uri:InputDataConfig', inputDataConfig_s3Uri - The -- Amazon S3 URI for the input data. The URI must be in same region as -- the API endpoint that you are calling. The URI can point to a single -- input file or it can provide the prefix for a collection of data -- files. -- -- For example, if you use the URI S3://bucketName/prefix, if -- the prefix is a single file, Amazon Comprehend uses that file as -- input. If more than one file begins with the prefix, Amazon Comprehend -- uses all of them as input. newInputDataConfig :: Text -> InputDataConfig -- | Provides configuration parameters to override the default actions for -- extracting text from PDF documents and image files. inputDataConfig_documentReaderConfig :: Lens' InputDataConfig (Maybe DocumentReaderConfig) -- | Specifies how the text in an input file should be processed: -- -- inputDataConfig_inputFormat :: Lens' InputDataConfig (Maybe InputFormat) -- | The Amazon S3 URI for the input data. The URI must be in same region -- as the API endpoint that you are calling. The URI can point to a -- single input file or it can provide the prefix for a collection of -- data files. -- -- For example, if you use the URI S3://bucketName/prefix, if -- the prefix is a single file, Amazon Comprehend uses that file as -- input. If more than one file begins with the prefix, Amazon Comprehend -- uses all of them as input. inputDataConfig_s3Uri :: Lens' InputDataConfig Text -- | Describes a key noun phrase. -- -- See: newKeyPhrase smart constructor. data KeyPhrase KeyPhrase' :: Maybe Int -> Maybe Int -> Maybe Double -> Maybe Text -> KeyPhrase -- | The zero-based offset from the beginning of the source text to the -- first character in the key phrase. [$sel:beginOffset:KeyPhrase'] :: KeyPhrase -> Maybe Int -- | The zero-based offset from the beginning of the source text to the -- last character in the key phrase. [$sel:endOffset:KeyPhrase'] :: KeyPhrase -> Maybe Int -- | The level of confidence that Amazon Comprehend has in the accuracy of -- the detection. [$sel:score:KeyPhrase'] :: KeyPhrase -> Maybe Double -- | The text of a key noun phrase. [$sel:text:KeyPhrase'] :: KeyPhrase -> Maybe Text -- | Create a value of KeyPhrase with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:beginOffset:KeyPhrase', keyPhrase_beginOffset - The -- zero-based offset from the beginning of the source text to the first -- character in the key phrase. -- -- $sel:endOffset:KeyPhrase', keyPhrase_endOffset - The -- zero-based offset from the beginning of the source text to the last -- character in the key phrase. -- -- $sel:score:KeyPhrase', keyPhrase_score - The level of -- confidence that Amazon Comprehend has in the accuracy of the -- detection. -- -- $sel:text:KeyPhrase', keyPhrase_text - The text of a key -- noun phrase. newKeyPhrase :: KeyPhrase -- | The zero-based offset from the beginning of the source text to the -- first character in the key phrase. keyPhrase_beginOffset :: Lens' KeyPhrase (Maybe Int) -- | The zero-based offset from the beginning of the source text to the -- last character in the key phrase. keyPhrase_endOffset :: Lens' KeyPhrase (Maybe Int) -- | The level of confidence that Amazon Comprehend has in the accuracy of -- the detection. keyPhrase_score :: Lens' KeyPhrase (Maybe Double) -- | The text of a key noun phrase. keyPhrase_text :: Lens' KeyPhrase (Maybe Text) -- | Provides information for filtering a list of dominant language -- detection jobs. For more information, see the operation. -- -- See: newKeyPhrasesDetectionJobFilter smart constructor. data KeyPhrasesDetectionJobFilter KeyPhrasesDetectionJobFilter' :: Maybe Text -> Maybe JobStatus -> Maybe POSIX -> Maybe POSIX -> KeyPhrasesDetectionJobFilter -- | Filters on the name of the job. [$sel:jobName:KeyPhrasesDetectionJobFilter'] :: KeyPhrasesDetectionJobFilter -> Maybe Text -- | Filters the list of jobs based on job status. Returns only jobs with -- the specified status. [$sel:jobStatus:KeyPhrasesDetectionJobFilter'] :: KeyPhrasesDetectionJobFilter -> Maybe JobStatus -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. [$sel:submitTimeAfter:KeyPhrasesDetectionJobFilter'] :: KeyPhrasesDetectionJobFilter -> Maybe POSIX -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. [$sel:submitTimeBefore:KeyPhrasesDetectionJobFilter'] :: KeyPhrasesDetectionJobFilter -> Maybe POSIX -- | Create a value of KeyPhrasesDetectionJobFilter with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:jobName:KeyPhrasesDetectionJobFilter', -- keyPhrasesDetectionJobFilter_jobName - Filters on the name of -- the job. -- -- $sel:jobStatus:KeyPhrasesDetectionJobFilter', -- keyPhrasesDetectionJobFilter_jobStatus - Filters the list of -- jobs based on job status. Returns only jobs with the specified status. -- -- $sel:submitTimeAfter:KeyPhrasesDetectionJobFilter', -- keyPhrasesDetectionJobFilter_submitTimeAfter - Filters the list -- of jobs based on the time that the job was submitted for processing. -- Returns only jobs submitted after the specified time. Jobs are -- returned in descending order, newest to oldest. -- -- $sel:submitTimeBefore:KeyPhrasesDetectionJobFilter', -- keyPhrasesDetectionJobFilter_submitTimeBefore - Filters the -- list of jobs based on the time that the job was submitted for -- processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. newKeyPhrasesDetectionJobFilter :: KeyPhrasesDetectionJobFilter -- | Filters on the name of the job. keyPhrasesDetectionJobFilter_jobName :: Lens' KeyPhrasesDetectionJobFilter (Maybe Text) -- | Filters the list of jobs based on job status. Returns only jobs with -- the specified status. keyPhrasesDetectionJobFilter_jobStatus :: Lens' KeyPhrasesDetectionJobFilter (Maybe JobStatus) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. keyPhrasesDetectionJobFilter_submitTimeAfter :: Lens' KeyPhrasesDetectionJobFilter (Maybe UTCTime) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. keyPhrasesDetectionJobFilter_submitTimeBefore :: Lens' KeyPhrasesDetectionJobFilter (Maybe UTCTime) -- | Provides information about a key phrases detection job. -- -- See: newKeyPhrasesDetectionJobProperties smart -- constructor. data KeyPhrasesDetectionJobProperties KeyPhrasesDetectionJobProperties' :: Maybe Text -> Maybe POSIX -> Maybe InputDataConfig -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe JobStatus -> Maybe LanguageCode -> Maybe Text -> Maybe OutputDataConfig -> Maybe POSIX -> Maybe Text -> Maybe VpcConfig -> KeyPhrasesDetectionJobProperties -- | The Amazon Resource Name (ARN) that gives Amazon Comprehend read -- access to your input data. [$sel:dataAccessRoleArn:KeyPhrasesDetectionJobProperties'] :: KeyPhrasesDetectionJobProperties -> Maybe Text -- | The time that the key phrases detection job completed. [$sel:endTime:KeyPhrasesDetectionJobProperties'] :: KeyPhrasesDetectionJobProperties -> Maybe POSIX -- | The input data configuration that you supplied when you created the -- key phrases detection job. [$sel:inputDataConfig:KeyPhrasesDetectionJobProperties'] :: KeyPhrasesDetectionJobProperties -> Maybe InputDataConfig -- | The Amazon Resource Name (ARN) of the key phrases detection job. It is -- a unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
--
[$sel:jobArn:KeyPhrasesDetectionJobProperties'] :: KeyPhrasesDetectionJobProperties -> Maybe Text -- | The identifier assigned to the key phrases detection job. [$sel:jobId:KeyPhrasesDetectionJobProperties'] :: KeyPhrasesDetectionJobProperties -> Maybe Text -- | The name that you assigned the key phrases detection job. [$sel:jobName:KeyPhrasesDetectionJobProperties'] :: KeyPhrasesDetectionJobProperties -> Maybe Text -- | The current status of the key phrases detection job. If the status is -- FAILED, the Message field shows the reason for the -- failure. [$sel:jobStatus:KeyPhrasesDetectionJobProperties'] :: KeyPhrasesDetectionJobProperties -> Maybe JobStatus -- | The language code of the input documents. [$sel:languageCode:KeyPhrasesDetectionJobProperties'] :: KeyPhrasesDetectionJobProperties -> Maybe LanguageCode -- | A description of the status of a job. [$sel:message:KeyPhrasesDetectionJobProperties'] :: KeyPhrasesDetectionJobProperties -> Maybe Text -- | The output data configuration that you supplied when you created the -- key phrases detection job. [$sel:outputDataConfig:KeyPhrasesDetectionJobProperties'] :: KeyPhrasesDetectionJobProperties -> Maybe OutputDataConfig -- | The time that the key phrases detection job was submitted for -- processing. [$sel:submitTime:KeyPhrasesDetectionJobProperties'] :: KeyPhrasesDetectionJobProperties -> Maybe POSIX -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- [$sel:volumeKmsKeyId:KeyPhrasesDetectionJobProperties'] :: KeyPhrasesDetectionJobProperties -> Maybe Text -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your key phrases detection -- job. For more information, see Amazon VPC. [$sel:vpcConfig:KeyPhrasesDetectionJobProperties'] :: KeyPhrasesDetectionJobProperties -> Maybe VpcConfig -- | Create a value of KeyPhrasesDetectionJobProperties with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:dataAccessRoleArn:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_dataAccessRoleArn - The Amazon -- Resource Name (ARN) that gives Amazon Comprehend read access to your -- input data. -- -- $sel:endTime:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_endTime - The time that the -- key phrases detection job completed. -- -- $sel:inputDataConfig:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_inputDataConfig - The input -- data configuration that you supplied when you created the key phrases -- detection job. -- -- $sel:jobArn:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_jobArn - The Amazon Resource -- Name (ARN) of the key phrases detection job. It is a unique, fully -- qualified identifier for the job. It includes the AWS account, Region, -- and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- $sel:jobId:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_jobId - The identifier -- assigned to the key phrases detection job. -- -- $sel:jobName:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_jobName - The name that you -- assigned the key phrases detection job. -- -- $sel:jobStatus:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_jobStatus - The current status -- of the key phrases detection job. If the status is FAILED, -- the Message field shows the reason for the failure. -- -- $sel:languageCode:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_languageCode - The language -- code of the input documents. -- -- $sel:message:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_message - A description of the -- status of a job. -- -- $sel:outputDataConfig:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_outputDataConfig - The output -- data configuration that you supplied when you created the key phrases -- detection job. -- -- $sel:submitTime:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_submitTime - The time that the -- key phrases detection job was submitted for processing. -- -- $sel:volumeKmsKeyId:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_volumeKmsKeyId - ID for the -- AWS Key Management Service (KMS) key that Amazon Comprehend uses to -- encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- -- -- $sel:vpcConfig:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_vpcConfig - Configuration -- parameters for a private Virtual Private Cloud (VPC) containing the -- resources you are using for your key phrases detection job. For more -- information, see Amazon VPC. newKeyPhrasesDetectionJobProperties :: KeyPhrasesDetectionJobProperties -- | The Amazon Resource Name (ARN) that gives Amazon Comprehend read -- access to your input data. keyPhrasesDetectionJobProperties_dataAccessRoleArn :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text) -- | The time that the key phrases detection job completed. keyPhrasesDetectionJobProperties_endTime :: Lens' KeyPhrasesDetectionJobProperties (Maybe UTCTime) -- | The input data configuration that you supplied when you created the -- key phrases detection job. keyPhrasesDetectionJobProperties_inputDataConfig :: Lens' KeyPhrasesDetectionJobProperties (Maybe InputDataConfig) -- | The Amazon Resource Name (ARN) of the key phrases detection job. It is -- a unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
--
keyPhrasesDetectionJobProperties_jobArn :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text) -- | The identifier assigned to the key phrases detection job. keyPhrasesDetectionJobProperties_jobId :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text) -- | The name that you assigned the key phrases detection job. keyPhrasesDetectionJobProperties_jobName :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text) -- | The current status of the key phrases detection job. If the status is -- FAILED, the Message field shows the reason for the -- failure. keyPhrasesDetectionJobProperties_jobStatus :: Lens' KeyPhrasesDetectionJobProperties (Maybe JobStatus) -- | The language code of the input documents. keyPhrasesDetectionJobProperties_languageCode :: Lens' KeyPhrasesDetectionJobProperties (Maybe LanguageCode) -- | A description of the status of a job. keyPhrasesDetectionJobProperties_message :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text) -- | The output data configuration that you supplied when you created the -- key phrases detection job. keyPhrasesDetectionJobProperties_outputDataConfig :: Lens' KeyPhrasesDetectionJobProperties (Maybe OutputDataConfig) -- | The time that the key phrases detection job was submitted for -- processing. keyPhrasesDetectionJobProperties_submitTime :: Lens' KeyPhrasesDetectionJobProperties (Maybe UTCTime) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- keyPhrasesDetectionJobProperties_volumeKmsKeyId :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text) -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your key phrases detection -- job. For more information, see Amazon VPC. keyPhrasesDetectionJobProperties_vpcConfig :: Lens' KeyPhrasesDetectionJobProperties (Maybe VpcConfig) -- | Contains the sentiment and sentiment score for one mention of an -- entity. -- -- For more information about targeted sentiment, see Targeted -- sentiment. -- -- See: newMentionSentiment smart constructor. data MentionSentiment MentionSentiment' :: Maybe SentimentType -> Maybe SentimentScore -> MentionSentiment -- | The sentiment of the mention. [$sel:sentiment:MentionSentiment'] :: MentionSentiment -> Maybe SentimentType [$sel:sentimentScore:MentionSentiment'] :: MentionSentiment -> Maybe SentimentScore -- | Create a value of MentionSentiment with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:sentiment:MentionSentiment', -- mentionSentiment_sentiment - The sentiment of the mention. -- -- $sel:sentimentScore:MentionSentiment', -- mentionSentiment_sentimentScore - Undocumented member. newMentionSentiment :: MentionSentiment -- | The sentiment of the mention. mentionSentiment_sentiment :: Lens' MentionSentiment (Maybe SentimentType) -- | Undocumented member. mentionSentiment_sentimentScore :: Lens' MentionSentiment (Maybe SentimentScore) -- | Provides configuration parameters for the output of inference jobs. -- -- See: newOutputDataConfig smart constructor. data OutputDataConfig OutputDataConfig' :: Maybe Text -> Text -> OutputDataConfig -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt the output results from an analysis job. The KmsKeyId -- can be one of the following formats: -- -- [$sel:kmsKeyId:OutputDataConfig'] :: OutputDataConfig -> Maybe Text -- | When you use the OutputDataConfig object with asynchronous -- operations, you specify the Amazon S3 location where you want to write -- the output data. The URI must be in the same region as the API -- endpoint that you are calling. The location is used as the prefix for -- the actual location of the output file. -- -- When the topic detection job is finished, the service creates an -- output file in a directory specific to the job. The S3Uri -- field contains the location of the output file, called -- output.tar.gz. It is a compressed archive that contains the -- ouput of the operation. -- -- For a PII entity detection job, the output file is plain text, not a -- compressed archive. The output file name is the same as the input -- file, with .out appended at the end. [$sel:s3Uri:OutputDataConfig'] :: OutputDataConfig -> Text -- | Create a value of OutputDataConfig with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:kmsKeyId:OutputDataConfig', -- outputDataConfig_kmsKeyId - ID for the AWS Key Management -- Service (KMS) key that Amazon Comprehend uses to encrypt the output -- results from an analysis job. The KmsKeyId can be one of the following -- formats: -- -- -- -- $sel:s3Uri:OutputDataConfig', outputDataConfig_s3Uri - -- When you use the OutputDataConfig object with asynchronous -- operations, you specify the Amazon S3 location where you want to write -- the output data. The URI must be in the same region as the API -- endpoint that you are calling. The location is used as the prefix for -- the actual location of the output file. -- -- When the topic detection job is finished, the service creates an -- output file in a directory specific to the job. The S3Uri -- field contains the location of the output file, called -- output.tar.gz. It is a compressed archive that contains the -- ouput of the operation. -- -- For a PII entity detection job, the output file is plain text, not a -- compressed archive. The output file name is the same as the input -- file, with .out appended at the end. newOutputDataConfig :: Text -> OutputDataConfig -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt the output results from an analysis job. The KmsKeyId -- can be one of the following formats: -- -- outputDataConfig_kmsKeyId :: Lens' OutputDataConfig (Maybe Text) -- | When you use the OutputDataConfig object with asynchronous -- operations, you specify the Amazon S3 location where you want to write -- the output data. The URI must be in the same region as the API -- endpoint that you are calling. The location is used as the prefix for -- the actual location of the output file. -- -- When the topic detection job is finished, the service creates an -- output file in a directory specific to the job. The S3Uri -- field contains the location of the output file, called -- output.tar.gz. It is a compressed archive that contains the -- ouput of the operation. -- -- For a PII entity detection job, the output file is plain text, not a -- compressed archive. The output file name is the same as the input -- file, with .out appended at the end. outputDataConfig_s3Uri :: Lens' OutputDataConfig Text -- | Identifies the part of speech represented by the token and gives the -- confidence that Amazon Comprehend has that the part of speech was -- correctly identified. For more information about the parts of speech -- that Amazon Comprehend can identify, see Syntax in the -- Comprehend Developer Guide. -- -- See: newPartOfSpeechTag smart constructor. data PartOfSpeechTag PartOfSpeechTag' :: Maybe Double -> Maybe PartOfSpeechTagType -> PartOfSpeechTag -- | The confidence that Amazon Comprehend has that the part of speech was -- correctly identified. [$sel:score:PartOfSpeechTag'] :: PartOfSpeechTag -> Maybe Double -- | Identifies the part of speech that the token represents. [$sel:tag:PartOfSpeechTag'] :: PartOfSpeechTag -> Maybe PartOfSpeechTagType -- | Create a value of PartOfSpeechTag with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:score:PartOfSpeechTag', partOfSpeechTag_score - The -- confidence that Amazon Comprehend has that the part of speech was -- correctly identified. -- -- $sel:tag:PartOfSpeechTag', partOfSpeechTag_tag - -- Identifies the part of speech that the token represents. newPartOfSpeechTag :: PartOfSpeechTag -- | The confidence that Amazon Comprehend has that the part of speech was -- correctly identified. partOfSpeechTag_score :: Lens' PartOfSpeechTag (Maybe Double) -- | Identifies the part of speech that the token represents. partOfSpeechTag_tag :: Lens' PartOfSpeechTag (Maybe PartOfSpeechTagType) -- | Provides information for filtering a list of PII entity detection -- jobs. -- -- See: newPiiEntitiesDetectionJobFilter smart constructor. data PiiEntitiesDetectionJobFilter PiiEntitiesDetectionJobFilter' :: Maybe Text -> Maybe JobStatus -> Maybe POSIX -> Maybe POSIX -> PiiEntitiesDetectionJobFilter -- | Filters on the name of the job. [$sel:jobName:PiiEntitiesDetectionJobFilter'] :: PiiEntitiesDetectionJobFilter -> Maybe Text -- | Filters the list of jobs based on job status. Returns only jobs with -- the specified status. [$sel:jobStatus:PiiEntitiesDetectionJobFilter'] :: PiiEntitiesDetectionJobFilter -> Maybe JobStatus -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. [$sel:submitTimeAfter:PiiEntitiesDetectionJobFilter'] :: PiiEntitiesDetectionJobFilter -> Maybe POSIX -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. [$sel:submitTimeBefore:PiiEntitiesDetectionJobFilter'] :: PiiEntitiesDetectionJobFilter -> Maybe POSIX -- | Create a value of PiiEntitiesDetectionJobFilter with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:jobName:PiiEntitiesDetectionJobFilter', -- piiEntitiesDetectionJobFilter_jobName - Filters on the name of -- the job. -- -- $sel:jobStatus:PiiEntitiesDetectionJobFilter', -- piiEntitiesDetectionJobFilter_jobStatus - Filters the list of -- jobs based on job status. Returns only jobs with the specified status. -- -- $sel:submitTimeAfter:PiiEntitiesDetectionJobFilter', -- piiEntitiesDetectionJobFilter_submitTimeAfter - Filters the -- list of jobs based on the time that the job was submitted for -- processing. Returns only jobs submitted after the specified time. Jobs -- are returned in descending order, newest to oldest. -- -- $sel:submitTimeBefore:PiiEntitiesDetectionJobFilter', -- piiEntitiesDetectionJobFilter_submitTimeBefore - Filters the -- list of jobs based on the time that the job was submitted for -- processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. newPiiEntitiesDetectionJobFilter :: PiiEntitiesDetectionJobFilter -- | Filters on the name of the job. piiEntitiesDetectionJobFilter_jobName :: Lens' PiiEntitiesDetectionJobFilter (Maybe Text) -- | Filters the list of jobs based on job status. Returns only jobs with -- the specified status. piiEntitiesDetectionJobFilter_jobStatus :: Lens' PiiEntitiesDetectionJobFilter (Maybe JobStatus) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. piiEntitiesDetectionJobFilter_submitTimeAfter :: Lens' PiiEntitiesDetectionJobFilter (Maybe UTCTime) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. piiEntitiesDetectionJobFilter_submitTimeBefore :: Lens' PiiEntitiesDetectionJobFilter (Maybe UTCTime) -- | Provides information about a PII entities detection job. -- -- See: newPiiEntitiesDetectionJobProperties smart -- constructor. data PiiEntitiesDetectionJobProperties PiiEntitiesDetectionJobProperties' :: Maybe Text -> Maybe POSIX -> Maybe InputDataConfig -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe JobStatus -> Maybe LanguageCode -> Maybe Text -> Maybe PiiEntitiesDetectionMode -> Maybe PiiOutputDataConfig -> Maybe RedactionConfig -> Maybe POSIX -> PiiEntitiesDetectionJobProperties -- | The Amazon Resource Name (ARN) that gives Amazon Comprehend read -- access to your input data. [$sel:dataAccessRoleArn:PiiEntitiesDetectionJobProperties'] :: PiiEntitiesDetectionJobProperties -> Maybe Text -- | The time that the PII entities detection job completed. [$sel:endTime:PiiEntitiesDetectionJobProperties'] :: PiiEntitiesDetectionJobProperties -> Maybe POSIX -- | The input properties for a PII entities detection job. [$sel:inputDataConfig:PiiEntitiesDetectionJobProperties'] :: PiiEntitiesDetectionJobProperties -> Maybe InputDataConfig -- | The Amazon Resource Name (ARN) of the PII entities detection job. It -- is a unique, fully qualified identifier for the job. It includes the -- AWS account, Region, and the job ID. The format of the ARN is as -- follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
--
[$sel:jobArn:PiiEntitiesDetectionJobProperties'] :: PiiEntitiesDetectionJobProperties -> Maybe Text -- | The identifier assigned to the PII entities detection job. [$sel:jobId:PiiEntitiesDetectionJobProperties'] :: PiiEntitiesDetectionJobProperties -> Maybe Text -- | The name that you assigned the PII entities detection job. [$sel:jobName:PiiEntitiesDetectionJobProperties'] :: PiiEntitiesDetectionJobProperties -> Maybe Text -- | The current status of the PII entities detection job. If the status is -- FAILED, the Message field shows the reason for the -- failure. [$sel:jobStatus:PiiEntitiesDetectionJobProperties'] :: PiiEntitiesDetectionJobProperties -> Maybe JobStatus -- | The language code of the input documents [$sel:languageCode:PiiEntitiesDetectionJobProperties'] :: PiiEntitiesDetectionJobProperties -> Maybe LanguageCode -- | A description of the status of a job. [$sel:message:PiiEntitiesDetectionJobProperties'] :: PiiEntitiesDetectionJobProperties -> Maybe Text -- | Specifies whether the output provides the locations (offsets) of PII -- entities or a file in which PII entities are redacted. [$sel:mode:PiiEntitiesDetectionJobProperties'] :: PiiEntitiesDetectionJobProperties -> Maybe PiiEntitiesDetectionMode -- | The output data configuration that you supplied when you created the -- PII entities detection job. [$sel:outputDataConfig:PiiEntitiesDetectionJobProperties'] :: PiiEntitiesDetectionJobProperties -> Maybe PiiOutputDataConfig -- | Provides configuration parameters for PII entity redaction. -- -- This parameter is required if you set the Mode parameter to -- ONLY_REDACTION. In that case, you must provide a -- RedactionConfig definition that includes the -- PiiEntityTypes parameter. [$sel:redactionConfig:PiiEntitiesDetectionJobProperties'] :: PiiEntitiesDetectionJobProperties -> Maybe RedactionConfig -- | The time that the PII entities detection job was submitted for -- processing. [$sel:submitTime:PiiEntitiesDetectionJobProperties'] :: PiiEntitiesDetectionJobProperties -> Maybe POSIX -- | Create a value of PiiEntitiesDetectionJobProperties with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:dataAccessRoleArn:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_dataAccessRoleArn - The -- Amazon Resource Name (ARN) that gives Amazon Comprehend read access to -- your input data. -- -- $sel:endTime:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_endTime - The time that the -- PII entities detection job completed. -- -- $sel:inputDataConfig:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_inputDataConfig - The input -- properties for a PII entities detection job. -- -- $sel:jobArn:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_jobArn - The Amazon Resource -- Name (ARN) of the PII entities detection job. It is a unique, fully -- qualified identifier for the job. It includes the AWS account, Region, -- and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- $sel:jobId:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_jobId - The identifier -- assigned to the PII entities detection job. -- -- $sel:jobName:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_jobName - The name that you -- assigned the PII entities detection job. -- -- $sel:jobStatus:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_jobStatus - The current -- status of the PII entities detection job. If the status is -- FAILED, the Message field shows the reason for the -- failure. -- -- $sel:languageCode:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_languageCode - The language -- code of the input documents -- -- $sel:message:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_message - A description of -- the status of a job. -- -- $sel:mode:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_mode - Specifies whether the -- output provides the locations (offsets) of PII entities or a file in -- which PII entities are redacted. -- -- $sel:outputDataConfig:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_outputDataConfig - The output -- data configuration that you supplied when you created the PII entities -- detection job. -- -- $sel:redactionConfig:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_redactionConfig - Provides -- configuration parameters for PII entity redaction. -- -- This parameter is required if you set the Mode parameter to -- ONLY_REDACTION. In that case, you must provide a -- RedactionConfig definition that includes the -- PiiEntityTypes parameter. -- -- $sel:submitTime:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_submitTime - The time that -- the PII entities detection job was submitted for processing. newPiiEntitiesDetectionJobProperties :: PiiEntitiesDetectionJobProperties -- | The Amazon Resource Name (ARN) that gives Amazon Comprehend read -- access to your input data. piiEntitiesDetectionJobProperties_dataAccessRoleArn :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text) -- | The time that the PII entities detection job completed. piiEntitiesDetectionJobProperties_endTime :: Lens' PiiEntitiesDetectionJobProperties (Maybe UTCTime) -- | The input properties for a PII entities detection job. piiEntitiesDetectionJobProperties_inputDataConfig :: Lens' PiiEntitiesDetectionJobProperties (Maybe InputDataConfig) -- | The Amazon Resource Name (ARN) of the PII entities detection job. It -- is a unique, fully qualified identifier for the job. It includes the -- AWS account, Region, and the job ID. The format of the ARN is as -- follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
--
piiEntitiesDetectionJobProperties_jobArn :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text) -- | The identifier assigned to the PII entities detection job. piiEntitiesDetectionJobProperties_jobId :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text) -- | The name that you assigned the PII entities detection job. piiEntitiesDetectionJobProperties_jobName :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text) -- | The current status of the PII entities detection job. If the status is -- FAILED, the Message field shows the reason for the -- failure. piiEntitiesDetectionJobProperties_jobStatus :: Lens' PiiEntitiesDetectionJobProperties (Maybe JobStatus) -- | The language code of the input documents piiEntitiesDetectionJobProperties_languageCode :: Lens' PiiEntitiesDetectionJobProperties (Maybe LanguageCode) -- | A description of the status of a job. piiEntitiesDetectionJobProperties_message :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text) -- | Specifies whether the output provides the locations (offsets) of PII -- entities or a file in which PII entities are redacted. piiEntitiesDetectionJobProperties_mode :: Lens' PiiEntitiesDetectionJobProperties (Maybe PiiEntitiesDetectionMode) -- | The output data configuration that you supplied when you created the -- PII entities detection job. piiEntitiesDetectionJobProperties_outputDataConfig :: Lens' PiiEntitiesDetectionJobProperties (Maybe PiiOutputDataConfig) -- | Provides configuration parameters for PII entity redaction. -- -- This parameter is required if you set the Mode parameter to -- ONLY_REDACTION. In that case, you must provide a -- RedactionConfig definition that includes the -- PiiEntityTypes parameter. piiEntitiesDetectionJobProperties_redactionConfig :: Lens' PiiEntitiesDetectionJobProperties (Maybe RedactionConfig) -- | The time that the PII entities detection job was submitted for -- processing. piiEntitiesDetectionJobProperties_submitTime :: Lens' PiiEntitiesDetectionJobProperties (Maybe UTCTime) -- | Provides information about a PII entity. -- -- See: newPiiEntity smart constructor. data PiiEntity PiiEntity' :: Maybe Int -> Maybe Int -> Maybe Double -> Maybe PiiEntityType -> PiiEntity -- | The zero-based offset from the beginning of the source text to the -- first character in the entity. [$sel:beginOffset:PiiEntity'] :: PiiEntity -> Maybe Int -- | The zero-based offset from the beginning of the source text to the -- last character in the entity. [$sel:endOffset:PiiEntity'] :: PiiEntity -> Maybe Int -- | The level of confidence that Amazon Comprehend has in the accuracy of -- the detection. [$sel:score:PiiEntity'] :: PiiEntity -> Maybe Double -- | The entity's type. [$sel:type':PiiEntity'] :: PiiEntity -> Maybe PiiEntityType -- | Create a value of PiiEntity with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:beginOffset:PiiEntity', piiEntity_beginOffset - The -- zero-based offset from the beginning of the source text to the first -- character in the entity. -- -- $sel:endOffset:PiiEntity', piiEntity_endOffset - The -- zero-based offset from the beginning of the source text to the last -- character in the entity. -- -- $sel:score:PiiEntity', piiEntity_score - The level of -- confidence that Amazon Comprehend has in the accuracy of the -- detection. -- -- $sel:type':PiiEntity', piiEntity_type - The entity's -- type. newPiiEntity :: PiiEntity -- | The zero-based offset from the beginning of the source text to the -- first character in the entity. piiEntity_beginOffset :: Lens' PiiEntity (Maybe Int) -- | The zero-based offset from the beginning of the source text to the -- last character in the entity. piiEntity_endOffset :: Lens' PiiEntity (Maybe Int) -- | The level of confidence that Amazon Comprehend has in the accuracy of -- the detection. piiEntity_score :: Lens' PiiEntity (Maybe Double) -- | The entity's type. piiEntity_type :: Lens' PiiEntity (Maybe PiiEntityType) -- | Provides configuration parameters for the output of PII entity -- detection jobs. -- -- See: newPiiOutputDataConfig smart constructor. data PiiOutputDataConfig PiiOutputDataConfig' :: Maybe Text -> Text -> PiiOutputDataConfig -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt the output results from an analysis job. [$sel:kmsKeyId:PiiOutputDataConfig'] :: PiiOutputDataConfig -> Maybe Text -- | When you use the PiiOutputDataConfig object with asynchronous -- operations, you specify the Amazon S3 location where you want to write -- the output data. -- -- For a PII entity detection job, the output file is plain text, not a -- compressed archive. The output file name is the same as the input -- file, with .out appended at the end. [$sel:s3Uri:PiiOutputDataConfig'] :: PiiOutputDataConfig -> Text -- | Create a value of PiiOutputDataConfig with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:kmsKeyId:PiiOutputDataConfig', -- piiOutputDataConfig_kmsKeyId - ID for the AWS Key Management -- Service (KMS) key that Amazon Comprehend uses to encrypt the output -- results from an analysis job. -- -- $sel:s3Uri:PiiOutputDataConfig', -- piiOutputDataConfig_s3Uri - When you use the -- PiiOutputDataConfig object with asynchronous operations, you -- specify the Amazon S3 location where you want to write the output -- data. -- -- For a PII entity detection job, the output file is plain text, not a -- compressed archive. The output file name is the same as the input -- file, with .out appended at the end. newPiiOutputDataConfig :: Text -> PiiOutputDataConfig -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt the output results from an analysis job. piiOutputDataConfig_kmsKeyId :: Lens' PiiOutputDataConfig (Maybe Text) -- | When you use the PiiOutputDataConfig object with asynchronous -- operations, you specify the Amazon S3 location where you want to write -- the output data. -- -- For a PII entity detection job, the output file is plain text, not a -- compressed archive. The output file name is the same as the input -- file, with .out appended at the end. piiOutputDataConfig_s3Uri :: Lens' PiiOutputDataConfig Text -- | The X and Y coordinates of a point on a document page. -- -- For additional information, see Point in the Amazon Textract -- API reference. -- -- See: newPoint smart constructor. data Point Point' :: Maybe Double -> Maybe Double -> Point -- | The value of the X coordinate for a point on a polygon [$sel:x:Point'] :: Point -> Maybe Double -- | The value of the Y coordinate for a point on a polygon [$sel:y:Point'] :: Point -> Maybe Double -- | Create a value of Point with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:x:Point', point_x - The value of the X coordinate -- for a point on a polygon -- -- $sel:y:Point', point_y - The value of the Y coordinate -- for a point on a polygon newPoint :: Point -- | The value of the X coordinate for a point on a polygon point_x :: Lens' Point (Maybe Double) -- | The value of the Y coordinate for a point on a polygon point_y :: Lens' Point (Maybe Double) -- | Provides configuration parameters for PII entity redaction. -- -- See: newRedactionConfig smart constructor. data RedactionConfig RedactionConfig' :: Maybe Text -> Maybe PiiEntitiesDetectionMaskMode -> Maybe [PiiEntityType] -> RedactionConfig -- | A character that replaces each character in the redacted PII entity. [$sel:maskCharacter:RedactionConfig'] :: RedactionConfig -> Maybe Text -- | Specifies whether the PII entity is redacted with the mask character -- or the entity type. [$sel:maskMode:RedactionConfig'] :: RedactionConfig -> Maybe PiiEntitiesDetectionMaskMode -- | An array of the types of PII entities that Amazon Comprehend detects -- in the input text for your request. [$sel:piiEntityTypes:RedactionConfig'] :: RedactionConfig -> Maybe [PiiEntityType] -- | Create a value of RedactionConfig with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:maskCharacter:RedactionConfig', -- redactionConfig_maskCharacter - A character that replaces each -- character in the redacted PII entity. -- -- $sel:maskMode:RedactionConfig', redactionConfig_maskMode -- - Specifies whether the PII entity is redacted with the mask character -- or the entity type. -- -- $sel:piiEntityTypes:RedactionConfig', -- redactionConfig_piiEntityTypes - An array of the types of PII -- entities that Amazon Comprehend detects in the input text for your -- request. newRedactionConfig :: RedactionConfig -- | A character that replaces each character in the redacted PII entity. redactionConfig_maskCharacter :: Lens' RedactionConfig (Maybe Text) -- | Specifies whether the PII entity is redacted with the mask character -- or the entity type. redactionConfig_maskMode :: Lens' RedactionConfig (Maybe PiiEntitiesDetectionMaskMode) -- | An array of the types of PII entities that Amazon Comprehend detects -- in the input text for your request. redactionConfig_piiEntityTypes :: Lens' RedactionConfig (Maybe [PiiEntityType]) -- | List of child blocks for the current block. -- -- See: newRelationshipsListItem smart constructor. data RelationshipsListItem RelationshipsListItem' :: Maybe [Text] -> Maybe RelationshipType -> RelationshipsListItem -- | Identifers of the child blocks. [$sel:ids:RelationshipsListItem'] :: RelationshipsListItem -> Maybe [Text] -- | Only supported relationship is a child relationship. [$sel:type':RelationshipsListItem'] :: RelationshipsListItem -> Maybe RelationshipType -- | Create a value of RelationshipsListItem with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:ids:RelationshipsListItem', -- relationshipsListItem_ids - Identifers of the child blocks. -- -- $sel:type':RelationshipsListItem', -- relationshipsListItem_type - Only supported relationship is a -- child relationship. newRelationshipsListItem :: RelationshipsListItem -- | Identifers of the child blocks. relationshipsListItem_ids :: Lens' RelationshipsListItem (Maybe [Text]) -- | Only supported relationship is a child relationship. relationshipsListItem_type :: Lens' RelationshipsListItem (Maybe RelationshipType) -- | Provides information for filtering a list of dominant language -- detection jobs. For more information, see the operation. -- -- See: newSentimentDetectionJobFilter smart constructor. data SentimentDetectionJobFilter SentimentDetectionJobFilter' :: Maybe Text -> Maybe JobStatus -> Maybe POSIX -> Maybe POSIX -> SentimentDetectionJobFilter -- | Filters on the name of the job. [$sel:jobName:SentimentDetectionJobFilter'] :: SentimentDetectionJobFilter -> Maybe Text -- | Filters the list of jobs based on job status. Returns only jobs with -- the specified status. [$sel:jobStatus:SentimentDetectionJobFilter'] :: SentimentDetectionJobFilter -> Maybe JobStatus -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. [$sel:submitTimeAfter:SentimentDetectionJobFilter'] :: SentimentDetectionJobFilter -> Maybe POSIX -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. [$sel:submitTimeBefore:SentimentDetectionJobFilter'] :: SentimentDetectionJobFilter -> Maybe POSIX -- | Create a value of SentimentDetectionJobFilter with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:jobName:SentimentDetectionJobFilter', -- sentimentDetectionJobFilter_jobName - Filters on the name of -- the job. -- -- $sel:jobStatus:SentimentDetectionJobFilter', -- sentimentDetectionJobFilter_jobStatus - Filters the list of -- jobs based on job status. Returns only jobs with the specified status. -- -- $sel:submitTimeAfter:SentimentDetectionJobFilter', -- sentimentDetectionJobFilter_submitTimeAfter - Filters the list -- of jobs based on the time that the job was submitted for processing. -- Returns only jobs submitted after the specified time. Jobs are -- returned in descending order, newest to oldest. -- -- $sel:submitTimeBefore:SentimentDetectionJobFilter', -- sentimentDetectionJobFilter_submitTimeBefore - Filters the list -- of jobs based on the time that the job was submitted for processing. -- Returns only jobs submitted before the specified time. Jobs are -- returned in ascending order, oldest to newest. newSentimentDetectionJobFilter :: SentimentDetectionJobFilter -- | Filters on the name of the job. sentimentDetectionJobFilter_jobName :: Lens' SentimentDetectionJobFilter (Maybe Text) -- | Filters the list of jobs based on job status. Returns only jobs with -- the specified status. sentimentDetectionJobFilter_jobStatus :: Lens' SentimentDetectionJobFilter (Maybe JobStatus) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. sentimentDetectionJobFilter_submitTimeAfter :: Lens' SentimentDetectionJobFilter (Maybe UTCTime) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. sentimentDetectionJobFilter_submitTimeBefore :: Lens' SentimentDetectionJobFilter (Maybe UTCTime) -- | Provides information about a sentiment detection job. -- -- See: newSentimentDetectionJobProperties smart -- constructor. data SentimentDetectionJobProperties SentimentDetectionJobProperties' :: Maybe Text -> Maybe POSIX -> Maybe InputDataConfig -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe JobStatus -> Maybe LanguageCode -> Maybe Text -> Maybe OutputDataConfig -> Maybe POSIX -> Maybe Text -> Maybe VpcConfig -> SentimentDetectionJobProperties -- | The Amazon Resource Name (ARN) that gives Amazon Comprehend read -- access to your input data. [$sel:dataAccessRoleArn:SentimentDetectionJobProperties'] :: SentimentDetectionJobProperties -> Maybe Text -- | The time that the sentiment detection job ended. [$sel:endTime:SentimentDetectionJobProperties'] :: SentimentDetectionJobProperties -> Maybe POSIX -- | The input data configuration that you supplied when you created the -- sentiment detection job. [$sel:inputDataConfig:SentimentDetectionJobProperties'] :: SentimentDetectionJobProperties -> Maybe InputDataConfig -- | The Amazon Resource Name (ARN) of the sentiment detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
--
[$sel:jobArn:SentimentDetectionJobProperties'] :: SentimentDetectionJobProperties -> Maybe Text -- | The identifier assigned to the sentiment detection job. [$sel:jobId:SentimentDetectionJobProperties'] :: SentimentDetectionJobProperties -> Maybe Text -- | The name that you assigned to the sentiment detection job [$sel:jobName:SentimentDetectionJobProperties'] :: SentimentDetectionJobProperties -> Maybe Text -- | The current status of the sentiment detection job. If the status is -- FAILED, the Messages field shows the reason for the -- failure. [$sel:jobStatus:SentimentDetectionJobProperties'] :: SentimentDetectionJobProperties -> Maybe JobStatus -- | The language code of the input documents. [$sel:languageCode:SentimentDetectionJobProperties'] :: SentimentDetectionJobProperties -> Maybe LanguageCode -- | A description of the status of a job. [$sel:message:SentimentDetectionJobProperties'] :: SentimentDetectionJobProperties -> Maybe Text -- | The output data configuration that you supplied when you created the -- sentiment detection job. [$sel:outputDataConfig:SentimentDetectionJobProperties'] :: SentimentDetectionJobProperties -> Maybe OutputDataConfig -- | The time that the sentiment detection job was submitted for -- processing. [$sel:submitTime:SentimentDetectionJobProperties'] :: SentimentDetectionJobProperties -> Maybe POSIX -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- [$sel:volumeKmsKeyId:SentimentDetectionJobProperties'] :: SentimentDetectionJobProperties -> Maybe Text -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your sentiment detection -- job. For more information, see Amazon VPC. [$sel:vpcConfig:SentimentDetectionJobProperties'] :: SentimentDetectionJobProperties -> Maybe VpcConfig -- | Create a value of SentimentDetectionJobProperties with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:dataAccessRoleArn:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_dataAccessRoleArn - The Amazon -- Resource Name (ARN) that gives Amazon Comprehend read access to your -- input data. -- -- $sel:endTime:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_endTime - The time that the -- sentiment detection job ended. -- -- $sel:inputDataConfig:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_inputDataConfig - The input -- data configuration that you supplied when you created the sentiment -- detection job. -- -- $sel:jobArn:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_jobArn - The Amazon Resource -- Name (ARN) of the sentiment detection job. It is a unique, fully -- qualified identifier for the job. It includes the AWS account, Region, -- and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- $sel:jobId:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_jobId - The identifier assigned -- to the sentiment detection job. -- -- $sel:jobName:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_jobName - The name that you -- assigned to the sentiment detection job -- -- $sel:jobStatus:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_jobStatus - The current status -- of the sentiment detection job. If the status is FAILED, the -- Messages field shows the reason for the failure. -- -- $sel:languageCode:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_languageCode - The language -- code of the input documents. -- -- $sel:message:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_message - A description of the -- status of a job. -- -- $sel:outputDataConfig:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_outputDataConfig - The output -- data configuration that you supplied when you created the sentiment -- detection job. -- -- $sel:submitTime:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_submitTime - The time that the -- sentiment detection job was submitted for processing. -- -- $sel:volumeKmsKeyId:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_volumeKmsKeyId - ID for the AWS -- Key Management Service (KMS) key that Amazon Comprehend uses to -- encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- -- -- $sel:vpcConfig:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_vpcConfig - Configuration -- parameters for a private Virtual Private Cloud (VPC) containing the -- resources you are using for your sentiment detection job. For more -- information, see Amazon VPC. newSentimentDetectionJobProperties :: SentimentDetectionJobProperties -- | The Amazon Resource Name (ARN) that gives Amazon Comprehend read -- access to your input data. sentimentDetectionJobProperties_dataAccessRoleArn :: Lens' SentimentDetectionJobProperties (Maybe Text) -- | The time that the sentiment detection job ended. sentimentDetectionJobProperties_endTime :: Lens' SentimentDetectionJobProperties (Maybe UTCTime) -- | The input data configuration that you supplied when you created the -- sentiment detection job. sentimentDetectionJobProperties_inputDataConfig :: Lens' SentimentDetectionJobProperties (Maybe InputDataConfig) -- | The Amazon Resource Name (ARN) of the sentiment detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
--
sentimentDetectionJobProperties_jobArn :: Lens' SentimentDetectionJobProperties (Maybe Text) -- | The identifier assigned to the sentiment detection job. sentimentDetectionJobProperties_jobId :: Lens' SentimentDetectionJobProperties (Maybe Text) -- | The name that you assigned to the sentiment detection job sentimentDetectionJobProperties_jobName :: Lens' SentimentDetectionJobProperties (Maybe Text) -- | The current status of the sentiment detection job. If the status is -- FAILED, the Messages field shows the reason for the -- failure. sentimentDetectionJobProperties_jobStatus :: Lens' SentimentDetectionJobProperties (Maybe JobStatus) -- | The language code of the input documents. sentimentDetectionJobProperties_languageCode :: Lens' SentimentDetectionJobProperties (Maybe LanguageCode) -- | A description of the status of a job. sentimentDetectionJobProperties_message :: Lens' SentimentDetectionJobProperties (Maybe Text) -- | The output data configuration that you supplied when you created the -- sentiment detection job. sentimentDetectionJobProperties_outputDataConfig :: Lens' SentimentDetectionJobProperties (Maybe OutputDataConfig) -- | The time that the sentiment detection job was submitted for -- processing. sentimentDetectionJobProperties_submitTime :: Lens' SentimentDetectionJobProperties (Maybe UTCTime) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- sentimentDetectionJobProperties_volumeKmsKeyId :: Lens' SentimentDetectionJobProperties (Maybe Text) -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your sentiment detection -- job. For more information, see Amazon VPC. sentimentDetectionJobProperties_vpcConfig :: Lens' SentimentDetectionJobProperties (Maybe VpcConfig) -- | Describes the level of confidence that Amazon Comprehend has in the -- accuracy of its detection of sentiments. -- -- See: newSentimentScore smart constructor. data SentimentScore SentimentScore' :: Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> SentimentScore -- | The level of confidence that Amazon Comprehend has in the accuracy of -- its detection of the MIXED sentiment. [$sel:mixed:SentimentScore'] :: SentimentScore -> Maybe Double -- | The level of confidence that Amazon Comprehend has in the accuracy of -- its detection of the NEGATIVE sentiment. [$sel:negative:SentimentScore'] :: SentimentScore -> Maybe Double -- | The level of confidence that Amazon Comprehend has in the accuracy of -- its detection of the NEUTRAL sentiment. [$sel:neutral:SentimentScore'] :: SentimentScore -> Maybe Double -- | The level of confidence that Amazon Comprehend has in the accuracy of -- its detection of the POSITIVE sentiment. [$sel:positive:SentimentScore'] :: SentimentScore -> Maybe Double -- | Create a value of SentimentScore with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:mixed:SentimentScore', sentimentScore_mixed - The -- level of confidence that Amazon Comprehend has in the accuracy of its -- detection of the MIXED sentiment. -- -- $sel:negative:SentimentScore', sentimentScore_negative - -- The level of confidence that Amazon Comprehend has in the accuracy of -- its detection of the NEGATIVE sentiment. -- -- $sel:neutral:SentimentScore', sentimentScore_neutral - -- The level of confidence that Amazon Comprehend has in the accuracy of -- its detection of the NEUTRAL sentiment. -- -- $sel:positive:SentimentScore', sentimentScore_positive - -- The level of confidence that Amazon Comprehend has in the accuracy of -- its detection of the POSITIVE sentiment. newSentimentScore :: SentimentScore -- | The level of confidence that Amazon Comprehend has in the accuracy of -- its detection of the MIXED sentiment. sentimentScore_mixed :: Lens' SentimentScore (Maybe Double) -- | The level of confidence that Amazon Comprehend has in the accuracy of -- its detection of the NEGATIVE sentiment. sentimentScore_negative :: Lens' SentimentScore (Maybe Double) -- | The level of confidence that Amazon Comprehend has in the accuracy of -- its detection of the NEUTRAL sentiment. sentimentScore_neutral :: Lens' SentimentScore (Maybe Double) -- | The level of confidence that Amazon Comprehend has in the accuracy of -- its detection of the POSITIVE sentiment. sentimentScore_positive :: Lens' SentimentScore (Maybe Double) -- | Represents a work in the input text that was recognized and assigned a -- part of speech. There is one syntax token record for each word in the -- source text. -- -- See: newSyntaxToken smart constructor. data SyntaxToken SyntaxToken' :: Maybe Int -> Maybe Int -> Maybe PartOfSpeechTag -> Maybe Text -> Maybe Int -> SyntaxToken -- | The zero-based offset from the beginning of the source text to the -- first character in the word. [$sel:beginOffset:SyntaxToken'] :: SyntaxToken -> Maybe Int -- | The zero-based offset from the beginning of the source text to the -- last character in the word. [$sel:endOffset:SyntaxToken'] :: SyntaxToken -> Maybe Int -- | Provides the part of speech label and the confidence level that Amazon -- Comprehend has that the part of speech was correctly identified. For -- more information, see Syntax in the Comprehend Developer Guide. [$sel:partOfSpeech:SyntaxToken'] :: SyntaxToken -> Maybe PartOfSpeechTag -- | The word that was recognized in the source text. [$sel:text:SyntaxToken'] :: SyntaxToken -> Maybe Text -- | A unique identifier for a token. [$sel:tokenId:SyntaxToken'] :: SyntaxToken -> Maybe Int -- | Create a value of SyntaxToken with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:beginOffset:SyntaxToken', syntaxToken_beginOffset - -- The zero-based offset from the beginning of the source text to the -- first character in the word. -- -- $sel:endOffset:SyntaxToken', syntaxToken_endOffset - The -- zero-based offset from the beginning of the source text to the last -- character in the word. -- -- $sel:partOfSpeech:SyntaxToken', syntaxToken_partOfSpeech -- - Provides the part of speech label and the confidence level that -- Amazon Comprehend has that the part of speech was correctly -- identified. For more information, see Syntax in the Comprehend -- Developer Guide. -- -- $sel:text:SyntaxToken', syntaxToken_text - The word that -- was recognized in the source text. -- -- $sel:tokenId:SyntaxToken', syntaxToken_tokenId - A -- unique identifier for a token. newSyntaxToken :: SyntaxToken -- | The zero-based offset from the beginning of the source text to the -- first character in the word. syntaxToken_beginOffset :: Lens' SyntaxToken (Maybe Int) -- | The zero-based offset from the beginning of the source text to the -- last character in the word. syntaxToken_endOffset :: Lens' SyntaxToken (Maybe Int) -- | Provides the part of speech label and the confidence level that Amazon -- Comprehend has that the part of speech was correctly identified. For -- more information, see Syntax in the Comprehend Developer Guide. syntaxToken_partOfSpeech :: Lens' SyntaxToken (Maybe PartOfSpeechTag) -- | The word that was recognized in the source text. syntaxToken_text :: Lens' SyntaxToken (Maybe Text) -- | A unique identifier for a token. syntaxToken_tokenId :: Lens' SyntaxToken (Maybe Int) -- | A key-value pair that adds as a metadata to a resource used by Amazon -- Comprehend. For example, a tag with the key-value pair -- ‘Department’:’Sales’ might be added to a resource to indicate its use -- by a particular department. -- -- See: newTag smart constructor. data Tag Tag' :: Maybe Text -> Text -> Tag -- | The second part of a key-value pair that forms a tag associated with a -- given resource. For instance, if you want to show which resources are -- used by which departments, you might use “Department” as the initial -- (key) portion of the pair, with a value of “sales” to indicate the -- sales department. [$sel:value:Tag'] :: Tag -> Maybe Text -- | The initial part of a key-value pair that forms a tag associated with -- a given resource. For instance, if you want to show which resources -- are used by which departments, you might use “Department” as the key -- portion of the pair, with multiple possible values such as “sales,” -- “legal,” and “administration.” [$sel:key:Tag'] :: Tag -> Text -- | Create a value of Tag with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:value:Tag', tag_value - The second part of a -- key-value pair that forms a tag associated with a given resource. For -- instance, if you want to show which resources are used by which -- departments, you might use “Department” as the initial (key) portion -- of the pair, with a value of “sales” to indicate the sales department. -- -- $sel:key:Tag', tag_key - The initial part of a key-value -- pair that forms a tag associated with a given resource. For instance, -- if you want to show which resources are used by which departments, you -- might use “Department” as the key portion of the pair, with multiple -- possible values such as “sales,” “legal,” and “administration.” newTag :: Text -> Tag -- | The second part of a key-value pair that forms a tag associated with a -- given resource. For instance, if you want to show which resources are -- used by which departments, you might use “Department” as the initial -- (key) portion of the pair, with a value of “sales” to indicate the -- sales department. tag_value :: Lens' Tag (Maybe Text) -- | The initial part of a key-value pair that forms a tag associated with -- a given resource. For instance, if you want to show which resources -- are used by which departments, you might use “Department” as the key -- portion of the pair, with multiple possible values such as “sales,” -- “legal,” and “administration.” tag_key :: Lens' Tag Text -- | Provides information for filtering a list of dominant language -- detection jobs. For more information, see the operation. -- -- See: newTargetedSentimentDetectionJobFilter smart -- constructor. data TargetedSentimentDetectionJobFilter TargetedSentimentDetectionJobFilter' :: Maybe Text -> Maybe JobStatus -> Maybe POSIX -> Maybe POSIX -> TargetedSentimentDetectionJobFilter -- | Filters on the name of the job. [$sel:jobName:TargetedSentimentDetectionJobFilter'] :: TargetedSentimentDetectionJobFilter -> Maybe Text -- | Filters the list of jobs based on job status. Returns only jobs with -- the specified status. [$sel:jobStatus:TargetedSentimentDetectionJobFilter'] :: TargetedSentimentDetectionJobFilter -> Maybe JobStatus -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. [$sel:submitTimeAfter:TargetedSentimentDetectionJobFilter'] :: TargetedSentimentDetectionJobFilter -> Maybe POSIX -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. [$sel:submitTimeBefore:TargetedSentimentDetectionJobFilter'] :: TargetedSentimentDetectionJobFilter -> Maybe POSIX -- | Create a value of TargetedSentimentDetectionJobFilter with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:jobName:TargetedSentimentDetectionJobFilter', -- targetedSentimentDetectionJobFilter_jobName - Filters on the -- name of the job. -- -- $sel:jobStatus:TargetedSentimentDetectionJobFilter', -- targetedSentimentDetectionJobFilter_jobStatus - Filters the -- list of jobs based on job status. Returns only jobs with the specified -- status. -- -- $sel:submitTimeAfter:TargetedSentimentDetectionJobFilter', -- targetedSentimentDetectionJobFilter_submitTimeAfter - Filters -- the list of jobs based on the time that the job was submitted for -- processing. Returns only jobs submitted after the specified time. Jobs -- are returned in descending order, newest to oldest. -- -- $sel:submitTimeBefore:TargetedSentimentDetectionJobFilter', -- targetedSentimentDetectionJobFilter_submitTimeBefore - Filters -- the list of jobs based on the time that the job was submitted for -- processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. newTargetedSentimentDetectionJobFilter :: TargetedSentimentDetectionJobFilter -- | Filters on the name of the job. targetedSentimentDetectionJobFilter_jobName :: Lens' TargetedSentimentDetectionJobFilter (Maybe Text) -- | Filters the list of jobs based on job status. Returns only jobs with -- the specified status. targetedSentimentDetectionJobFilter_jobStatus :: Lens' TargetedSentimentDetectionJobFilter (Maybe JobStatus) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. targetedSentimentDetectionJobFilter_submitTimeAfter :: Lens' TargetedSentimentDetectionJobFilter (Maybe UTCTime) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. targetedSentimentDetectionJobFilter_submitTimeBefore :: Lens' TargetedSentimentDetectionJobFilter (Maybe UTCTime) -- | Provides information about a targeted sentiment detection job. -- -- See: newTargetedSentimentDetectionJobProperties smart -- constructor. data TargetedSentimentDetectionJobProperties TargetedSentimentDetectionJobProperties' :: Maybe Text -> Maybe POSIX -> Maybe InputDataConfig -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe JobStatus -> Maybe LanguageCode -> Maybe Text -> Maybe OutputDataConfig -> Maybe POSIX -> Maybe Text -> Maybe VpcConfig -> TargetedSentimentDetectionJobProperties -- | The Amazon Resource Name (ARN) that gives Amazon Comprehend read -- access to your input data. [$sel:dataAccessRoleArn:TargetedSentimentDetectionJobProperties'] :: TargetedSentimentDetectionJobProperties -> Maybe Text -- | The time that the targeted sentiment detection job ended. [$sel:endTime:TargetedSentimentDetectionJobProperties'] :: TargetedSentimentDetectionJobProperties -> Maybe POSIX [$sel:inputDataConfig:TargetedSentimentDetectionJobProperties'] :: TargetedSentimentDetectionJobProperties -> Maybe InputDataConfig -- | The Amazon Resource Name (ARN) of the targeted sentiment detection -- job. It is a unique, fully qualified identifier for the job. It -- includes the AWS account, Region, and the job ID. The format of the -- ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
--
[$sel:jobArn:TargetedSentimentDetectionJobProperties'] :: TargetedSentimentDetectionJobProperties -> Maybe Text -- | The identifier assigned to the targeted sentiment detection job. [$sel:jobId:TargetedSentimentDetectionJobProperties'] :: TargetedSentimentDetectionJobProperties -> Maybe Text -- | The name that you assigned to the targeted sentiment detection job. [$sel:jobName:TargetedSentimentDetectionJobProperties'] :: TargetedSentimentDetectionJobProperties -> Maybe Text -- | The current status of the targeted sentiment detection job. If the -- status is FAILED, the Messages field shows the -- reason for the failure. [$sel:jobStatus:TargetedSentimentDetectionJobProperties'] :: TargetedSentimentDetectionJobProperties -> Maybe JobStatus -- | The language code of the input documents. [$sel:languageCode:TargetedSentimentDetectionJobProperties'] :: TargetedSentimentDetectionJobProperties -> Maybe LanguageCode -- | A description of the status of a job. [$sel:message:TargetedSentimentDetectionJobProperties'] :: TargetedSentimentDetectionJobProperties -> Maybe Text [$sel:outputDataConfig:TargetedSentimentDetectionJobProperties'] :: TargetedSentimentDetectionJobProperties -> Maybe OutputDataConfig -- | The time that the targeted sentiment detection job was submitted for -- processing. [$sel:submitTime:TargetedSentimentDetectionJobProperties'] :: TargetedSentimentDetectionJobProperties -> Maybe POSIX -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the targeted sentiment detection job. The -- VolumeKmsKeyId can be either of the following formats: -- -- [$sel:volumeKmsKeyId:TargetedSentimentDetectionJobProperties'] :: TargetedSentimentDetectionJobProperties -> Maybe Text [$sel:vpcConfig:TargetedSentimentDetectionJobProperties'] :: TargetedSentimentDetectionJobProperties -> Maybe VpcConfig -- | Create a value of TargetedSentimentDetectionJobProperties with -- all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:dataAccessRoleArn:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_dataAccessRoleArn - The -- Amazon Resource Name (ARN) that gives Amazon Comprehend read access to -- your input data. -- -- $sel:endTime:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_endTime - The time that -- the targeted sentiment detection job ended. -- -- $sel:inputDataConfig:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_inputDataConfig - -- Undocumented member. -- -- $sel:jobArn:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_jobArn - The Amazon -- Resource Name (ARN) of the targeted sentiment detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- $sel:jobId:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_jobId - The identifier -- assigned to the targeted sentiment detection job. -- -- $sel:jobName:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_jobName - The name that -- you assigned to the targeted sentiment detection job. -- -- $sel:jobStatus:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_jobStatus - The current -- status of the targeted sentiment detection job. If the status is -- FAILED, the Messages field shows the reason for the -- failure. -- -- $sel:languageCode:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_languageCode - The -- language code of the input documents. -- -- $sel:message:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_message - A description -- of the status of a job. -- -- $sel:outputDataConfig:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_outputDataConfig - -- Undocumented member. -- -- $sel:submitTime:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_submitTime - The time -- that the targeted sentiment detection job was submitted for -- processing. -- -- $sel:volumeKmsKeyId:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_volumeKmsKeyId - ID for -- the AWS Key Management Service (KMS) key that Amazon Comprehend uses -- to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the targeted sentiment detection job. The -- VolumeKmsKeyId can be either of the following formats: -- -- -- -- $sel:vpcConfig:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_vpcConfig - -- Undocumented member. newTargetedSentimentDetectionJobProperties :: TargetedSentimentDetectionJobProperties -- | The Amazon Resource Name (ARN) that gives Amazon Comprehend read -- access to your input data. targetedSentimentDetectionJobProperties_dataAccessRoleArn :: Lens' TargetedSentimentDetectionJobProperties (Maybe Text) -- | The time that the targeted sentiment detection job ended. targetedSentimentDetectionJobProperties_endTime :: Lens' TargetedSentimentDetectionJobProperties (Maybe UTCTime) -- | Undocumented member. targetedSentimentDetectionJobProperties_inputDataConfig :: Lens' TargetedSentimentDetectionJobProperties (Maybe InputDataConfig) -- | The Amazon Resource Name (ARN) of the targeted sentiment detection -- job. It is a unique, fully qualified identifier for the job. It -- includes the AWS account, Region, and the job ID. The format of the -- ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
--
targetedSentimentDetectionJobProperties_jobArn :: Lens' TargetedSentimentDetectionJobProperties (Maybe Text) -- | The identifier assigned to the targeted sentiment detection job. targetedSentimentDetectionJobProperties_jobId :: Lens' TargetedSentimentDetectionJobProperties (Maybe Text) -- | The name that you assigned to the targeted sentiment detection job. targetedSentimentDetectionJobProperties_jobName :: Lens' TargetedSentimentDetectionJobProperties (Maybe Text) -- | The current status of the targeted sentiment detection job. If the -- status is FAILED, the Messages field shows the -- reason for the failure. targetedSentimentDetectionJobProperties_jobStatus :: Lens' TargetedSentimentDetectionJobProperties (Maybe JobStatus) -- | The language code of the input documents. targetedSentimentDetectionJobProperties_languageCode :: Lens' TargetedSentimentDetectionJobProperties (Maybe LanguageCode) -- | A description of the status of a job. targetedSentimentDetectionJobProperties_message :: Lens' TargetedSentimentDetectionJobProperties (Maybe Text) -- | Undocumented member. targetedSentimentDetectionJobProperties_outputDataConfig :: Lens' TargetedSentimentDetectionJobProperties (Maybe OutputDataConfig) -- | The time that the targeted sentiment detection job was submitted for -- processing. targetedSentimentDetectionJobProperties_submitTime :: Lens' TargetedSentimentDetectionJobProperties (Maybe UTCTime) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the targeted sentiment detection job. The -- VolumeKmsKeyId can be either of the following formats: -- -- targetedSentimentDetectionJobProperties_volumeKmsKeyId :: Lens' TargetedSentimentDetectionJobProperties (Maybe Text) -- | Undocumented member. targetedSentimentDetectionJobProperties_vpcConfig :: Lens' TargetedSentimentDetectionJobProperties (Maybe VpcConfig) -- | Information about one of the entities found by targeted sentiment -- analysis. -- -- For more information about targeted sentiment, see Targeted -- sentiment. -- -- See: newTargetedSentimentEntity smart constructor. data TargetedSentimentEntity TargetedSentimentEntity' :: Maybe [Int] -> Maybe [TargetedSentimentMention] -> TargetedSentimentEntity -- | One or more index into the Mentions array that provides the best name -- for the entity group. [$sel:descriptiveMentionIndex:TargetedSentimentEntity'] :: TargetedSentimentEntity -> Maybe [Int] -- | An array of mentions of the entity in the document. The array -- represents a co-reference group. See Co-reference group for an -- example. [$sel:mentions:TargetedSentimentEntity'] :: TargetedSentimentEntity -> Maybe [TargetedSentimentMention] -- | Create a value of TargetedSentimentEntity with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:descriptiveMentionIndex:TargetedSentimentEntity', -- targetedSentimentEntity_descriptiveMentionIndex - One or more -- index into the Mentions array that provides the best name for the -- entity group. -- -- $sel:mentions:TargetedSentimentEntity', -- targetedSentimentEntity_mentions - An array of mentions of the -- entity in the document. The array represents a co-reference group. See -- Co-reference group for an example. newTargetedSentimentEntity :: TargetedSentimentEntity -- | One or more index into the Mentions array that provides the best name -- for the entity group. targetedSentimentEntity_descriptiveMentionIndex :: Lens' TargetedSentimentEntity (Maybe [Int]) -- | An array of mentions of the entity in the document. The array -- represents a co-reference group. See Co-reference group for an -- example. targetedSentimentEntity_mentions :: Lens' TargetedSentimentEntity (Maybe [TargetedSentimentMention]) -- | Information about one mention of an entity. The mention information -- includes the location of the mention in the text and the sentiment of -- the mention. -- -- For more information about targeted sentiment, see Targeted -- sentiment. -- -- See: newTargetedSentimentMention smart constructor. data TargetedSentimentMention TargetedSentimentMention' :: Maybe Int -> Maybe Int -> Maybe Double -> Maybe MentionSentiment -> Maybe Double -> Maybe Text -> Maybe TargetedSentimentEntityType -> TargetedSentimentMention -- | The offset into the document text where the mention begins. [$sel:beginOffset:TargetedSentimentMention'] :: TargetedSentimentMention -> Maybe Int -- | The offset into the document text where the mention ends. [$sel:endOffset:TargetedSentimentMention'] :: TargetedSentimentMention -> Maybe Int -- | The confidence that all the entities mentioned in the group relate to -- the same entity. [$sel:groupScore:TargetedSentimentMention'] :: TargetedSentimentMention -> Maybe Double -- | Contains the sentiment and sentiment score for the mention. [$sel:mentionSentiment:TargetedSentimentMention'] :: TargetedSentimentMention -> Maybe MentionSentiment -- | Model confidence that the entity is relevant. Value range is zero to -- one, where one is highest confidence. [$sel:score:TargetedSentimentMention'] :: TargetedSentimentMention -> Maybe Double -- | The text in the document that identifies the entity. [$sel:text:TargetedSentimentMention'] :: TargetedSentimentMention -> Maybe Text -- | The type of the entity. Amazon Comprehend supports a variety of -- entity types. [$sel:type':TargetedSentimentMention'] :: TargetedSentimentMention -> Maybe TargetedSentimentEntityType -- | Create a value of TargetedSentimentMention with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:beginOffset:TargetedSentimentMention', -- targetedSentimentMention_beginOffset - The offset into the -- document text where the mention begins. -- -- $sel:endOffset:TargetedSentimentMention', -- targetedSentimentMention_endOffset - The offset into the -- document text where the mention ends. -- -- $sel:groupScore:TargetedSentimentMention', -- targetedSentimentMention_groupScore - The confidence that all -- the entities mentioned in the group relate to the same entity. -- -- $sel:mentionSentiment:TargetedSentimentMention', -- targetedSentimentMention_mentionSentiment - Contains the -- sentiment and sentiment score for the mention. -- -- $sel:score:TargetedSentimentMention', -- targetedSentimentMention_score - Model confidence that the -- entity is relevant. Value range is zero to one, where one is highest -- confidence. -- -- $sel:text:TargetedSentimentMention', -- targetedSentimentMention_text - The text in the document that -- identifies the entity. -- -- $sel:type':TargetedSentimentMention', -- targetedSentimentMention_type - The type of the entity. Amazon -- Comprehend supports a variety of entity types. newTargetedSentimentMention :: TargetedSentimentMention -- | The offset into the document text where the mention begins. targetedSentimentMention_beginOffset :: Lens' TargetedSentimentMention (Maybe Int) -- | The offset into the document text where the mention ends. targetedSentimentMention_endOffset :: Lens' TargetedSentimentMention (Maybe Int) -- | The confidence that all the entities mentioned in the group relate to -- the same entity. targetedSentimentMention_groupScore :: Lens' TargetedSentimentMention (Maybe Double) -- | Contains the sentiment and sentiment score for the mention. targetedSentimentMention_mentionSentiment :: Lens' TargetedSentimentMention (Maybe MentionSentiment) -- | Model confidence that the entity is relevant. Value range is zero to -- one, where one is highest confidence. targetedSentimentMention_score :: Lens' TargetedSentimentMention (Maybe Double) -- | The text in the document that identifies the entity. targetedSentimentMention_text :: Lens' TargetedSentimentMention (Maybe Text) -- | The type of the entity. Amazon Comprehend supports a variety of -- entity types. targetedSentimentMention_type :: Lens' TargetedSentimentMention (Maybe TargetedSentimentEntityType) -- | Provides information for filtering topic detection jobs. For more -- information, see . -- -- See: newTopicsDetectionJobFilter smart constructor. data TopicsDetectionJobFilter TopicsDetectionJobFilter' :: Maybe Text -> Maybe JobStatus -> Maybe POSIX -> Maybe POSIX -> TopicsDetectionJobFilter [$sel:jobName:TopicsDetectionJobFilter'] :: TopicsDetectionJobFilter -> Maybe Text -- | Filters the list of topic detection jobs based on job status. Returns -- only jobs with the specified status. [$sel:jobStatus:TopicsDetectionJobFilter'] :: TopicsDetectionJobFilter -> Maybe JobStatus -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Only returns jobs submitted after the specified time. -- Jobs are returned in ascending order, oldest to newest. [$sel:submitTimeAfter:TopicsDetectionJobFilter'] :: TopicsDetectionJobFilter -> Maybe POSIX -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Only returns jobs submitted before the specified time. -- Jobs are returned in descending order, newest to oldest. [$sel:submitTimeBefore:TopicsDetectionJobFilter'] :: TopicsDetectionJobFilter -> Maybe POSIX -- | Create a value of TopicsDetectionJobFilter with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:jobName:TopicsDetectionJobFilter', -- topicsDetectionJobFilter_jobName - -- -- $sel:jobStatus:TopicsDetectionJobFilter', -- topicsDetectionJobFilter_jobStatus - Filters the list of topic -- detection jobs based on job status. Returns only jobs with the -- specified status. -- -- $sel:submitTimeAfter:TopicsDetectionJobFilter', -- topicsDetectionJobFilter_submitTimeAfter - Filters the list of -- jobs based on the time that the job was submitted for processing. Only -- returns jobs submitted after the specified time. Jobs are returned in -- ascending order, oldest to newest. -- -- $sel:submitTimeBefore:TopicsDetectionJobFilter', -- topicsDetectionJobFilter_submitTimeBefore - Filters the list of -- jobs based on the time that the job was submitted for processing. Only -- returns jobs submitted before the specified time. Jobs are returned in -- descending order, newest to oldest. newTopicsDetectionJobFilter :: TopicsDetectionJobFilter topicsDetectionJobFilter_jobName :: Lens' TopicsDetectionJobFilter (Maybe Text) -- | Filters the list of topic detection jobs based on job status. Returns -- only jobs with the specified status. topicsDetectionJobFilter_jobStatus :: Lens' TopicsDetectionJobFilter (Maybe JobStatus) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Only returns jobs submitted after the specified time. -- Jobs are returned in ascending order, oldest to newest. topicsDetectionJobFilter_submitTimeAfter :: Lens' TopicsDetectionJobFilter (Maybe UTCTime) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Only returns jobs submitted before the specified time. -- Jobs are returned in descending order, newest to oldest. topicsDetectionJobFilter_submitTimeBefore :: Lens' TopicsDetectionJobFilter (Maybe UTCTime) -- | Provides information about a topic detection job. -- -- See: newTopicsDetectionJobProperties smart constructor. data TopicsDetectionJobProperties TopicsDetectionJobProperties' :: Maybe Text -> Maybe POSIX -> Maybe InputDataConfig -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe JobStatus -> Maybe Text -> Maybe Int -> Maybe OutputDataConfig -> Maybe POSIX -> Maybe Text -> Maybe VpcConfig -> TopicsDetectionJobProperties -- | The Amazon Resource Name (ARN) of the AWS Identity and Management -- (IAM) role that grants Amazon Comprehend read access to your job data. [$sel:dataAccessRoleArn:TopicsDetectionJobProperties'] :: TopicsDetectionJobProperties -> Maybe Text -- | The time that the topic detection job was completed. [$sel:endTime:TopicsDetectionJobProperties'] :: TopicsDetectionJobProperties -> Maybe POSIX -- | The input data configuration supplied when you created the topic -- detection job. [$sel:inputDataConfig:TopicsDetectionJobProperties'] :: TopicsDetectionJobProperties -> Maybe InputDataConfig -- | The Amazon Resource Name (ARN) of the topics detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab
--
[$sel:jobArn:TopicsDetectionJobProperties'] :: TopicsDetectionJobProperties -> Maybe Text -- | The identifier assigned to the topic detection job. [$sel:jobId:TopicsDetectionJobProperties'] :: TopicsDetectionJobProperties -> Maybe Text -- | The name of the topic detection job. [$sel:jobName:TopicsDetectionJobProperties'] :: TopicsDetectionJobProperties -> Maybe Text -- | The current status of the topic detection job. If the status is -- Failed, the reason for the failure is shown in the -- Message field. [$sel:jobStatus:TopicsDetectionJobProperties'] :: TopicsDetectionJobProperties -> Maybe JobStatus -- | A description for the status of a job. [$sel:message:TopicsDetectionJobProperties'] :: TopicsDetectionJobProperties -> Maybe Text -- | The number of topics to detect supplied when you created the topic -- detection job. The default is 10. [$sel:numberOfTopics:TopicsDetectionJobProperties'] :: TopicsDetectionJobProperties -> Maybe Int -- | The output data configuration supplied when you created the topic -- detection job. [$sel:outputDataConfig:TopicsDetectionJobProperties'] :: TopicsDetectionJobProperties -> Maybe OutputDataConfig -- | The time that the topic detection job was submitted for processing. [$sel:submitTime:TopicsDetectionJobProperties'] :: TopicsDetectionJobProperties -> Maybe POSIX -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- [$sel:volumeKmsKeyId:TopicsDetectionJobProperties'] :: TopicsDetectionJobProperties -> Maybe Text -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your topic detection job. -- For more information, see Amazon VPC. [$sel:vpcConfig:TopicsDetectionJobProperties'] :: TopicsDetectionJobProperties -> Maybe VpcConfig -- | Create a value of TopicsDetectionJobProperties with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:dataAccessRoleArn:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_dataAccessRoleArn - The Amazon -- Resource Name (ARN) of the AWS Identity and Management (IAM) role that -- grants Amazon Comprehend read access to your job data. -- -- $sel:endTime:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_endTime - The time that the topic -- detection job was completed. -- -- $sel:inputDataConfig:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_inputDataConfig - The input data -- configuration supplied when you created the topic detection job. -- -- $sel:jobArn:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_jobArn - The Amazon Resource Name -- (ARN) of the topics detection job. It is a unique, fully qualified -- identifier for the job. It includes the AWS account, Region, and the -- job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- $sel:jobId:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_jobId - The identifier assigned to -- the topic detection job. -- -- $sel:jobName:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_jobName - The name of the topic -- detection job. -- -- $sel:jobStatus:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_jobStatus - The current status of -- the topic detection job. If the status is Failed, the reason -- for the failure is shown in the Message field. -- -- $sel:message:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_message - A description for the -- status of a job. -- -- $sel:numberOfTopics:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_numberOfTopics - The number of -- topics to detect supplied when you created the topic detection job. -- The default is 10. -- -- $sel:outputDataConfig:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_outputDataConfig - The output data -- configuration supplied when you created the topic detection job. -- -- $sel:submitTime:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_submitTime - The time that the -- topic detection job was submitted for processing. -- -- $sel:volumeKmsKeyId:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_volumeKmsKeyId - ID for the AWS -- Key Management Service (KMS) key that Amazon Comprehend uses to -- encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- -- -- $sel:vpcConfig:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_vpcConfig - Configuration -- parameters for a private Virtual Private Cloud (VPC) containing the -- resources you are using for your topic detection job. For more -- information, see Amazon VPC. newTopicsDetectionJobProperties :: TopicsDetectionJobProperties -- | The Amazon Resource Name (ARN) of the AWS Identity and Management -- (IAM) role that grants Amazon Comprehend read access to your job data. topicsDetectionJobProperties_dataAccessRoleArn :: Lens' TopicsDetectionJobProperties (Maybe Text) -- | The time that the topic detection job was completed. topicsDetectionJobProperties_endTime :: Lens' TopicsDetectionJobProperties (Maybe UTCTime) -- | The input data configuration supplied when you created the topic -- detection job. topicsDetectionJobProperties_inputDataConfig :: Lens' TopicsDetectionJobProperties (Maybe InputDataConfig) -- | The Amazon Resource Name (ARN) of the topics detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab
--
topicsDetectionJobProperties_jobArn :: Lens' TopicsDetectionJobProperties (Maybe Text) -- | The identifier assigned to the topic detection job. topicsDetectionJobProperties_jobId :: Lens' TopicsDetectionJobProperties (Maybe Text) -- | The name of the topic detection job. topicsDetectionJobProperties_jobName :: Lens' TopicsDetectionJobProperties (Maybe Text) -- | The current status of the topic detection job. If the status is -- Failed, the reason for the failure is shown in the -- Message field. topicsDetectionJobProperties_jobStatus :: Lens' TopicsDetectionJobProperties (Maybe JobStatus) -- | A description for the status of a job. topicsDetectionJobProperties_message :: Lens' TopicsDetectionJobProperties (Maybe Text) -- | The number of topics to detect supplied when you created the topic -- detection job. The default is 10. topicsDetectionJobProperties_numberOfTopics :: Lens' TopicsDetectionJobProperties (Maybe Int) -- | The output data configuration supplied when you created the topic -- detection job. topicsDetectionJobProperties_outputDataConfig :: Lens' TopicsDetectionJobProperties (Maybe OutputDataConfig) -- | The time that the topic detection job was submitted for processing. topicsDetectionJobProperties_submitTime :: Lens' TopicsDetectionJobProperties (Maybe UTCTime) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- topicsDetectionJobProperties_volumeKmsKeyId :: Lens' TopicsDetectionJobProperties (Maybe Text) -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your topic detection job. -- For more information, see Amazon VPC. topicsDetectionJobProperties_vpcConfig :: Lens' TopicsDetectionJobProperties (Maybe VpcConfig) -- | Configuration parameters for an optional private Virtual Private Cloud -- (VPC) containing the resources you are using for the job. For more -- information, see Amazon VPC. -- -- See: newVpcConfig smart constructor. data VpcConfig VpcConfig' :: NonEmpty Text -> NonEmpty Text -> VpcConfig -- | The ID number for a security group on an instance of your private VPC. -- Security groups on your VPC function serve as a virtual firewall to -- control inbound and outbound traffic and provides security for the -- resources that you’ll be accessing on the VPC. This ID number is -- preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more -- information, see Security Groups for your VPC. [$sel:securityGroupIds:VpcConfig'] :: VpcConfig -> NonEmpty Text -- | The ID for each subnet being used in your private VPC. This subnet is -- a subset of the a range of IPv4 addresses used by the VPC and is -- specific to a given availability zone in the VPC’s region. This ID -- number is preceded by "subnet-", for instance: -- "subnet-04ccf456919e69055". For more information, see VPCs and -- Subnets. [$sel:subnets:VpcConfig'] :: VpcConfig -> NonEmpty Text -- | Create a value of VpcConfig with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:securityGroupIds:VpcConfig', -- vpcConfig_securityGroupIds - The ID number for a security group -- on an instance of your private VPC. Security groups on your VPC -- function serve as a virtual firewall to control inbound and outbound -- traffic and provides security for the resources that you’ll be -- accessing on the VPC. This ID number is preceded by "sg-", for -- instance: "sg-03b388029b0a285ea". For more information, see -- Security Groups for your VPC. -- -- $sel:subnets:VpcConfig', vpcConfig_subnets - The ID for -- each subnet being used in your private VPC. This subnet is a subset of -- the a range of IPv4 addresses used by the VPC and is specific to a -- given availability zone in the VPC’s region. This ID number is -- preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For -- more information, see VPCs and Subnets. newVpcConfig :: NonEmpty Text -> NonEmpty Text -> VpcConfig -- | The ID number for a security group on an instance of your private VPC. -- Security groups on your VPC function serve as a virtual firewall to -- control inbound and outbound traffic and provides security for the -- resources that you’ll be accessing on the VPC. This ID number is -- preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more -- information, see Security Groups for your VPC. vpcConfig_securityGroupIds :: Lens' VpcConfig (NonEmpty Text) -- | The ID for each subnet being used in your private VPC. This subnet is -- a subset of the a range of IPv4 addresses used by the VPC and is -- specific to a given availability zone in the VPC’s region. This ID -- number is preceded by "subnet-", for instance: -- "subnet-04ccf456919e69055". For more information, see VPCs and -- Subnets. vpcConfig_subnets :: Lens' VpcConfig (NonEmpty Text) -- | Associates a specific tag with an Amazon Comprehend resource. A tag is -- a key-value pair that adds as a metadata to a resource used by Amazon -- Comprehend. For example, a tag with "Sales" as the key might be added -- to a resource to indicate its use by the sales department. module Amazonka.Comprehend.TagResource -- | See: newTagResource smart constructor. data TagResource TagResource' :: Text -> [Tag] -> TagResource -- | The Amazon Resource Name (ARN) of the given Amazon Comprehend resource -- to which you want to associate the tags. [$sel:resourceArn:TagResource'] :: TagResource -> Text -- | Tags being associated with a specific Amazon Comprehend resource. -- There can be a maximum of 50 tags (both existing and pending) -- associated with a specific resource. [$sel:tags:TagResource'] :: TagResource -> [Tag] -- | Create a value of TagResource with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:resourceArn:TagResource', tagResource_resourceArn - -- The Amazon Resource Name (ARN) of the given Amazon Comprehend resource -- to which you want to associate the tags. -- -- $sel:tags:TagResource', tagResource_tags - Tags being -- associated with a specific Amazon Comprehend resource. There can be a -- maximum of 50 tags (both existing and pending) associated with a -- specific resource. newTagResource :: Text -> TagResource -- | The Amazon Resource Name (ARN) of the given Amazon Comprehend resource -- to which you want to associate the tags. tagResource_resourceArn :: Lens' TagResource Text -- | Tags being associated with a specific Amazon Comprehend resource. -- There can be a maximum of 50 tags (both existing and pending) -- associated with a specific resource. tagResource_tags :: Lens' TagResource [Tag] -- | See: newTagResourceResponse smart constructor. data TagResourceResponse TagResourceResponse' :: Int -> TagResourceResponse -- | The response's http status code. [$sel:httpStatus:TagResourceResponse'] :: TagResourceResponse -> Int -- | Create a value of TagResourceResponse with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:httpStatus:TagResourceResponse', -- tagResourceResponse_httpStatus - The response's http status -- code. newTagResourceResponse :: Int -> TagResourceResponse -- | The response's http status code. tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.TagResource.TagResource instance GHC.Show.Show Amazonka.Comprehend.TagResource.TagResource instance GHC.Read.Read Amazonka.Comprehend.TagResource.TagResource instance GHC.Classes.Eq Amazonka.Comprehend.TagResource.TagResource instance GHC.Generics.Generic Amazonka.Comprehend.TagResource.TagResourceResponse instance GHC.Show.Show Amazonka.Comprehend.TagResource.TagResourceResponse instance GHC.Read.Read Amazonka.Comprehend.TagResource.TagResourceResponse instance GHC.Classes.Eq Amazonka.Comprehend.TagResource.TagResourceResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.TagResource.TagResource instance Control.DeepSeq.NFData Amazonka.Comprehend.TagResource.TagResourceResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.TagResource.TagResource instance Control.DeepSeq.NFData Amazonka.Comprehend.TagResource.TagResource instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.TagResource.TagResource instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.TagResource.TagResource instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.TagResource.TagResource instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.TagResource.TagResource -- | Stops an entity recognizer training job while in progress. -- -- If the training job state is TRAINING, the job is marked for -- termination and put into the STOP_REQUESTED state. If the -- training job completes before it can be stopped, it is put into the -- TRAINED; otherwise the training job is stopped and putted -- into the STOPPED state and the service sends back an HTTP 200 -- response with an empty HTTP body. module Amazonka.Comprehend.StopTrainingEntityRecognizer -- | See: newStopTrainingEntityRecognizer smart constructor. data StopTrainingEntityRecognizer StopTrainingEntityRecognizer' :: Text -> StopTrainingEntityRecognizer -- | The Amazon Resource Name (ARN) that identifies the entity recognizer -- currently being trained. [$sel:entityRecognizerArn:StopTrainingEntityRecognizer'] :: StopTrainingEntityRecognizer -> Text -- | Create a value of StopTrainingEntityRecognizer with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StopTrainingEntityRecognizer, -- stopTrainingEntityRecognizer_entityRecognizerArn - The Amazon -- Resource Name (ARN) that identifies the entity recognizer currently -- being trained. newStopTrainingEntityRecognizer :: Text -> StopTrainingEntityRecognizer -- | The Amazon Resource Name (ARN) that identifies the entity recognizer -- currently being trained. stopTrainingEntityRecognizer_entityRecognizerArn :: Lens' StopTrainingEntityRecognizer Text -- | See: newStopTrainingEntityRecognizerResponse smart -- constructor. data StopTrainingEntityRecognizerResponse StopTrainingEntityRecognizerResponse' :: Int -> StopTrainingEntityRecognizerResponse -- | The response's http status code. [$sel:httpStatus:StopTrainingEntityRecognizerResponse'] :: StopTrainingEntityRecognizerResponse -> Int -- | Create a value of StopTrainingEntityRecognizerResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:httpStatus:StopTrainingEntityRecognizerResponse', -- stopTrainingEntityRecognizerResponse_httpStatus - The -- response's http status code. newStopTrainingEntityRecognizerResponse :: Int -> StopTrainingEntityRecognizerResponse -- | The response's http status code. stopTrainingEntityRecognizerResponse_httpStatus :: Lens' StopTrainingEntityRecognizerResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.StopTrainingEntityRecognizer.StopTrainingEntityRecognizer instance GHC.Show.Show Amazonka.Comprehend.StopTrainingEntityRecognizer.StopTrainingEntityRecognizer instance GHC.Read.Read Amazonka.Comprehend.StopTrainingEntityRecognizer.StopTrainingEntityRecognizer instance GHC.Classes.Eq Amazonka.Comprehend.StopTrainingEntityRecognizer.StopTrainingEntityRecognizer instance GHC.Generics.Generic Amazonka.Comprehend.StopTrainingEntityRecognizer.StopTrainingEntityRecognizerResponse instance GHC.Show.Show Amazonka.Comprehend.StopTrainingEntityRecognizer.StopTrainingEntityRecognizerResponse instance GHC.Read.Read Amazonka.Comprehend.StopTrainingEntityRecognizer.StopTrainingEntityRecognizerResponse instance GHC.Classes.Eq Amazonka.Comprehend.StopTrainingEntityRecognizer.StopTrainingEntityRecognizerResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.StopTrainingEntityRecognizer.StopTrainingEntityRecognizer instance Control.DeepSeq.NFData Amazonka.Comprehend.StopTrainingEntityRecognizer.StopTrainingEntityRecognizerResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.StopTrainingEntityRecognizer.StopTrainingEntityRecognizer instance Control.DeepSeq.NFData Amazonka.Comprehend.StopTrainingEntityRecognizer.StopTrainingEntityRecognizer instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.StopTrainingEntityRecognizer.StopTrainingEntityRecognizer instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.StopTrainingEntityRecognizer.StopTrainingEntityRecognizer instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.StopTrainingEntityRecognizer.StopTrainingEntityRecognizer instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.StopTrainingEntityRecognizer.StopTrainingEntityRecognizer -- | Stops a document classifier training job while in progress. -- -- If the training job state is TRAINING, the job is marked for -- termination and put into the STOP_REQUESTED state. If the -- training job completes before it can be stopped, it is put into the -- TRAINED; otherwise the training job is stopped and put into -- the STOPPED state and the service sends back an HTTP 200 -- response with an empty HTTP body. module Amazonka.Comprehend.StopTrainingDocumentClassifier -- | See: newStopTrainingDocumentClassifier smart -- constructor. data StopTrainingDocumentClassifier StopTrainingDocumentClassifier' :: Text -> StopTrainingDocumentClassifier -- | The Amazon Resource Name (ARN) that identifies the document classifier -- currently being trained. [$sel:documentClassifierArn:StopTrainingDocumentClassifier'] :: StopTrainingDocumentClassifier -> Text -- | Create a value of StopTrainingDocumentClassifier with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StopTrainingDocumentClassifier, -- stopTrainingDocumentClassifier_documentClassifierArn - The -- Amazon Resource Name (ARN) that identifies the document classifier -- currently being trained. newStopTrainingDocumentClassifier :: Text -> StopTrainingDocumentClassifier -- | The Amazon Resource Name (ARN) that identifies the document classifier -- currently being trained. stopTrainingDocumentClassifier_documentClassifierArn :: Lens' StopTrainingDocumentClassifier Text -- | See: newStopTrainingDocumentClassifierResponse smart -- constructor. data StopTrainingDocumentClassifierResponse StopTrainingDocumentClassifierResponse' :: Int -> StopTrainingDocumentClassifierResponse -- | The response's http status code. [$sel:httpStatus:StopTrainingDocumentClassifierResponse'] :: StopTrainingDocumentClassifierResponse -> Int -- | Create a value of StopTrainingDocumentClassifierResponse with -- all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:httpStatus:StopTrainingDocumentClassifierResponse', -- stopTrainingDocumentClassifierResponse_httpStatus - The -- response's http status code. newStopTrainingDocumentClassifierResponse :: Int -> StopTrainingDocumentClassifierResponse -- | The response's http status code. stopTrainingDocumentClassifierResponse_httpStatus :: Lens' StopTrainingDocumentClassifierResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.StopTrainingDocumentClassifier.StopTrainingDocumentClassifier instance GHC.Show.Show Amazonka.Comprehend.StopTrainingDocumentClassifier.StopTrainingDocumentClassifier instance GHC.Read.Read Amazonka.Comprehend.StopTrainingDocumentClassifier.StopTrainingDocumentClassifier instance GHC.Classes.Eq Amazonka.Comprehend.StopTrainingDocumentClassifier.StopTrainingDocumentClassifier instance GHC.Generics.Generic Amazonka.Comprehend.StopTrainingDocumentClassifier.StopTrainingDocumentClassifierResponse instance GHC.Show.Show Amazonka.Comprehend.StopTrainingDocumentClassifier.StopTrainingDocumentClassifierResponse instance GHC.Read.Read Amazonka.Comprehend.StopTrainingDocumentClassifier.StopTrainingDocumentClassifierResponse instance GHC.Classes.Eq Amazonka.Comprehend.StopTrainingDocumentClassifier.StopTrainingDocumentClassifierResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.StopTrainingDocumentClassifier.StopTrainingDocumentClassifier instance Control.DeepSeq.NFData Amazonka.Comprehend.StopTrainingDocumentClassifier.StopTrainingDocumentClassifierResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.StopTrainingDocumentClassifier.StopTrainingDocumentClassifier instance Control.DeepSeq.NFData Amazonka.Comprehend.StopTrainingDocumentClassifier.StopTrainingDocumentClassifier instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.StopTrainingDocumentClassifier.StopTrainingDocumentClassifier instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.StopTrainingDocumentClassifier.StopTrainingDocumentClassifier instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.StopTrainingDocumentClassifier.StopTrainingDocumentClassifier instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.StopTrainingDocumentClassifier.StopTrainingDocumentClassifier -- | Stops a targeted sentiment detection job in progress. -- -- If the job state is IN_PROGRESS, the job is marked for -- termination and put into the STOP_REQUESTED state. If the job -- completes before it can be stopped, it is put into the -- COMPLETED state; otherwise the job is be stopped and put into -- the STOPPED state. -- -- If the job is in the COMPLETED or FAILED state when -- you call the StopDominantLanguageDetectionJob operation, the -- operation returns a 400 Internal Request Exception. -- -- When a job is stopped, any documents already processed are written to -- the output location. module Amazonka.Comprehend.StopTargetedSentimentDetectionJob -- | See: newStopTargetedSentimentDetectionJob smart -- constructor. data StopTargetedSentimentDetectionJob StopTargetedSentimentDetectionJob' :: Text -> StopTargetedSentimentDetectionJob -- | The identifier of the targeted sentiment detection job to stop. [$sel:jobId:StopTargetedSentimentDetectionJob'] :: StopTargetedSentimentDetectionJob -> Text -- | Create a value of StopTargetedSentimentDetectionJob with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StopTargetedSentimentDetectionJob, -- stopTargetedSentimentDetectionJob_jobId - The identifier of the -- targeted sentiment detection job to stop. newStopTargetedSentimentDetectionJob :: Text -> StopTargetedSentimentDetectionJob -- | The identifier of the targeted sentiment detection job to stop. stopTargetedSentimentDetectionJob_jobId :: Lens' StopTargetedSentimentDetectionJob Text -- | See: newStopTargetedSentimentDetectionJobResponse smart -- constructor. data StopTargetedSentimentDetectionJobResponse StopTargetedSentimentDetectionJobResponse' :: Maybe Text -> Maybe JobStatus -> Int -> StopTargetedSentimentDetectionJobResponse -- | The identifier of the targeted sentiment detection job to stop. [$sel:jobId:StopTargetedSentimentDetectionJobResponse'] :: StopTargetedSentimentDetectionJobResponse -> Maybe Text -- | Either STOP_REQUESTED if the job is currently running, or -- STOPPED if the job was previously stopped with the -- StopSentimentDetectionJob operation. [$sel:jobStatus:StopTargetedSentimentDetectionJobResponse'] :: StopTargetedSentimentDetectionJobResponse -> Maybe JobStatus -- | The response's http status code. [$sel:httpStatus:StopTargetedSentimentDetectionJobResponse'] :: StopTargetedSentimentDetectionJobResponse -> Int -- | Create a value of StopTargetedSentimentDetectionJobResponse -- with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StopTargetedSentimentDetectionJob, -- stopTargetedSentimentDetectionJobResponse_jobId - The -- identifier of the targeted sentiment detection job to stop. -- -- StopTargetedSentimentDetectionJobResponse, -- stopTargetedSentimentDetectionJobResponse_jobStatus - Either -- STOP_REQUESTED if the job is currently running, or -- STOPPED if the job was previously stopped with the -- StopSentimentDetectionJob operation. -- -- $sel:httpStatus:StopTargetedSentimentDetectionJobResponse', -- stopTargetedSentimentDetectionJobResponse_httpStatus - The -- response's http status code. newStopTargetedSentimentDetectionJobResponse :: Int -> StopTargetedSentimentDetectionJobResponse -- | The identifier of the targeted sentiment detection job to stop. stopTargetedSentimentDetectionJobResponse_jobId :: Lens' StopTargetedSentimentDetectionJobResponse (Maybe Text) -- | Either STOP_REQUESTED if the job is currently running, or -- STOPPED if the job was previously stopped with the -- StopSentimentDetectionJob operation. stopTargetedSentimentDetectionJobResponse_jobStatus :: Lens' StopTargetedSentimentDetectionJobResponse (Maybe JobStatus) -- | The response's http status code. stopTargetedSentimentDetectionJobResponse_httpStatus :: Lens' StopTargetedSentimentDetectionJobResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.StopTargetedSentimentDetectionJob.StopTargetedSentimentDetectionJob instance GHC.Show.Show Amazonka.Comprehend.StopTargetedSentimentDetectionJob.StopTargetedSentimentDetectionJob instance GHC.Read.Read Amazonka.Comprehend.StopTargetedSentimentDetectionJob.StopTargetedSentimentDetectionJob instance GHC.Classes.Eq Amazonka.Comprehend.StopTargetedSentimentDetectionJob.StopTargetedSentimentDetectionJob instance GHC.Generics.Generic Amazonka.Comprehend.StopTargetedSentimentDetectionJob.StopTargetedSentimentDetectionJobResponse instance GHC.Show.Show Amazonka.Comprehend.StopTargetedSentimentDetectionJob.StopTargetedSentimentDetectionJobResponse instance GHC.Read.Read Amazonka.Comprehend.StopTargetedSentimentDetectionJob.StopTargetedSentimentDetectionJobResponse instance GHC.Classes.Eq Amazonka.Comprehend.StopTargetedSentimentDetectionJob.StopTargetedSentimentDetectionJobResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.StopTargetedSentimentDetectionJob.StopTargetedSentimentDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.StopTargetedSentimentDetectionJob.StopTargetedSentimentDetectionJobResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.StopTargetedSentimentDetectionJob.StopTargetedSentimentDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.StopTargetedSentimentDetectionJob.StopTargetedSentimentDetectionJob instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.StopTargetedSentimentDetectionJob.StopTargetedSentimentDetectionJob instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.StopTargetedSentimentDetectionJob.StopTargetedSentimentDetectionJob instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.StopTargetedSentimentDetectionJob.StopTargetedSentimentDetectionJob instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.StopTargetedSentimentDetectionJob.StopTargetedSentimentDetectionJob -- | Stops a sentiment detection job in progress. -- -- If the job state is IN_PROGRESS, the job is marked for -- termination and put into the STOP_REQUESTED state. If the job -- completes before it can be stopped, it is put into the -- COMPLETED state; otherwise the job is be stopped and put into -- the STOPPED state. -- -- If the job is in the COMPLETED or FAILED state when -- you call the StopDominantLanguageDetectionJob operation, the -- operation returns a 400 Internal Request Exception. -- -- When a job is stopped, any documents already processed are written to -- the output location. module Amazonka.Comprehend.StopSentimentDetectionJob -- | See: newStopSentimentDetectionJob smart constructor. data StopSentimentDetectionJob StopSentimentDetectionJob' :: Text -> StopSentimentDetectionJob -- | The identifier of the sentiment detection job to stop. [$sel:jobId:StopSentimentDetectionJob'] :: StopSentimentDetectionJob -> Text -- | Create a value of StopSentimentDetectionJob with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StopSentimentDetectionJob, -- stopSentimentDetectionJob_jobId - The identifier of the -- sentiment detection job to stop. newStopSentimentDetectionJob :: Text -> StopSentimentDetectionJob -- | The identifier of the sentiment detection job to stop. stopSentimentDetectionJob_jobId :: Lens' StopSentimentDetectionJob Text -- | See: newStopSentimentDetectionJobResponse smart -- constructor. data StopSentimentDetectionJobResponse StopSentimentDetectionJobResponse' :: Maybe Text -> Maybe JobStatus -> Int -> StopSentimentDetectionJobResponse -- | The identifier of the sentiment detection job to stop. [$sel:jobId:StopSentimentDetectionJobResponse'] :: StopSentimentDetectionJobResponse -> Maybe Text -- | Either STOP_REQUESTED if the job is currently running, or -- STOPPED if the job was previously stopped with the -- StopSentimentDetectionJob operation. [$sel:jobStatus:StopSentimentDetectionJobResponse'] :: StopSentimentDetectionJobResponse -> Maybe JobStatus -- | The response's http status code. [$sel:httpStatus:StopSentimentDetectionJobResponse'] :: StopSentimentDetectionJobResponse -> Int -- | Create a value of StopSentimentDetectionJobResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StopSentimentDetectionJob, -- stopSentimentDetectionJobResponse_jobId - The identifier of the -- sentiment detection job to stop. -- -- StopSentimentDetectionJobResponse, -- stopSentimentDetectionJobResponse_jobStatus - Either -- STOP_REQUESTED if the job is currently running, or -- STOPPED if the job was previously stopped with the -- StopSentimentDetectionJob operation. -- -- $sel:httpStatus:StopSentimentDetectionJobResponse', -- stopSentimentDetectionJobResponse_httpStatus - The response's -- http status code. newStopSentimentDetectionJobResponse :: Int -> StopSentimentDetectionJobResponse -- | The identifier of the sentiment detection job to stop. stopSentimentDetectionJobResponse_jobId :: Lens' StopSentimentDetectionJobResponse (Maybe Text) -- | Either STOP_REQUESTED if the job is currently running, or -- STOPPED if the job was previously stopped with the -- StopSentimentDetectionJob operation. stopSentimentDetectionJobResponse_jobStatus :: Lens' StopSentimentDetectionJobResponse (Maybe JobStatus) -- | The response's http status code. stopSentimentDetectionJobResponse_httpStatus :: Lens' StopSentimentDetectionJobResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.StopSentimentDetectionJob.StopSentimentDetectionJob instance GHC.Show.Show Amazonka.Comprehend.StopSentimentDetectionJob.StopSentimentDetectionJob instance GHC.Read.Read Amazonka.Comprehend.StopSentimentDetectionJob.StopSentimentDetectionJob instance GHC.Classes.Eq Amazonka.Comprehend.StopSentimentDetectionJob.StopSentimentDetectionJob instance GHC.Generics.Generic Amazonka.Comprehend.StopSentimentDetectionJob.StopSentimentDetectionJobResponse instance GHC.Show.Show Amazonka.Comprehend.StopSentimentDetectionJob.StopSentimentDetectionJobResponse instance GHC.Read.Read Amazonka.Comprehend.StopSentimentDetectionJob.StopSentimentDetectionJobResponse instance GHC.Classes.Eq Amazonka.Comprehend.StopSentimentDetectionJob.StopSentimentDetectionJobResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.StopSentimentDetectionJob.StopSentimentDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.StopSentimentDetectionJob.StopSentimentDetectionJobResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.StopSentimentDetectionJob.StopSentimentDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.StopSentimentDetectionJob.StopSentimentDetectionJob instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.StopSentimentDetectionJob.StopSentimentDetectionJob instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.StopSentimentDetectionJob.StopSentimentDetectionJob instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.StopSentimentDetectionJob.StopSentimentDetectionJob instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.StopSentimentDetectionJob.StopSentimentDetectionJob -- | Stops a PII entities detection job in progress. module Amazonka.Comprehend.StopPiiEntitiesDetectionJob -- | See: newStopPiiEntitiesDetectionJob smart constructor. data StopPiiEntitiesDetectionJob StopPiiEntitiesDetectionJob' :: Text -> StopPiiEntitiesDetectionJob -- | The identifier of the PII entities detection job to stop. [$sel:jobId:StopPiiEntitiesDetectionJob'] :: StopPiiEntitiesDetectionJob -> Text -- | Create a value of StopPiiEntitiesDetectionJob with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StopPiiEntitiesDetectionJob, -- stopPiiEntitiesDetectionJob_jobId - The identifier of the PII -- entities detection job to stop. newStopPiiEntitiesDetectionJob :: Text -> StopPiiEntitiesDetectionJob -- | The identifier of the PII entities detection job to stop. stopPiiEntitiesDetectionJob_jobId :: Lens' StopPiiEntitiesDetectionJob Text -- | See: newStopPiiEntitiesDetectionJobResponse smart -- constructor. data StopPiiEntitiesDetectionJobResponse StopPiiEntitiesDetectionJobResponse' :: Maybe Text -> Maybe JobStatus -> Int -> StopPiiEntitiesDetectionJobResponse -- | The identifier of the PII entities detection job to stop. [$sel:jobId:StopPiiEntitiesDetectionJobResponse'] :: StopPiiEntitiesDetectionJobResponse -> Maybe Text -- | The status of the PII entities detection job. [$sel:jobStatus:StopPiiEntitiesDetectionJobResponse'] :: StopPiiEntitiesDetectionJobResponse -> Maybe JobStatus -- | The response's http status code. [$sel:httpStatus:StopPiiEntitiesDetectionJobResponse'] :: StopPiiEntitiesDetectionJobResponse -> Int -- | Create a value of StopPiiEntitiesDetectionJobResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StopPiiEntitiesDetectionJob, -- stopPiiEntitiesDetectionJobResponse_jobId - The identifier of -- the PII entities detection job to stop. -- -- StopPiiEntitiesDetectionJobResponse, -- stopPiiEntitiesDetectionJobResponse_jobStatus - The status of -- the PII entities detection job. -- -- $sel:httpStatus:StopPiiEntitiesDetectionJobResponse', -- stopPiiEntitiesDetectionJobResponse_httpStatus - The response's -- http status code. newStopPiiEntitiesDetectionJobResponse :: Int -> StopPiiEntitiesDetectionJobResponse -- | The identifier of the PII entities detection job to stop. stopPiiEntitiesDetectionJobResponse_jobId :: Lens' StopPiiEntitiesDetectionJobResponse (Maybe Text) -- | The status of the PII entities detection job. stopPiiEntitiesDetectionJobResponse_jobStatus :: Lens' StopPiiEntitiesDetectionJobResponse (Maybe JobStatus) -- | The response's http status code. stopPiiEntitiesDetectionJobResponse_httpStatus :: Lens' StopPiiEntitiesDetectionJobResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.StopPiiEntitiesDetectionJob.StopPiiEntitiesDetectionJob instance GHC.Show.Show Amazonka.Comprehend.StopPiiEntitiesDetectionJob.StopPiiEntitiesDetectionJob instance GHC.Read.Read Amazonka.Comprehend.StopPiiEntitiesDetectionJob.StopPiiEntitiesDetectionJob instance GHC.Classes.Eq Amazonka.Comprehend.StopPiiEntitiesDetectionJob.StopPiiEntitiesDetectionJob instance GHC.Generics.Generic Amazonka.Comprehend.StopPiiEntitiesDetectionJob.StopPiiEntitiesDetectionJobResponse instance GHC.Show.Show Amazonka.Comprehend.StopPiiEntitiesDetectionJob.StopPiiEntitiesDetectionJobResponse instance GHC.Read.Read Amazonka.Comprehend.StopPiiEntitiesDetectionJob.StopPiiEntitiesDetectionJobResponse instance GHC.Classes.Eq Amazonka.Comprehend.StopPiiEntitiesDetectionJob.StopPiiEntitiesDetectionJobResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.StopPiiEntitiesDetectionJob.StopPiiEntitiesDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.StopPiiEntitiesDetectionJob.StopPiiEntitiesDetectionJobResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.StopPiiEntitiesDetectionJob.StopPiiEntitiesDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.StopPiiEntitiesDetectionJob.StopPiiEntitiesDetectionJob instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.StopPiiEntitiesDetectionJob.StopPiiEntitiesDetectionJob instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.StopPiiEntitiesDetectionJob.StopPiiEntitiesDetectionJob instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.StopPiiEntitiesDetectionJob.StopPiiEntitiesDetectionJob instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.StopPiiEntitiesDetectionJob.StopPiiEntitiesDetectionJob -- | Stops a key phrases detection job in progress. -- -- If the job state is IN_PROGRESS the job is marked for -- termination and put into the STOP_REQUESTED state. If the job -- completes before it can be stopped, it is put into the -- COMPLETED state; otherwise the job is stopped and put into -- the STOPPED state. -- -- If the job is in the COMPLETED or FAILED state when -- you call the StopDominantLanguageDetectionJob operation, the -- operation returns a 400 Internal Request Exception. -- -- When a job is stopped, any documents already processed are written to -- the output location. module Amazonka.Comprehend.StopKeyPhrasesDetectionJob -- | See: newStopKeyPhrasesDetectionJob smart constructor. data StopKeyPhrasesDetectionJob StopKeyPhrasesDetectionJob' :: Text -> StopKeyPhrasesDetectionJob -- | The identifier of the key phrases detection job to stop. [$sel:jobId:StopKeyPhrasesDetectionJob'] :: StopKeyPhrasesDetectionJob -> Text -- | Create a value of StopKeyPhrasesDetectionJob with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StopKeyPhrasesDetectionJob, -- stopKeyPhrasesDetectionJob_jobId - The identifier of the key -- phrases detection job to stop. newStopKeyPhrasesDetectionJob :: Text -> StopKeyPhrasesDetectionJob -- | The identifier of the key phrases detection job to stop. stopKeyPhrasesDetectionJob_jobId :: Lens' StopKeyPhrasesDetectionJob Text -- | See: newStopKeyPhrasesDetectionJobResponse smart -- constructor. data StopKeyPhrasesDetectionJobResponse StopKeyPhrasesDetectionJobResponse' :: Maybe Text -> Maybe JobStatus -> Int -> StopKeyPhrasesDetectionJobResponse -- | The identifier of the key phrases detection job to stop. [$sel:jobId:StopKeyPhrasesDetectionJobResponse'] :: StopKeyPhrasesDetectionJobResponse -> Maybe Text -- | Either STOP_REQUESTED if the job is currently running, or -- STOPPED if the job was previously stopped with the -- StopKeyPhrasesDetectionJob operation. [$sel:jobStatus:StopKeyPhrasesDetectionJobResponse'] :: StopKeyPhrasesDetectionJobResponse -> Maybe JobStatus -- | The response's http status code. [$sel:httpStatus:StopKeyPhrasesDetectionJobResponse'] :: StopKeyPhrasesDetectionJobResponse -> Int -- | Create a value of StopKeyPhrasesDetectionJobResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StopKeyPhrasesDetectionJob, -- stopKeyPhrasesDetectionJobResponse_jobId - The identifier of -- the key phrases detection job to stop. -- -- StopKeyPhrasesDetectionJobResponse, -- stopKeyPhrasesDetectionJobResponse_jobStatus - Either -- STOP_REQUESTED if the job is currently running, or -- STOPPED if the job was previously stopped with the -- StopKeyPhrasesDetectionJob operation. -- -- $sel:httpStatus:StopKeyPhrasesDetectionJobResponse', -- stopKeyPhrasesDetectionJobResponse_httpStatus - The response's -- http status code. newStopKeyPhrasesDetectionJobResponse :: Int -> StopKeyPhrasesDetectionJobResponse -- | The identifier of the key phrases detection job to stop. stopKeyPhrasesDetectionJobResponse_jobId :: Lens' StopKeyPhrasesDetectionJobResponse (Maybe Text) -- | Either STOP_REQUESTED if the job is currently running, or -- STOPPED if the job was previously stopped with the -- StopKeyPhrasesDetectionJob operation. stopKeyPhrasesDetectionJobResponse_jobStatus :: Lens' StopKeyPhrasesDetectionJobResponse (Maybe JobStatus) -- | The response's http status code. stopKeyPhrasesDetectionJobResponse_httpStatus :: Lens' StopKeyPhrasesDetectionJobResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.StopKeyPhrasesDetectionJob.StopKeyPhrasesDetectionJob instance GHC.Show.Show Amazonka.Comprehend.StopKeyPhrasesDetectionJob.StopKeyPhrasesDetectionJob instance GHC.Read.Read Amazonka.Comprehend.StopKeyPhrasesDetectionJob.StopKeyPhrasesDetectionJob instance GHC.Classes.Eq Amazonka.Comprehend.StopKeyPhrasesDetectionJob.StopKeyPhrasesDetectionJob instance GHC.Generics.Generic Amazonka.Comprehend.StopKeyPhrasesDetectionJob.StopKeyPhrasesDetectionJobResponse instance GHC.Show.Show Amazonka.Comprehend.StopKeyPhrasesDetectionJob.StopKeyPhrasesDetectionJobResponse instance GHC.Read.Read Amazonka.Comprehend.StopKeyPhrasesDetectionJob.StopKeyPhrasesDetectionJobResponse instance GHC.Classes.Eq Amazonka.Comprehend.StopKeyPhrasesDetectionJob.StopKeyPhrasesDetectionJobResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.StopKeyPhrasesDetectionJob.StopKeyPhrasesDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.StopKeyPhrasesDetectionJob.StopKeyPhrasesDetectionJobResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.StopKeyPhrasesDetectionJob.StopKeyPhrasesDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.StopKeyPhrasesDetectionJob.StopKeyPhrasesDetectionJob instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.StopKeyPhrasesDetectionJob.StopKeyPhrasesDetectionJob instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.StopKeyPhrasesDetectionJob.StopKeyPhrasesDetectionJob instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.StopKeyPhrasesDetectionJob.StopKeyPhrasesDetectionJob instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.StopKeyPhrasesDetectionJob.StopKeyPhrasesDetectionJob -- | Stops an events detection job in progress. module Amazonka.Comprehend.StopEventsDetectionJob -- | See: newStopEventsDetectionJob smart constructor. data StopEventsDetectionJob StopEventsDetectionJob' :: Text -> StopEventsDetectionJob -- | The identifier of the events detection job to stop. [$sel:jobId:StopEventsDetectionJob'] :: StopEventsDetectionJob -> Text -- | Create a value of StopEventsDetectionJob with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StopEventsDetectionJob, stopEventsDetectionJob_jobId - -- The identifier of the events detection job to stop. newStopEventsDetectionJob :: Text -> StopEventsDetectionJob -- | The identifier of the events detection job to stop. stopEventsDetectionJob_jobId :: Lens' StopEventsDetectionJob Text -- | See: newStopEventsDetectionJobResponse smart -- constructor. data StopEventsDetectionJobResponse StopEventsDetectionJobResponse' :: Maybe Text -> Maybe JobStatus -> Int -> StopEventsDetectionJobResponse -- | The identifier of the events detection job to stop. [$sel:jobId:StopEventsDetectionJobResponse'] :: StopEventsDetectionJobResponse -> Maybe Text -- | The status of the events detection job. [$sel:jobStatus:StopEventsDetectionJobResponse'] :: StopEventsDetectionJobResponse -> Maybe JobStatus -- | The response's http status code. [$sel:httpStatus:StopEventsDetectionJobResponse'] :: StopEventsDetectionJobResponse -> Int -- | Create a value of StopEventsDetectionJobResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StopEventsDetectionJob, -- stopEventsDetectionJobResponse_jobId - The identifier of the -- events detection job to stop. -- -- StopEventsDetectionJobResponse, -- stopEventsDetectionJobResponse_jobStatus - The status of the -- events detection job. -- -- $sel:httpStatus:StopEventsDetectionJobResponse', -- stopEventsDetectionJobResponse_httpStatus - The response's http -- status code. newStopEventsDetectionJobResponse :: Int -> StopEventsDetectionJobResponse -- | The identifier of the events detection job to stop. stopEventsDetectionJobResponse_jobId :: Lens' StopEventsDetectionJobResponse (Maybe Text) -- | The status of the events detection job. stopEventsDetectionJobResponse_jobStatus :: Lens' StopEventsDetectionJobResponse (Maybe JobStatus) -- | The response's http status code. stopEventsDetectionJobResponse_httpStatus :: Lens' StopEventsDetectionJobResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.StopEventsDetectionJob.StopEventsDetectionJob instance GHC.Show.Show Amazonka.Comprehend.StopEventsDetectionJob.StopEventsDetectionJob instance GHC.Read.Read Amazonka.Comprehend.StopEventsDetectionJob.StopEventsDetectionJob instance GHC.Classes.Eq Amazonka.Comprehend.StopEventsDetectionJob.StopEventsDetectionJob instance GHC.Generics.Generic Amazonka.Comprehend.StopEventsDetectionJob.StopEventsDetectionJobResponse instance GHC.Show.Show Amazonka.Comprehend.StopEventsDetectionJob.StopEventsDetectionJobResponse instance GHC.Read.Read Amazonka.Comprehend.StopEventsDetectionJob.StopEventsDetectionJobResponse instance GHC.Classes.Eq Amazonka.Comprehend.StopEventsDetectionJob.StopEventsDetectionJobResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.StopEventsDetectionJob.StopEventsDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.StopEventsDetectionJob.StopEventsDetectionJobResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.StopEventsDetectionJob.StopEventsDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.StopEventsDetectionJob.StopEventsDetectionJob instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.StopEventsDetectionJob.StopEventsDetectionJob instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.StopEventsDetectionJob.StopEventsDetectionJob instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.StopEventsDetectionJob.StopEventsDetectionJob instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.StopEventsDetectionJob.StopEventsDetectionJob -- | Stops an entities detection job in progress. -- -- If the job state is IN_PROGRESS the job is marked for -- termination and put into the STOP_REQUESTED state. If the job -- completes before it can be stopped, it is put into the -- COMPLETED state; otherwise the job is stopped and put into -- the STOPPED state. -- -- If the job is in the COMPLETED or FAILED state when -- you call the StopDominantLanguageDetectionJob operation, the -- operation returns a 400 Internal Request Exception. -- -- When a job is stopped, any documents already processed are written to -- the output location. module Amazonka.Comprehend.StopEntitiesDetectionJob -- | See: newStopEntitiesDetectionJob smart constructor. data StopEntitiesDetectionJob StopEntitiesDetectionJob' :: Text -> StopEntitiesDetectionJob -- | The identifier of the entities detection job to stop. [$sel:jobId:StopEntitiesDetectionJob'] :: StopEntitiesDetectionJob -> Text -- | Create a value of StopEntitiesDetectionJob with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StopEntitiesDetectionJob, stopEntitiesDetectionJob_jobId -- - The identifier of the entities detection job to stop. newStopEntitiesDetectionJob :: Text -> StopEntitiesDetectionJob -- | The identifier of the entities detection job to stop. stopEntitiesDetectionJob_jobId :: Lens' StopEntitiesDetectionJob Text -- | See: newStopEntitiesDetectionJobResponse smart -- constructor. data StopEntitiesDetectionJobResponse StopEntitiesDetectionJobResponse' :: Maybe Text -> Maybe JobStatus -> Int -> StopEntitiesDetectionJobResponse -- | The identifier of the entities detection job to stop. [$sel:jobId:StopEntitiesDetectionJobResponse'] :: StopEntitiesDetectionJobResponse -> Maybe Text -- | Either STOP_REQUESTED if the job is currently running, or -- STOPPED if the job was previously stopped with the -- StopEntitiesDetectionJob operation. [$sel:jobStatus:StopEntitiesDetectionJobResponse'] :: StopEntitiesDetectionJobResponse -> Maybe JobStatus -- | The response's http status code. [$sel:httpStatus:StopEntitiesDetectionJobResponse'] :: StopEntitiesDetectionJobResponse -> Int -- | Create a value of StopEntitiesDetectionJobResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StopEntitiesDetectionJob, -- stopEntitiesDetectionJobResponse_jobId - The identifier of the -- entities detection job to stop. -- -- StopEntitiesDetectionJobResponse, -- stopEntitiesDetectionJobResponse_jobStatus - Either -- STOP_REQUESTED if the job is currently running, or -- STOPPED if the job was previously stopped with the -- StopEntitiesDetectionJob operation. -- -- $sel:httpStatus:StopEntitiesDetectionJobResponse', -- stopEntitiesDetectionJobResponse_httpStatus - The response's -- http status code. newStopEntitiesDetectionJobResponse :: Int -> StopEntitiesDetectionJobResponse -- | The identifier of the entities detection job to stop. stopEntitiesDetectionJobResponse_jobId :: Lens' StopEntitiesDetectionJobResponse (Maybe Text) -- | Either STOP_REQUESTED if the job is currently running, or -- STOPPED if the job was previously stopped with the -- StopEntitiesDetectionJob operation. stopEntitiesDetectionJobResponse_jobStatus :: Lens' StopEntitiesDetectionJobResponse (Maybe JobStatus) -- | The response's http status code. stopEntitiesDetectionJobResponse_httpStatus :: Lens' StopEntitiesDetectionJobResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.StopEntitiesDetectionJob.StopEntitiesDetectionJob instance GHC.Show.Show Amazonka.Comprehend.StopEntitiesDetectionJob.StopEntitiesDetectionJob instance GHC.Read.Read Amazonka.Comprehend.StopEntitiesDetectionJob.StopEntitiesDetectionJob instance GHC.Classes.Eq Amazonka.Comprehend.StopEntitiesDetectionJob.StopEntitiesDetectionJob instance GHC.Generics.Generic Amazonka.Comprehend.StopEntitiesDetectionJob.StopEntitiesDetectionJobResponse instance GHC.Show.Show Amazonka.Comprehend.StopEntitiesDetectionJob.StopEntitiesDetectionJobResponse instance GHC.Read.Read Amazonka.Comprehend.StopEntitiesDetectionJob.StopEntitiesDetectionJobResponse instance GHC.Classes.Eq Amazonka.Comprehend.StopEntitiesDetectionJob.StopEntitiesDetectionJobResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.StopEntitiesDetectionJob.StopEntitiesDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.StopEntitiesDetectionJob.StopEntitiesDetectionJobResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.StopEntitiesDetectionJob.StopEntitiesDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.StopEntitiesDetectionJob.StopEntitiesDetectionJob instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.StopEntitiesDetectionJob.StopEntitiesDetectionJob instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.StopEntitiesDetectionJob.StopEntitiesDetectionJob instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.StopEntitiesDetectionJob.StopEntitiesDetectionJob instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.StopEntitiesDetectionJob.StopEntitiesDetectionJob -- | Stops a dominant language detection job in progress. -- -- If the job state is IN_PROGRESS the job is marked for -- termination and put into the STOP_REQUESTED state. If the job -- completes before it can be stopped, it is put into the -- COMPLETED state; otherwise the job is stopped and put into -- the STOPPED state. -- -- If the job is in the COMPLETED or FAILED state when -- you call the StopDominantLanguageDetectionJob operation, the -- operation returns a 400 Internal Request Exception. -- -- When a job is stopped, any documents already processed are written to -- the output location. module Amazonka.Comprehend.StopDominantLanguageDetectionJob -- | See: newStopDominantLanguageDetectionJob smart -- constructor. data StopDominantLanguageDetectionJob StopDominantLanguageDetectionJob' :: Text -> StopDominantLanguageDetectionJob -- | The identifier of the dominant language detection job to stop. [$sel:jobId:StopDominantLanguageDetectionJob'] :: StopDominantLanguageDetectionJob -> Text -- | Create a value of StopDominantLanguageDetectionJob with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StopDominantLanguageDetectionJob, -- stopDominantLanguageDetectionJob_jobId - The identifier of the -- dominant language detection job to stop. newStopDominantLanguageDetectionJob :: Text -> StopDominantLanguageDetectionJob -- | The identifier of the dominant language detection job to stop. stopDominantLanguageDetectionJob_jobId :: Lens' StopDominantLanguageDetectionJob Text -- | See: newStopDominantLanguageDetectionJobResponse smart -- constructor. data StopDominantLanguageDetectionJobResponse StopDominantLanguageDetectionJobResponse' :: Maybe Text -> Maybe JobStatus -> Int -> StopDominantLanguageDetectionJobResponse -- | The identifier of the dominant language detection job to stop. [$sel:jobId:StopDominantLanguageDetectionJobResponse'] :: StopDominantLanguageDetectionJobResponse -> Maybe Text -- | Either STOP_REQUESTED if the job is currently running, or -- STOPPED if the job was previously stopped with the -- StopDominantLanguageDetectionJob operation. [$sel:jobStatus:StopDominantLanguageDetectionJobResponse'] :: StopDominantLanguageDetectionJobResponse -> Maybe JobStatus -- | The response's http status code. [$sel:httpStatus:StopDominantLanguageDetectionJobResponse'] :: StopDominantLanguageDetectionJobResponse -> Int -- | Create a value of StopDominantLanguageDetectionJobResponse with -- all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StopDominantLanguageDetectionJob, -- stopDominantLanguageDetectionJobResponse_jobId - The identifier -- of the dominant language detection job to stop. -- -- StopDominantLanguageDetectionJobResponse, -- stopDominantLanguageDetectionJobResponse_jobStatus - Either -- STOP_REQUESTED if the job is currently running, or -- STOPPED if the job was previously stopped with the -- StopDominantLanguageDetectionJob operation. -- -- $sel:httpStatus:StopDominantLanguageDetectionJobResponse', -- stopDominantLanguageDetectionJobResponse_httpStatus - The -- response's http status code. newStopDominantLanguageDetectionJobResponse :: Int -> StopDominantLanguageDetectionJobResponse -- | The identifier of the dominant language detection job to stop. stopDominantLanguageDetectionJobResponse_jobId :: Lens' StopDominantLanguageDetectionJobResponse (Maybe Text) -- | Either STOP_REQUESTED if the job is currently running, or -- STOPPED if the job was previously stopped with the -- StopDominantLanguageDetectionJob operation. stopDominantLanguageDetectionJobResponse_jobStatus :: Lens' StopDominantLanguageDetectionJobResponse (Maybe JobStatus) -- | The response's http status code. stopDominantLanguageDetectionJobResponse_httpStatus :: Lens' StopDominantLanguageDetectionJobResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.StopDominantLanguageDetectionJob.StopDominantLanguageDetectionJob instance GHC.Show.Show Amazonka.Comprehend.StopDominantLanguageDetectionJob.StopDominantLanguageDetectionJob instance GHC.Read.Read Amazonka.Comprehend.StopDominantLanguageDetectionJob.StopDominantLanguageDetectionJob instance GHC.Classes.Eq Amazonka.Comprehend.StopDominantLanguageDetectionJob.StopDominantLanguageDetectionJob instance GHC.Generics.Generic Amazonka.Comprehend.StopDominantLanguageDetectionJob.StopDominantLanguageDetectionJobResponse instance GHC.Show.Show Amazonka.Comprehend.StopDominantLanguageDetectionJob.StopDominantLanguageDetectionJobResponse instance GHC.Read.Read Amazonka.Comprehend.StopDominantLanguageDetectionJob.StopDominantLanguageDetectionJobResponse instance GHC.Classes.Eq Amazonka.Comprehend.StopDominantLanguageDetectionJob.StopDominantLanguageDetectionJobResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.StopDominantLanguageDetectionJob.StopDominantLanguageDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.StopDominantLanguageDetectionJob.StopDominantLanguageDetectionJobResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.StopDominantLanguageDetectionJob.StopDominantLanguageDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.StopDominantLanguageDetectionJob.StopDominantLanguageDetectionJob instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.StopDominantLanguageDetectionJob.StopDominantLanguageDetectionJob instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.StopDominantLanguageDetectionJob.StopDominantLanguageDetectionJob instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.StopDominantLanguageDetectionJob.StopDominantLanguageDetectionJob instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.StopDominantLanguageDetectionJob.StopDominantLanguageDetectionJob -- | Starts an asynchronous topic detection job. Use the -- DescribeTopicDetectionJob operation to track the status of a -- job. module Amazonka.Comprehend.StartTopicsDetectionJob -- | See: newStartTopicsDetectionJob smart constructor. data StartTopicsDetectionJob StartTopicsDetectionJob' :: Maybe Text -> Maybe Text -> Maybe Natural -> Maybe [Tag] -> Maybe Text -> Maybe VpcConfig -> InputDataConfig -> OutputDataConfig -> Text -> StartTopicsDetectionJob -- | A unique identifier for the request. If you do not set the client -- request token, Amazon Comprehend generates one. [$sel:clientRequestToken:StartTopicsDetectionJob'] :: StartTopicsDetectionJob -> Maybe Text -- | The identifier of the job. [$sel:jobName:StartTopicsDetectionJob'] :: StartTopicsDetectionJob -> Maybe Text -- | The number of topics to detect. [$sel:numberOfTopics:StartTopicsDetectionJob'] :: StartTopicsDetectionJob -> Maybe Natural -- | Tags to be associated with the topics detection job. A tag is a -- key-value pair that adds metadata to a resource used by Amazon -- Comprehend. For example, a tag with "Sales" as the key might be added -- to a resource to indicate its use by the sales department. [$sel:tags:StartTopicsDetectionJob'] :: StartTopicsDetectionJob -> Maybe [Tag] -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- [$sel:volumeKmsKeyId:StartTopicsDetectionJob'] :: StartTopicsDetectionJob -> Maybe Text -- | Configuration parameters for an optional private Virtual Private Cloud -- (VPC) containing the resources you are using for your topic detection -- job. For more information, see Amazon VPC. [$sel:vpcConfig:StartTopicsDetectionJob'] :: StartTopicsDetectionJob -> Maybe VpcConfig -- | Specifies the format and location of the input data for the job. [$sel:inputDataConfig:StartTopicsDetectionJob'] :: StartTopicsDetectionJob -> InputDataConfig -- | Specifies where to send the output files. The output is a compressed -- archive with two files, topic-terms.csv that lists the terms -- associated with each topic, and doc-topics.csv that lists the -- documents associated with each topic [$sel:outputDataConfig:StartTopicsDetectionJob'] :: StartTopicsDetectionJob -> OutputDataConfig -- | The Amazon Resource Name (ARN) of the AWS Identity and Access -- Management (IAM) role 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. [$sel:dataAccessRoleArn:StartTopicsDetectionJob'] :: StartTopicsDetectionJob -> Text -- | Create a value of StartTopicsDetectionJob with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:clientRequestToken:StartTopicsDetectionJob', -- startTopicsDetectionJob_clientRequestToken - A unique -- identifier for the request. If you do not set the client request -- token, Amazon Comprehend generates one. -- -- StartTopicsDetectionJob, startTopicsDetectionJob_jobName -- - The identifier of the job. -- -- StartTopicsDetectionJob, -- startTopicsDetectionJob_numberOfTopics - The number of topics -- to detect. -- -- $sel:tags:StartTopicsDetectionJob', -- startTopicsDetectionJob_tags - Tags to be associated with the -- topics detection job. A tag is a key-value pair that adds metadata to -- a resource used by Amazon Comprehend. For example, a tag with "Sales" -- as the key might be added to a resource to indicate its use by the -- sales department. -- -- StartTopicsDetectionJob, -- startTopicsDetectionJob_volumeKmsKeyId - ID for the AWS Key -- Management Service (KMS) key that Amazon Comprehend uses to encrypt -- data on the storage volume attached to the ML compute instance(s) that -- process the analysis job. The VolumeKmsKeyId can be either of the -- following formats: -- -- -- -- StartTopicsDetectionJob, -- startTopicsDetectionJob_vpcConfig - Configuration parameters -- for an optional private Virtual Private Cloud (VPC) containing the -- resources you are using for your topic detection job. For more -- information, see Amazon VPC. -- -- StartTopicsDetectionJob, -- startTopicsDetectionJob_inputDataConfig - Specifies the format -- and location of the input data for the job. -- -- StartTopicsDetectionJob, -- startTopicsDetectionJob_outputDataConfig - Specifies where to -- send the output files. The output is a compressed archive with two -- files, topic-terms.csv that lists the terms associated with -- each topic, and doc-topics.csv that lists the documents -- associated with each topic -- -- StartTopicsDetectionJob, -- startTopicsDetectionJob_dataAccessRoleArn - The Amazon Resource -- Name (ARN) of the AWS Identity and Access Management (IAM) role 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. newStartTopicsDetectionJob :: InputDataConfig -> OutputDataConfig -> Text -> StartTopicsDetectionJob -- | A unique identifier for the request. If you do not set the client -- request token, Amazon Comprehend generates one. startTopicsDetectionJob_clientRequestToken :: Lens' StartTopicsDetectionJob (Maybe Text) -- | The identifier of the job. startTopicsDetectionJob_jobName :: Lens' StartTopicsDetectionJob (Maybe Text) -- | The number of topics to detect. startTopicsDetectionJob_numberOfTopics :: Lens' StartTopicsDetectionJob (Maybe Natural) -- | Tags to be associated with the topics detection job. A tag is a -- key-value pair that adds metadata to a resource used by Amazon -- Comprehend. For example, a tag with "Sales" as the key might be added -- to a resource to indicate its use by the sales department. startTopicsDetectionJob_tags :: Lens' StartTopicsDetectionJob (Maybe [Tag]) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- startTopicsDetectionJob_volumeKmsKeyId :: Lens' StartTopicsDetectionJob (Maybe Text) -- | Configuration parameters for an optional private Virtual Private Cloud -- (VPC) containing the resources you are using for your topic detection -- job. For more information, see Amazon VPC. startTopicsDetectionJob_vpcConfig :: Lens' StartTopicsDetectionJob (Maybe VpcConfig) -- | Specifies the format and location of the input data for the job. startTopicsDetectionJob_inputDataConfig :: Lens' StartTopicsDetectionJob InputDataConfig -- | Specifies where to send the output files. The output is a compressed -- archive with two files, topic-terms.csv that lists the terms -- associated with each topic, and doc-topics.csv that lists the -- documents associated with each topic startTopicsDetectionJob_outputDataConfig :: Lens' StartTopicsDetectionJob OutputDataConfig -- | The Amazon Resource Name (ARN) of the AWS Identity and Access -- Management (IAM) role 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. startTopicsDetectionJob_dataAccessRoleArn :: Lens' StartTopicsDetectionJob Text -- | See: newStartTopicsDetectionJobResponse smart -- constructor. data StartTopicsDetectionJobResponse StartTopicsDetectionJobResponse' :: Maybe Text -> Maybe Text -> Maybe JobStatus -> Int -> StartTopicsDetectionJobResponse -- | The Amazon Resource Name (ARN) of the topics detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
--
[$sel:jobArn:StartTopicsDetectionJobResponse'] :: StartTopicsDetectionJobResponse -> Maybe Text -- | The identifier generated for the job. To get the status of the job, -- use this identifier with the DescribeTopicDetectionJob -- operation. [$sel:jobId:StartTopicsDetectionJobResponse'] :: StartTopicsDetectionJobResponse -> Maybe Text -- | The status of the job: -- -- [$sel:jobStatus:StartTopicsDetectionJobResponse'] :: StartTopicsDetectionJobResponse -> Maybe JobStatus -- | The response's http status code. [$sel:httpStatus:StartTopicsDetectionJobResponse'] :: StartTopicsDetectionJobResponse -> Int -- | Create a value of StartTopicsDetectionJobResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StartTopicsDetectionJobResponse, -- startTopicsDetectionJobResponse_jobArn - The Amazon Resource -- Name (ARN) of the topics detection job. It is a unique, fully -- qualified identifier for the job. It includes the AWS account, Region, -- and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- StartTopicsDetectionJobResponse, -- startTopicsDetectionJobResponse_jobId - The identifier -- generated for the job. To get the status of the job, use this -- identifier with the DescribeTopicDetectionJob operation. -- -- StartTopicsDetectionJobResponse, -- startTopicsDetectionJobResponse_jobStatus - The status of the -- job: -- -- -- -- $sel:httpStatus:StartTopicsDetectionJobResponse', -- startTopicsDetectionJobResponse_httpStatus - The response's -- http status code. newStartTopicsDetectionJobResponse :: Int -> StartTopicsDetectionJobResponse -- | The Amazon Resource Name (ARN) of the topics detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
--
startTopicsDetectionJobResponse_jobArn :: Lens' StartTopicsDetectionJobResponse (Maybe Text) -- | The identifier generated for the job. To get the status of the job, -- use this identifier with the DescribeTopicDetectionJob -- operation. startTopicsDetectionJobResponse_jobId :: Lens' StartTopicsDetectionJobResponse (Maybe Text) -- | The status of the job: -- -- startTopicsDetectionJobResponse_jobStatus :: Lens' StartTopicsDetectionJobResponse (Maybe JobStatus) -- | The response's http status code. startTopicsDetectionJobResponse_httpStatus :: Lens' StartTopicsDetectionJobResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.StartTopicsDetectionJob.StartTopicsDetectionJob instance GHC.Show.Show Amazonka.Comprehend.StartTopicsDetectionJob.StartTopicsDetectionJob instance GHC.Read.Read Amazonka.Comprehend.StartTopicsDetectionJob.StartTopicsDetectionJob instance GHC.Classes.Eq Amazonka.Comprehend.StartTopicsDetectionJob.StartTopicsDetectionJob instance GHC.Generics.Generic Amazonka.Comprehend.StartTopicsDetectionJob.StartTopicsDetectionJobResponse instance GHC.Show.Show Amazonka.Comprehend.StartTopicsDetectionJob.StartTopicsDetectionJobResponse instance GHC.Read.Read Amazonka.Comprehend.StartTopicsDetectionJob.StartTopicsDetectionJobResponse instance GHC.Classes.Eq Amazonka.Comprehend.StartTopicsDetectionJob.StartTopicsDetectionJobResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.StartTopicsDetectionJob.StartTopicsDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.StartTopicsDetectionJob.StartTopicsDetectionJobResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.StartTopicsDetectionJob.StartTopicsDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.StartTopicsDetectionJob.StartTopicsDetectionJob instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.StartTopicsDetectionJob.StartTopicsDetectionJob instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.StartTopicsDetectionJob.StartTopicsDetectionJob instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.StartTopicsDetectionJob.StartTopicsDetectionJob instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.StartTopicsDetectionJob.StartTopicsDetectionJob -- | Starts an asynchronous targeted sentiment detection job for a -- collection of documents. Use the operation to track the status of a -- job. module Amazonka.Comprehend.StartTargetedSentimentDetectionJob -- | See: newStartTargetedSentimentDetectionJob smart -- constructor. data StartTargetedSentimentDetectionJob StartTargetedSentimentDetectionJob' :: Maybe Text -> Maybe Text -> Maybe [Tag] -> Maybe Text -> Maybe VpcConfig -> InputDataConfig -> OutputDataConfig -> Text -> LanguageCode -> StartTargetedSentimentDetectionJob -- | A unique identifier for the request. If you don't set the client -- request token, Amazon Comprehend generates one. [$sel:clientRequestToken:StartTargetedSentimentDetectionJob'] :: StartTargetedSentimentDetectionJob -> Maybe Text -- | The identifier of the job. [$sel:jobName:StartTargetedSentimentDetectionJob'] :: StartTargetedSentimentDetectionJob -> Maybe Text -- | Tags to be associated with the targeted sentiment detection job. A tag -- is a key-value pair that adds metadata to a resource used by Amazon -- Comprehend. For example, a tag with "Sales" as the key might be added -- to a resource to indicate its use by the sales department. [$sel:tags:StartTargetedSentimentDetectionJob'] :: StartTargetedSentimentDetectionJob -> Maybe [Tag] -- | ID for the KMS key that Amazon Comprehend uses to encrypt data on the -- storage volume attached to the ML compute instance(s) that process the -- analysis job. The VolumeKmsKeyId can be either of the following -- formats: -- -- [$sel:volumeKmsKeyId:StartTargetedSentimentDetectionJob'] :: StartTargetedSentimentDetectionJob -> Maybe Text [$sel:vpcConfig:StartTargetedSentimentDetectionJob'] :: StartTargetedSentimentDetectionJob -> Maybe VpcConfig [$sel:inputDataConfig:StartTargetedSentimentDetectionJob'] :: StartTargetedSentimentDetectionJob -> InputDataConfig -- | Specifies where to send the output files. [$sel:outputDataConfig:StartTargetedSentimentDetectionJob'] :: StartTargetedSentimentDetectionJob -> OutputDataConfig -- | The Amazon Resource Name (ARN) of the AWS Identity and Access -- Management (IAM) role that grants Amazon Comprehend read access to -- your input data. For more information, see Role-based -- permissions. [$sel:dataAccessRoleArn:StartTargetedSentimentDetectionJob'] :: StartTargetedSentimentDetectionJob -> Text -- | The language of the input documents. Currently, English is the only -- supported language. [$sel:languageCode:StartTargetedSentimentDetectionJob'] :: StartTargetedSentimentDetectionJob -> LanguageCode -- | Create a value of StartTargetedSentimentDetectionJob with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:clientRequestToken:StartTargetedSentimentDetectionJob', -- startTargetedSentimentDetectionJob_clientRequestToken - A -- unique identifier for the request. If you don't set the client request -- token, Amazon Comprehend generates one. -- -- StartTargetedSentimentDetectionJob, -- startTargetedSentimentDetectionJob_jobName - The identifier of -- the job. -- -- $sel:tags:StartTargetedSentimentDetectionJob', -- startTargetedSentimentDetectionJob_tags - Tags to be associated -- with the targeted sentiment detection job. A tag is a key-value pair -- that adds metadata to a resource used by Amazon Comprehend. For -- example, a tag with "Sales" as the key might be added to a resource to -- indicate its use by the sales department. -- -- StartTargetedSentimentDetectionJob, -- startTargetedSentimentDetectionJob_volumeKmsKeyId - ID for the -- KMS key that Amazon Comprehend uses to encrypt data on the storage -- volume attached to the ML compute instance(s) that process the -- analysis job. The VolumeKmsKeyId can be either of the following -- formats: -- -- -- -- StartTargetedSentimentDetectionJob, -- startTargetedSentimentDetectionJob_vpcConfig - Undocumented -- member. -- -- StartTargetedSentimentDetectionJob, -- startTargetedSentimentDetectionJob_inputDataConfig - -- Undocumented member. -- -- StartTargetedSentimentDetectionJob, -- startTargetedSentimentDetectionJob_outputDataConfig - Specifies -- where to send the output files. -- -- StartTargetedSentimentDetectionJob, -- startTargetedSentimentDetectionJob_dataAccessRoleArn - The -- Amazon Resource Name (ARN) of the AWS Identity and Access Management -- (IAM) role that grants Amazon Comprehend read access to your input -- data. For more information, see Role-based permissions. -- -- StartTargetedSentimentDetectionJob, -- startTargetedSentimentDetectionJob_languageCode - The language -- of the input documents. Currently, English is the only supported -- language. newStartTargetedSentimentDetectionJob :: InputDataConfig -> OutputDataConfig -> Text -> LanguageCode -> StartTargetedSentimentDetectionJob -- | A unique identifier for the request. If you don't set the client -- request token, Amazon Comprehend generates one. startTargetedSentimentDetectionJob_clientRequestToken :: Lens' StartTargetedSentimentDetectionJob (Maybe Text) -- | The identifier of the job. startTargetedSentimentDetectionJob_jobName :: Lens' StartTargetedSentimentDetectionJob (Maybe Text) -- | Tags to be associated with the targeted sentiment detection job. A tag -- is a key-value pair that adds metadata to a resource used by Amazon -- Comprehend. For example, a tag with "Sales" as the key might be added -- to a resource to indicate its use by the sales department. startTargetedSentimentDetectionJob_tags :: Lens' StartTargetedSentimentDetectionJob (Maybe [Tag]) -- | ID for the KMS key that Amazon Comprehend uses to encrypt data on the -- storage volume attached to the ML compute instance(s) that process the -- analysis job. The VolumeKmsKeyId can be either of the following -- formats: -- -- startTargetedSentimentDetectionJob_volumeKmsKeyId :: Lens' StartTargetedSentimentDetectionJob (Maybe Text) -- | Undocumented member. startTargetedSentimentDetectionJob_vpcConfig :: Lens' StartTargetedSentimentDetectionJob (Maybe VpcConfig) -- | Undocumented member. startTargetedSentimentDetectionJob_inputDataConfig :: Lens' StartTargetedSentimentDetectionJob InputDataConfig -- | Specifies where to send the output files. startTargetedSentimentDetectionJob_outputDataConfig :: Lens' StartTargetedSentimentDetectionJob OutputDataConfig -- | The Amazon Resource Name (ARN) of the AWS Identity and Access -- Management (IAM) role that grants Amazon Comprehend read access to -- your input data. For more information, see Role-based -- permissions. startTargetedSentimentDetectionJob_dataAccessRoleArn :: Lens' StartTargetedSentimentDetectionJob Text -- | The language of the input documents. Currently, English is the only -- supported language. startTargetedSentimentDetectionJob_languageCode :: Lens' StartTargetedSentimentDetectionJob LanguageCode -- | See: newStartTargetedSentimentDetectionJobResponse smart -- constructor. data StartTargetedSentimentDetectionJobResponse StartTargetedSentimentDetectionJobResponse' :: Maybe Text -> Maybe Text -> Maybe JobStatus -> Int -> StartTargetedSentimentDetectionJobResponse -- | The Amazon Resource Name (ARN) of the targeted sentiment detection -- job. It is a unique, fully qualified identifier for the job. It -- includes the AWS account, Region, and the job ID. The format of the -- ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
--
[$sel:jobArn:StartTargetedSentimentDetectionJobResponse'] :: StartTargetedSentimentDetectionJobResponse -> Maybe Text -- | The identifier generated for the job. To get the status of a job, use -- this identifier with the operation. [$sel:jobId:StartTargetedSentimentDetectionJobResponse'] :: StartTargetedSentimentDetectionJobResponse -> Maybe Text -- | The status of the job. -- -- [$sel:jobStatus:StartTargetedSentimentDetectionJobResponse'] :: StartTargetedSentimentDetectionJobResponse -> Maybe JobStatus -- | The response's http status code. [$sel:httpStatus:StartTargetedSentimentDetectionJobResponse'] :: StartTargetedSentimentDetectionJobResponse -> Int -- | Create a value of StartTargetedSentimentDetectionJobResponse -- with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StartTargetedSentimentDetectionJobResponse, -- startTargetedSentimentDetectionJobResponse_jobArn - The Amazon -- Resource Name (ARN) of the targeted sentiment detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- StartTargetedSentimentDetectionJobResponse, -- startTargetedSentimentDetectionJobResponse_jobId - The -- identifier generated for the job. To get the status of a job, use this -- identifier with the operation. -- -- StartTargetedSentimentDetectionJobResponse, -- startTargetedSentimentDetectionJobResponse_jobStatus - The -- status of the job. -- -- -- -- $sel:httpStatus:StartTargetedSentimentDetectionJobResponse', -- startTargetedSentimentDetectionJobResponse_httpStatus - The -- response's http status code. newStartTargetedSentimentDetectionJobResponse :: Int -> StartTargetedSentimentDetectionJobResponse -- | The Amazon Resource Name (ARN) of the targeted sentiment detection -- job. It is a unique, fully qualified identifier for the job. It -- includes the AWS account, Region, and the job ID. The format of the -- ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
--
startTargetedSentimentDetectionJobResponse_jobArn :: Lens' StartTargetedSentimentDetectionJobResponse (Maybe Text) -- | The identifier generated for the job. To get the status of a job, use -- this identifier with the operation. startTargetedSentimentDetectionJobResponse_jobId :: Lens' StartTargetedSentimentDetectionJobResponse (Maybe Text) -- | The status of the job. -- -- startTargetedSentimentDetectionJobResponse_jobStatus :: Lens' StartTargetedSentimentDetectionJobResponse (Maybe JobStatus) -- | The response's http status code. startTargetedSentimentDetectionJobResponse_httpStatus :: Lens' StartTargetedSentimentDetectionJobResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.StartTargetedSentimentDetectionJob.StartTargetedSentimentDetectionJob instance GHC.Show.Show Amazonka.Comprehend.StartTargetedSentimentDetectionJob.StartTargetedSentimentDetectionJob instance GHC.Read.Read Amazonka.Comprehend.StartTargetedSentimentDetectionJob.StartTargetedSentimentDetectionJob instance GHC.Classes.Eq Amazonka.Comprehend.StartTargetedSentimentDetectionJob.StartTargetedSentimentDetectionJob instance GHC.Generics.Generic Amazonka.Comprehend.StartTargetedSentimentDetectionJob.StartTargetedSentimentDetectionJobResponse instance GHC.Show.Show Amazonka.Comprehend.StartTargetedSentimentDetectionJob.StartTargetedSentimentDetectionJobResponse instance GHC.Read.Read Amazonka.Comprehend.StartTargetedSentimentDetectionJob.StartTargetedSentimentDetectionJobResponse instance GHC.Classes.Eq Amazonka.Comprehend.StartTargetedSentimentDetectionJob.StartTargetedSentimentDetectionJobResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.StartTargetedSentimentDetectionJob.StartTargetedSentimentDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.StartTargetedSentimentDetectionJob.StartTargetedSentimentDetectionJobResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.StartTargetedSentimentDetectionJob.StartTargetedSentimentDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.StartTargetedSentimentDetectionJob.StartTargetedSentimentDetectionJob instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.StartTargetedSentimentDetectionJob.StartTargetedSentimentDetectionJob instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.StartTargetedSentimentDetectionJob.StartTargetedSentimentDetectionJob instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.StartTargetedSentimentDetectionJob.StartTargetedSentimentDetectionJob instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.StartTargetedSentimentDetectionJob.StartTargetedSentimentDetectionJob -- | Starts an asynchronous sentiment detection job for a collection of -- documents. Use the operation to track the status of a job. module Amazonka.Comprehend.StartSentimentDetectionJob -- | See: newStartSentimentDetectionJob smart constructor. data StartSentimentDetectionJob StartSentimentDetectionJob' :: Maybe Text -> Maybe Text -> Maybe [Tag] -> Maybe Text -> Maybe VpcConfig -> InputDataConfig -> OutputDataConfig -> Text -> LanguageCode -> StartSentimentDetectionJob -- | A unique identifier for the request. If you don't set the client -- request token, Amazon Comprehend generates one. [$sel:clientRequestToken:StartSentimentDetectionJob'] :: StartSentimentDetectionJob -> Maybe Text -- | The identifier of the job. [$sel:jobName:StartSentimentDetectionJob'] :: StartSentimentDetectionJob -> Maybe Text -- | Tags to be associated with the sentiment detection job. A tag is a -- key-value pair that adds metadata to a resource used by Amazon -- Comprehend. For example, a tag with "Sales" as the key might be added -- to a resource to indicate its use by the sales department. [$sel:tags:StartSentimentDetectionJob'] :: StartSentimentDetectionJob -> Maybe [Tag] -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- [$sel:volumeKmsKeyId:StartSentimentDetectionJob'] :: StartSentimentDetectionJob -> Maybe Text -- | Configuration parameters for an optional private Virtual Private Cloud -- (VPC) containing the resources you are using for your sentiment -- detection job. For more information, see Amazon VPC. [$sel:vpcConfig:StartSentimentDetectionJob'] :: StartSentimentDetectionJob -> Maybe VpcConfig -- | Specifies the format and location of the input data for the job. [$sel:inputDataConfig:StartSentimentDetectionJob'] :: StartSentimentDetectionJob -> InputDataConfig -- | Specifies where to send the output files. [$sel:outputDataConfig:StartSentimentDetectionJob'] :: StartSentimentDetectionJob -> OutputDataConfig -- | The Amazon Resource Name (ARN) of the AWS Identity and Access -- Management (IAM) role 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. [$sel:dataAccessRoleArn:StartSentimentDetectionJob'] :: StartSentimentDetectionJob -> Text -- | The language of the input documents. You can specify any of the -- primary languages supported by Amazon Comprehend. All documents must -- be in the same language. [$sel:languageCode:StartSentimentDetectionJob'] :: StartSentimentDetectionJob -> LanguageCode -- | Create a value of StartSentimentDetectionJob with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:clientRequestToken:StartSentimentDetectionJob', -- startSentimentDetectionJob_clientRequestToken - A unique -- identifier for the request. If you don't set the client request token, -- Amazon Comprehend generates one. -- -- StartSentimentDetectionJob, -- startSentimentDetectionJob_jobName - The identifier of the job. -- -- $sel:tags:StartSentimentDetectionJob', -- startSentimentDetectionJob_tags - Tags to be associated with -- the sentiment detection job. A tag is a key-value pair that adds -- metadata to a resource used by Amazon Comprehend. For example, a tag -- with "Sales" as the key might be added to a resource to indicate its -- use by the sales department. -- -- StartSentimentDetectionJob, -- startSentimentDetectionJob_volumeKmsKeyId - ID for the AWS Key -- Management Service (KMS) key that Amazon Comprehend uses to encrypt -- data on the storage volume attached to the ML compute instance(s) that -- process the analysis job. The VolumeKmsKeyId can be either of the -- following formats: -- -- -- -- StartSentimentDetectionJob, -- startSentimentDetectionJob_vpcConfig - Configuration parameters -- for an optional private Virtual Private Cloud (VPC) containing the -- resources you are using for your sentiment detection job. For more -- information, see Amazon VPC. -- -- StartSentimentDetectionJob, -- startSentimentDetectionJob_inputDataConfig - Specifies the -- format and location of the input data for the job. -- -- StartSentimentDetectionJob, -- startSentimentDetectionJob_outputDataConfig - Specifies where -- to send the output files. -- -- StartSentimentDetectionJob, -- startSentimentDetectionJob_dataAccessRoleArn - The Amazon -- Resource Name (ARN) of the AWS Identity and Access Management (IAM) -- role 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. -- -- StartSentimentDetectionJob, -- startSentimentDetectionJob_languageCode - The language of the -- input documents. You can specify any of the primary languages -- supported by Amazon Comprehend. All documents must be in the same -- language. newStartSentimentDetectionJob :: InputDataConfig -> OutputDataConfig -> Text -> LanguageCode -> StartSentimentDetectionJob -- | A unique identifier for the request. If you don't set the client -- request token, Amazon Comprehend generates one. startSentimentDetectionJob_clientRequestToken :: Lens' StartSentimentDetectionJob (Maybe Text) -- | The identifier of the job. startSentimentDetectionJob_jobName :: Lens' StartSentimentDetectionJob (Maybe Text) -- | Tags to be associated with the sentiment detection job. A tag is a -- key-value pair that adds metadata to a resource used by Amazon -- Comprehend. For example, a tag with "Sales" as the key might be added -- to a resource to indicate its use by the sales department. startSentimentDetectionJob_tags :: Lens' StartSentimentDetectionJob (Maybe [Tag]) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- startSentimentDetectionJob_volumeKmsKeyId :: Lens' StartSentimentDetectionJob (Maybe Text) -- | Configuration parameters for an optional private Virtual Private Cloud -- (VPC) containing the resources you are using for your sentiment -- detection job. For more information, see Amazon VPC. startSentimentDetectionJob_vpcConfig :: Lens' StartSentimentDetectionJob (Maybe VpcConfig) -- | Specifies the format and location of the input data for the job. startSentimentDetectionJob_inputDataConfig :: Lens' StartSentimentDetectionJob InputDataConfig -- | Specifies where to send the output files. startSentimentDetectionJob_outputDataConfig :: Lens' StartSentimentDetectionJob OutputDataConfig -- | The Amazon Resource Name (ARN) of the AWS Identity and Access -- Management (IAM) role 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. startSentimentDetectionJob_dataAccessRoleArn :: Lens' StartSentimentDetectionJob Text -- | The language of the input documents. You can specify any of the -- primary languages supported by Amazon Comprehend. All documents must -- be in the same language. startSentimentDetectionJob_languageCode :: Lens' StartSentimentDetectionJob LanguageCode -- | See: newStartSentimentDetectionJobResponse smart -- constructor. data StartSentimentDetectionJobResponse StartSentimentDetectionJobResponse' :: Maybe Text -> Maybe Text -> Maybe JobStatus -> Int -> StartSentimentDetectionJobResponse -- | The Amazon Resource Name (ARN) of the sentiment detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
--
[$sel:jobArn:StartSentimentDetectionJobResponse'] :: StartSentimentDetectionJobResponse -> Maybe Text -- | The identifier generated for the job. To get the status of a job, use -- this identifier with the operation. [$sel:jobId:StartSentimentDetectionJobResponse'] :: StartSentimentDetectionJobResponse -> Maybe Text -- | The status of the job. -- -- [$sel:jobStatus:StartSentimentDetectionJobResponse'] :: StartSentimentDetectionJobResponse -> Maybe JobStatus -- | The response's http status code. [$sel:httpStatus:StartSentimentDetectionJobResponse'] :: StartSentimentDetectionJobResponse -> Int -- | Create a value of StartSentimentDetectionJobResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StartSentimentDetectionJobResponse, -- startSentimentDetectionJobResponse_jobArn - The Amazon Resource -- Name (ARN) of the sentiment detection job. It is a unique, fully -- qualified identifier for the job. It includes the AWS account, Region, -- and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- StartSentimentDetectionJobResponse, -- startSentimentDetectionJobResponse_jobId - The identifier -- generated for the job. To get the status of a job, use this identifier -- with the operation. -- -- StartSentimentDetectionJobResponse, -- startSentimentDetectionJobResponse_jobStatus - The status of -- the job. -- -- -- -- $sel:httpStatus:StartSentimentDetectionJobResponse', -- startSentimentDetectionJobResponse_httpStatus - The response's -- http status code. newStartSentimentDetectionJobResponse :: Int -> StartSentimentDetectionJobResponse -- | The Amazon Resource Name (ARN) of the sentiment detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
--
startSentimentDetectionJobResponse_jobArn :: Lens' StartSentimentDetectionJobResponse (Maybe Text) -- | The identifier generated for the job. To get the status of a job, use -- this identifier with the operation. startSentimentDetectionJobResponse_jobId :: Lens' StartSentimentDetectionJobResponse (Maybe Text) -- | The status of the job. -- -- startSentimentDetectionJobResponse_jobStatus :: Lens' StartSentimentDetectionJobResponse (Maybe JobStatus) -- | The response's http status code. startSentimentDetectionJobResponse_httpStatus :: Lens' StartSentimentDetectionJobResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.StartSentimentDetectionJob.StartSentimentDetectionJob instance GHC.Show.Show Amazonka.Comprehend.StartSentimentDetectionJob.StartSentimentDetectionJob instance GHC.Read.Read Amazonka.Comprehend.StartSentimentDetectionJob.StartSentimentDetectionJob instance GHC.Classes.Eq Amazonka.Comprehend.StartSentimentDetectionJob.StartSentimentDetectionJob instance GHC.Generics.Generic Amazonka.Comprehend.StartSentimentDetectionJob.StartSentimentDetectionJobResponse instance GHC.Show.Show Amazonka.Comprehend.StartSentimentDetectionJob.StartSentimentDetectionJobResponse instance GHC.Read.Read Amazonka.Comprehend.StartSentimentDetectionJob.StartSentimentDetectionJobResponse instance GHC.Classes.Eq Amazonka.Comprehend.StartSentimentDetectionJob.StartSentimentDetectionJobResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.StartSentimentDetectionJob.StartSentimentDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.StartSentimentDetectionJob.StartSentimentDetectionJobResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.StartSentimentDetectionJob.StartSentimentDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.StartSentimentDetectionJob.StartSentimentDetectionJob instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.StartSentimentDetectionJob.StartSentimentDetectionJob instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.StartSentimentDetectionJob.StartSentimentDetectionJob instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.StartSentimentDetectionJob.StartSentimentDetectionJob instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.StartSentimentDetectionJob.StartSentimentDetectionJob -- | Starts an asynchronous PII entity detection job for a collection of -- documents. module Amazonka.Comprehend.StartPiiEntitiesDetectionJob -- | See: newStartPiiEntitiesDetectionJob smart constructor. data StartPiiEntitiesDetectionJob StartPiiEntitiesDetectionJob' :: Maybe Text -> Maybe Text -> Maybe RedactionConfig -> Maybe [Tag] -> InputDataConfig -> OutputDataConfig -> PiiEntitiesDetectionMode -> Text -> LanguageCode -> StartPiiEntitiesDetectionJob -- | A unique identifier for the request. If you don't set the client -- request token, Amazon Comprehend generates one. [$sel:clientRequestToken:StartPiiEntitiesDetectionJob'] :: StartPiiEntitiesDetectionJob -> Maybe Text -- | The identifier of the job. [$sel:jobName:StartPiiEntitiesDetectionJob'] :: StartPiiEntitiesDetectionJob -> Maybe Text -- | Provides configuration parameters for PII entity redaction. -- -- This parameter is required if you set the Mode parameter to -- ONLY_REDACTION. In that case, you must provide a -- RedactionConfig definition that includes the -- PiiEntityTypes parameter. [$sel:redactionConfig:StartPiiEntitiesDetectionJob'] :: StartPiiEntitiesDetectionJob -> Maybe RedactionConfig -- | Tags to be associated with the PII entities detection job. A tag is a -- key-value pair that adds metadata to a resource used by Amazon -- Comprehend. For example, a tag with "Sales" as the key might be added -- to a resource to indicate its use by the sales department. [$sel:tags:StartPiiEntitiesDetectionJob'] :: StartPiiEntitiesDetectionJob -> Maybe [Tag] -- | The input properties for a PII entities detection job. [$sel:inputDataConfig:StartPiiEntitiesDetectionJob'] :: StartPiiEntitiesDetectionJob -> InputDataConfig -- | Provides configuration parameters for the output of PII entity -- detection jobs. [$sel:outputDataConfig:StartPiiEntitiesDetectionJob'] :: StartPiiEntitiesDetectionJob -> OutputDataConfig -- | Specifies whether the output provides the locations (offsets) of PII -- entities or a file in which PII entities are redacted. [$sel:mode:StartPiiEntitiesDetectionJob'] :: StartPiiEntitiesDetectionJob -> PiiEntitiesDetectionMode -- | The Amazon Resource Name (ARN) of the AWS Identity and Access -- Management (IAM) role that grants Amazon Comprehend read access to -- your input data. [$sel:dataAccessRoleArn:StartPiiEntitiesDetectionJob'] :: StartPiiEntitiesDetectionJob -> Text -- | The language of the input documents. Currently, English is the only -- valid language. [$sel:languageCode:StartPiiEntitiesDetectionJob'] :: StartPiiEntitiesDetectionJob -> LanguageCode -- | Create a value of StartPiiEntitiesDetectionJob with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:clientRequestToken:StartPiiEntitiesDetectionJob', -- startPiiEntitiesDetectionJob_clientRequestToken - A unique -- identifier for the request. If you don't set the client request token, -- Amazon Comprehend generates one. -- -- StartPiiEntitiesDetectionJob, -- startPiiEntitiesDetectionJob_jobName - The identifier of the -- job. -- -- StartPiiEntitiesDetectionJob, -- startPiiEntitiesDetectionJob_redactionConfig - Provides -- configuration parameters for PII entity redaction. -- -- This parameter is required if you set the Mode parameter to -- ONLY_REDACTION. In that case, you must provide a -- RedactionConfig definition that includes the -- PiiEntityTypes parameter. -- -- $sel:tags:StartPiiEntitiesDetectionJob', -- startPiiEntitiesDetectionJob_tags - Tags to be associated with -- the PII entities detection job. A tag is a key-value pair that adds -- metadata to a resource used by Amazon Comprehend. For example, a tag -- with "Sales" as the key might be added to a resource to indicate its -- use by the sales department. -- -- StartPiiEntitiesDetectionJob, -- startPiiEntitiesDetectionJob_inputDataConfig - The input -- properties for a PII entities detection job. -- -- StartPiiEntitiesDetectionJob, -- startPiiEntitiesDetectionJob_outputDataConfig - Provides -- configuration parameters for the output of PII entity detection jobs. -- -- StartPiiEntitiesDetectionJob, -- startPiiEntitiesDetectionJob_mode - Specifies whether the -- output provides the locations (offsets) of PII entities or a file in -- which PII entities are redacted. -- -- StartPiiEntitiesDetectionJob, -- startPiiEntitiesDetectionJob_dataAccessRoleArn - The Amazon -- Resource Name (ARN) of the AWS Identity and Access Management (IAM) -- role that grants Amazon Comprehend read access to your input data. -- -- StartPiiEntitiesDetectionJob, -- startPiiEntitiesDetectionJob_languageCode - The language of the -- input documents. Currently, English is the only valid language. newStartPiiEntitiesDetectionJob :: InputDataConfig -> OutputDataConfig -> PiiEntitiesDetectionMode -> Text -> LanguageCode -> StartPiiEntitiesDetectionJob -- | A unique identifier for the request. If you don't set the client -- request token, Amazon Comprehend generates one. startPiiEntitiesDetectionJob_clientRequestToken :: Lens' StartPiiEntitiesDetectionJob (Maybe Text) -- | The identifier of the job. startPiiEntitiesDetectionJob_jobName :: Lens' StartPiiEntitiesDetectionJob (Maybe Text) -- | Provides configuration parameters for PII entity redaction. -- -- This parameter is required if you set the Mode parameter to -- ONLY_REDACTION. In that case, you must provide a -- RedactionConfig definition that includes the -- PiiEntityTypes parameter. startPiiEntitiesDetectionJob_redactionConfig :: Lens' StartPiiEntitiesDetectionJob (Maybe RedactionConfig) -- | Tags to be associated with the PII entities detection job. A tag is a -- key-value pair that adds metadata to a resource used by Amazon -- Comprehend. For example, a tag with "Sales" as the key might be added -- to a resource to indicate its use by the sales department. startPiiEntitiesDetectionJob_tags :: Lens' StartPiiEntitiesDetectionJob (Maybe [Tag]) -- | The input properties for a PII entities detection job. startPiiEntitiesDetectionJob_inputDataConfig :: Lens' StartPiiEntitiesDetectionJob InputDataConfig -- | Provides configuration parameters for the output of PII entity -- detection jobs. startPiiEntitiesDetectionJob_outputDataConfig :: Lens' StartPiiEntitiesDetectionJob OutputDataConfig -- | Specifies whether the output provides the locations (offsets) of PII -- entities or a file in which PII entities are redacted. startPiiEntitiesDetectionJob_mode :: Lens' StartPiiEntitiesDetectionJob PiiEntitiesDetectionMode -- | The Amazon Resource Name (ARN) of the AWS Identity and Access -- Management (IAM) role that grants Amazon Comprehend read access to -- your input data. startPiiEntitiesDetectionJob_dataAccessRoleArn :: Lens' StartPiiEntitiesDetectionJob Text -- | The language of the input documents. Currently, English is the only -- valid language. startPiiEntitiesDetectionJob_languageCode :: Lens' StartPiiEntitiesDetectionJob LanguageCode -- | See: newStartPiiEntitiesDetectionJobResponse smart -- constructor. data StartPiiEntitiesDetectionJobResponse StartPiiEntitiesDetectionJobResponse' :: Maybe Text -> Maybe Text -> Maybe JobStatus -> Int -> StartPiiEntitiesDetectionJobResponse -- | The Amazon Resource Name (ARN) of the PII entity detection job. It is -- a unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
--
[$sel:jobArn:StartPiiEntitiesDetectionJobResponse'] :: StartPiiEntitiesDetectionJobResponse -> Maybe Text -- | The identifier generated for the job. [$sel:jobId:StartPiiEntitiesDetectionJobResponse'] :: StartPiiEntitiesDetectionJobResponse -> Maybe Text -- | The status of the job. [$sel:jobStatus:StartPiiEntitiesDetectionJobResponse'] :: StartPiiEntitiesDetectionJobResponse -> Maybe JobStatus -- | The response's http status code. [$sel:httpStatus:StartPiiEntitiesDetectionJobResponse'] :: StartPiiEntitiesDetectionJobResponse -> Int -- | Create a value of StartPiiEntitiesDetectionJobResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StartPiiEntitiesDetectionJobResponse, -- startPiiEntitiesDetectionJobResponse_jobArn - The Amazon -- Resource Name (ARN) of the PII entity detection job. It is a unique, -- fully qualified identifier for the job. It includes the AWS account, -- Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- StartPiiEntitiesDetectionJobResponse, -- startPiiEntitiesDetectionJobResponse_jobId - The identifier -- generated for the job. -- -- StartPiiEntitiesDetectionJobResponse, -- startPiiEntitiesDetectionJobResponse_jobStatus - The status of -- the job. -- -- $sel:httpStatus:StartPiiEntitiesDetectionJobResponse', -- startPiiEntitiesDetectionJobResponse_httpStatus - The -- response's http status code. newStartPiiEntitiesDetectionJobResponse :: Int -> StartPiiEntitiesDetectionJobResponse -- | The Amazon Resource Name (ARN) of the PII entity detection job. It is -- a unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
--
startPiiEntitiesDetectionJobResponse_jobArn :: Lens' StartPiiEntitiesDetectionJobResponse (Maybe Text) -- | The identifier generated for the job. startPiiEntitiesDetectionJobResponse_jobId :: Lens' StartPiiEntitiesDetectionJobResponse (Maybe Text) -- | The status of the job. startPiiEntitiesDetectionJobResponse_jobStatus :: Lens' StartPiiEntitiesDetectionJobResponse (Maybe JobStatus) -- | The response's http status code. startPiiEntitiesDetectionJobResponse_httpStatus :: Lens' StartPiiEntitiesDetectionJobResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.StartPiiEntitiesDetectionJob.StartPiiEntitiesDetectionJob instance GHC.Show.Show Amazonka.Comprehend.StartPiiEntitiesDetectionJob.StartPiiEntitiesDetectionJob instance GHC.Read.Read Amazonka.Comprehend.StartPiiEntitiesDetectionJob.StartPiiEntitiesDetectionJob instance GHC.Classes.Eq Amazonka.Comprehend.StartPiiEntitiesDetectionJob.StartPiiEntitiesDetectionJob instance GHC.Generics.Generic Amazonka.Comprehend.StartPiiEntitiesDetectionJob.StartPiiEntitiesDetectionJobResponse instance GHC.Show.Show Amazonka.Comprehend.StartPiiEntitiesDetectionJob.StartPiiEntitiesDetectionJobResponse instance GHC.Read.Read Amazonka.Comprehend.StartPiiEntitiesDetectionJob.StartPiiEntitiesDetectionJobResponse instance GHC.Classes.Eq Amazonka.Comprehend.StartPiiEntitiesDetectionJob.StartPiiEntitiesDetectionJobResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.StartPiiEntitiesDetectionJob.StartPiiEntitiesDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.StartPiiEntitiesDetectionJob.StartPiiEntitiesDetectionJobResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.StartPiiEntitiesDetectionJob.StartPiiEntitiesDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.StartPiiEntitiesDetectionJob.StartPiiEntitiesDetectionJob instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.StartPiiEntitiesDetectionJob.StartPiiEntitiesDetectionJob instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.StartPiiEntitiesDetectionJob.StartPiiEntitiesDetectionJob instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.StartPiiEntitiesDetectionJob.StartPiiEntitiesDetectionJob instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.StartPiiEntitiesDetectionJob.StartPiiEntitiesDetectionJob -- | Starts an asynchronous key phrase detection job for a collection of -- documents. Use the operation to track the status of a job. module Amazonka.Comprehend.StartKeyPhrasesDetectionJob -- | See: newStartKeyPhrasesDetectionJob smart constructor. data StartKeyPhrasesDetectionJob StartKeyPhrasesDetectionJob' :: Maybe Text -> Maybe Text -> Maybe [Tag] -> Maybe Text -> Maybe VpcConfig -> InputDataConfig -> OutputDataConfig -> Text -> LanguageCode -> StartKeyPhrasesDetectionJob -- | A unique identifier for the request. If you don't set the client -- request token, Amazon Comprehend generates one. [$sel:clientRequestToken:StartKeyPhrasesDetectionJob'] :: StartKeyPhrasesDetectionJob -> Maybe Text -- | The identifier of the job. [$sel:jobName:StartKeyPhrasesDetectionJob'] :: StartKeyPhrasesDetectionJob -> Maybe Text -- | Tags to be associated with the key phrases detection job. A tag is a -- key-value pair that adds metadata to a resource used by Amazon -- Comprehend. For example, a tag with "Sales" as the key might be added -- to a resource to indicate its use by the sales department. [$sel:tags:StartKeyPhrasesDetectionJob'] :: StartKeyPhrasesDetectionJob -> Maybe [Tag] -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- [$sel:volumeKmsKeyId:StartKeyPhrasesDetectionJob'] :: StartKeyPhrasesDetectionJob -> Maybe Text -- | Configuration parameters for an optional private Virtual Private Cloud -- (VPC) containing the resources you are using for your key phrases -- detection job. For more information, see Amazon VPC. [$sel:vpcConfig:StartKeyPhrasesDetectionJob'] :: StartKeyPhrasesDetectionJob -> Maybe VpcConfig -- | Specifies the format and location of the input data for the job. [$sel:inputDataConfig:StartKeyPhrasesDetectionJob'] :: StartKeyPhrasesDetectionJob -> InputDataConfig -- | Specifies where to send the output files. [$sel:outputDataConfig:StartKeyPhrasesDetectionJob'] :: StartKeyPhrasesDetectionJob -> OutputDataConfig -- | The Amazon Resource Name (ARN) of the AWS Identity and Access -- Management (IAM) role 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. [$sel:dataAccessRoleArn:StartKeyPhrasesDetectionJob'] :: StartKeyPhrasesDetectionJob -> Text -- | The language of the input documents. You can specify any of the -- primary languages supported by Amazon Comprehend. All documents must -- be in the same language. [$sel:languageCode:StartKeyPhrasesDetectionJob'] :: StartKeyPhrasesDetectionJob -> LanguageCode -- | Create a value of StartKeyPhrasesDetectionJob with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:clientRequestToken:StartKeyPhrasesDetectionJob', -- startKeyPhrasesDetectionJob_clientRequestToken - A unique -- identifier for the request. If you don't set the client request token, -- Amazon Comprehend generates one. -- -- StartKeyPhrasesDetectionJob, -- startKeyPhrasesDetectionJob_jobName - The identifier of the -- job. -- -- $sel:tags:StartKeyPhrasesDetectionJob', -- startKeyPhrasesDetectionJob_tags - Tags to be associated with -- the key phrases detection job. A tag is a key-value pair that adds -- metadata to a resource used by Amazon Comprehend. For example, a tag -- with "Sales" as the key might be added to a resource to indicate its -- use by the sales department. -- -- StartKeyPhrasesDetectionJob, -- startKeyPhrasesDetectionJob_volumeKmsKeyId - ID for the AWS Key -- Management Service (KMS) key that Amazon Comprehend uses to encrypt -- data on the storage volume attached to the ML compute instance(s) that -- process the analysis job. The VolumeKmsKeyId can be either of the -- following formats: -- -- -- -- StartKeyPhrasesDetectionJob, -- startKeyPhrasesDetectionJob_vpcConfig - Configuration -- parameters for an optional private Virtual Private Cloud (VPC) -- containing the resources you are using for your key phrases detection -- job. For more information, see Amazon VPC. -- -- StartKeyPhrasesDetectionJob, -- startKeyPhrasesDetectionJob_inputDataConfig - Specifies the -- format and location of the input data for the job. -- -- StartKeyPhrasesDetectionJob, -- startKeyPhrasesDetectionJob_outputDataConfig - Specifies where -- to send the output files. -- -- StartKeyPhrasesDetectionJob, -- startKeyPhrasesDetectionJob_dataAccessRoleArn - The Amazon -- Resource Name (ARN) of the AWS Identity and Access Management (IAM) -- role 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. -- -- StartKeyPhrasesDetectionJob, -- startKeyPhrasesDetectionJob_languageCode - The language of the -- input documents. You can specify any of the primary languages -- supported by Amazon Comprehend. All documents must be in the same -- language. newStartKeyPhrasesDetectionJob :: InputDataConfig -> OutputDataConfig -> Text -> LanguageCode -> StartKeyPhrasesDetectionJob -- | A unique identifier for the request. If you don't set the client -- request token, Amazon Comprehend generates one. startKeyPhrasesDetectionJob_clientRequestToken :: Lens' StartKeyPhrasesDetectionJob (Maybe Text) -- | The identifier of the job. startKeyPhrasesDetectionJob_jobName :: Lens' StartKeyPhrasesDetectionJob (Maybe Text) -- | Tags to be associated with the key phrases detection job. A tag is a -- key-value pair that adds metadata to a resource used by Amazon -- Comprehend. For example, a tag with "Sales" as the key might be added -- to a resource to indicate its use by the sales department. startKeyPhrasesDetectionJob_tags :: Lens' StartKeyPhrasesDetectionJob (Maybe [Tag]) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- startKeyPhrasesDetectionJob_volumeKmsKeyId :: Lens' StartKeyPhrasesDetectionJob (Maybe Text) -- | Configuration parameters for an optional private Virtual Private Cloud -- (VPC) containing the resources you are using for your key phrases -- detection job. For more information, see Amazon VPC. startKeyPhrasesDetectionJob_vpcConfig :: Lens' StartKeyPhrasesDetectionJob (Maybe VpcConfig) -- | Specifies the format and location of the input data for the job. startKeyPhrasesDetectionJob_inputDataConfig :: Lens' StartKeyPhrasesDetectionJob InputDataConfig -- | Specifies where to send the output files. startKeyPhrasesDetectionJob_outputDataConfig :: Lens' StartKeyPhrasesDetectionJob OutputDataConfig -- | The Amazon Resource Name (ARN) of the AWS Identity and Access -- Management (IAM) role 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. startKeyPhrasesDetectionJob_dataAccessRoleArn :: Lens' StartKeyPhrasesDetectionJob Text -- | The language of the input documents. You can specify any of the -- primary languages supported by Amazon Comprehend. All documents must -- be in the same language. startKeyPhrasesDetectionJob_languageCode :: Lens' StartKeyPhrasesDetectionJob LanguageCode -- | See: newStartKeyPhrasesDetectionJobResponse smart -- constructor. data StartKeyPhrasesDetectionJobResponse StartKeyPhrasesDetectionJobResponse' :: Maybe Text -> Maybe Text -> Maybe JobStatus -> Int -> StartKeyPhrasesDetectionJobResponse -- | The Amazon Resource Name (ARN) of the key phrase detection job. It is -- a unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
--
[$sel:jobArn:StartKeyPhrasesDetectionJobResponse'] :: StartKeyPhrasesDetectionJobResponse -> Maybe Text -- | The identifier generated for the job. To get the status of a job, use -- this identifier with the operation. [$sel:jobId:StartKeyPhrasesDetectionJobResponse'] :: StartKeyPhrasesDetectionJobResponse -> Maybe Text -- | The status of the job. -- -- [$sel:jobStatus:StartKeyPhrasesDetectionJobResponse'] :: StartKeyPhrasesDetectionJobResponse -> Maybe JobStatus -- | The response's http status code. [$sel:httpStatus:StartKeyPhrasesDetectionJobResponse'] :: StartKeyPhrasesDetectionJobResponse -> Int -- | Create a value of StartKeyPhrasesDetectionJobResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StartKeyPhrasesDetectionJobResponse, -- startKeyPhrasesDetectionJobResponse_jobArn - The Amazon -- Resource Name (ARN) of the key phrase detection job. It is a unique, -- fully qualified identifier for the job. It includes the AWS account, -- Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- StartKeyPhrasesDetectionJobResponse, -- startKeyPhrasesDetectionJobResponse_jobId - The identifier -- generated for the job. To get the status of a job, use this identifier -- with the operation. -- -- StartKeyPhrasesDetectionJobResponse, -- startKeyPhrasesDetectionJobResponse_jobStatus - The status of -- the job. -- -- -- -- $sel:httpStatus:StartKeyPhrasesDetectionJobResponse', -- startKeyPhrasesDetectionJobResponse_httpStatus - The response's -- http status code. newStartKeyPhrasesDetectionJobResponse :: Int -> StartKeyPhrasesDetectionJobResponse -- | The Amazon Resource Name (ARN) of the key phrase detection job. It is -- a unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
--
startKeyPhrasesDetectionJobResponse_jobArn :: Lens' StartKeyPhrasesDetectionJobResponse (Maybe Text) -- | The identifier generated for the job. To get the status of a job, use -- this identifier with the operation. startKeyPhrasesDetectionJobResponse_jobId :: Lens' StartKeyPhrasesDetectionJobResponse (Maybe Text) -- | The status of the job. -- -- startKeyPhrasesDetectionJobResponse_jobStatus :: Lens' StartKeyPhrasesDetectionJobResponse (Maybe JobStatus) -- | The response's http status code. startKeyPhrasesDetectionJobResponse_httpStatus :: Lens' StartKeyPhrasesDetectionJobResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.StartKeyPhrasesDetectionJob.StartKeyPhrasesDetectionJob instance GHC.Show.Show Amazonka.Comprehend.StartKeyPhrasesDetectionJob.StartKeyPhrasesDetectionJob instance GHC.Read.Read Amazonka.Comprehend.StartKeyPhrasesDetectionJob.StartKeyPhrasesDetectionJob instance GHC.Classes.Eq Amazonka.Comprehend.StartKeyPhrasesDetectionJob.StartKeyPhrasesDetectionJob instance GHC.Generics.Generic Amazonka.Comprehend.StartKeyPhrasesDetectionJob.StartKeyPhrasesDetectionJobResponse instance GHC.Show.Show Amazonka.Comprehend.StartKeyPhrasesDetectionJob.StartKeyPhrasesDetectionJobResponse instance GHC.Read.Read Amazonka.Comprehend.StartKeyPhrasesDetectionJob.StartKeyPhrasesDetectionJobResponse instance GHC.Classes.Eq Amazonka.Comprehend.StartKeyPhrasesDetectionJob.StartKeyPhrasesDetectionJobResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.StartKeyPhrasesDetectionJob.StartKeyPhrasesDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.StartKeyPhrasesDetectionJob.StartKeyPhrasesDetectionJobResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.StartKeyPhrasesDetectionJob.StartKeyPhrasesDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.StartKeyPhrasesDetectionJob.StartKeyPhrasesDetectionJob instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.StartKeyPhrasesDetectionJob.StartKeyPhrasesDetectionJob instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.StartKeyPhrasesDetectionJob.StartKeyPhrasesDetectionJob instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.StartKeyPhrasesDetectionJob.StartKeyPhrasesDetectionJob instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.StartKeyPhrasesDetectionJob.StartKeyPhrasesDetectionJob -- | Starts an asynchronous event detection job for a collection of -- documents. module Amazonka.Comprehend.StartEventsDetectionJob -- | See: newStartEventsDetectionJob smart constructor. data StartEventsDetectionJob StartEventsDetectionJob' :: Maybe Text -> Maybe Text -> Maybe [Tag] -> InputDataConfig -> OutputDataConfig -> Text -> LanguageCode -> NonEmpty Text -> StartEventsDetectionJob -- | An unique identifier for the request. If you don't set the client -- request token, Amazon Comprehend generates one. [$sel:clientRequestToken:StartEventsDetectionJob'] :: StartEventsDetectionJob -> Maybe Text -- | The identifier of the events detection job. [$sel:jobName:StartEventsDetectionJob'] :: StartEventsDetectionJob -> Maybe Text -- | Tags to be associated with the events detection job. A tag is a -- key-value pair that adds metadata to a resource used by Amazon -- Comprehend. For example, a tag with "Sales" as the key might be added -- to a resource to indicate its use by the sales department. [$sel:tags:StartEventsDetectionJob'] :: StartEventsDetectionJob -> Maybe [Tag] -- | Specifies the format and location of the input data for the job. [$sel:inputDataConfig:StartEventsDetectionJob'] :: StartEventsDetectionJob -> InputDataConfig -- | Specifies where to send the output files. [$sel:outputDataConfig:StartEventsDetectionJob'] :: StartEventsDetectionJob -> OutputDataConfig -- | The Amazon Resource Name (ARN) of the AWS Identity and Access -- Management (IAM) role that grants Amazon Comprehend read access to -- your input data. [$sel:dataAccessRoleArn:StartEventsDetectionJob'] :: StartEventsDetectionJob -> Text -- | The language code of the input documents. [$sel:languageCode:StartEventsDetectionJob'] :: StartEventsDetectionJob -> LanguageCode -- | The types of events to detect in the input documents. [$sel:targetEventTypes:StartEventsDetectionJob'] :: StartEventsDetectionJob -> NonEmpty Text -- | Create a value of StartEventsDetectionJob with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:clientRequestToken:StartEventsDetectionJob', -- startEventsDetectionJob_clientRequestToken - An unique -- identifier for the request. If you don't set the client request token, -- Amazon Comprehend generates one. -- -- StartEventsDetectionJob, startEventsDetectionJob_jobName -- - The identifier of the events detection job. -- -- $sel:tags:StartEventsDetectionJob', -- startEventsDetectionJob_tags - Tags to be associated with the -- events detection job. A tag is a key-value pair that adds metadata to -- a resource used by Amazon Comprehend. For example, a tag with "Sales" -- as the key might be added to a resource to indicate its use by the -- sales department. -- -- StartEventsDetectionJob, -- startEventsDetectionJob_inputDataConfig - Specifies the format -- and location of the input data for the job. -- -- StartEventsDetectionJob, -- startEventsDetectionJob_outputDataConfig - Specifies where to -- send the output files. -- -- StartEventsDetectionJob, -- startEventsDetectionJob_dataAccessRoleArn - The Amazon Resource -- Name (ARN) of the AWS Identity and Access Management (IAM) role that -- grants Amazon Comprehend read access to your input data. -- -- StartEventsDetectionJob, -- startEventsDetectionJob_languageCode - The language code of the -- input documents. -- -- StartEventsDetectionJob, -- startEventsDetectionJob_targetEventTypes - The types of events -- to detect in the input documents. newStartEventsDetectionJob :: InputDataConfig -> OutputDataConfig -> Text -> LanguageCode -> NonEmpty Text -> StartEventsDetectionJob -- | An unique identifier for the request. If you don't set the client -- request token, Amazon Comprehend generates one. startEventsDetectionJob_clientRequestToken :: Lens' StartEventsDetectionJob (Maybe Text) -- | The identifier of the events detection job. startEventsDetectionJob_jobName :: Lens' StartEventsDetectionJob (Maybe Text) -- | Tags to be associated with the events detection job. A tag is a -- key-value pair that adds metadata to a resource used by Amazon -- Comprehend. For example, a tag with "Sales" as the key might be added -- to a resource to indicate its use by the sales department. startEventsDetectionJob_tags :: Lens' StartEventsDetectionJob (Maybe [Tag]) -- | Specifies the format and location of the input data for the job. startEventsDetectionJob_inputDataConfig :: Lens' StartEventsDetectionJob InputDataConfig -- | Specifies where to send the output files. startEventsDetectionJob_outputDataConfig :: Lens' StartEventsDetectionJob OutputDataConfig -- | The Amazon Resource Name (ARN) of the AWS Identity and Access -- Management (IAM) role that grants Amazon Comprehend read access to -- your input data. startEventsDetectionJob_dataAccessRoleArn :: Lens' StartEventsDetectionJob Text -- | The language code of the input documents. startEventsDetectionJob_languageCode :: Lens' StartEventsDetectionJob LanguageCode -- | The types of events to detect in the input documents. startEventsDetectionJob_targetEventTypes :: Lens' StartEventsDetectionJob (NonEmpty Text) -- | See: newStartEventsDetectionJobResponse smart -- constructor. data StartEventsDetectionJobResponse StartEventsDetectionJobResponse' :: Maybe Text -> Maybe Text -> Maybe JobStatus -> Int -> StartEventsDetectionJobResponse -- | The Amazon Resource Name (ARN) of the events detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
--
[$sel:jobArn:StartEventsDetectionJobResponse'] :: StartEventsDetectionJobResponse -> Maybe Text -- | An unique identifier for the request. If you don't set the client -- request token, Amazon Comprehend generates one. [$sel:jobId:StartEventsDetectionJobResponse'] :: StartEventsDetectionJobResponse -> Maybe Text -- | The status of the events detection job. [$sel:jobStatus:StartEventsDetectionJobResponse'] :: StartEventsDetectionJobResponse -> Maybe JobStatus -- | The response's http status code. [$sel:httpStatus:StartEventsDetectionJobResponse'] :: StartEventsDetectionJobResponse -> Int -- | Create a value of StartEventsDetectionJobResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StartEventsDetectionJobResponse, -- startEventsDetectionJobResponse_jobArn - The Amazon Resource -- Name (ARN) of the events detection job. It is a unique, fully -- qualified identifier for the job. It includes the AWS account, Region, -- and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- StartEventsDetectionJobResponse, -- startEventsDetectionJobResponse_jobId - An unique identifier -- for the request. If you don't set the client request token, Amazon -- Comprehend generates one. -- -- StartEventsDetectionJobResponse, -- startEventsDetectionJobResponse_jobStatus - The status of the -- events detection job. -- -- $sel:httpStatus:StartEventsDetectionJobResponse', -- startEventsDetectionJobResponse_httpStatus - The response's -- http status code. newStartEventsDetectionJobResponse :: Int -> StartEventsDetectionJobResponse -- | The Amazon Resource Name (ARN) of the events detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
--
startEventsDetectionJobResponse_jobArn :: Lens' StartEventsDetectionJobResponse (Maybe Text) -- | An unique identifier for the request. If you don't set the client -- request token, Amazon Comprehend generates one. startEventsDetectionJobResponse_jobId :: Lens' StartEventsDetectionJobResponse (Maybe Text) -- | The status of the events detection job. startEventsDetectionJobResponse_jobStatus :: Lens' StartEventsDetectionJobResponse (Maybe JobStatus) -- | The response's http status code. startEventsDetectionJobResponse_httpStatus :: Lens' StartEventsDetectionJobResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.StartEventsDetectionJob.StartEventsDetectionJob instance GHC.Show.Show Amazonka.Comprehend.StartEventsDetectionJob.StartEventsDetectionJob instance GHC.Read.Read Amazonka.Comprehend.StartEventsDetectionJob.StartEventsDetectionJob instance GHC.Classes.Eq Amazonka.Comprehend.StartEventsDetectionJob.StartEventsDetectionJob instance GHC.Generics.Generic Amazonka.Comprehend.StartEventsDetectionJob.StartEventsDetectionJobResponse instance GHC.Show.Show Amazonka.Comprehend.StartEventsDetectionJob.StartEventsDetectionJobResponse instance GHC.Read.Read Amazonka.Comprehend.StartEventsDetectionJob.StartEventsDetectionJobResponse instance GHC.Classes.Eq Amazonka.Comprehend.StartEventsDetectionJob.StartEventsDetectionJobResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.StartEventsDetectionJob.StartEventsDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.StartEventsDetectionJob.StartEventsDetectionJobResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.StartEventsDetectionJob.StartEventsDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.StartEventsDetectionJob.StartEventsDetectionJob instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.StartEventsDetectionJob.StartEventsDetectionJob instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.StartEventsDetectionJob.StartEventsDetectionJob instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.StartEventsDetectionJob.StartEventsDetectionJob instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.StartEventsDetectionJob.StartEventsDetectionJob -- | Starts an asynchronous entity detection job for a collection of -- documents. Use the operation to track the status of a job. -- -- This API can be used for either standard entity detection or custom -- entity recognition. In order to be used for custom entity recognition, -- the optional EntityRecognizerArn must be used in order to -- provide access to the recognizer being used to detect the custom -- entity. module Amazonka.Comprehend.StartEntitiesDetectionJob -- | See: newStartEntitiesDetectionJob smart constructor. data StartEntitiesDetectionJob StartEntitiesDetectionJob' :: Maybe Text -> Maybe Text -> Maybe Text -> Maybe [Tag] -> Maybe Text -> Maybe VpcConfig -> InputDataConfig -> OutputDataConfig -> Text -> LanguageCode -> StartEntitiesDetectionJob -- | A unique identifier for the request. If you don't set the client -- request token, Amazon Comprehend generates one. [$sel:clientRequestToken:StartEntitiesDetectionJob'] :: StartEntitiesDetectionJob -> Maybe Text -- | The Amazon Resource Name (ARN) that identifies the specific entity -- recognizer to be used by the StartEntitiesDetectionJob. This -- ARN is optional and is only used for a custom entity recognition job. [$sel:entityRecognizerArn:StartEntitiesDetectionJob'] :: StartEntitiesDetectionJob -> Maybe Text -- | The identifier of the job. [$sel:jobName:StartEntitiesDetectionJob'] :: StartEntitiesDetectionJob -> Maybe Text -- | Tags to be associated with the entities detection job. A tag is a -- key-value pair that adds metadata to a resource used by Amazon -- Comprehend. For example, a tag with "Sales" as the key might be added -- to a resource to indicate its use by the sales department. [$sel:tags:StartEntitiesDetectionJob'] :: StartEntitiesDetectionJob -> Maybe [Tag] -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- [$sel:volumeKmsKeyId:StartEntitiesDetectionJob'] :: StartEntitiesDetectionJob -> Maybe Text -- | Configuration parameters for an optional private Virtual Private Cloud -- (VPC) containing the resources you are using for your entity detection -- job. For more information, see Amazon VPC. [$sel:vpcConfig:StartEntitiesDetectionJob'] :: StartEntitiesDetectionJob -> Maybe VpcConfig -- | Specifies the format and location of the input data for the job. [$sel:inputDataConfig:StartEntitiesDetectionJob'] :: StartEntitiesDetectionJob -> InputDataConfig -- | Specifies where to send the output files. [$sel:outputDataConfig:StartEntitiesDetectionJob'] :: StartEntitiesDetectionJob -> OutputDataConfig -- | The Amazon Resource Name (ARN) of the AWS Identity and Access -- Management (IAM) role 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. [$sel:dataAccessRoleArn:StartEntitiesDetectionJob'] :: StartEntitiesDetectionJob -> Text -- | The language of the input documents. All documents must be in the same -- language. You can specify any of the languages supported by Amazon -- Comprehend. If custom entities recognition is used, this parameter is -- ignored and the language used for training the model is used instead. [$sel:languageCode:StartEntitiesDetectionJob'] :: StartEntitiesDetectionJob -> LanguageCode -- | Create a value of StartEntitiesDetectionJob with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:clientRequestToken:StartEntitiesDetectionJob', -- startEntitiesDetectionJob_clientRequestToken - A unique -- identifier for the request. If you don't set the client request token, -- Amazon Comprehend generates one. -- -- StartEntitiesDetectionJob, -- startEntitiesDetectionJob_entityRecognizerArn - The Amazon -- Resource Name (ARN) that identifies the specific entity recognizer to -- be used by the StartEntitiesDetectionJob. This ARN is -- optional and is only used for a custom entity recognition job. -- -- StartEntitiesDetectionJob, -- startEntitiesDetectionJob_jobName - The identifier of the job. -- -- $sel:tags:StartEntitiesDetectionJob', -- startEntitiesDetectionJob_tags - Tags to be associated with the -- entities detection job. A tag is a key-value pair that adds metadata -- to a resource used by Amazon Comprehend. For example, a tag with -- "Sales" as the key might be added to a resource to indicate its use by -- the sales department. -- -- StartEntitiesDetectionJob, -- startEntitiesDetectionJob_volumeKmsKeyId - ID for the AWS Key -- Management Service (KMS) key that Amazon Comprehend uses to encrypt -- data on the storage volume attached to the ML compute instance(s) that -- process the analysis job. The VolumeKmsKeyId can be either of the -- following formats: -- -- -- -- StartEntitiesDetectionJob, -- startEntitiesDetectionJob_vpcConfig - Configuration parameters -- for an optional private Virtual Private Cloud (VPC) containing the -- resources you are using for your entity detection job. For more -- information, see Amazon VPC. -- -- StartEntitiesDetectionJob, -- startEntitiesDetectionJob_inputDataConfig - Specifies the -- format and location of the input data for the job. -- -- StartEntitiesDetectionJob, -- startEntitiesDetectionJob_outputDataConfig - Specifies where to -- send the output files. -- -- StartEntitiesDetectionJob, -- startEntitiesDetectionJob_dataAccessRoleArn - The Amazon -- Resource Name (ARN) of the AWS Identity and Access Management (IAM) -- role 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. -- -- StartEntitiesDetectionJob, -- startEntitiesDetectionJob_languageCode - The language of the -- input documents. All documents must be in the same language. You can -- specify any of the languages supported by Amazon Comprehend. If custom -- entities recognition is used, this parameter is ignored and the -- language used for training the model is used instead. newStartEntitiesDetectionJob :: InputDataConfig -> OutputDataConfig -> Text -> LanguageCode -> StartEntitiesDetectionJob -- | A unique identifier for the request. If you don't set the client -- request token, Amazon Comprehend generates one. startEntitiesDetectionJob_clientRequestToken :: Lens' StartEntitiesDetectionJob (Maybe Text) -- | The Amazon Resource Name (ARN) that identifies the specific entity -- recognizer to be used by the StartEntitiesDetectionJob. This -- ARN is optional and is only used for a custom entity recognition job. startEntitiesDetectionJob_entityRecognizerArn :: Lens' StartEntitiesDetectionJob (Maybe Text) -- | The identifier of the job. startEntitiesDetectionJob_jobName :: Lens' StartEntitiesDetectionJob (Maybe Text) -- | Tags to be associated with the entities detection job. A tag is a -- key-value pair that adds metadata to a resource used by Amazon -- Comprehend. For example, a tag with "Sales" as the key might be added -- to a resource to indicate its use by the sales department. startEntitiesDetectionJob_tags :: Lens' StartEntitiesDetectionJob (Maybe [Tag]) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- startEntitiesDetectionJob_volumeKmsKeyId :: Lens' StartEntitiesDetectionJob (Maybe Text) -- | Configuration parameters for an optional private Virtual Private Cloud -- (VPC) containing the resources you are using for your entity detection -- job. For more information, see Amazon VPC. startEntitiesDetectionJob_vpcConfig :: Lens' StartEntitiesDetectionJob (Maybe VpcConfig) -- | Specifies the format and location of the input data for the job. startEntitiesDetectionJob_inputDataConfig :: Lens' StartEntitiesDetectionJob InputDataConfig -- | Specifies where to send the output files. startEntitiesDetectionJob_outputDataConfig :: Lens' StartEntitiesDetectionJob OutputDataConfig -- | The Amazon Resource Name (ARN) of the AWS Identity and Access -- Management (IAM) role 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. startEntitiesDetectionJob_dataAccessRoleArn :: Lens' StartEntitiesDetectionJob Text -- | The language of the input documents. All documents must be in the same -- language. You can specify any of the languages supported by Amazon -- Comprehend. If custom entities recognition is used, this parameter is -- ignored and the language used for training the model is used instead. startEntitiesDetectionJob_languageCode :: Lens' StartEntitiesDetectionJob LanguageCode -- | See: newStartEntitiesDetectionJobResponse smart -- constructor. data StartEntitiesDetectionJobResponse StartEntitiesDetectionJobResponse' :: Maybe Text -> Maybe Text -> Maybe JobStatus -> Int -> StartEntitiesDetectionJobResponse -- | The Amazon Resource Name (ARN) of the entities detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
--
[$sel:jobArn:StartEntitiesDetectionJobResponse'] :: StartEntitiesDetectionJobResponse -> Maybe Text -- | The identifier generated for the job. To get the status of job, use -- this identifier with the operation. [$sel:jobId:StartEntitiesDetectionJobResponse'] :: StartEntitiesDetectionJobResponse -> Maybe Text -- | The status of the job. -- -- [$sel:jobStatus:StartEntitiesDetectionJobResponse'] :: StartEntitiesDetectionJobResponse -> Maybe JobStatus -- | The response's http status code. [$sel:httpStatus:StartEntitiesDetectionJobResponse'] :: StartEntitiesDetectionJobResponse -> Int -- | Create a value of StartEntitiesDetectionJobResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StartEntitiesDetectionJobResponse, -- startEntitiesDetectionJobResponse_jobArn - The Amazon Resource -- Name (ARN) of the entities detection job. It is a unique, fully -- qualified identifier for the job. It includes the AWS account, Region, -- and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- StartEntitiesDetectionJobResponse, -- startEntitiesDetectionJobResponse_jobId - The identifier -- generated for the job. To get the status of job, use this identifier -- with the operation. -- -- StartEntitiesDetectionJobResponse, -- startEntitiesDetectionJobResponse_jobStatus - The status of the -- job. -- -- -- -- $sel:httpStatus:StartEntitiesDetectionJobResponse', -- startEntitiesDetectionJobResponse_httpStatus - The response's -- http status code. newStartEntitiesDetectionJobResponse :: Int -> StartEntitiesDetectionJobResponse -- | The Amazon Resource Name (ARN) of the entities detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
--
startEntitiesDetectionJobResponse_jobArn :: Lens' StartEntitiesDetectionJobResponse (Maybe Text) -- | The identifier generated for the job. To get the status of job, use -- this identifier with the operation. startEntitiesDetectionJobResponse_jobId :: Lens' StartEntitiesDetectionJobResponse (Maybe Text) -- | The status of the job. -- -- startEntitiesDetectionJobResponse_jobStatus :: Lens' StartEntitiesDetectionJobResponse (Maybe JobStatus) -- | The response's http status code. startEntitiesDetectionJobResponse_httpStatus :: Lens' StartEntitiesDetectionJobResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.StartEntitiesDetectionJob.StartEntitiesDetectionJob instance GHC.Show.Show Amazonka.Comprehend.StartEntitiesDetectionJob.StartEntitiesDetectionJob instance GHC.Read.Read Amazonka.Comprehend.StartEntitiesDetectionJob.StartEntitiesDetectionJob instance GHC.Classes.Eq Amazonka.Comprehend.StartEntitiesDetectionJob.StartEntitiesDetectionJob instance GHC.Generics.Generic Amazonka.Comprehend.StartEntitiesDetectionJob.StartEntitiesDetectionJobResponse instance GHC.Show.Show Amazonka.Comprehend.StartEntitiesDetectionJob.StartEntitiesDetectionJobResponse instance GHC.Read.Read Amazonka.Comprehend.StartEntitiesDetectionJob.StartEntitiesDetectionJobResponse instance GHC.Classes.Eq Amazonka.Comprehend.StartEntitiesDetectionJob.StartEntitiesDetectionJobResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.StartEntitiesDetectionJob.StartEntitiesDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.StartEntitiesDetectionJob.StartEntitiesDetectionJobResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.StartEntitiesDetectionJob.StartEntitiesDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.StartEntitiesDetectionJob.StartEntitiesDetectionJob instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.StartEntitiesDetectionJob.StartEntitiesDetectionJob instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.StartEntitiesDetectionJob.StartEntitiesDetectionJob instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.StartEntitiesDetectionJob.StartEntitiesDetectionJob instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.StartEntitiesDetectionJob.StartEntitiesDetectionJob -- | Starts an asynchronous dominant language detection job for a -- collection of documents. Use the operation to track the status of a -- job. module Amazonka.Comprehend.StartDominantLanguageDetectionJob -- | See: newStartDominantLanguageDetectionJob smart -- constructor. data StartDominantLanguageDetectionJob StartDominantLanguageDetectionJob' :: Maybe Text -> Maybe Text -> Maybe [Tag] -> Maybe Text -> Maybe VpcConfig -> InputDataConfig -> OutputDataConfig -> Text -> StartDominantLanguageDetectionJob -- | A unique identifier for the request. If you do not set the client -- request token, Amazon Comprehend generates one. [$sel:clientRequestToken:StartDominantLanguageDetectionJob'] :: StartDominantLanguageDetectionJob -> Maybe Text -- | An identifier for the job. [$sel:jobName:StartDominantLanguageDetectionJob'] :: StartDominantLanguageDetectionJob -> Maybe Text -- | Tags to be associated with the dominant language detection job. A tag -- is a key-value pair that adds metadata to a resource used by Amazon -- Comprehend. For example, a tag with "Sales" as the key might be added -- to a resource to indicate its use by the sales department. [$sel:tags:StartDominantLanguageDetectionJob'] :: StartDominantLanguageDetectionJob -> Maybe [Tag] -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- [$sel:volumeKmsKeyId:StartDominantLanguageDetectionJob'] :: StartDominantLanguageDetectionJob -> Maybe Text -- | Configuration parameters for an optional private Virtual Private Cloud -- (VPC) containing the resources you are using for your dominant -- language detection job. For more information, see Amazon VPC. [$sel:vpcConfig:StartDominantLanguageDetectionJob'] :: StartDominantLanguageDetectionJob -> Maybe VpcConfig -- | Specifies the format and location of the input data for the job. [$sel:inputDataConfig:StartDominantLanguageDetectionJob'] :: StartDominantLanguageDetectionJob -> InputDataConfig -- | Specifies where to send the output files. [$sel:outputDataConfig:StartDominantLanguageDetectionJob'] :: StartDominantLanguageDetectionJob -> OutputDataConfig -- | The Amazon Resource Name (ARN) of the AWS Identity and Access -- Management (IAM) role 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. [$sel:dataAccessRoleArn:StartDominantLanguageDetectionJob'] :: StartDominantLanguageDetectionJob -> Text -- | Create a value of StartDominantLanguageDetectionJob with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:clientRequestToken:StartDominantLanguageDetectionJob', -- startDominantLanguageDetectionJob_clientRequestToken - A unique -- identifier for the request. If you do not set the client request -- token, Amazon Comprehend generates one. -- -- StartDominantLanguageDetectionJob, -- startDominantLanguageDetectionJob_jobName - An identifier for -- the job. -- -- $sel:tags:StartDominantLanguageDetectionJob', -- startDominantLanguageDetectionJob_tags - Tags to be associated -- with the dominant language detection job. A tag is a key-value pair -- that adds metadata to a resource used by Amazon Comprehend. For -- example, a tag with "Sales" as the key might be added to a resource to -- indicate its use by the sales department. -- -- StartDominantLanguageDetectionJob, -- startDominantLanguageDetectionJob_volumeKmsKeyId - ID for the -- AWS Key Management Service (KMS) key that Amazon Comprehend uses to -- encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- -- -- StartDominantLanguageDetectionJob, -- startDominantLanguageDetectionJob_vpcConfig - Configuration -- parameters for an optional private Virtual Private Cloud (VPC) -- containing the resources you are using for your dominant language -- detection job. For more information, see Amazon VPC. -- -- StartDominantLanguageDetectionJob, -- startDominantLanguageDetectionJob_inputDataConfig - Specifies -- the format and location of the input data for the job. -- -- StartDominantLanguageDetectionJob, -- startDominantLanguageDetectionJob_outputDataConfig - Specifies -- where to send the output files. -- -- StartDominantLanguageDetectionJob, -- startDominantLanguageDetectionJob_dataAccessRoleArn - The -- Amazon Resource Name (ARN) of the AWS Identity and Access Management -- (IAM) role 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. newStartDominantLanguageDetectionJob :: InputDataConfig -> OutputDataConfig -> Text -> StartDominantLanguageDetectionJob -- | A unique identifier for the request. If you do not set the client -- request token, Amazon Comprehend generates one. startDominantLanguageDetectionJob_clientRequestToken :: Lens' StartDominantLanguageDetectionJob (Maybe Text) -- | An identifier for the job. startDominantLanguageDetectionJob_jobName :: Lens' StartDominantLanguageDetectionJob (Maybe Text) -- | Tags to be associated with the dominant language detection job. A tag -- is a key-value pair that adds metadata to a resource used by Amazon -- Comprehend. For example, a tag with "Sales" as the key might be added -- to a resource to indicate its use by the sales department. startDominantLanguageDetectionJob_tags :: Lens' StartDominantLanguageDetectionJob (Maybe [Tag]) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- startDominantLanguageDetectionJob_volumeKmsKeyId :: Lens' StartDominantLanguageDetectionJob (Maybe Text) -- | Configuration parameters for an optional private Virtual Private Cloud -- (VPC) containing the resources you are using for your dominant -- language detection job. For more information, see Amazon VPC. startDominantLanguageDetectionJob_vpcConfig :: Lens' StartDominantLanguageDetectionJob (Maybe VpcConfig) -- | Specifies the format and location of the input data for the job. startDominantLanguageDetectionJob_inputDataConfig :: Lens' StartDominantLanguageDetectionJob InputDataConfig -- | Specifies where to send the output files. startDominantLanguageDetectionJob_outputDataConfig :: Lens' StartDominantLanguageDetectionJob OutputDataConfig -- | The Amazon Resource Name (ARN) of the AWS Identity and Access -- Management (IAM) role 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. startDominantLanguageDetectionJob_dataAccessRoleArn :: Lens' StartDominantLanguageDetectionJob Text -- | See: newStartDominantLanguageDetectionJobResponse smart -- constructor. data StartDominantLanguageDetectionJobResponse StartDominantLanguageDetectionJobResponse' :: Maybe Text -> Maybe Text -> Maybe JobStatus -> Int -> StartDominantLanguageDetectionJobResponse -- | The Amazon Resource Name (ARN) of the dominant language detection job. -- It is a unique, fully qualified identifier for the job. It includes -- the AWS account, Region, and the job ID. The format of the ARN is as -- follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
--
[$sel:jobArn:StartDominantLanguageDetectionJobResponse'] :: StartDominantLanguageDetectionJobResponse -> Maybe Text -- | The identifier generated for the job. To get the status of a job, use -- this identifier with the operation. [$sel:jobId:StartDominantLanguageDetectionJobResponse'] :: StartDominantLanguageDetectionJobResponse -> Maybe Text -- | The status of the job. -- -- [$sel:jobStatus:StartDominantLanguageDetectionJobResponse'] :: StartDominantLanguageDetectionJobResponse -> Maybe JobStatus -- | The response's http status code. [$sel:httpStatus:StartDominantLanguageDetectionJobResponse'] :: StartDominantLanguageDetectionJobResponse -> Int -- | Create a value of StartDominantLanguageDetectionJobResponse -- with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StartDominantLanguageDetectionJobResponse, -- startDominantLanguageDetectionJobResponse_jobArn - The Amazon -- Resource Name (ARN) of the dominant language detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- StartDominantLanguageDetectionJobResponse, -- startDominantLanguageDetectionJobResponse_jobId - The -- identifier generated for the job. To get the status of a job, use this -- identifier with the operation. -- -- StartDominantLanguageDetectionJobResponse, -- startDominantLanguageDetectionJobResponse_jobStatus - The -- status of the job. -- -- -- -- $sel:httpStatus:StartDominantLanguageDetectionJobResponse', -- startDominantLanguageDetectionJobResponse_httpStatus - The -- response's http status code. newStartDominantLanguageDetectionJobResponse :: Int -> StartDominantLanguageDetectionJobResponse -- | The Amazon Resource Name (ARN) of the dominant language detection job. -- It is a unique, fully qualified identifier for the job. It includes -- the AWS account, Region, and the job ID. The format of the ARN is as -- follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
--
startDominantLanguageDetectionJobResponse_jobArn :: Lens' StartDominantLanguageDetectionJobResponse (Maybe Text) -- | The identifier generated for the job. To get the status of a job, use -- this identifier with the operation. startDominantLanguageDetectionJobResponse_jobId :: Lens' StartDominantLanguageDetectionJobResponse (Maybe Text) -- | The status of the job. -- -- startDominantLanguageDetectionJobResponse_jobStatus :: Lens' StartDominantLanguageDetectionJobResponse (Maybe JobStatus) -- | The response's http status code. startDominantLanguageDetectionJobResponse_httpStatus :: Lens' StartDominantLanguageDetectionJobResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.StartDominantLanguageDetectionJob.StartDominantLanguageDetectionJob instance GHC.Show.Show Amazonka.Comprehend.StartDominantLanguageDetectionJob.StartDominantLanguageDetectionJob instance GHC.Read.Read Amazonka.Comprehend.StartDominantLanguageDetectionJob.StartDominantLanguageDetectionJob instance GHC.Classes.Eq Amazonka.Comprehend.StartDominantLanguageDetectionJob.StartDominantLanguageDetectionJob instance GHC.Generics.Generic Amazonka.Comprehend.StartDominantLanguageDetectionJob.StartDominantLanguageDetectionJobResponse instance GHC.Show.Show Amazonka.Comprehend.StartDominantLanguageDetectionJob.StartDominantLanguageDetectionJobResponse instance GHC.Read.Read Amazonka.Comprehend.StartDominantLanguageDetectionJob.StartDominantLanguageDetectionJobResponse instance GHC.Classes.Eq Amazonka.Comprehend.StartDominantLanguageDetectionJob.StartDominantLanguageDetectionJobResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.StartDominantLanguageDetectionJob.StartDominantLanguageDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.StartDominantLanguageDetectionJob.StartDominantLanguageDetectionJobResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.StartDominantLanguageDetectionJob.StartDominantLanguageDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.StartDominantLanguageDetectionJob.StartDominantLanguageDetectionJob instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.StartDominantLanguageDetectionJob.StartDominantLanguageDetectionJob instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.StartDominantLanguageDetectionJob.StartDominantLanguageDetectionJob instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.StartDominantLanguageDetectionJob.StartDominantLanguageDetectionJob instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.StartDominantLanguageDetectionJob.StartDominantLanguageDetectionJob -- | Starts an asynchronous document classification job. Use the operation -- to track the progress of the job. module Amazonka.Comprehend.StartDocumentClassificationJob -- | See: newStartDocumentClassificationJob smart -- constructor. data StartDocumentClassificationJob StartDocumentClassificationJob' :: Maybe Text -> Maybe Text -> Maybe [Tag] -> Maybe Text -> Maybe VpcConfig -> Text -> InputDataConfig -> OutputDataConfig -> Text -> StartDocumentClassificationJob -- | A unique identifier for the request. If you do not set the client -- request token, Amazon Comprehend generates one. [$sel:clientRequestToken:StartDocumentClassificationJob'] :: StartDocumentClassificationJob -> Maybe Text -- | The identifier of the job. [$sel:jobName:StartDocumentClassificationJob'] :: StartDocumentClassificationJob -> Maybe Text -- | Tags to be associated with the document classification job. A tag is a -- key-value pair that adds metadata to a resource used by Amazon -- Comprehend. For example, a tag with "Sales" as the key might be added -- to a resource to indicate its use by the sales department. [$sel:tags:StartDocumentClassificationJob'] :: StartDocumentClassificationJob -> Maybe [Tag] -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- [$sel:volumeKmsKeyId:StartDocumentClassificationJob'] :: StartDocumentClassificationJob -> Maybe Text -- | Configuration parameters for an optional private Virtual Private Cloud -- (VPC) containing the resources you are using for your document -- classification job. For more information, see Amazon VPC. [$sel:vpcConfig:StartDocumentClassificationJob'] :: StartDocumentClassificationJob -> Maybe VpcConfig -- | The Amazon Resource Name (ARN) of the document classifier to use to -- process the job. [$sel:documentClassifierArn:StartDocumentClassificationJob'] :: StartDocumentClassificationJob -> Text -- | Specifies the format and location of the input data for the job. [$sel:inputDataConfig:StartDocumentClassificationJob'] :: StartDocumentClassificationJob -> InputDataConfig -- | Specifies where to send the output files. [$sel:outputDataConfig:StartDocumentClassificationJob'] :: StartDocumentClassificationJob -> OutputDataConfig -- | The Amazon Resource Name (ARN) of the AWS Identity and Access -- Management (IAM) role that grants Amazon Comprehend read access to -- your input data. [$sel:dataAccessRoleArn:StartDocumentClassificationJob'] :: StartDocumentClassificationJob -> Text -- | Create a value of StartDocumentClassificationJob with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:clientRequestToken:StartDocumentClassificationJob', -- startDocumentClassificationJob_clientRequestToken - A unique -- identifier for the request. If you do not set the client request -- token, Amazon Comprehend generates one. -- -- StartDocumentClassificationJob, -- startDocumentClassificationJob_jobName - The identifier of the -- job. -- -- $sel:tags:StartDocumentClassificationJob', -- startDocumentClassificationJob_tags - Tags to be associated -- with the document classification job. A tag is a key-value pair that -- adds metadata to a resource used by Amazon Comprehend. For example, a -- tag with "Sales" as the key might be added to a resource to indicate -- its use by the sales department. -- -- StartDocumentClassificationJob, -- startDocumentClassificationJob_volumeKmsKeyId - ID for the AWS -- Key Management Service (KMS) key that Amazon Comprehend uses to -- encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- -- -- StartDocumentClassificationJob, -- startDocumentClassificationJob_vpcConfig - Configuration -- parameters for an optional private Virtual Private Cloud (VPC) -- containing the resources you are using for your document -- classification job. For more information, see Amazon VPC. -- -- StartDocumentClassificationJob, -- startDocumentClassificationJob_documentClassifierArn - The -- Amazon Resource Name (ARN) of the document classifier to use to -- process the job. -- -- StartDocumentClassificationJob, -- startDocumentClassificationJob_inputDataConfig - Specifies the -- format and location of the input data for the job. -- -- StartDocumentClassificationJob, -- startDocumentClassificationJob_outputDataConfig - Specifies -- where to send the output files. -- -- StartDocumentClassificationJob, -- startDocumentClassificationJob_dataAccessRoleArn - The Amazon -- Resource Name (ARN) of the AWS Identity and Access Management (IAM) -- role that grants Amazon Comprehend read access to your input data. newStartDocumentClassificationJob :: Text -> InputDataConfig -> OutputDataConfig -> Text -> StartDocumentClassificationJob -- | A unique identifier for the request. If you do not set the client -- request token, Amazon Comprehend generates one. startDocumentClassificationJob_clientRequestToken :: Lens' StartDocumentClassificationJob (Maybe Text) -- | The identifier of the job. startDocumentClassificationJob_jobName :: Lens' StartDocumentClassificationJob (Maybe Text) -- | Tags to be associated with the document classification job. A tag is a -- key-value pair that adds metadata to a resource used by Amazon -- Comprehend. For example, a tag with "Sales" as the key might be added -- to a resource to indicate its use by the sales department. startDocumentClassificationJob_tags :: Lens' StartDocumentClassificationJob (Maybe [Tag]) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- startDocumentClassificationJob_volumeKmsKeyId :: Lens' StartDocumentClassificationJob (Maybe Text) -- | Configuration parameters for an optional private Virtual Private Cloud -- (VPC) containing the resources you are using for your document -- classification job. For more information, see Amazon VPC. startDocumentClassificationJob_vpcConfig :: Lens' StartDocumentClassificationJob (Maybe VpcConfig) -- | The Amazon Resource Name (ARN) of the document classifier to use to -- process the job. startDocumentClassificationJob_documentClassifierArn :: Lens' StartDocumentClassificationJob Text -- | Specifies the format and location of the input data for the job. startDocumentClassificationJob_inputDataConfig :: Lens' StartDocumentClassificationJob InputDataConfig -- | Specifies where to send the output files. startDocumentClassificationJob_outputDataConfig :: Lens' StartDocumentClassificationJob OutputDataConfig -- | The Amazon Resource Name (ARN) of the AWS Identity and Access -- Management (IAM) role that grants Amazon Comprehend read access to -- your input data. startDocumentClassificationJob_dataAccessRoleArn :: Lens' StartDocumentClassificationJob Text -- | See: newStartDocumentClassificationJobResponse smart -- constructor. data StartDocumentClassificationJobResponse StartDocumentClassificationJobResponse' :: Maybe Text -> Maybe Text -> Maybe JobStatus -> Int -> StartDocumentClassificationJobResponse -- | The Amazon Resource Name (ARN) of the document classification job. It -- is a unique, fully qualified identifier for the job. It includes the -- AWS account, Region, and the job ID. The format of the ARN is as -- follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
--
[$sel:jobArn:StartDocumentClassificationJobResponse'] :: StartDocumentClassificationJobResponse -> Maybe Text -- | The identifier generated for the job. To get the status of the job, -- use this identifier with the operation. [$sel:jobId:StartDocumentClassificationJobResponse'] :: StartDocumentClassificationJobResponse -> Maybe Text -- | The status of the job: -- -- [$sel:jobStatus:StartDocumentClassificationJobResponse'] :: StartDocumentClassificationJobResponse -> Maybe JobStatus -- | The response's http status code. [$sel:httpStatus:StartDocumentClassificationJobResponse'] :: StartDocumentClassificationJobResponse -> Int -- | Create a value of StartDocumentClassificationJobResponse with -- all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StartDocumentClassificationJobResponse, -- startDocumentClassificationJobResponse_jobArn - The Amazon -- Resource Name (ARN) of the document classification job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- StartDocumentClassificationJobResponse, -- startDocumentClassificationJobResponse_jobId - The identifier -- generated for the job. To get the status of the job, use this -- identifier with the operation. -- -- StartDocumentClassificationJobResponse, -- startDocumentClassificationJobResponse_jobStatus - The status -- of the job: -- -- -- -- $sel:httpStatus:StartDocumentClassificationJobResponse', -- startDocumentClassificationJobResponse_httpStatus - The -- response's http status code. newStartDocumentClassificationJobResponse :: Int -> StartDocumentClassificationJobResponse -- | The Amazon Resource Name (ARN) of the document classification job. It -- is a unique, fully qualified identifier for the job. It includes the -- AWS account, Region, and the job ID. The format of the ARN is as -- follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
--
startDocumentClassificationJobResponse_jobArn :: Lens' StartDocumentClassificationJobResponse (Maybe Text) -- | The identifier generated for the job. To get the status of the job, -- use this identifier with the operation. startDocumentClassificationJobResponse_jobId :: Lens' StartDocumentClassificationJobResponse (Maybe Text) -- | The status of the job: -- -- startDocumentClassificationJobResponse_jobStatus :: Lens' StartDocumentClassificationJobResponse (Maybe JobStatus) -- | The response's http status code. startDocumentClassificationJobResponse_httpStatus :: Lens' StartDocumentClassificationJobResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.StartDocumentClassificationJob.StartDocumentClassificationJob instance GHC.Show.Show Amazonka.Comprehend.StartDocumentClassificationJob.StartDocumentClassificationJob instance GHC.Read.Read Amazonka.Comprehend.StartDocumentClassificationJob.StartDocumentClassificationJob instance GHC.Classes.Eq Amazonka.Comprehend.StartDocumentClassificationJob.StartDocumentClassificationJob instance GHC.Generics.Generic Amazonka.Comprehend.StartDocumentClassificationJob.StartDocumentClassificationJobResponse instance GHC.Show.Show Amazonka.Comprehend.StartDocumentClassificationJob.StartDocumentClassificationJobResponse instance GHC.Read.Read Amazonka.Comprehend.StartDocumentClassificationJob.StartDocumentClassificationJobResponse instance GHC.Classes.Eq Amazonka.Comprehend.StartDocumentClassificationJob.StartDocumentClassificationJobResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.StartDocumentClassificationJob.StartDocumentClassificationJob instance Control.DeepSeq.NFData Amazonka.Comprehend.StartDocumentClassificationJob.StartDocumentClassificationJobResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.StartDocumentClassificationJob.StartDocumentClassificationJob instance Control.DeepSeq.NFData Amazonka.Comprehend.StartDocumentClassificationJob.StartDocumentClassificationJob instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.StartDocumentClassificationJob.StartDocumentClassificationJob instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.StartDocumentClassificationJob.StartDocumentClassificationJob instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.StartDocumentClassificationJob.StartDocumentClassificationJob instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.StartDocumentClassificationJob.StartDocumentClassificationJob -- | Attaches a resource-based policy to a custom model. You can use this -- policy to authorize an entity in another AWS account to import the -- custom model, which replicates it in Amazon Comprehend in their -- account. module Amazonka.Comprehend.PutResourcePolicy -- | See: newPutResourcePolicy smart constructor. data PutResourcePolicy PutResourcePolicy' :: Maybe Text -> Text -> Text -> PutResourcePolicy -- | The revision ID that Amazon Comprehend assigned to the policy that you -- are updating. If you are creating a new policy that has no prior -- version, don't use this parameter. Amazon Comprehend creates the -- revision ID for you. [$sel:policyRevisionId:PutResourcePolicy'] :: PutResourcePolicy -> Maybe Text -- | The Amazon Resource Name (ARN) of the custom model to attach the -- policy to. [$sel:resourceArn:PutResourcePolicy'] :: PutResourcePolicy -> Text -- | The JSON resource-based policy to attach to your custom model. Provide -- your JSON as a UTF-8 encoded string without line breaks. To provide -- valid JSON for your policy, enclose the attribute names and values in -- double quotes. If the JSON body is also enclosed in double quotes, -- then you must escape the double quotes that are inside the policy: -- -- 
--   "{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
--
-- -- To avoid escaping quotes, you can use single quotes to enclose the -- policy and double quotes to enclose the JSON names and values: -- -- 
--   '{"attribute": "value", "attribute": ["value"]}'
--
[$sel:resourcePolicy:PutResourcePolicy'] :: PutResourcePolicy -> Text -- | Create a value of PutResourcePolicy with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- PutResourcePolicy, putResourcePolicy_policyRevisionId - -- The revision ID that Amazon Comprehend assigned to the policy that you -- are updating. If you are creating a new policy that has no prior -- version, don't use this parameter. Amazon Comprehend creates the -- revision ID for you. -- -- $sel:resourceArn:PutResourcePolicy', -- putResourcePolicy_resourceArn - The Amazon Resource Name (ARN) -- of the custom model to attach the policy to. -- -- $sel:resourcePolicy:PutResourcePolicy', -- putResourcePolicy_resourcePolicy - The JSON resource-based -- policy to attach to your custom model. Provide your JSON as a UTF-8 -- encoded string without line breaks. To provide valid JSON for your -- policy, enclose the attribute names and values in double quotes. If -- the JSON body is also enclosed in double quotes, then you must escape -- the double quotes that are inside the policy: -- -- 
--   "{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
--
-- -- To avoid escaping quotes, you can use single quotes to enclose the -- policy and double quotes to enclose the JSON names and values: -- -- 
--   '{"attribute": "value", "attribute": ["value"]}'
--
newPutResourcePolicy :: Text -> Text -> PutResourcePolicy -- | The revision ID that Amazon Comprehend assigned to the policy that you -- are updating. If you are creating a new policy that has no prior -- version, don't use this parameter. Amazon Comprehend creates the -- revision ID for you. putResourcePolicy_policyRevisionId :: Lens' PutResourcePolicy (Maybe Text) -- | The Amazon Resource Name (ARN) of the custom model to attach the -- policy to. putResourcePolicy_resourceArn :: Lens' PutResourcePolicy Text -- | The JSON resource-based policy to attach to your custom model. Provide -- your JSON as a UTF-8 encoded string without line breaks. To provide -- valid JSON for your policy, enclose the attribute names and values in -- double quotes. If the JSON body is also enclosed in double quotes, -- then you must escape the double quotes that are inside the policy: -- -- 
--   "{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
--
-- -- To avoid escaping quotes, you can use single quotes to enclose the -- policy and double quotes to enclose the JSON names and values: -- -- 
--   '{"attribute": "value", "attribute": ["value"]}'
--
putResourcePolicy_resourcePolicy :: Lens' PutResourcePolicy Text -- | See: newPutResourcePolicyResponse smart constructor. data PutResourcePolicyResponse PutResourcePolicyResponse' :: Maybe Text -> Int -> PutResourcePolicyResponse -- | The revision ID of the policy. Each time you modify a policy, Amazon -- Comprehend assigns a new revision ID, and it deletes the prior version -- of the policy. [$sel:policyRevisionId:PutResourcePolicyResponse'] :: PutResourcePolicyResponse -> Maybe Text -- | The response's http status code. [$sel:httpStatus:PutResourcePolicyResponse'] :: PutResourcePolicyResponse -> Int -- | Create a value of PutResourcePolicyResponse with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- PutResourcePolicy, -- putResourcePolicyResponse_policyRevisionId - The revision ID of -- the policy. Each time you modify a policy, Amazon Comprehend assigns a -- new revision ID, and it deletes the prior version of the policy. -- -- $sel:httpStatus:PutResourcePolicyResponse', -- putResourcePolicyResponse_httpStatus - The response's http -- status code. newPutResourcePolicyResponse :: Int -> PutResourcePolicyResponse -- | The revision ID of the policy. Each time you modify a policy, Amazon -- Comprehend assigns a new revision ID, and it deletes the prior version -- of the policy. putResourcePolicyResponse_policyRevisionId :: Lens' PutResourcePolicyResponse (Maybe Text) -- | The response's http status code. putResourcePolicyResponse_httpStatus :: Lens' PutResourcePolicyResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.PutResourcePolicy.PutResourcePolicy instance GHC.Show.Show Amazonka.Comprehend.PutResourcePolicy.PutResourcePolicy instance GHC.Read.Read Amazonka.Comprehend.PutResourcePolicy.PutResourcePolicy instance GHC.Classes.Eq Amazonka.Comprehend.PutResourcePolicy.PutResourcePolicy instance GHC.Generics.Generic Amazonka.Comprehend.PutResourcePolicy.PutResourcePolicyResponse instance GHC.Show.Show Amazonka.Comprehend.PutResourcePolicy.PutResourcePolicyResponse instance GHC.Read.Read Amazonka.Comprehend.PutResourcePolicy.PutResourcePolicyResponse instance GHC.Classes.Eq Amazonka.Comprehend.PutResourcePolicy.PutResourcePolicyResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.PutResourcePolicy.PutResourcePolicy instance Control.DeepSeq.NFData Amazonka.Comprehend.PutResourcePolicy.PutResourcePolicyResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.PutResourcePolicy.PutResourcePolicy instance Control.DeepSeq.NFData Amazonka.Comprehend.PutResourcePolicy.PutResourcePolicy instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.PutResourcePolicy.PutResourcePolicy instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.PutResourcePolicy.PutResourcePolicy instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.PutResourcePolicy.PutResourcePolicy instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.PutResourcePolicy.PutResourcePolicy -- | Gets a list of the topic detection jobs that you have submitted. -- -- This operation returns paginated results. module Amazonka.Comprehend.ListTopicsDetectionJobs -- | See: newListTopicsDetectionJobs smart constructor. data ListTopicsDetectionJobs ListTopicsDetectionJobs' :: Maybe TopicsDetectionJobFilter -> Maybe Natural -> Maybe Text -> ListTopicsDetectionJobs -- | Filters the jobs that are returned. Jobs can be filtered on their -- name, status, or the date and time that they were submitted. You can -- set only one filter at a time. [$sel:filter':ListTopicsDetectionJobs'] :: ListTopicsDetectionJobs -> Maybe TopicsDetectionJobFilter -- | The maximum number of results to return in each page. The default is -- 100. [$sel:maxResults:ListTopicsDetectionJobs'] :: ListTopicsDetectionJobs -> Maybe Natural -- | Identifies the next page of results to return. [$sel:nextToken:ListTopicsDetectionJobs'] :: ListTopicsDetectionJobs -> Maybe Text -- | Create a value of ListTopicsDetectionJobs with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:filter':ListTopicsDetectionJobs', -- listTopicsDetectionJobs_filter - Filters the jobs that are -- returned. Jobs can be filtered on their name, status, or the date and -- time that they were submitted. You can set only one filter at a time. -- -- $sel:maxResults:ListTopicsDetectionJobs', -- listTopicsDetectionJobs_maxResults - The maximum number of -- results to return in each page. The default is 100. -- -- ListTopicsDetectionJobs, -- listTopicsDetectionJobs_nextToken - Identifies the next page of -- results to return. newListTopicsDetectionJobs :: ListTopicsDetectionJobs -- | Filters the jobs that are returned. Jobs can be filtered on their -- name, status, or the date and time that they were submitted. You can -- set only one filter at a time. listTopicsDetectionJobs_filter :: Lens' ListTopicsDetectionJobs (Maybe TopicsDetectionJobFilter) -- | The maximum number of results to return in each page. The default is -- 100. listTopicsDetectionJobs_maxResults :: Lens' ListTopicsDetectionJobs (Maybe Natural) -- | Identifies the next page of results to return. listTopicsDetectionJobs_nextToken :: Lens' ListTopicsDetectionJobs (Maybe Text) -- | See: newListTopicsDetectionJobsResponse smart -- constructor. data ListTopicsDetectionJobsResponse ListTopicsDetectionJobsResponse' :: Maybe Text -> Maybe [TopicsDetectionJobProperties] -> Int -> ListTopicsDetectionJobsResponse -- | Identifies the next page of results to return. [$sel:nextToken:ListTopicsDetectionJobsResponse'] :: ListTopicsDetectionJobsResponse -> Maybe Text -- | A list containing the properties of each job that is returned. [$sel:topicsDetectionJobPropertiesList:ListTopicsDetectionJobsResponse'] :: ListTopicsDetectionJobsResponse -> Maybe [TopicsDetectionJobProperties] -- | The response's http status code. [$sel:httpStatus:ListTopicsDetectionJobsResponse'] :: ListTopicsDetectionJobsResponse -> Int -- | Create a value of ListTopicsDetectionJobsResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- ListTopicsDetectionJobs, -- listTopicsDetectionJobsResponse_nextToken - Identifies the next -- page of results to return. -- -- -- $sel:topicsDetectionJobPropertiesList:ListTopicsDetectionJobsResponse', -- listTopicsDetectionJobsResponse_topicsDetectionJobPropertiesList -- - A list containing the properties of each job that is returned. -- -- $sel:httpStatus:ListTopicsDetectionJobsResponse', -- listTopicsDetectionJobsResponse_httpStatus - The response's -- http status code. newListTopicsDetectionJobsResponse :: Int -> ListTopicsDetectionJobsResponse -- | Identifies the next page of results to return. listTopicsDetectionJobsResponse_nextToken :: Lens' ListTopicsDetectionJobsResponse (Maybe Text) -- | A list containing the properties of each job that is returned. listTopicsDetectionJobsResponse_topicsDetectionJobPropertiesList :: Lens' ListTopicsDetectionJobsResponse (Maybe [TopicsDetectionJobProperties]) -- | The response's http status code. listTopicsDetectionJobsResponse_httpStatus :: Lens' ListTopicsDetectionJobsResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.ListTopicsDetectionJobs.ListTopicsDetectionJobs instance GHC.Show.Show Amazonka.Comprehend.ListTopicsDetectionJobs.ListTopicsDetectionJobs instance GHC.Read.Read Amazonka.Comprehend.ListTopicsDetectionJobs.ListTopicsDetectionJobs instance GHC.Classes.Eq Amazonka.Comprehend.ListTopicsDetectionJobs.ListTopicsDetectionJobs instance GHC.Generics.Generic Amazonka.Comprehend.ListTopicsDetectionJobs.ListTopicsDetectionJobsResponse instance GHC.Show.Show Amazonka.Comprehend.ListTopicsDetectionJobs.ListTopicsDetectionJobsResponse instance GHC.Read.Read Amazonka.Comprehend.ListTopicsDetectionJobs.ListTopicsDetectionJobsResponse instance GHC.Classes.Eq Amazonka.Comprehend.ListTopicsDetectionJobs.ListTopicsDetectionJobsResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.ListTopicsDetectionJobs.ListTopicsDetectionJobs instance Control.DeepSeq.NFData Amazonka.Comprehend.ListTopicsDetectionJobs.ListTopicsDetectionJobsResponse instance Amazonka.Pager.AWSPager Amazonka.Comprehend.ListTopicsDetectionJobs.ListTopicsDetectionJobs instance Data.Hashable.Class.Hashable Amazonka.Comprehend.ListTopicsDetectionJobs.ListTopicsDetectionJobs instance Control.DeepSeq.NFData Amazonka.Comprehend.ListTopicsDetectionJobs.ListTopicsDetectionJobs instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.ListTopicsDetectionJobs.ListTopicsDetectionJobs instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.ListTopicsDetectionJobs.ListTopicsDetectionJobs instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.ListTopicsDetectionJobs.ListTopicsDetectionJobs instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.ListTopicsDetectionJobs.ListTopicsDetectionJobs -- | Gets a list of targeted sentiment detection jobs that you have -- submitted. module Amazonka.Comprehend.ListTargetedSentimentDetectionJobs -- | See: newListTargetedSentimentDetectionJobs smart -- constructor. data ListTargetedSentimentDetectionJobs ListTargetedSentimentDetectionJobs' :: Maybe TargetedSentimentDetectionJobFilter -> Maybe Natural -> Maybe Text -> ListTargetedSentimentDetectionJobs -- | Filters the jobs that are returned. You can filter jobs on their name, -- status, or the date and time that they were submitted. You can only -- set one filter at a time. [$sel:filter':ListTargetedSentimentDetectionJobs'] :: ListTargetedSentimentDetectionJobs -> Maybe TargetedSentimentDetectionJobFilter -- | The maximum number of results to return in each page. The default is -- 100. [$sel:maxResults:ListTargetedSentimentDetectionJobs'] :: ListTargetedSentimentDetectionJobs -> Maybe Natural -- | Identifies the next page of results to return. [$sel:nextToken:ListTargetedSentimentDetectionJobs'] :: ListTargetedSentimentDetectionJobs -> Maybe Text -- | Create a value of ListTargetedSentimentDetectionJobs with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:filter':ListTargetedSentimentDetectionJobs', -- listTargetedSentimentDetectionJobs_filter - Filters the jobs -- that are returned. You can filter jobs on their name, status, or the -- date and time that they were submitted. You can only set one filter at -- a time. -- -- $sel:maxResults:ListTargetedSentimentDetectionJobs', -- listTargetedSentimentDetectionJobs_maxResults - The maximum -- number of results to return in each page. The default is 100. -- -- ListTargetedSentimentDetectionJobs, -- listTargetedSentimentDetectionJobs_nextToken - Identifies the -- next page of results to return. newListTargetedSentimentDetectionJobs :: ListTargetedSentimentDetectionJobs -- | Filters the jobs that are returned. You can filter jobs on their name, -- status, or the date and time that they were submitted. You can only -- set one filter at a time. listTargetedSentimentDetectionJobs_filter :: Lens' ListTargetedSentimentDetectionJobs (Maybe TargetedSentimentDetectionJobFilter) -- | The maximum number of results to return in each page. The default is -- 100. listTargetedSentimentDetectionJobs_maxResults :: Lens' ListTargetedSentimentDetectionJobs (Maybe Natural) -- | Identifies the next page of results to return. listTargetedSentimentDetectionJobs_nextToken :: Lens' ListTargetedSentimentDetectionJobs (Maybe Text) -- | See: newListTargetedSentimentDetectionJobsResponse smart -- constructor. data ListTargetedSentimentDetectionJobsResponse ListTargetedSentimentDetectionJobsResponse' :: Maybe Text -> Maybe [TargetedSentimentDetectionJobProperties] -> Int -> ListTargetedSentimentDetectionJobsResponse -- | Identifies the next page of results to return. [$sel:nextToken:ListTargetedSentimentDetectionJobsResponse'] :: ListTargetedSentimentDetectionJobsResponse -> Maybe Text -- | A list containing the properties of each job that is returned. [$sel:targetedSentimentDetectionJobPropertiesList:ListTargetedSentimentDetectionJobsResponse'] :: ListTargetedSentimentDetectionJobsResponse -> Maybe [TargetedSentimentDetectionJobProperties] -- | The response's http status code. [$sel:httpStatus:ListTargetedSentimentDetectionJobsResponse'] :: ListTargetedSentimentDetectionJobsResponse -> Int -- | Create a value of ListTargetedSentimentDetectionJobsResponse -- with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- ListTargetedSentimentDetectionJobs, -- listTargetedSentimentDetectionJobsResponse_nextToken - -- Identifies the next page of results to return. -- -- -- $sel:targetedSentimentDetectionJobPropertiesList:ListTargetedSentimentDetectionJobsResponse', -- listTargetedSentimentDetectionJobsResponse_targetedSentimentDetectionJobPropertiesList -- - A list containing the properties of each job that is returned. -- -- $sel:httpStatus:ListTargetedSentimentDetectionJobsResponse', -- listTargetedSentimentDetectionJobsResponse_httpStatus - The -- response's http status code. newListTargetedSentimentDetectionJobsResponse :: Int -> ListTargetedSentimentDetectionJobsResponse -- | Identifies the next page of results to return. listTargetedSentimentDetectionJobsResponse_nextToken :: Lens' ListTargetedSentimentDetectionJobsResponse (Maybe Text) -- | A list containing the properties of each job that is returned. listTargetedSentimentDetectionJobsResponse_targetedSentimentDetectionJobPropertiesList :: Lens' ListTargetedSentimentDetectionJobsResponse (Maybe [TargetedSentimentDetectionJobProperties]) -- | The response's http status code. listTargetedSentimentDetectionJobsResponse_httpStatus :: Lens' ListTargetedSentimentDetectionJobsResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.ListTargetedSentimentDetectionJobs.ListTargetedSentimentDetectionJobs instance GHC.Show.Show Amazonka.Comprehend.ListTargetedSentimentDetectionJobs.ListTargetedSentimentDetectionJobs instance GHC.Read.Read Amazonka.Comprehend.ListTargetedSentimentDetectionJobs.ListTargetedSentimentDetectionJobs instance GHC.Classes.Eq Amazonka.Comprehend.ListTargetedSentimentDetectionJobs.ListTargetedSentimentDetectionJobs instance GHC.Generics.Generic Amazonka.Comprehend.ListTargetedSentimentDetectionJobs.ListTargetedSentimentDetectionJobsResponse instance GHC.Show.Show Amazonka.Comprehend.ListTargetedSentimentDetectionJobs.ListTargetedSentimentDetectionJobsResponse instance GHC.Read.Read Amazonka.Comprehend.ListTargetedSentimentDetectionJobs.ListTargetedSentimentDetectionJobsResponse instance GHC.Classes.Eq Amazonka.Comprehend.ListTargetedSentimentDetectionJobs.ListTargetedSentimentDetectionJobsResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.ListTargetedSentimentDetectionJobs.ListTargetedSentimentDetectionJobs instance Control.DeepSeq.NFData Amazonka.Comprehend.ListTargetedSentimentDetectionJobs.ListTargetedSentimentDetectionJobsResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.ListTargetedSentimentDetectionJobs.ListTargetedSentimentDetectionJobs instance Control.DeepSeq.NFData Amazonka.Comprehend.ListTargetedSentimentDetectionJobs.ListTargetedSentimentDetectionJobs instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.ListTargetedSentimentDetectionJobs.ListTargetedSentimentDetectionJobs instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.ListTargetedSentimentDetectionJobs.ListTargetedSentimentDetectionJobs instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.ListTargetedSentimentDetectionJobs.ListTargetedSentimentDetectionJobs instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.ListTargetedSentimentDetectionJobs.ListTargetedSentimentDetectionJobs -- | Lists all tags associated with a given Amazon Comprehend resource. module Amazonka.Comprehend.ListTagsForResource -- | See: newListTagsForResource smart constructor. data ListTagsForResource ListTagsForResource' :: Text -> ListTagsForResource -- | The Amazon Resource Name (ARN) of the given Amazon Comprehend resource -- you are querying. [$sel:resourceArn:ListTagsForResource'] :: ListTagsForResource -> Text -- | Create a value of ListTagsForResource with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- ListTagsForResource, listTagsForResource_resourceArn - -- The Amazon Resource Name (ARN) of the given Amazon Comprehend resource -- you are querying. newListTagsForResource :: Text -> ListTagsForResource -- | The Amazon Resource Name (ARN) of the given Amazon Comprehend resource -- you are querying. listTagsForResource_resourceArn :: Lens' ListTagsForResource Text -- | See: newListTagsForResourceResponse smart constructor. data ListTagsForResourceResponse ListTagsForResourceResponse' :: Maybe Text -> Maybe [Tag] -> Int -> ListTagsForResourceResponse -- | The Amazon Resource Name (ARN) of the given Amazon Comprehend resource -- you are querying. [$sel:resourceArn:ListTagsForResourceResponse'] :: ListTagsForResourceResponse -> Maybe Text -- | Tags associated with the Amazon Comprehend resource being queried. A -- tag is a key-value pair that adds as a metadata to a resource used by -- Amazon Comprehend. For example, a tag with "Sales" as the key might be -- added to a resource to indicate its use by the sales department. [$sel:tags:ListTagsForResourceResponse'] :: ListTagsForResourceResponse -> Maybe [Tag] -- | The response's http status code. [$sel:httpStatus:ListTagsForResourceResponse'] :: ListTagsForResourceResponse -> Int -- | Create a value of ListTagsForResourceResponse with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- ListTagsForResource, -- listTagsForResourceResponse_resourceArn - The Amazon Resource -- Name (ARN) of the given Amazon Comprehend resource you are querying. -- -- $sel:tags:ListTagsForResourceResponse', -- listTagsForResourceResponse_tags - Tags associated with the -- Amazon Comprehend resource being queried. A tag is a key-value pair -- that adds as a metadata to a resource used by Amazon Comprehend. For -- example, a tag with "Sales" as the key might be added to a resource to -- indicate its use by the sales department. -- -- $sel:httpStatus:ListTagsForResourceResponse', -- listTagsForResourceResponse_httpStatus - The response's http -- status code. newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse -- | The Amazon Resource Name (ARN) of the given Amazon Comprehend resource -- you are querying. listTagsForResourceResponse_resourceArn :: Lens' ListTagsForResourceResponse (Maybe Text) -- | Tags associated with the Amazon Comprehend resource being queried. A -- tag is a key-value pair that adds as a metadata to a resource used by -- Amazon Comprehend. For example, a tag with "Sales" as the key might be -- added to a resource to indicate its use by the sales department. listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag]) -- | The response's http status code. listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.ListTagsForResource.ListTagsForResource instance GHC.Show.Show Amazonka.Comprehend.ListTagsForResource.ListTagsForResource instance GHC.Read.Read Amazonka.Comprehend.ListTagsForResource.ListTagsForResource instance GHC.Classes.Eq Amazonka.Comprehend.ListTagsForResource.ListTagsForResource instance GHC.Generics.Generic Amazonka.Comprehend.ListTagsForResource.ListTagsForResourceResponse instance GHC.Show.Show Amazonka.Comprehend.ListTagsForResource.ListTagsForResourceResponse instance GHC.Read.Read Amazonka.Comprehend.ListTagsForResource.ListTagsForResourceResponse instance GHC.Classes.Eq Amazonka.Comprehend.ListTagsForResource.ListTagsForResourceResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.ListTagsForResource.ListTagsForResource instance Control.DeepSeq.NFData Amazonka.Comprehend.ListTagsForResource.ListTagsForResourceResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.ListTagsForResource.ListTagsForResource instance Control.DeepSeq.NFData Amazonka.Comprehend.ListTagsForResource.ListTagsForResource instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.ListTagsForResource.ListTagsForResource instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.ListTagsForResource.ListTagsForResource instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.ListTagsForResource.ListTagsForResource instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.ListTagsForResource.ListTagsForResource -- | Gets a list of sentiment detection jobs that you have submitted. -- -- This operation returns paginated results. module Amazonka.Comprehend.ListSentimentDetectionJobs -- | See: newListSentimentDetectionJobs smart constructor. data ListSentimentDetectionJobs ListSentimentDetectionJobs' :: Maybe SentimentDetectionJobFilter -> Maybe Natural -> Maybe Text -> ListSentimentDetectionJobs -- | Filters the jobs that are returned. You can filter jobs on their name, -- status, or the date and time that they were submitted. You can only -- set one filter at a time. [$sel:filter':ListSentimentDetectionJobs'] :: ListSentimentDetectionJobs -> Maybe SentimentDetectionJobFilter -- | The maximum number of results to return in each page. The default is -- 100. [$sel:maxResults:ListSentimentDetectionJobs'] :: ListSentimentDetectionJobs -> Maybe Natural -- | Identifies the next page of results to return. [$sel:nextToken:ListSentimentDetectionJobs'] :: ListSentimentDetectionJobs -> Maybe Text -- | Create a value of ListSentimentDetectionJobs with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:filter':ListSentimentDetectionJobs', -- listSentimentDetectionJobs_filter - Filters the jobs that are -- returned. You can filter jobs on their name, status, or the date and -- time that they were submitted. You can only set one filter at a time. -- -- $sel:maxResults:ListSentimentDetectionJobs', -- listSentimentDetectionJobs_maxResults - The maximum number of -- results to return in each page. The default is 100. -- -- ListSentimentDetectionJobs, -- listSentimentDetectionJobs_nextToken - Identifies the next page -- of results to return. newListSentimentDetectionJobs :: ListSentimentDetectionJobs -- | Filters the jobs that are returned. You can filter jobs on their name, -- status, or the date and time that they were submitted. You can only -- set one filter at a time. listSentimentDetectionJobs_filter :: Lens' ListSentimentDetectionJobs (Maybe SentimentDetectionJobFilter) -- | The maximum number of results to return in each page. The default is -- 100. listSentimentDetectionJobs_maxResults :: Lens' ListSentimentDetectionJobs (Maybe Natural) -- | Identifies the next page of results to return. listSentimentDetectionJobs_nextToken :: Lens' ListSentimentDetectionJobs (Maybe Text) -- | See: newListSentimentDetectionJobsResponse smart -- constructor. data ListSentimentDetectionJobsResponse ListSentimentDetectionJobsResponse' :: Maybe Text -> Maybe [SentimentDetectionJobProperties] -> Int -> ListSentimentDetectionJobsResponse -- | Identifies the next page of results to return. [$sel:nextToken:ListSentimentDetectionJobsResponse'] :: ListSentimentDetectionJobsResponse -> Maybe Text -- | A list containing the properties of each job that is returned. [$sel:sentimentDetectionJobPropertiesList:ListSentimentDetectionJobsResponse'] :: ListSentimentDetectionJobsResponse -> Maybe [SentimentDetectionJobProperties] -- | The response's http status code. [$sel:httpStatus:ListSentimentDetectionJobsResponse'] :: ListSentimentDetectionJobsResponse -> Int -- | Create a value of ListSentimentDetectionJobsResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- ListSentimentDetectionJobs, -- listSentimentDetectionJobsResponse_nextToken - Identifies the -- next page of results to return. -- -- -- $sel:sentimentDetectionJobPropertiesList:ListSentimentDetectionJobsResponse', -- listSentimentDetectionJobsResponse_sentimentDetectionJobPropertiesList -- - A list containing the properties of each job that is returned. -- -- $sel:httpStatus:ListSentimentDetectionJobsResponse', -- listSentimentDetectionJobsResponse_httpStatus - The response's -- http status code. newListSentimentDetectionJobsResponse :: Int -> ListSentimentDetectionJobsResponse -- | Identifies the next page of results to return. listSentimentDetectionJobsResponse_nextToken :: Lens' ListSentimentDetectionJobsResponse (Maybe Text) -- | A list containing the properties of each job that is returned. listSentimentDetectionJobsResponse_sentimentDetectionJobPropertiesList :: Lens' ListSentimentDetectionJobsResponse (Maybe [SentimentDetectionJobProperties]) -- | The response's http status code. listSentimentDetectionJobsResponse_httpStatus :: Lens' ListSentimentDetectionJobsResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.ListSentimentDetectionJobs.ListSentimentDetectionJobs instance GHC.Show.Show Amazonka.Comprehend.ListSentimentDetectionJobs.ListSentimentDetectionJobs instance GHC.Read.Read Amazonka.Comprehend.ListSentimentDetectionJobs.ListSentimentDetectionJobs instance GHC.Classes.Eq Amazonka.Comprehend.ListSentimentDetectionJobs.ListSentimentDetectionJobs instance GHC.Generics.Generic Amazonka.Comprehend.ListSentimentDetectionJobs.ListSentimentDetectionJobsResponse instance GHC.Show.Show Amazonka.Comprehend.ListSentimentDetectionJobs.ListSentimentDetectionJobsResponse instance GHC.Read.Read Amazonka.Comprehend.ListSentimentDetectionJobs.ListSentimentDetectionJobsResponse instance GHC.Classes.Eq Amazonka.Comprehend.ListSentimentDetectionJobs.ListSentimentDetectionJobsResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.ListSentimentDetectionJobs.ListSentimentDetectionJobs instance Control.DeepSeq.NFData Amazonka.Comprehend.ListSentimentDetectionJobs.ListSentimentDetectionJobsResponse instance Amazonka.Pager.AWSPager Amazonka.Comprehend.ListSentimentDetectionJobs.ListSentimentDetectionJobs instance Data.Hashable.Class.Hashable Amazonka.Comprehend.ListSentimentDetectionJobs.ListSentimentDetectionJobs instance Control.DeepSeq.NFData Amazonka.Comprehend.ListSentimentDetectionJobs.ListSentimentDetectionJobs instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.ListSentimentDetectionJobs.ListSentimentDetectionJobs instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.ListSentimentDetectionJobs.ListSentimentDetectionJobs instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.ListSentimentDetectionJobs.ListSentimentDetectionJobs instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.ListSentimentDetectionJobs.ListSentimentDetectionJobs -- | Gets a list of the PII entity detection jobs that you have submitted. -- -- This operation returns paginated results. module Amazonka.Comprehend.ListPiiEntitiesDetectionJobs -- | See: newListPiiEntitiesDetectionJobs smart constructor. data ListPiiEntitiesDetectionJobs ListPiiEntitiesDetectionJobs' :: Maybe PiiEntitiesDetectionJobFilter -> Maybe Natural -> Maybe Text -> ListPiiEntitiesDetectionJobs -- | Filters the jobs that are returned. You can filter jobs on their name, -- status, or the date and time that they were submitted. You can only -- set one filter at a time. [$sel:filter':ListPiiEntitiesDetectionJobs'] :: ListPiiEntitiesDetectionJobs -> Maybe PiiEntitiesDetectionJobFilter -- | The maximum number of results to return in each page. [$sel:maxResults:ListPiiEntitiesDetectionJobs'] :: ListPiiEntitiesDetectionJobs -> Maybe Natural -- | Identifies the next page of results to return. [$sel:nextToken:ListPiiEntitiesDetectionJobs'] :: ListPiiEntitiesDetectionJobs -> Maybe Text -- | Create a value of ListPiiEntitiesDetectionJobs with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:filter':ListPiiEntitiesDetectionJobs', -- listPiiEntitiesDetectionJobs_filter - Filters the jobs that are -- returned. You can filter jobs on their name, status, or the date and -- time that they were submitted. You can only set one filter at a time. -- -- $sel:maxResults:ListPiiEntitiesDetectionJobs', -- listPiiEntitiesDetectionJobs_maxResults - The maximum number of -- results to return in each page. -- -- ListPiiEntitiesDetectionJobs, -- listPiiEntitiesDetectionJobs_nextToken - Identifies the next -- page of results to return. newListPiiEntitiesDetectionJobs :: ListPiiEntitiesDetectionJobs -- | Filters the jobs that are returned. You can filter jobs on their name, -- status, or the date and time that they were submitted. You can only -- set one filter at a time. listPiiEntitiesDetectionJobs_filter :: Lens' ListPiiEntitiesDetectionJobs (Maybe PiiEntitiesDetectionJobFilter) -- | The maximum number of results to return in each page. listPiiEntitiesDetectionJobs_maxResults :: Lens' ListPiiEntitiesDetectionJobs (Maybe Natural) -- | Identifies the next page of results to return. listPiiEntitiesDetectionJobs_nextToken :: Lens' ListPiiEntitiesDetectionJobs (Maybe Text) -- | See: newListPiiEntitiesDetectionJobsResponse smart -- constructor. data ListPiiEntitiesDetectionJobsResponse ListPiiEntitiesDetectionJobsResponse' :: Maybe Text -> Maybe [PiiEntitiesDetectionJobProperties] -> Int -> ListPiiEntitiesDetectionJobsResponse -- | Identifies the next page of results to return. [$sel:nextToken:ListPiiEntitiesDetectionJobsResponse'] :: ListPiiEntitiesDetectionJobsResponse -> Maybe Text -- | A list containing the properties of each job that is returned. [$sel:piiEntitiesDetectionJobPropertiesList:ListPiiEntitiesDetectionJobsResponse'] :: ListPiiEntitiesDetectionJobsResponse -> Maybe [PiiEntitiesDetectionJobProperties] -- | The response's http status code. [$sel:httpStatus:ListPiiEntitiesDetectionJobsResponse'] :: ListPiiEntitiesDetectionJobsResponse -> Int -- | Create a value of ListPiiEntitiesDetectionJobsResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- ListPiiEntitiesDetectionJobs, -- listPiiEntitiesDetectionJobsResponse_nextToken - Identifies the -- next page of results to return. -- -- -- $sel:piiEntitiesDetectionJobPropertiesList:ListPiiEntitiesDetectionJobsResponse', -- listPiiEntitiesDetectionJobsResponse_piiEntitiesDetectionJobPropertiesList -- - A list containing the properties of each job that is returned. -- -- $sel:httpStatus:ListPiiEntitiesDetectionJobsResponse', -- listPiiEntitiesDetectionJobsResponse_httpStatus - The -- response's http status code. newListPiiEntitiesDetectionJobsResponse :: Int -> ListPiiEntitiesDetectionJobsResponse -- | Identifies the next page of results to return. listPiiEntitiesDetectionJobsResponse_nextToken :: Lens' ListPiiEntitiesDetectionJobsResponse (Maybe Text) -- | A list containing the properties of each job that is returned. listPiiEntitiesDetectionJobsResponse_piiEntitiesDetectionJobPropertiesList :: Lens' ListPiiEntitiesDetectionJobsResponse (Maybe [PiiEntitiesDetectionJobProperties]) -- | The response's http status code. listPiiEntitiesDetectionJobsResponse_httpStatus :: Lens' ListPiiEntitiesDetectionJobsResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.ListPiiEntitiesDetectionJobs.ListPiiEntitiesDetectionJobs instance GHC.Show.Show Amazonka.Comprehend.ListPiiEntitiesDetectionJobs.ListPiiEntitiesDetectionJobs instance GHC.Read.Read Amazonka.Comprehend.ListPiiEntitiesDetectionJobs.ListPiiEntitiesDetectionJobs instance GHC.Classes.Eq Amazonka.Comprehend.ListPiiEntitiesDetectionJobs.ListPiiEntitiesDetectionJobs instance GHC.Generics.Generic Amazonka.Comprehend.ListPiiEntitiesDetectionJobs.ListPiiEntitiesDetectionJobsResponse instance GHC.Show.Show Amazonka.Comprehend.ListPiiEntitiesDetectionJobs.ListPiiEntitiesDetectionJobsResponse instance GHC.Read.Read Amazonka.Comprehend.ListPiiEntitiesDetectionJobs.ListPiiEntitiesDetectionJobsResponse instance GHC.Classes.Eq Amazonka.Comprehend.ListPiiEntitiesDetectionJobs.ListPiiEntitiesDetectionJobsResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.ListPiiEntitiesDetectionJobs.ListPiiEntitiesDetectionJobs instance Control.DeepSeq.NFData Amazonka.Comprehend.ListPiiEntitiesDetectionJobs.ListPiiEntitiesDetectionJobsResponse instance Amazonka.Pager.AWSPager Amazonka.Comprehend.ListPiiEntitiesDetectionJobs.ListPiiEntitiesDetectionJobs instance Data.Hashable.Class.Hashable Amazonka.Comprehend.ListPiiEntitiesDetectionJobs.ListPiiEntitiesDetectionJobs instance Control.DeepSeq.NFData Amazonka.Comprehend.ListPiiEntitiesDetectionJobs.ListPiiEntitiesDetectionJobs instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.ListPiiEntitiesDetectionJobs.ListPiiEntitiesDetectionJobs instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.ListPiiEntitiesDetectionJobs.ListPiiEntitiesDetectionJobs instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.ListPiiEntitiesDetectionJobs.ListPiiEntitiesDetectionJobs instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.ListPiiEntitiesDetectionJobs.ListPiiEntitiesDetectionJobs -- | Get a list of key phrase detection jobs that you have submitted. -- -- This operation returns paginated results. module Amazonka.Comprehend.ListKeyPhrasesDetectionJobs -- | See: newListKeyPhrasesDetectionJobs smart constructor. data ListKeyPhrasesDetectionJobs ListKeyPhrasesDetectionJobs' :: Maybe KeyPhrasesDetectionJobFilter -> Maybe Natural -> Maybe Text -> ListKeyPhrasesDetectionJobs -- | Filters the jobs that are returned. You can filter jobs on their name, -- status, or the date and time that they were submitted. You can only -- set one filter at a time. [$sel:filter':ListKeyPhrasesDetectionJobs'] :: ListKeyPhrasesDetectionJobs -> Maybe KeyPhrasesDetectionJobFilter -- | The maximum number of results to return in each page. The default is -- 100. [$sel:maxResults:ListKeyPhrasesDetectionJobs'] :: ListKeyPhrasesDetectionJobs -> Maybe Natural -- | Identifies the next page of results to return. [$sel:nextToken:ListKeyPhrasesDetectionJobs'] :: ListKeyPhrasesDetectionJobs -> Maybe Text -- | Create a value of ListKeyPhrasesDetectionJobs with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:filter':ListKeyPhrasesDetectionJobs', -- listKeyPhrasesDetectionJobs_filter - Filters the jobs that are -- returned. You can filter jobs on their name, status, or the date and -- time that they were submitted. You can only set one filter at a time. -- -- $sel:maxResults:ListKeyPhrasesDetectionJobs', -- listKeyPhrasesDetectionJobs_maxResults - The maximum number of -- results to return in each page. The default is 100. -- -- ListKeyPhrasesDetectionJobs, -- listKeyPhrasesDetectionJobs_nextToken - Identifies the next -- page of results to return. newListKeyPhrasesDetectionJobs :: ListKeyPhrasesDetectionJobs -- | Filters the jobs that are returned. You can filter jobs on their name, -- status, or the date and time that they were submitted. You can only -- set one filter at a time. listKeyPhrasesDetectionJobs_filter :: Lens' ListKeyPhrasesDetectionJobs (Maybe KeyPhrasesDetectionJobFilter) -- | The maximum number of results to return in each page. The default is -- 100. listKeyPhrasesDetectionJobs_maxResults :: Lens' ListKeyPhrasesDetectionJobs (Maybe Natural) -- | Identifies the next page of results to return. listKeyPhrasesDetectionJobs_nextToken :: Lens' ListKeyPhrasesDetectionJobs (Maybe Text) -- | See: newListKeyPhrasesDetectionJobsResponse smart -- constructor. data ListKeyPhrasesDetectionJobsResponse ListKeyPhrasesDetectionJobsResponse' :: Maybe [KeyPhrasesDetectionJobProperties] -> Maybe Text -> Int -> ListKeyPhrasesDetectionJobsResponse -- | A list containing the properties of each job that is returned. [$sel:keyPhrasesDetectionJobPropertiesList:ListKeyPhrasesDetectionJobsResponse'] :: ListKeyPhrasesDetectionJobsResponse -> Maybe [KeyPhrasesDetectionJobProperties] -- | Identifies the next page of results to return. [$sel:nextToken:ListKeyPhrasesDetectionJobsResponse'] :: ListKeyPhrasesDetectionJobsResponse -> Maybe Text -- | The response's http status code. [$sel:httpStatus:ListKeyPhrasesDetectionJobsResponse'] :: ListKeyPhrasesDetectionJobsResponse -> Int -- | Create a value of ListKeyPhrasesDetectionJobsResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:keyPhrasesDetectionJobPropertiesList:ListKeyPhrasesDetectionJobsResponse', -- listKeyPhrasesDetectionJobsResponse_keyPhrasesDetectionJobPropertiesList -- - A list containing the properties of each job that is returned. -- -- ListKeyPhrasesDetectionJobs, -- listKeyPhrasesDetectionJobsResponse_nextToken - Identifies the -- next page of results to return. -- -- $sel:httpStatus:ListKeyPhrasesDetectionJobsResponse', -- listKeyPhrasesDetectionJobsResponse_httpStatus - The response's -- http status code. newListKeyPhrasesDetectionJobsResponse :: Int -> ListKeyPhrasesDetectionJobsResponse -- | A list containing the properties of each job that is returned. listKeyPhrasesDetectionJobsResponse_keyPhrasesDetectionJobPropertiesList :: Lens' ListKeyPhrasesDetectionJobsResponse (Maybe [KeyPhrasesDetectionJobProperties]) -- | Identifies the next page of results to return. listKeyPhrasesDetectionJobsResponse_nextToken :: Lens' ListKeyPhrasesDetectionJobsResponse (Maybe Text) -- | The response's http status code. listKeyPhrasesDetectionJobsResponse_httpStatus :: Lens' ListKeyPhrasesDetectionJobsResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.ListKeyPhrasesDetectionJobs.ListKeyPhrasesDetectionJobs instance GHC.Show.Show Amazonka.Comprehend.ListKeyPhrasesDetectionJobs.ListKeyPhrasesDetectionJobs instance GHC.Read.Read Amazonka.Comprehend.ListKeyPhrasesDetectionJobs.ListKeyPhrasesDetectionJobs instance GHC.Classes.Eq Amazonka.Comprehend.ListKeyPhrasesDetectionJobs.ListKeyPhrasesDetectionJobs instance GHC.Generics.Generic Amazonka.Comprehend.ListKeyPhrasesDetectionJobs.ListKeyPhrasesDetectionJobsResponse instance GHC.Show.Show Amazonka.Comprehend.ListKeyPhrasesDetectionJobs.ListKeyPhrasesDetectionJobsResponse instance GHC.Read.Read Amazonka.Comprehend.ListKeyPhrasesDetectionJobs.ListKeyPhrasesDetectionJobsResponse instance GHC.Classes.Eq Amazonka.Comprehend.ListKeyPhrasesDetectionJobs.ListKeyPhrasesDetectionJobsResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.ListKeyPhrasesDetectionJobs.ListKeyPhrasesDetectionJobs instance Control.DeepSeq.NFData Amazonka.Comprehend.ListKeyPhrasesDetectionJobs.ListKeyPhrasesDetectionJobsResponse instance Amazonka.Pager.AWSPager Amazonka.Comprehend.ListKeyPhrasesDetectionJobs.ListKeyPhrasesDetectionJobs instance Data.Hashable.Class.Hashable Amazonka.Comprehend.ListKeyPhrasesDetectionJobs.ListKeyPhrasesDetectionJobs instance Control.DeepSeq.NFData Amazonka.Comprehend.ListKeyPhrasesDetectionJobs.ListKeyPhrasesDetectionJobs instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.ListKeyPhrasesDetectionJobs.ListKeyPhrasesDetectionJobs instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.ListKeyPhrasesDetectionJobs.ListKeyPhrasesDetectionJobs instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.ListKeyPhrasesDetectionJobs.ListKeyPhrasesDetectionJobs instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.ListKeyPhrasesDetectionJobs.ListKeyPhrasesDetectionJobs -- | Gets a list of the events detection jobs that you have submitted. module Amazonka.Comprehend.ListEventsDetectionJobs -- | See: newListEventsDetectionJobs smart constructor. data ListEventsDetectionJobs ListEventsDetectionJobs' :: Maybe EventsDetectionJobFilter -> Maybe Natural -> Maybe Text -> ListEventsDetectionJobs -- | Filters the jobs that are returned. You can filter jobs on their name, -- status, or the date and time that they were submitted. You can only -- set one filter at a time. [$sel:filter':ListEventsDetectionJobs'] :: ListEventsDetectionJobs -> Maybe EventsDetectionJobFilter -- | The maximum number of results to return in each page. [$sel:maxResults:ListEventsDetectionJobs'] :: ListEventsDetectionJobs -> Maybe Natural -- | Identifies the next page of results to return. [$sel:nextToken:ListEventsDetectionJobs'] :: ListEventsDetectionJobs -> Maybe Text -- | Create a value of ListEventsDetectionJobs with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:filter':ListEventsDetectionJobs', -- listEventsDetectionJobs_filter - Filters the jobs that are -- returned. You can filter jobs on their name, status, or the date and -- time that they were submitted. You can only set one filter at a time. -- -- $sel:maxResults:ListEventsDetectionJobs', -- listEventsDetectionJobs_maxResults - The maximum number of -- results to return in each page. -- -- ListEventsDetectionJobs, -- listEventsDetectionJobs_nextToken - Identifies the next page of -- results to return. newListEventsDetectionJobs :: ListEventsDetectionJobs -- | Filters the jobs that are returned. You can filter jobs on their name, -- status, or the date and time that they were submitted. You can only -- set one filter at a time. listEventsDetectionJobs_filter :: Lens' ListEventsDetectionJobs (Maybe EventsDetectionJobFilter) -- | The maximum number of results to return in each page. listEventsDetectionJobs_maxResults :: Lens' ListEventsDetectionJobs (Maybe Natural) -- | Identifies the next page of results to return. listEventsDetectionJobs_nextToken :: Lens' ListEventsDetectionJobs (Maybe Text) -- | See: newListEventsDetectionJobsResponse smart -- constructor. data ListEventsDetectionJobsResponse ListEventsDetectionJobsResponse' :: Maybe [EventsDetectionJobProperties] -> Maybe Text -> Int -> ListEventsDetectionJobsResponse -- | A list containing the properties of each job that is returned. [$sel:eventsDetectionJobPropertiesList:ListEventsDetectionJobsResponse'] :: ListEventsDetectionJobsResponse -> Maybe [EventsDetectionJobProperties] -- | Identifies the next page of results to return. [$sel:nextToken:ListEventsDetectionJobsResponse'] :: ListEventsDetectionJobsResponse -> Maybe Text -- | The response's http status code. [$sel:httpStatus:ListEventsDetectionJobsResponse'] :: ListEventsDetectionJobsResponse -> Int -- | Create a value of ListEventsDetectionJobsResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:eventsDetectionJobPropertiesList:ListEventsDetectionJobsResponse', -- listEventsDetectionJobsResponse_eventsDetectionJobPropertiesList -- - A list containing the properties of each job that is returned. -- -- ListEventsDetectionJobs, -- listEventsDetectionJobsResponse_nextToken - Identifies the next -- page of results to return. -- -- $sel:httpStatus:ListEventsDetectionJobsResponse', -- listEventsDetectionJobsResponse_httpStatus - The response's -- http status code. newListEventsDetectionJobsResponse :: Int -> ListEventsDetectionJobsResponse -- | A list containing the properties of each job that is returned. listEventsDetectionJobsResponse_eventsDetectionJobPropertiesList :: Lens' ListEventsDetectionJobsResponse (Maybe [EventsDetectionJobProperties]) -- | Identifies the next page of results to return. listEventsDetectionJobsResponse_nextToken :: Lens' ListEventsDetectionJobsResponse (Maybe Text) -- | The response's http status code. listEventsDetectionJobsResponse_httpStatus :: Lens' ListEventsDetectionJobsResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.ListEventsDetectionJobs.ListEventsDetectionJobs instance GHC.Show.Show Amazonka.Comprehend.ListEventsDetectionJobs.ListEventsDetectionJobs instance GHC.Read.Read Amazonka.Comprehend.ListEventsDetectionJobs.ListEventsDetectionJobs instance GHC.Classes.Eq Amazonka.Comprehend.ListEventsDetectionJobs.ListEventsDetectionJobs instance GHC.Generics.Generic Amazonka.Comprehend.ListEventsDetectionJobs.ListEventsDetectionJobsResponse instance GHC.Show.Show Amazonka.Comprehend.ListEventsDetectionJobs.ListEventsDetectionJobsResponse instance GHC.Read.Read Amazonka.Comprehend.ListEventsDetectionJobs.ListEventsDetectionJobsResponse instance GHC.Classes.Eq Amazonka.Comprehend.ListEventsDetectionJobs.ListEventsDetectionJobsResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.ListEventsDetectionJobs.ListEventsDetectionJobs instance Control.DeepSeq.NFData Amazonka.Comprehend.ListEventsDetectionJobs.ListEventsDetectionJobsResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.ListEventsDetectionJobs.ListEventsDetectionJobs instance Control.DeepSeq.NFData Amazonka.Comprehend.ListEventsDetectionJobs.ListEventsDetectionJobs instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.ListEventsDetectionJobs.ListEventsDetectionJobs instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.ListEventsDetectionJobs.ListEventsDetectionJobs instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.ListEventsDetectionJobs.ListEventsDetectionJobs instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.ListEventsDetectionJobs.ListEventsDetectionJobs -- | Gets a list of the properties of all entity recognizers that you -- created, including recognizers currently in training. Allows you to -- filter the list of recognizers based on criteria such as status and -- submission time. This call returns up to 500 entity recognizers in the -- list, with a default number of 100 recognizers in the list. -- -- The results of this list are not in any particular order. Please get -- the list and sort locally if needed. -- -- This operation returns paginated results. module Amazonka.Comprehend.ListEntityRecognizers -- | See: newListEntityRecognizers smart constructor. data ListEntityRecognizers ListEntityRecognizers' :: Maybe EntityRecognizerFilter -> Maybe Natural -> Maybe Text -> ListEntityRecognizers -- | Filters the list of entities returned. You can filter on -- Status, SubmitTimeBefore, or -- SubmitTimeAfter. You can only set one filter at a time. [$sel:filter':ListEntityRecognizers'] :: ListEntityRecognizers -> Maybe EntityRecognizerFilter -- | The maximum number of results to return on each page. The default is -- 100. [$sel:maxResults:ListEntityRecognizers'] :: ListEntityRecognizers -> Maybe Natural -- | Identifies the next page of results to return. [$sel:nextToken:ListEntityRecognizers'] :: ListEntityRecognizers -> Maybe Text -- | Create a value of ListEntityRecognizers with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:filter':ListEntityRecognizers', -- listEntityRecognizers_filter - Filters the list of entities -- returned. You can filter on Status, -- SubmitTimeBefore, or SubmitTimeAfter. You can only -- set one filter at a time. -- -- $sel:maxResults:ListEntityRecognizers', -- listEntityRecognizers_maxResults - The maximum number of -- results to return on each page. The default is 100. -- -- ListEntityRecognizers, listEntityRecognizers_nextToken - -- Identifies the next page of results to return. newListEntityRecognizers :: ListEntityRecognizers -- | Filters the list of entities returned. You can filter on -- Status, SubmitTimeBefore, or -- SubmitTimeAfter. You can only set one filter at a time. listEntityRecognizers_filter :: Lens' ListEntityRecognizers (Maybe EntityRecognizerFilter) -- | The maximum number of results to return on each page. The default is -- 100. listEntityRecognizers_maxResults :: Lens' ListEntityRecognizers (Maybe Natural) -- | Identifies the next page of results to return. listEntityRecognizers_nextToken :: Lens' ListEntityRecognizers (Maybe Text) -- | See: newListEntityRecognizersResponse smart constructor. data ListEntityRecognizersResponse ListEntityRecognizersResponse' :: Maybe [EntityRecognizerProperties] -> Maybe Text -> Int -> ListEntityRecognizersResponse -- | The list of properties of an entity recognizer. [$sel:entityRecognizerPropertiesList:ListEntityRecognizersResponse'] :: ListEntityRecognizersResponse -> Maybe [EntityRecognizerProperties] -- | Identifies the next page of results to return. [$sel:nextToken:ListEntityRecognizersResponse'] :: ListEntityRecognizersResponse -> Maybe Text -- | The response's http status code. [$sel:httpStatus:ListEntityRecognizersResponse'] :: ListEntityRecognizersResponse -> Int -- | Create a value of ListEntityRecognizersResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:entityRecognizerPropertiesList:ListEntityRecognizersResponse', -- listEntityRecognizersResponse_entityRecognizerPropertiesList - -- The list of properties of an entity recognizer. -- -- ListEntityRecognizers, -- listEntityRecognizersResponse_nextToken - Identifies the next -- page of results to return. -- -- $sel:httpStatus:ListEntityRecognizersResponse', -- listEntityRecognizersResponse_httpStatus - The response's http -- status code. newListEntityRecognizersResponse :: Int -> ListEntityRecognizersResponse -- | The list of properties of an entity recognizer. listEntityRecognizersResponse_entityRecognizerPropertiesList :: Lens' ListEntityRecognizersResponse (Maybe [EntityRecognizerProperties]) -- | Identifies the next page of results to return. listEntityRecognizersResponse_nextToken :: Lens' ListEntityRecognizersResponse (Maybe Text) -- | The response's http status code. listEntityRecognizersResponse_httpStatus :: Lens' ListEntityRecognizersResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.ListEntityRecognizers.ListEntityRecognizers instance GHC.Show.Show Amazonka.Comprehend.ListEntityRecognizers.ListEntityRecognizers instance GHC.Read.Read Amazonka.Comprehend.ListEntityRecognizers.ListEntityRecognizers instance GHC.Classes.Eq Amazonka.Comprehend.ListEntityRecognizers.ListEntityRecognizers instance GHC.Generics.Generic Amazonka.Comprehend.ListEntityRecognizers.ListEntityRecognizersResponse instance GHC.Show.Show Amazonka.Comprehend.ListEntityRecognizers.ListEntityRecognizersResponse instance GHC.Classes.Eq Amazonka.Comprehend.ListEntityRecognizers.ListEntityRecognizersResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.ListEntityRecognizers.ListEntityRecognizers instance Control.DeepSeq.NFData Amazonka.Comprehend.ListEntityRecognizers.ListEntityRecognizersResponse instance Amazonka.Pager.AWSPager Amazonka.Comprehend.ListEntityRecognizers.ListEntityRecognizers instance Data.Hashable.Class.Hashable Amazonka.Comprehend.ListEntityRecognizers.ListEntityRecognizers instance Control.DeepSeq.NFData Amazonka.Comprehend.ListEntityRecognizers.ListEntityRecognizers instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.ListEntityRecognizers.ListEntityRecognizers instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.ListEntityRecognizers.ListEntityRecognizers instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.ListEntityRecognizers.ListEntityRecognizers instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.ListEntityRecognizers.ListEntityRecognizers -- | Gets a list of summaries for the entity recognizers that you have -- created. module Amazonka.Comprehend.ListEntityRecognizerSummaries -- | See: newListEntityRecognizerSummaries smart constructor. data ListEntityRecognizerSummaries ListEntityRecognizerSummaries' :: Maybe Natural -> Maybe Text -> ListEntityRecognizerSummaries -- | The maximum number of results to return on each page. The default is -- 100. [$sel:maxResults:ListEntityRecognizerSummaries'] :: ListEntityRecognizerSummaries -> Maybe Natural -- | Identifies the next page of results to return. [$sel:nextToken:ListEntityRecognizerSummaries'] :: ListEntityRecognizerSummaries -> Maybe Text -- | Create a value of ListEntityRecognizerSummaries with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:maxResults:ListEntityRecognizerSummaries', -- listEntityRecognizerSummaries_maxResults - The maximum number -- of results to return on each page. The default is 100. -- -- ListEntityRecognizerSummaries, -- listEntityRecognizerSummaries_nextToken - Identifies the next -- page of results to return. newListEntityRecognizerSummaries :: ListEntityRecognizerSummaries -- | The maximum number of results to return on each page. The default is -- 100. listEntityRecognizerSummaries_maxResults :: Lens' ListEntityRecognizerSummaries (Maybe Natural) -- | Identifies the next page of results to return. listEntityRecognizerSummaries_nextToken :: Lens' ListEntityRecognizerSummaries (Maybe Text) -- | See: newListEntityRecognizerSummariesResponse smart -- constructor. data ListEntityRecognizerSummariesResponse ListEntityRecognizerSummariesResponse' :: Maybe [EntityRecognizerSummary] -> Maybe Text -> Int -> ListEntityRecognizerSummariesResponse -- | The list entity recognizer summaries. [$sel:entityRecognizerSummariesList:ListEntityRecognizerSummariesResponse'] :: ListEntityRecognizerSummariesResponse -> Maybe [EntityRecognizerSummary] -- | The list entity recognizer summaries. [$sel:nextToken:ListEntityRecognizerSummariesResponse'] :: ListEntityRecognizerSummariesResponse -> Maybe Text -- | The response's http status code. [$sel:httpStatus:ListEntityRecognizerSummariesResponse'] :: ListEntityRecognizerSummariesResponse -> Int -- | Create a value of ListEntityRecognizerSummariesResponse with -- all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:entityRecognizerSummariesList:ListEntityRecognizerSummariesResponse', -- listEntityRecognizerSummariesResponse_entityRecognizerSummariesList -- - The list entity recognizer summaries. -- -- ListEntityRecognizerSummaries, -- listEntityRecognizerSummariesResponse_nextToken - The list -- entity recognizer summaries. -- -- $sel:httpStatus:ListEntityRecognizerSummariesResponse', -- listEntityRecognizerSummariesResponse_httpStatus - The -- response's http status code. newListEntityRecognizerSummariesResponse :: Int -> ListEntityRecognizerSummariesResponse -- | The list entity recognizer summaries. listEntityRecognizerSummariesResponse_entityRecognizerSummariesList :: Lens' ListEntityRecognizerSummariesResponse (Maybe [EntityRecognizerSummary]) -- | The list entity recognizer summaries. listEntityRecognizerSummariesResponse_nextToken :: Lens' ListEntityRecognizerSummariesResponse (Maybe Text) -- | The response's http status code. listEntityRecognizerSummariesResponse_httpStatus :: Lens' ListEntityRecognizerSummariesResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.ListEntityRecognizerSummaries.ListEntityRecognizerSummaries instance GHC.Show.Show Amazonka.Comprehend.ListEntityRecognizerSummaries.ListEntityRecognizerSummaries instance GHC.Read.Read Amazonka.Comprehend.ListEntityRecognizerSummaries.ListEntityRecognizerSummaries instance GHC.Classes.Eq Amazonka.Comprehend.ListEntityRecognizerSummaries.ListEntityRecognizerSummaries instance GHC.Generics.Generic Amazonka.Comprehend.ListEntityRecognizerSummaries.ListEntityRecognizerSummariesResponse instance GHC.Show.Show Amazonka.Comprehend.ListEntityRecognizerSummaries.ListEntityRecognizerSummariesResponse instance GHC.Read.Read Amazonka.Comprehend.ListEntityRecognizerSummaries.ListEntityRecognizerSummariesResponse instance GHC.Classes.Eq Amazonka.Comprehend.ListEntityRecognizerSummaries.ListEntityRecognizerSummariesResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.ListEntityRecognizerSummaries.ListEntityRecognizerSummaries instance Control.DeepSeq.NFData Amazonka.Comprehend.ListEntityRecognizerSummaries.ListEntityRecognizerSummariesResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.ListEntityRecognizerSummaries.ListEntityRecognizerSummaries instance Control.DeepSeq.NFData Amazonka.Comprehend.ListEntityRecognizerSummaries.ListEntityRecognizerSummaries instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.ListEntityRecognizerSummaries.ListEntityRecognizerSummaries instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.ListEntityRecognizerSummaries.ListEntityRecognizerSummaries instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.ListEntityRecognizerSummaries.ListEntityRecognizerSummaries instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.ListEntityRecognizerSummaries.ListEntityRecognizerSummaries -- | Gets a list of the entity detection jobs that you have submitted. -- -- This operation returns paginated results. module Amazonka.Comprehend.ListEntitiesDetectionJobs -- | See: newListEntitiesDetectionJobs smart constructor. data ListEntitiesDetectionJobs ListEntitiesDetectionJobs' :: Maybe EntitiesDetectionJobFilter -> Maybe Natural -> Maybe Text -> ListEntitiesDetectionJobs -- | Filters the jobs that are returned. You can filter jobs on their name, -- status, or the date and time that they were submitted. You can only -- set one filter at a time. [$sel:filter':ListEntitiesDetectionJobs'] :: ListEntitiesDetectionJobs -> Maybe EntitiesDetectionJobFilter -- | The maximum number of results to return in each page. The default is -- 100. [$sel:maxResults:ListEntitiesDetectionJobs'] :: ListEntitiesDetectionJobs -> Maybe Natural -- | Identifies the next page of results to return. [$sel:nextToken:ListEntitiesDetectionJobs'] :: ListEntitiesDetectionJobs -> Maybe Text -- | Create a value of ListEntitiesDetectionJobs with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:filter':ListEntitiesDetectionJobs', -- listEntitiesDetectionJobs_filter - Filters the jobs that are -- returned. You can filter jobs on their name, status, or the date and -- time that they were submitted. You can only set one filter at a time. -- -- $sel:maxResults:ListEntitiesDetectionJobs', -- listEntitiesDetectionJobs_maxResults - The maximum number of -- results to return in each page. The default is 100. -- -- ListEntitiesDetectionJobs, -- listEntitiesDetectionJobs_nextToken - Identifies the next page -- of results to return. newListEntitiesDetectionJobs :: ListEntitiesDetectionJobs -- | Filters the jobs that are returned. You can filter jobs on their name, -- status, or the date and time that they were submitted. You can only -- set one filter at a time. listEntitiesDetectionJobs_filter :: Lens' ListEntitiesDetectionJobs (Maybe EntitiesDetectionJobFilter) -- | The maximum number of results to return in each page. The default is -- 100. listEntitiesDetectionJobs_maxResults :: Lens' ListEntitiesDetectionJobs (Maybe Natural) -- | Identifies the next page of results to return. listEntitiesDetectionJobs_nextToken :: Lens' ListEntitiesDetectionJobs (Maybe Text) -- | See: newListEntitiesDetectionJobsResponse smart -- constructor. data ListEntitiesDetectionJobsResponse ListEntitiesDetectionJobsResponse' :: Maybe [EntitiesDetectionJobProperties] -> Maybe Text -> Int -> ListEntitiesDetectionJobsResponse -- | A list containing the properties of each job that is returned. [$sel:entitiesDetectionJobPropertiesList:ListEntitiesDetectionJobsResponse'] :: ListEntitiesDetectionJobsResponse -> Maybe [EntitiesDetectionJobProperties] -- | Identifies the next page of results to return. [$sel:nextToken:ListEntitiesDetectionJobsResponse'] :: ListEntitiesDetectionJobsResponse -> Maybe Text -- | The response's http status code. [$sel:httpStatus:ListEntitiesDetectionJobsResponse'] :: ListEntitiesDetectionJobsResponse -> Int -- | Create a value of ListEntitiesDetectionJobsResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:entitiesDetectionJobPropertiesList:ListEntitiesDetectionJobsResponse', -- listEntitiesDetectionJobsResponse_entitiesDetectionJobPropertiesList -- - A list containing the properties of each job that is returned. -- -- ListEntitiesDetectionJobs, -- listEntitiesDetectionJobsResponse_nextToken - Identifies the -- next page of results to return. -- -- $sel:httpStatus:ListEntitiesDetectionJobsResponse', -- listEntitiesDetectionJobsResponse_httpStatus - The response's -- http status code. newListEntitiesDetectionJobsResponse :: Int -> ListEntitiesDetectionJobsResponse -- | A list containing the properties of each job that is returned. listEntitiesDetectionJobsResponse_entitiesDetectionJobPropertiesList :: Lens' ListEntitiesDetectionJobsResponse (Maybe [EntitiesDetectionJobProperties]) -- | Identifies the next page of results to return. listEntitiesDetectionJobsResponse_nextToken :: Lens' ListEntitiesDetectionJobsResponse (Maybe Text) -- | The response's http status code. listEntitiesDetectionJobsResponse_httpStatus :: Lens' ListEntitiesDetectionJobsResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.ListEntitiesDetectionJobs.ListEntitiesDetectionJobs instance GHC.Show.Show Amazonka.Comprehend.ListEntitiesDetectionJobs.ListEntitiesDetectionJobs instance GHC.Read.Read Amazonka.Comprehend.ListEntitiesDetectionJobs.ListEntitiesDetectionJobs instance GHC.Classes.Eq Amazonka.Comprehend.ListEntitiesDetectionJobs.ListEntitiesDetectionJobs instance GHC.Generics.Generic Amazonka.Comprehend.ListEntitiesDetectionJobs.ListEntitiesDetectionJobsResponse instance GHC.Show.Show Amazonka.Comprehend.ListEntitiesDetectionJobs.ListEntitiesDetectionJobsResponse instance GHC.Read.Read Amazonka.Comprehend.ListEntitiesDetectionJobs.ListEntitiesDetectionJobsResponse instance GHC.Classes.Eq Amazonka.Comprehend.ListEntitiesDetectionJobs.ListEntitiesDetectionJobsResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.ListEntitiesDetectionJobs.ListEntitiesDetectionJobs instance Control.DeepSeq.NFData Amazonka.Comprehend.ListEntitiesDetectionJobs.ListEntitiesDetectionJobsResponse instance Amazonka.Pager.AWSPager Amazonka.Comprehend.ListEntitiesDetectionJobs.ListEntitiesDetectionJobs instance Data.Hashable.Class.Hashable Amazonka.Comprehend.ListEntitiesDetectionJobs.ListEntitiesDetectionJobs instance Control.DeepSeq.NFData Amazonka.Comprehend.ListEntitiesDetectionJobs.ListEntitiesDetectionJobs instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.ListEntitiesDetectionJobs.ListEntitiesDetectionJobs instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.ListEntitiesDetectionJobs.ListEntitiesDetectionJobs instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.ListEntitiesDetectionJobs.ListEntitiesDetectionJobs instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.ListEntitiesDetectionJobs.ListEntitiesDetectionJobs -- | Gets a list of all existing endpoints that you've created. For -- information about endpoints, see Managing endpoints. -- -- This operation returns paginated results. module Amazonka.Comprehend.ListEndpoints -- | See: newListEndpoints smart constructor. data ListEndpoints ListEndpoints' :: Maybe EndpointFilter -> Maybe Natural -> Maybe Text -> ListEndpoints -- | Filters the endpoints that are returned. You can filter endpoints on -- their name, model, status, or the date and time that they were -- created. You can only set one filter at a time. [$sel:filter':ListEndpoints'] :: ListEndpoints -> Maybe EndpointFilter -- | The maximum number of results to return in each page. The default is -- 100. [$sel:maxResults:ListEndpoints'] :: ListEndpoints -> Maybe Natural -- | Identifies the next page of results to return. [$sel:nextToken:ListEndpoints'] :: ListEndpoints -> Maybe Text -- | Create a value of ListEndpoints with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:filter':ListEndpoints', listEndpoints_filter - -- Filters the endpoints that are returned. You can filter endpoints on -- their name, model, status, or the date and time that they were -- created. You can only set one filter at a time. -- -- $sel:maxResults:ListEndpoints', listEndpoints_maxResults -- - The maximum number of results to return in each page. The default is -- 100. -- -- ListEndpoints, listEndpoints_nextToken - Identifies the -- next page of results to return. newListEndpoints :: ListEndpoints -- | Filters the endpoints that are returned. You can filter endpoints on -- their name, model, status, or the date and time that they were -- created. You can only set one filter at a time. listEndpoints_filter :: Lens' ListEndpoints (Maybe EndpointFilter) -- | The maximum number of results to return in each page. The default is -- 100. listEndpoints_maxResults :: Lens' ListEndpoints (Maybe Natural) -- | Identifies the next page of results to return. listEndpoints_nextToken :: Lens' ListEndpoints (Maybe Text) -- | See: newListEndpointsResponse smart constructor. data ListEndpointsResponse ListEndpointsResponse' :: Maybe [EndpointProperties] -> Maybe Text -> Int -> ListEndpointsResponse -- | Displays a list of endpoint properties being retrieved by the service -- in response to the request. [$sel:endpointPropertiesList:ListEndpointsResponse'] :: ListEndpointsResponse -> Maybe [EndpointProperties] -- | Identifies the next page of results to return. [$sel:nextToken:ListEndpointsResponse'] :: ListEndpointsResponse -> Maybe Text -- | The response's http status code. [$sel:httpStatus:ListEndpointsResponse'] :: ListEndpointsResponse -> Int -- | Create a value of ListEndpointsResponse with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:endpointPropertiesList:ListEndpointsResponse', -- listEndpointsResponse_endpointPropertiesList - Displays a list -- of endpoint properties being retrieved by the service in response to -- the request. -- -- ListEndpoints, listEndpointsResponse_nextToken - -- Identifies the next page of results to return. -- -- $sel:httpStatus:ListEndpointsResponse', -- listEndpointsResponse_httpStatus - The response's http status -- code. newListEndpointsResponse :: Int -> ListEndpointsResponse -- | Displays a list of endpoint properties being retrieved by the service -- in response to the request. listEndpointsResponse_endpointPropertiesList :: Lens' ListEndpointsResponse (Maybe [EndpointProperties]) -- | Identifies the next page of results to return. listEndpointsResponse_nextToken :: Lens' ListEndpointsResponse (Maybe Text) -- | The response's http status code. listEndpointsResponse_httpStatus :: Lens' ListEndpointsResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.ListEndpoints.ListEndpoints instance GHC.Show.Show Amazonka.Comprehend.ListEndpoints.ListEndpoints instance GHC.Read.Read Amazonka.Comprehend.ListEndpoints.ListEndpoints instance GHC.Classes.Eq Amazonka.Comprehend.ListEndpoints.ListEndpoints instance GHC.Generics.Generic Amazonka.Comprehend.ListEndpoints.ListEndpointsResponse instance GHC.Show.Show Amazonka.Comprehend.ListEndpoints.ListEndpointsResponse instance GHC.Read.Read Amazonka.Comprehend.ListEndpoints.ListEndpointsResponse instance GHC.Classes.Eq Amazonka.Comprehend.ListEndpoints.ListEndpointsResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.ListEndpoints.ListEndpoints instance Control.DeepSeq.NFData Amazonka.Comprehend.ListEndpoints.ListEndpointsResponse instance Amazonka.Pager.AWSPager Amazonka.Comprehend.ListEndpoints.ListEndpoints instance Data.Hashable.Class.Hashable Amazonka.Comprehend.ListEndpoints.ListEndpoints instance Control.DeepSeq.NFData Amazonka.Comprehend.ListEndpoints.ListEndpoints instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.ListEndpoints.ListEndpoints instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.ListEndpoints.ListEndpoints instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.ListEndpoints.ListEndpoints instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.ListEndpoints.ListEndpoints -- | Gets a list of the dominant language detection jobs that you have -- submitted. -- -- This operation returns paginated results. module Amazonka.Comprehend.ListDominantLanguageDetectionJobs -- | See: newListDominantLanguageDetectionJobs smart -- constructor. data ListDominantLanguageDetectionJobs ListDominantLanguageDetectionJobs' :: Maybe DominantLanguageDetectionJobFilter -> Maybe Natural -> Maybe Text -> ListDominantLanguageDetectionJobs -- | Filters that jobs that are returned. You can filter jobs on their -- name, status, or the date and time that they were submitted. You can -- only set one filter at a time. [$sel:filter':ListDominantLanguageDetectionJobs'] :: ListDominantLanguageDetectionJobs -> Maybe DominantLanguageDetectionJobFilter -- | The maximum number of results to return in each page. The default is -- 100. [$sel:maxResults:ListDominantLanguageDetectionJobs'] :: ListDominantLanguageDetectionJobs -> Maybe Natural -- | Identifies the next page of results to return. [$sel:nextToken:ListDominantLanguageDetectionJobs'] :: ListDominantLanguageDetectionJobs -> Maybe Text -- | Create a value of ListDominantLanguageDetectionJobs with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:filter':ListDominantLanguageDetectionJobs', -- listDominantLanguageDetectionJobs_filter - Filters that jobs -- that are returned. You can filter jobs on their name, status, or the -- date and time that they were submitted. You can only set one filter at -- a time. -- -- $sel:maxResults:ListDominantLanguageDetectionJobs', -- listDominantLanguageDetectionJobs_maxResults - The maximum -- number of results to return in each page. The default is 100. -- -- ListDominantLanguageDetectionJobs, -- listDominantLanguageDetectionJobs_nextToken - Identifies the -- next page of results to return. newListDominantLanguageDetectionJobs :: ListDominantLanguageDetectionJobs -- | Filters that jobs that are returned. You can filter jobs on their -- name, status, or the date and time that they were submitted. You can -- only set one filter at a time. listDominantLanguageDetectionJobs_filter :: Lens' ListDominantLanguageDetectionJobs (Maybe DominantLanguageDetectionJobFilter) -- | The maximum number of results to return in each page. The default is -- 100. listDominantLanguageDetectionJobs_maxResults :: Lens' ListDominantLanguageDetectionJobs (Maybe Natural) -- | Identifies the next page of results to return. listDominantLanguageDetectionJobs_nextToken :: Lens' ListDominantLanguageDetectionJobs (Maybe Text) -- | See: newListDominantLanguageDetectionJobsResponse smart -- constructor. data ListDominantLanguageDetectionJobsResponse ListDominantLanguageDetectionJobsResponse' :: Maybe [DominantLanguageDetectionJobProperties] -> Maybe Text -> Int -> ListDominantLanguageDetectionJobsResponse -- | A list containing the properties of each job that is returned. [$sel:dominantLanguageDetectionJobPropertiesList:ListDominantLanguageDetectionJobsResponse'] :: ListDominantLanguageDetectionJobsResponse -> Maybe [DominantLanguageDetectionJobProperties] -- | Identifies the next page of results to return. [$sel:nextToken:ListDominantLanguageDetectionJobsResponse'] :: ListDominantLanguageDetectionJobsResponse -> Maybe Text -- | The response's http status code. [$sel:httpStatus:ListDominantLanguageDetectionJobsResponse'] :: ListDominantLanguageDetectionJobsResponse -> Int -- | Create a value of ListDominantLanguageDetectionJobsResponse -- with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:dominantLanguageDetectionJobPropertiesList:ListDominantLanguageDetectionJobsResponse', -- listDominantLanguageDetectionJobsResponse_dominantLanguageDetectionJobPropertiesList -- - A list containing the properties of each job that is returned. -- -- ListDominantLanguageDetectionJobs, -- listDominantLanguageDetectionJobsResponse_nextToken - -- Identifies the next page of results to return. -- -- $sel:httpStatus:ListDominantLanguageDetectionJobsResponse', -- listDominantLanguageDetectionJobsResponse_httpStatus - The -- response's http status code. newListDominantLanguageDetectionJobsResponse :: Int -> ListDominantLanguageDetectionJobsResponse -- | A list containing the properties of each job that is returned. listDominantLanguageDetectionJobsResponse_dominantLanguageDetectionJobPropertiesList :: Lens' ListDominantLanguageDetectionJobsResponse (Maybe [DominantLanguageDetectionJobProperties]) -- | Identifies the next page of results to return. listDominantLanguageDetectionJobsResponse_nextToken :: Lens' ListDominantLanguageDetectionJobsResponse (Maybe Text) -- | The response's http status code. listDominantLanguageDetectionJobsResponse_httpStatus :: Lens' ListDominantLanguageDetectionJobsResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.ListDominantLanguageDetectionJobs.ListDominantLanguageDetectionJobs instance GHC.Show.Show Amazonka.Comprehend.ListDominantLanguageDetectionJobs.ListDominantLanguageDetectionJobs instance GHC.Read.Read Amazonka.Comprehend.ListDominantLanguageDetectionJobs.ListDominantLanguageDetectionJobs instance GHC.Classes.Eq Amazonka.Comprehend.ListDominantLanguageDetectionJobs.ListDominantLanguageDetectionJobs instance GHC.Generics.Generic Amazonka.Comprehend.ListDominantLanguageDetectionJobs.ListDominantLanguageDetectionJobsResponse instance GHC.Show.Show Amazonka.Comprehend.ListDominantLanguageDetectionJobs.ListDominantLanguageDetectionJobsResponse instance GHC.Read.Read Amazonka.Comprehend.ListDominantLanguageDetectionJobs.ListDominantLanguageDetectionJobsResponse instance GHC.Classes.Eq Amazonka.Comprehend.ListDominantLanguageDetectionJobs.ListDominantLanguageDetectionJobsResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.ListDominantLanguageDetectionJobs.ListDominantLanguageDetectionJobs instance Control.DeepSeq.NFData Amazonka.Comprehend.ListDominantLanguageDetectionJobs.ListDominantLanguageDetectionJobsResponse instance Amazonka.Pager.AWSPager Amazonka.Comprehend.ListDominantLanguageDetectionJobs.ListDominantLanguageDetectionJobs instance Data.Hashable.Class.Hashable Amazonka.Comprehend.ListDominantLanguageDetectionJobs.ListDominantLanguageDetectionJobs instance Control.DeepSeq.NFData Amazonka.Comprehend.ListDominantLanguageDetectionJobs.ListDominantLanguageDetectionJobs instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.ListDominantLanguageDetectionJobs.ListDominantLanguageDetectionJobs instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.ListDominantLanguageDetectionJobs.ListDominantLanguageDetectionJobs instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.ListDominantLanguageDetectionJobs.ListDominantLanguageDetectionJobs instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.ListDominantLanguageDetectionJobs.ListDominantLanguageDetectionJobs -- | Gets a list of the document classifiers that you have created. -- -- This operation returns paginated results. module Amazonka.Comprehend.ListDocumentClassifiers -- | See: newListDocumentClassifiers smart constructor. data ListDocumentClassifiers ListDocumentClassifiers' :: Maybe DocumentClassifierFilter -> Maybe Natural -> Maybe Text -> ListDocumentClassifiers -- | Filters the jobs that are returned. You can filter jobs on their name, -- status, or the date and time that they were submitted. You can only -- set one filter at a time. [$sel:filter':ListDocumentClassifiers'] :: ListDocumentClassifiers -> Maybe DocumentClassifierFilter -- | The maximum number of results to return in each page. The default is -- 100. [$sel:maxResults:ListDocumentClassifiers'] :: ListDocumentClassifiers -> Maybe Natural -- | Identifies the next page of results to return. [$sel:nextToken:ListDocumentClassifiers'] :: ListDocumentClassifiers -> Maybe Text -- | Create a value of ListDocumentClassifiers with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:filter':ListDocumentClassifiers', -- listDocumentClassifiers_filter - Filters the jobs that are -- returned. You can filter jobs on their name, status, or the date and -- time that they were submitted. You can only set one filter at a time. -- -- $sel:maxResults:ListDocumentClassifiers', -- listDocumentClassifiers_maxResults - The maximum number of -- results to return in each page. The default is 100. -- -- ListDocumentClassifiers, -- listDocumentClassifiers_nextToken - Identifies the next page of -- results to return. newListDocumentClassifiers :: ListDocumentClassifiers -- | Filters the jobs that are returned. You can filter jobs on their name, -- status, or the date and time that they were submitted. You can only -- set one filter at a time. listDocumentClassifiers_filter :: Lens' ListDocumentClassifiers (Maybe DocumentClassifierFilter) -- | The maximum number of results to return in each page. The default is -- 100. listDocumentClassifiers_maxResults :: Lens' ListDocumentClassifiers (Maybe Natural) -- | Identifies the next page of results to return. listDocumentClassifiers_nextToken :: Lens' ListDocumentClassifiers (Maybe Text) -- | See: newListDocumentClassifiersResponse smart -- constructor. data ListDocumentClassifiersResponse ListDocumentClassifiersResponse' :: Maybe [DocumentClassifierProperties] -> Maybe Text -> Int -> ListDocumentClassifiersResponse -- | A list containing the properties of each job returned. [$sel:documentClassifierPropertiesList:ListDocumentClassifiersResponse'] :: ListDocumentClassifiersResponse -> Maybe [DocumentClassifierProperties] -- | Identifies the next page of results to return. [$sel:nextToken:ListDocumentClassifiersResponse'] :: ListDocumentClassifiersResponse -> Maybe Text -- | The response's http status code. [$sel:httpStatus:ListDocumentClassifiersResponse'] :: ListDocumentClassifiersResponse -> Int -- | Create a value of ListDocumentClassifiersResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:documentClassifierPropertiesList:ListDocumentClassifiersResponse', -- listDocumentClassifiersResponse_documentClassifierPropertiesList -- - A list containing the properties of each job returned. -- -- ListDocumentClassifiers, -- listDocumentClassifiersResponse_nextToken - Identifies the next -- page of results to return. -- -- $sel:httpStatus:ListDocumentClassifiersResponse', -- listDocumentClassifiersResponse_httpStatus - The response's -- http status code. newListDocumentClassifiersResponse :: Int -> ListDocumentClassifiersResponse -- | A list containing the properties of each job returned. listDocumentClassifiersResponse_documentClassifierPropertiesList :: Lens' ListDocumentClassifiersResponse (Maybe [DocumentClassifierProperties]) -- | Identifies the next page of results to return. listDocumentClassifiersResponse_nextToken :: Lens' ListDocumentClassifiersResponse (Maybe Text) -- | The response's http status code. listDocumentClassifiersResponse_httpStatus :: Lens' ListDocumentClassifiersResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.ListDocumentClassifiers.ListDocumentClassifiers instance GHC.Show.Show Amazonka.Comprehend.ListDocumentClassifiers.ListDocumentClassifiers instance GHC.Read.Read Amazonka.Comprehend.ListDocumentClassifiers.ListDocumentClassifiers instance GHC.Classes.Eq Amazonka.Comprehend.ListDocumentClassifiers.ListDocumentClassifiers instance GHC.Generics.Generic Amazonka.Comprehend.ListDocumentClassifiers.ListDocumentClassifiersResponse instance GHC.Show.Show Amazonka.Comprehend.ListDocumentClassifiers.ListDocumentClassifiersResponse instance GHC.Classes.Eq Amazonka.Comprehend.ListDocumentClassifiers.ListDocumentClassifiersResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.ListDocumentClassifiers.ListDocumentClassifiers instance Control.DeepSeq.NFData Amazonka.Comprehend.ListDocumentClassifiers.ListDocumentClassifiersResponse instance Amazonka.Pager.AWSPager Amazonka.Comprehend.ListDocumentClassifiers.ListDocumentClassifiers instance Data.Hashable.Class.Hashable Amazonka.Comprehend.ListDocumentClassifiers.ListDocumentClassifiers instance Control.DeepSeq.NFData Amazonka.Comprehend.ListDocumentClassifiers.ListDocumentClassifiers instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.ListDocumentClassifiers.ListDocumentClassifiers instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.ListDocumentClassifiers.ListDocumentClassifiers instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.ListDocumentClassifiers.ListDocumentClassifiers instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.ListDocumentClassifiers.ListDocumentClassifiers -- | Gets a list of summaries of the document classifiers that you have -- created module Amazonka.Comprehend.ListDocumentClassifierSummaries -- | See: newListDocumentClassifierSummaries smart -- constructor. data ListDocumentClassifierSummaries ListDocumentClassifierSummaries' :: Maybe Natural -> Maybe Text -> ListDocumentClassifierSummaries -- | The maximum number of results to return on each page. The default is -- 100. [$sel:maxResults:ListDocumentClassifierSummaries'] :: ListDocumentClassifierSummaries -> Maybe Natural -- | Identifies the next page of results to return. [$sel:nextToken:ListDocumentClassifierSummaries'] :: ListDocumentClassifierSummaries -> Maybe Text -- | Create a value of ListDocumentClassifierSummaries with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:maxResults:ListDocumentClassifierSummaries', -- listDocumentClassifierSummaries_maxResults - The maximum number -- of results to return on each page. The default is 100. -- -- ListDocumentClassifierSummaries, -- listDocumentClassifierSummaries_nextToken - Identifies the next -- page of results to return. newListDocumentClassifierSummaries :: ListDocumentClassifierSummaries -- | The maximum number of results to return on each page. The default is -- 100. listDocumentClassifierSummaries_maxResults :: Lens' ListDocumentClassifierSummaries (Maybe Natural) -- | Identifies the next page of results to return. listDocumentClassifierSummaries_nextToken :: Lens' ListDocumentClassifierSummaries (Maybe Text) -- | See: newListDocumentClassifierSummariesResponse smart -- constructor. data ListDocumentClassifierSummariesResponse ListDocumentClassifierSummariesResponse' :: Maybe [DocumentClassifierSummary] -> Maybe Text -> Int -> ListDocumentClassifierSummariesResponse -- | The list of summaries of document classifiers. [$sel:documentClassifierSummariesList:ListDocumentClassifierSummariesResponse'] :: ListDocumentClassifierSummariesResponse -> Maybe [DocumentClassifierSummary] -- | Identifies the next page of results to return. [$sel:nextToken:ListDocumentClassifierSummariesResponse'] :: ListDocumentClassifierSummariesResponse -> Maybe Text -- | The response's http status code. [$sel:httpStatus:ListDocumentClassifierSummariesResponse'] :: ListDocumentClassifierSummariesResponse -> Int -- | Create a value of ListDocumentClassifierSummariesResponse with -- all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:documentClassifierSummariesList:ListDocumentClassifierSummariesResponse', -- listDocumentClassifierSummariesResponse_documentClassifierSummariesList -- - The list of summaries of document classifiers. -- -- ListDocumentClassifierSummaries, -- listDocumentClassifierSummariesResponse_nextToken - Identifies -- the next page of results to return. -- -- $sel:httpStatus:ListDocumentClassifierSummariesResponse', -- listDocumentClassifierSummariesResponse_httpStatus - The -- response's http status code. newListDocumentClassifierSummariesResponse :: Int -> ListDocumentClassifierSummariesResponse -- | The list of summaries of document classifiers. listDocumentClassifierSummariesResponse_documentClassifierSummariesList :: Lens' ListDocumentClassifierSummariesResponse (Maybe [DocumentClassifierSummary]) -- | Identifies the next page of results to return. listDocumentClassifierSummariesResponse_nextToken :: Lens' ListDocumentClassifierSummariesResponse (Maybe Text) -- | The response's http status code. listDocumentClassifierSummariesResponse_httpStatus :: Lens' ListDocumentClassifierSummariesResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.ListDocumentClassifierSummaries.ListDocumentClassifierSummaries instance GHC.Show.Show Amazonka.Comprehend.ListDocumentClassifierSummaries.ListDocumentClassifierSummaries instance GHC.Read.Read Amazonka.Comprehend.ListDocumentClassifierSummaries.ListDocumentClassifierSummaries instance GHC.Classes.Eq Amazonka.Comprehend.ListDocumentClassifierSummaries.ListDocumentClassifierSummaries instance GHC.Generics.Generic Amazonka.Comprehend.ListDocumentClassifierSummaries.ListDocumentClassifierSummariesResponse instance GHC.Show.Show Amazonka.Comprehend.ListDocumentClassifierSummaries.ListDocumentClassifierSummariesResponse instance GHC.Read.Read Amazonka.Comprehend.ListDocumentClassifierSummaries.ListDocumentClassifierSummariesResponse instance GHC.Classes.Eq Amazonka.Comprehend.ListDocumentClassifierSummaries.ListDocumentClassifierSummariesResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.ListDocumentClassifierSummaries.ListDocumentClassifierSummaries instance Control.DeepSeq.NFData Amazonka.Comprehend.ListDocumentClassifierSummaries.ListDocumentClassifierSummariesResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.ListDocumentClassifierSummaries.ListDocumentClassifierSummaries instance Control.DeepSeq.NFData Amazonka.Comprehend.ListDocumentClassifierSummaries.ListDocumentClassifierSummaries instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.ListDocumentClassifierSummaries.ListDocumentClassifierSummaries instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.ListDocumentClassifierSummaries.ListDocumentClassifierSummaries instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.ListDocumentClassifierSummaries.ListDocumentClassifierSummaries instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.ListDocumentClassifierSummaries.ListDocumentClassifierSummaries -- | Gets a list of the documentation classification jobs that you have -- submitted. -- -- This operation returns paginated results. module Amazonka.Comprehend.ListDocumentClassificationJobs -- | See: newListDocumentClassificationJobs smart -- constructor. data ListDocumentClassificationJobs ListDocumentClassificationJobs' :: Maybe DocumentClassificationJobFilter -> Maybe Natural -> Maybe Text -> ListDocumentClassificationJobs -- | Filters the jobs that are returned. You can filter jobs on their -- names, status, or the date and time that they were submitted. You can -- only set one filter at a time. [$sel:filter':ListDocumentClassificationJobs'] :: ListDocumentClassificationJobs -> Maybe DocumentClassificationJobFilter -- | The maximum number of results to return in each page. The default is -- 100. [$sel:maxResults:ListDocumentClassificationJobs'] :: ListDocumentClassificationJobs -> Maybe Natural -- | Identifies the next page of results to return. [$sel:nextToken:ListDocumentClassificationJobs'] :: ListDocumentClassificationJobs -> Maybe Text -- | Create a value of ListDocumentClassificationJobs with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:filter':ListDocumentClassificationJobs', -- listDocumentClassificationJobs_filter - Filters the jobs that -- are returned. You can filter jobs on their names, status, or the date -- and time that they were submitted. You can only set one filter at a -- time. -- -- $sel:maxResults:ListDocumentClassificationJobs', -- listDocumentClassificationJobs_maxResults - The maximum number -- of results to return in each page. The default is 100. -- -- ListDocumentClassificationJobs, -- listDocumentClassificationJobs_nextToken - Identifies the next -- page of results to return. newListDocumentClassificationJobs :: ListDocumentClassificationJobs -- | Filters the jobs that are returned. You can filter jobs on their -- names, status, or the date and time that they were submitted. You can -- only set one filter at a time. listDocumentClassificationJobs_filter :: Lens' ListDocumentClassificationJobs (Maybe DocumentClassificationJobFilter) -- | The maximum number of results to return in each page. The default is -- 100. listDocumentClassificationJobs_maxResults :: Lens' ListDocumentClassificationJobs (Maybe Natural) -- | Identifies the next page of results to return. listDocumentClassificationJobs_nextToken :: Lens' ListDocumentClassificationJobs (Maybe Text) -- | See: newListDocumentClassificationJobsResponse smart -- constructor. data ListDocumentClassificationJobsResponse ListDocumentClassificationJobsResponse' :: Maybe [DocumentClassificationJobProperties] -> Maybe Text -> Int -> ListDocumentClassificationJobsResponse -- | A list containing the properties of each job returned. [$sel:documentClassificationJobPropertiesList:ListDocumentClassificationJobsResponse'] :: ListDocumentClassificationJobsResponse -> Maybe [DocumentClassificationJobProperties] -- | Identifies the next page of results to return. [$sel:nextToken:ListDocumentClassificationJobsResponse'] :: ListDocumentClassificationJobsResponse -> Maybe Text -- | The response's http status code. [$sel:httpStatus:ListDocumentClassificationJobsResponse'] :: ListDocumentClassificationJobsResponse -> Int -- | Create a value of ListDocumentClassificationJobsResponse with -- all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:documentClassificationJobPropertiesList:ListDocumentClassificationJobsResponse', -- listDocumentClassificationJobsResponse_documentClassificationJobPropertiesList -- - A list containing the properties of each job returned. -- -- ListDocumentClassificationJobs, -- listDocumentClassificationJobsResponse_nextToken - Identifies -- the next page of results to return. -- -- $sel:httpStatus:ListDocumentClassificationJobsResponse', -- listDocumentClassificationJobsResponse_httpStatus - The -- response's http status code. newListDocumentClassificationJobsResponse :: Int -> ListDocumentClassificationJobsResponse -- | A list containing the properties of each job returned. listDocumentClassificationJobsResponse_documentClassificationJobPropertiesList :: Lens' ListDocumentClassificationJobsResponse (Maybe [DocumentClassificationJobProperties]) -- | Identifies the next page of results to return. listDocumentClassificationJobsResponse_nextToken :: Lens' ListDocumentClassificationJobsResponse (Maybe Text) -- | The response's http status code. listDocumentClassificationJobsResponse_httpStatus :: Lens' ListDocumentClassificationJobsResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.ListDocumentClassificationJobs.ListDocumentClassificationJobs instance GHC.Show.Show Amazonka.Comprehend.ListDocumentClassificationJobs.ListDocumentClassificationJobs instance GHC.Read.Read Amazonka.Comprehend.ListDocumentClassificationJobs.ListDocumentClassificationJobs instance GHC.Classes.Eq Amazonka.Comprehend.ListDocumentClassificationJobs.ListDocumentClassificationJobs instance GHC.Generics.Generic Amazonka.Comprehend.ListDocumentClassificationJobs.ListDocumentClassificationJobsResponse instance GHC.Show.Show Amazonka.Comprehend.ListDocumentClassificationJobs.ListDocumentClassificationJobsResponse instance GHC.Read.Read Amazonka.Comprehend.ListDocumentClassificationJobs.ListDocumentClassificationJobsResponse instance GHC.Classes.Eq Amazonka.Comprehend.ListDocumentClassificationJobs.ListDocumentClassificationJobsResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.ListDocumentClassificationJobs.ListDocumentClassificationJobs instance Control.DeepSeq.NFData Amazonka.Comprehend.ListDocumentClassificationJobs.ListDocumentClassificationJobsResponse instance Amazonka.Pager.AWSPager Amazonka.Comprehend.ListDocumentClassificationJobs.ListDocumentClassificationJobs instance Data.Hashable.Class.Hashable Amazonka.Comprehend.ListDocumentClassificationJobs.ListDocumentClassificationJobs instance Control.DeepSeq.NFData Amazonka.Comprehend.ListDocumentClassificationJobs.ListDocumentClassificationJobs instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.ListDocumentClassificationJobs.ListDocumentClassificationJobs instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.ListDocumentClassificationJobs.ListDocumentClassificationJobs instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.ListDocumentClassificationJobs.ListDocumentClassificationJobs instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.ListDocumentClassificationJobs.ListDocumentClassificationJobs -- | Creates a new custom model that replicates a source custom model that -- you import. The source model can be in your AWS account or another -- one. -- -- If the source model is in another AWS account, then it must have a -- resource-based policy that authorizes you to import it. -- -- The source model must be in the same AWS region that you're using when -- you import. You can't import a model that's in a different region. module Amazonka.Comprehend.ImportModel -- | See: newImportModel smart constructor. data ImportModel ImportModel' :: Maybe Text -> Maybe Text -> Maybe Text -> Maybe [Tag] -> Maybe Text -> Text -> ImportModel -- | The Amazon Resource Name (ARN) of the AWS Identity and Management -- (IAM) role that allows Amazon Comprehend to use Amazon Key Management -- Service (KMS) to encrypt or decrypt the custom model. [$sel:dataAccessRoleArn:ImportModel'] :: ImportModel -> Maybe Text -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt trained custom models. The ModelKmsKeyId can be either -- of the following formats: -- -- [$sel:modelKmsKeyId:ImportModel'] :: ImportModel -> Maybe Text -- | The name to assign to the custom model that is created in Amazon -- Comprehend by this import. [$sel:modelName:ImportModel'] :: ImportModel -> Maybe Text -- | Tags to be associated with the custom model that is created by this -- import. A tag is a key-value pair that adds as a metadata to a -- resource used by Amazon Comprehend. For example, a tag with "Sales" as -- the key might be added to a resource to indicate its use by the sales -- department. [$sel:tags:ImportModel'] :: ImportModel -> Maybe [Tag] -- | The version name given to the custom model that is created by this -- import. Version names can have a maximum of 256 characters. -- Alphanumeric characters, hyphens (-) and underscores (_) are allowed. -- The version name must be unique among all models with the same -- classifier name in the account/AWS Region. [$sel:versionName:ImportModel'] :: ImportModel -> Maybe Text -- | The Amazon Resource Name (ARN) of the custom model to import. [$sel:sourceModelArn:ImportModel'] :: ImportModel -> Text -- | Create a value of ImportModel with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- ImportModel, importModel_dataAccessRoleArn - The Amazon -- Resource Name (ARN) of the AWS Identity and Management (IAM) role that -- allows Amazon Comprehend to use Amazon Key Management Service (KMS) to -- encrypt or decrypt the custom model. -- -- ImportModel, importModel_modelKmsKeyId - ID for the AWS -- Key Management Service (KMS) key that Amazon Comprehend uses to -- encrypt trained custom models. The ModelKmsKeyId can be either of the -- following formats: -- -- -- -- $sel:modelName:ImportModel', importModel_modelName - The -- name to assign to the custom model that is created in Amazon -- Comprehend by this import. -- -- $sel:tags:ImportModel', importModel_tags - Tags to be -- associated with the custom model that is created by this import. A tag -- is a key-value pair that adds as a metadata to a resource used by -- Amazon Comprehend. For example, a tag with "Sales" as the key might be -- added to a resource to indicate its use by the sales department. -- -- ImportModel, importModel_versionName - The version name -- given to the custom model that is created by this import. Version -- names can have a maximum of 256 characters. Alphanumeric characters, -- hyphens (-) and underscores (_) are allowed. The version name must be -- unique among all models with the same classifier name in the -- account/AWS Region. -- -- ImportModel, importModel_sourceModelArn - The Amazon -- Resource Name (ARN) of the custom model to import. newImportModel :: Text -> ImportModel -- | The Amazon Resource Name (ARN) of the AWS Identity and Management -- (IAM) role that allows Amazon Comprehend to use Amazon Key Management -- Service (KMS) to encrypt or decrypt the custom model. importModel_dataAccessRoleArn :: Lens' ImportModel (Maybe Text) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt trained custom models. The ModelKmsKeyId can be either -- of the following formats: -- -- importModel_modelKmsKeyId :: Lens' ImportModel (Maybe Text) -- | The name to assign to the custom model that is created in Amazon -- Comprehend by this import. importModel_modelName :: Lens' ImportModel (Maybe Text) -- | Tags to be associated with the custom model that is created by this -- import. A tag is a key-value pair that adds as a metadata to a -- resource used by Amazon Comprehend. For example, a tag with "Sales" as -- the key might be added to a resource to indicate its use by the sales -- department. importModel_tags :: Lens' ImportModel (Maybe [Tag]) -- | The version name given to the custom model that is created by this -- import. Version names can have a maximum of 256 characters. -- Alphanumeric characters, hyphens (-) and underscores (_) are allowed. -- The version name must be unique among all models with the same -- classifier name in the account/AWS Region. importModel_versionName :: Lens' ImportModel (Maybe Text) -- | The Amazon Resource Name (ARN) of the custom model to import. importModel_sourceModelArn :: Lens' ImportModel Text -- | See: newImportModelResponse smart constructor. data ImportModelResponse ImportModelResponse' :: Maybe Text -> Int -> ImportModelResponse -- | The Amazon Resource Name (ARN) of the custom model being imported. [$sel:modelArn:ImportModelResponse'] :: ImportModelResponse -> Maybe Text -- | The response's http status code. [$sel:httpStatus:ImportModelResponse'] :: ImportModelResponse -> Int -- | Create a value of ImportModelResponse with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- ImportModelResponse, importModelResponse_modelArn - The -- Amazon Resource Name (ARN) of the custom model being imported. -- -- $sel:httpStatus:ImportModelResponse', -- importModelResponse_httpStatus - The response's http status -- code. newImportModelResponse :: Int -> ImportModelResponse -- | The Amazon Resource Name (ARN) of the custom model being imported. importModelResponse_modelArn :: Lens' ImportModelResponse (Maybe Text) -- | The response's http status code. importModelResponse_httpStatus :: Lens' ImportModelResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.ImportModel.ImportModel instance GHC.Show.Show Amazonka.Comprehend.ImportModel.ImportModel instance GHC.Read.Read Amazonka.Comprehend.ImportModel.ImportModel instance GHC.Classes.Eq Amazonka.Comprehend.ImportModel.ImportModel instance GHC.Generics.Generic Amazonka.Comprehend.ImportModel.ImportModelResponse instance GHC.Show.Show Amazonka.Comprehend.ImportModel.ImportModelResponse instance GHC.Read.Read Amazonka.Comprehend.ImportModel.ImportModelResponse instance GHC.Classes.Eq Amazonka.Comprehend.ImportModel.ImportModelResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.ImportModel.ImportModel instance Control.DeepSeq.NFData Amazonka.Comprehend.ImportModel.ImportModelResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.ImportModel.ImportModel instance Control.DeepSeq.NFData Amazonka.Comprehend.ImportModel.ImportModel instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.ImportModel.ImportModel instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.ImportModel.ImportModel instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.ImportModel.ImportModel instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.ImportModel.ImportModel -- | Inspects the input text and returns a sentiment analysis for each -- entity identified in the text. -- -- For more information about targeted sentiment, see Targeted -- sentiment. module Amazonka.Comprehend.DetectTargetedSentiment -- | See: newDetectTargetedSentiment smart constructor. data DetectTargetedSentiment DetectTargetedSentiment' :: Sensitive Text -> LanguageCode -> DetectTargetedSentiment -- | A UTF-8 text string. The maximum string length is 5 KB. [$sel:text:DetectTargetedSentiment'] :: DetectTargetedSentiment -> Sensitive Text -- | The language of the input documents. Currently, English is the only -- supported language. [$sel:languageCode:DetectTargetedSentiment'] :: DetectTargetedSentiment -> LanguageCode -- | Create a value of DetectTargetedSentiment with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DetectTargetedSentiment, detectTargetedSentiment_text - -- A UTF-8 text string. The maximum string length is 5 KB. -- -- DetectTargetedSentiment, -- detectTargetedSentiment_languageCode - The language of the -- input documents. Currently, English is the only supported language. newDetectTargetedSentiment :: Text -> LanguageCode -> DetectTargetedSentiment -- | A UTF-8 text string. The maximum string length is 5 KB. detectTargetedSentiment_text :: Lens' DetectTargetedSentiment Text -- | The language of the input documents. Currently, English is the only -- supported language. detectTargetedSentiment_languageCode :: Lens' DetectTargetedSentiment LanguageCode -- | See: newDetectTargetedSentimentResponse smart -- constructor. data DetectTargetedSentimentResponse DetectTargetedSentimentResponse' :: Maybe [TargetedSentimentEntity] -> Int -> DetectTargetedSentimentResponse -- | Targeted sentiment analysis for each of the entities identified in the -- input text. [$sel:entities:DetectTargetedSentimentResponse'] :: DetectTargetedSentimentResponse -> Maybe [TargetedSentimentEntity] -- | The response's http status code. [$sel:httpStatus:DetectTargetedSentimentResponse'] :: DetectTargetedSentimentResponse -> Int -- | Create a value of DetectTargetedSentimentResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DetectTargetedSentimentResponse, -- detectTargetedSentimentResponse_entities - Targeted sentiment -- analysis for each of the entities identified in the input text. -- -- $sel:httpStatus:DetectTargetedSentimentResponse', -- detectTargetedSentimentResponse_httpStatus - The response's -- http status code. newDetectTargetedSentimentResponse :: Int -> DetectTargetedSentimentResponse -- | Targeted sentiment analysis for each of the entities identified in the -- input text. detectTargetedSentimentResponse_entities :: Lens' DetectTargetedSentimentResponse (Maybe [TargetedSentimentEntity]) -- | The response's http status code. detectTargetedSentimentResponse_httpStatus :: Lens' DetectTargetedSentimentResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.DetectTargetedSentiment.DetectTargetedSentiment instance GHC.Show.Show Amazonka.Comprehend.DetectTargetedSentiment.DetectTargetedSentiment instance GHC.Classes.Eq Amazonka.Comprehend.DetectTargetedSentiment.DetectTargetedSentiment instance GHC.Generics.Generic Amazonka.Comprehend.DetectTargetedSentiment.DetectTargetedSentimentResponse instance GHC.Show.Show Amazonka.Comprehend.DetectTargetedSentiment.DetectTargetedSentimentResponse instance GHC.Classes.Eq Amazonka.Comprehend.DetectTargetedSentiment.DetectTargetedSentimentResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.DetectTargetedSentiment.DetectTargetedSentiment instance Control.DeepSeq.NFData Amazonka.Comprehend.DetectTargetedSentiment.DetectTargetedSentimentResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.DetectTargetedSentiment.DetectTargetedSentiment instance Control.DeepSeq.NFData Amazonka.Comprehend.DetectTargetedSentiment.DetectTargetedSentiment instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.DetectTargetedSentiment.DetectTargetedSentiment instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.DetectTargetedSentiment.DetectTargetedSentiment instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.DetectTargetedSentiment.DetectTargetedSentiment instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.DetectTargetedSentiment.DetectTargetedSentiment -- | Inspects text for syntax and the part of speech of words in the -- document. For more information, see Syntax in the Comprehend -- Developer Guide. module Amazonka.Comprehend.DetectSyntax -- | See: newDetectSyntax smart constructor. data DetectSyntax DetectSyntax' :: Sensitive Text -> SyntaxLanguageCode -> DetectSyntax -- | A UTF-8 string. The maximum string size is 5 KB. [$sel:text:DetectSyntax'] :: DetectSyntax -> Sensitive Text -- | The language code of the input documents. You can specify any of the -- following languages supported by Amazon Comprehend: German ("de"), -- English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or -- Portuguese ("pt"). [$sel:languageCode:DetectSyntax'] :: DetectSyntax -> SyntaxLanguageCode -- | Create a value of DetectSyntax with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DetectSyntax, detectSyntax_text - A UTF-8 string. The -- maximum string size is 5 KB. -- -- DetectSyntax, detectSyntax_languageCode - The language -- code of the input documents. You can specify any of the following -- languages supported by Amazon Comprehend: German ("de"), English -- ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese -- ("pt"). newDetectSyntax :: Text -> SyntaxLanguageCode -> DetectSyntax -- | A UTF-8 string. The maximum string size is 5 KB. detectSyntax_text :: Lens' DetectSyntax Text -- | The language code of the input documents. You can specify any of the -- following languages supported by Amazon Comprehend: German ("de"), -- English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or -- Portuguese ("pt"). detectSyntax_languageCode :: Lens' DetectSyntax SyntaxLanguageCode -- | See: newDetectSyntaxResponse smart constructor. data DetectSyntaxResponse DetectSyntaxResponse' :: Maybe [SyntaxToken] -> Int -> DetectSyntaxResponse -- | A collection of syntax tokens describing the text. For each token, the -- response provides the text, the token type, where the text begins and -- ends, and the level of confidence that Amazon Comprehend has that the -- token is correct. For a list of token types, see Syntax in the -- Comprehend Developer Guide. [$sel:syntaxTokens:DetectSyntaxResponse'] :: DetectSyntaxResponse -> Maybe [SyntaxToken] -- | The response's http status code. [$sel:httpStatus:DetectSyntaxResponse'] :: DetectSyntaxResponse -> Int -- | Create a value of DetectSyntaxResponse with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DetectSyntaxResponse, detectSyntaxResponse_syntaxTokens -- - A collection of syntax tokens describing the text. For each token, -- the response provides the text, the token type, where the text begins -- and ends, and the level of confidence that Amazon Comprehend has that -- the token is correct. For a list of token types, see Syntax in -- the Comprehend Developer Guide. -- -- $sel:httpStatus:DetectSyntaxResponse', -- detectSyntaxResponse_httpStatus - The response's http status -- code. newDetectSyntaxResponse :: Int -> DetectSyntaxResponse -- | A collection of syntax tokens describing the text. For each token, the -- response provides the text, the token type, where the text begins and -- ends, and the level of confidence that Amazon Comprehend has that the -- token is correct. For a list of token types, see Syntax in the -- Comprehend Developer Guide. detectSyntaxResponse_syntaxTokens :: Lens' DetectSyntaxResponse (Maybe [SyntaxToken]) -- | The response's http status code. detectSyntaxResponse_httpStatus :: Lens' DetectSyntaxResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.DetectSyntax.DetectSyntax instance GHC.Show.Show Amazonka.Comprehend.DetectSyntax.DetectSyntax instance GHC.Classes.Eq Amazonka.Comprehend.DetectSyntax.DetectSyntax instance GHC.Generics.Generic Amazonka.Comprehend.DetectSyntax.DetectSyntaxResponse instance GHC.Show.Show Amazonka.Comprehend.DetectSyntax.DetectSyntaxResponse instance GHC.Classes.Eq Amazonka.Comprehend.DetectSyntax.DetectSyntaxResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.DetectSyntax.DetectSyntax instance Control.DeepSeq.NFData Amazonka.Comprehend.DetectSyntax.DetectSyntaxResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.DetectSyntax.DetectSyntax instance Control.DeepSeq.NFData Amazonka.Comprehend.DetectSyntax.DetectSyntax instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.DetectSyntax.DetectSyntax instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.DetectSyntax.DetectSyntax instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.DetectSyntax.DetectSyntax instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.DetectSyntax.DetectSyntax -- | Inspects text and returns an inference of the prevailing sentiment -- (POSITIVE, NEUTRAL, MIXED, or -- NEGATIVE). module Amazonka.Comprehend.DetectSentiment -- | See: newDetectSentiment smart constructor. data DetectSentiment DetectSentiment' :: Sensitive Text -> LanguageCode -> DetectSentiment -- | A UTF-8 text string. The maximum string size is 5 KB. -- -- Amazon Comprehend performs real-time sentiment analysis on the first -- 500 characters of the input text and ignores any additional text in -- the input. [$sel:text:DetectSentiment'] :: DetectSentiment -> Sensitive Text -- | The language of the input documents. You can specify any of the -- primary languages supported by Amazon Comprehend. All documents must -- be in the same language. [$sel:languageCode:DetectSentiment'] :: DetectSentiment -> LanguageCode -- | Create a value of DetectSentiment with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DetectSentiment, detectSentiment_text - A UTF-8 text -- string. The maximum string size is 5 KB. -- -- Amazon Comprehend performs real-time sentiment analysis on the first -- 500 characters of the input text and ignores any additional text in -- the input. -- -- DetectSentiment, detectSentiment_languageCode - The -- language of the input documents. You can specify any of the primary -- languages supported by Amazon Comprehend. All documents must be in the -- same language. newDetectSentiment :: Text -> LanguageCode -> DetectSentiment -- | A UTF-8 text string. The maximum string size is 5 KB. -- -- Amazon Comprehend performs real-time sentiment analysis on the first -- 500 characters of the input text and ignores any additional text in -- the input. detectSentiment_text :: Lens' DetectSentiment Text -- | The language of the input documents. You can specify any of the -- primary languages supported by Amazon Comprehend. All documents must -- be in the same language. detectSentiment_languageCode :: Lens' DetectSentiment LanguageCode -- | See: newDetectSentimentResponse smart constructor. data DetectSentimentResponse DetectSentimentResponse' :: Maybe SentimentType -> Maybe SentimentScore -> Int -> DetectSentimentResponse -- | The inferred sentiment that Amazon Comprehend has the highest level of -- confidence in. [$sel:sentiment:DetectSentimentResponse'] :: DetectSentimentResponse -> Maybe SentimentType -- | An object that lists the sentiments, and their corresponding -- confidence levels. [$sel:sentimentScore:DetectSentimentResponse'] :: DetectSentimentResponse -> Maybe SentimentScore -- | The response's http status code. [$sel:httpStatus:DetectSentimentResponse'] :: DetectSentimentResponse -> Int -- | Create a value of DetectSentimentResponse with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DetectSentimentResponse, -- detectSentimentResponse_sentiment - The inferred sentiment that -- Amazon Comprehend has the highest level of confidence in. -- -- DetectSentimentResponse, -- detectSentimentResponse_sentimentScore - An object that lists -- the sentiments, and their corresponding confidence levels. -- -- $sel:httpStatus:DetectSentimentResponse', -- detectSentimentResponse_httpStatus - The response's http status -- code. newDetectSentimentResponse :: Int -> DetectSentimentResponse -- | The inferred sentiment that Amazon Comprehend has the highest level of -- confidence in. detectSentimentResponse_sentiment :: Lens' DetectSentimentResponse (Maybe SentimentType) -- | An object that lists the sentiments, and their corresponding -- confidence levels. detectSentimentResponse_sentimentScore :: Lens' DetectSentimentResponse (Maybe SentimentScore) -- | The response's http status code. detectSentimentResponse_httpStatus :: Lens' DetectSentimentResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.DetectSentiment.DetectSentiment instance GHC.Show.Show Amazonka.Comprehend.DetectSentiment.DetectSentiment instance GHC.Classes.Eq Amazonka.Comprehend.DetectSentiment.DetectSentiment instance GHC.Generics.Generic Amazonka.Comprehend.DetectSentiment.DetectSentimentResponse instance GHC.Show.Show Amazonka.Comprehend.DetectSentiment.DetectSentimentResponse instance GHC.Classes.Eq Amazonka.Comprehend.DetectSentiment.DetectSentimentResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.DetectSentiment.DetectSentiment instance Control.DeepSeq.NFData Amazonka.Comprehend.DetectSentiment.DetectSentimentResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.DetectSentiment.DetectSentiment instance Control.DeepSeq.NFData Amazonka.Comprehend.DetectSentiment.DetectSentiment instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.DetectSentiment.DetectSentiment instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.DetectSentiment.DetectSentiment instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.DetectSentiment.DetectSentiment instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.DetectSentiment.DetectSentiment -- | Inspects the input text for entities that contain personally -- identifiable information (PII) and returns information about them. module Amazonka.Comprehend.DetectPiiEntities -- | See: newDetectPiiEntities smart constructor. data DetectPiiEntities DetectPiiEntities' :: Text -> LanguageCode -> DetectPiiEntities -- | A UTF-8 text string. The maximum string size is 100 KB. [$sel:text:DetectPiiEntities'] :: DetectPiiEntities -> Text -- | The language of the input documents. Currently, English is the only -- valid language. [$sel:languageCode:DetectPiiEntities'] :: DetectPiiEntities -> LanguageCode -- | Create a value of DetectPiiEntities with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DetectPiiEntities, detectPiiEntities_text - A UTF-8 text -- string. The maximum string size is 100 KB. -- -- DetectPiiEntities, detectPiiEntities_languageCode - The -- language of the input documents. Currently, English is the only valid -- language. newDetectPiiEntities :: Text -> LanguageCode -> DetectPiiEntities -- | A UTF-8 text string. The maximum string size is 100 KB. detectPiiEntities_text :: Lens' DetectPiiEntities Text -- | The language of the input documents. Currently, English is the only -- valid language. detectPiiEntities_languageCode :: Lens' DetectPiiEntities LanguageCode -- | See: newDetectPiiEntitiesResponse smart constructor. data DetectPiiEntitiesResponse DetectPiiEntitiesResponse' :: Maybe [PiiEntity] -> Int -> DetectPiiEntitiesResponse -- | A collection of PII entities identified in the input text. For each -- entity, the response provides the entity type, where the entity text -- begins and ends, and the level of confidence that Amazon Comprehend -- has in the detection. [$sel:entities:DetectPiiEntitiesResponse'] :: DetectPiiEntitiesResponse -> Maybe [PiiEntity] -- | The response's http status code. [$sel:httpStatus:DetectPiiEntitiesResponse'] :: DetectPiiEntitiesResponse -> Int -- | Create a value of DetectPiiEntitiesResponse with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DetectPiiEntitiesResponse, -- detectPiiEntitiesResponse_entities - A collection of PII -- entities identified in the input text. For each entity, the response -- provides the entity type, where the entity text begins and ends, and -- the level of confidence that Amazon Comprehend has in the detection. -- -- $sel:httpStatus:DetectPiiEntitiesResponse', -- detectPiiEntitiesResponse_httpStatus - The response's http -- status code. newDetectPiiEntitiesResponse :: Int -> DetectPiiEntitiesResponse -- | A collection of PII entities identified in the input text. For each -- entity, the response provides the entity type, where the entity text -- begins and ends, and the level of confidence that Amazon Comprehend -- has in the detection. detectPiiEntitiesResponse_entities :: Lens' DetectPiiEntitiesResponse (Maybe [PiiEntity]) -- | The response's http status code. detectPiiEntitiesResponse_httpStatus :: Lens' DetectPiiEntitiesResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.DetectPiiEntities.DetectPiiEntities instance GHC.Show.Show Amazonka.Comprehend.DetectPiiEntities.DetectPiiEntities instance GHC.Read.Read Amazonka.Comprehend.DetectPiiEntities.DetectPiiEntities instance GHC.Classes.Eq Amazonka.Comprehend.DetectPiiEntities.DetectPiiEntities instance GHC.Generics.Generic Amazonka.Comprehend.DetectPiiEntities.DetectPiiEntitiesResponse instance GHC.Show.Show Amazonka.Comprehend.DetectPiiEntities.DetectPiiEntitiesResponse instance GHC.Read.Read Amazonka.Comprehend.DetectPiiEntities.DetectPiiEntitiesResponse instance GHC.Classes.Eq Amazonka.Comprehend.DetectPiiEntities.DetectPiiEntitiesResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.DetectPiiEntities.DetectPiiEntities instance Control.DeepSeq.NFData Amazonka.Comprehend.DetectPiiEntities.DetectPiiEntitiesResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.DetectPiiEntities.DetectPiiEntities instance Control.DeepSeq.NFData Amazonka.Comprehend.DetectPiiEntities.DetectPiiEntities instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.DetectPiiEntities.DetectPiiEntities instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.DetectPiiEntities.DetectPiiEntities instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.DetectPiiEntities.DetectPiiEntities instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.DetectPiiEntities.DetectPiiEntities -- | Detects the key noun phrases found in the text. module Amazonka.Comprehend.DetectKeyPhrases -- | See: newDetectKeyPhrases smart constructor. data DetectKeyPhrases DetectKeyPhrases' :: Sensitive Text -> LanguageCode -> DetectKeyPhrases -- | A UTF-8 text string. The string must contain less than 100 KB of UTF-8 -- encoded characters. [$sel:text:DetectKeyPhrases'] :: DetectKeyPhrases -> Sensitive Text -- | The language of the input documents. You can specify any of the -- primary languages supported by Amazon Comprehend. All documents must -- be in the same language. [$sel:languageCode:DetectKeyPhrases'] :: DetectKeyPhrases -> LanguageCode -- | Create a value of DetectKeyPhrases with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DetectKeyPhrases, detectKeyPhrases_text - A UTF-8 text -- string. The string must contain less than 100 KB of UTF-8 encoded -- characters. -- -- DetectKeyPhrases, detectKeyPhrases_languageCode - The -- language of the input documents. You can specify any of the primary -- languages supported by Amazon Comprehend. All documents must be in the -- same language. newDetectKeyPhrases :: Text -> LanguageCode -> DetectKeyPhrases -- | A UTF-8 text string. The string must contain less than 100 KB of UTF-8 -- encoded characters. detectKeyPhrases_text :: Lens' DetectKeyPhrases Text -- | The language of the input documents. You can specify any of the -- primary languages supported by Amazon Comprehend. All documents must -- be in the same language. detectKeyPhrases_languageCode :: Lens' DetectKeyPhrases LanguageCode -- | See: newDetectKeyPhrasesResponse smart constructor. data DetectKeyPhrasesResponse DetectKeyPhrasesResponse' :: Maybe [KeyPhrase] -> Int -> DetectKeyPhrasesResponse -- | A collection of key phrases that Amazon Comprehend identified in the -- input text. For each key phrase, the response provides the text of the -- key phrase, where the key phrase begins and ends, and the level of -- confidence that Amazon Comprehend has in the accuracy of the -- detection. [$sel:keyPhrases:DetectKeyPhrasesResponse'] :: DetectKeyPhrasesResponse -> Maybe [KeyPhrase] -- | The response's http status code. [$sel:httpStatus:DetectKeyPhrasesResponse'] :: DetectKeyPhrasesResponse -> Int -- | Create a value of DetectKeyPhrasesResponse with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DetectKeyPhrasesResponse, -- detectKeyPhrasesResponse_keyPhrases - A collection of key -- phrases that Amazon Comprehend identified in the input text. For each -- key phrase, the response provides the text of the key phrase, where -- the key phrase begins and ends, and the level of confidence that -- Amazon Comprehend has in the accuracy of the detection. -- -- $sel:httpStatus:DetectKeyPhrasesResponse', -- detectKeyPhrasesResponse_httpStatus - The response's http -- status code. newDetectKeyPhrasesResponse :: Int -> DetectKeyPhrasesResponse -- | A collection of key phrases that Amazon Comprehend identified in the -- input text. For each key phrase, the response provides the text of the -- key phrase, where the key phrase begins and ends, and the level of -- confidence that Amazon Comprehend has in the accuracy of the -- detection. detectKeyPhrasesResponse_keyPhrases :: Lens' DetectKeyPhrasesResponse (Maybe [KeyPhrase]) -- | The response's http status code. detectKeyPhrasesResponse_httpStatus :: Lens' DetectKeyPhrasesResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.DetectKeyPhrases.DetectKeyPhrases instance GHC.Show.Show Amazonka.Comprehend.DetectKeyPhrases.DetectKeyPhrases instance GHC.Classes.Eq Amazonka.Comprehend.DetectKeyPhrases.DetectKeyPhrases instance GHC.Generics.Generic Amazonka.Comprehend.DetectKeyPhrases.DetectKeyPhrasesResponse instance GHC.Show.Show Amazonka.Comprehend.DetectKeyPhrases.DetectKeyPhrasesResponse instance GHC.Classes.Eq Amazonka.Comprehend.DetectKeyPhrases.DetectKeyPhrasesResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.DetectKeyPhrases.DetectKeyPhrases instance Control.DeepSeq.NFData Amazonka.Comprehend.DetectKeyPhrases.DetectKeyPhrasesResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.DetectKeyPhrases.DetectKeyPhrases instance Control.DeepSeq.NFData Amazonka.Comprehend.DetectKeyPhrases.DetectKeyPhrases instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.DetectKeyPhrases.DetectKeyPhrases instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.DetectKeyPhrases.DetectKeyPhrases instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.DetectKeyPhrases.DetectKeyPhrases instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.DetectKeyPhrases.DetectKeyPhrases -- | Detects named entities in input text when you use the pre-trained -- model. Detects custom entities if you have a custom entity recognition -- model. -- -- When detecting named entities using the pre-trained model, use plain -- text as the input. For more information about named entities, see -- Entities in the Comprehend Developer Guide. -- -- When you use a custom entity recognition model, you can input plain -- text or you can upload a single-page input document (text, PDF, Word, -- or image). -- -- If the system detects errors while processing a page in the input -- document, the API response includes an entry in Errors for -- each error. -- -- If the system detects a document-level error in your input document, -- the API returns an InvalidRequestException error response. -- For details about this exception, see Errors in semi-structured -- documents in the Comprehend Developer Guide. module Amazonka.Comprehend.DetectEntities -- | See: newDetectEntities smart constructor. data DetectEntities DetectEntities' :: Maybe Base64 -> Maybe DocumentReaderConfig -> Maybe Text -> Maybe LanguageCode -> Maybe (Sensitive Text) -> DetectEntities -- | This field applies only when you use a custom entity recognition model -- that was trained with PDF annotations. For other cases, enter your -- text input in the Text field. -- -- Use the Bytes parameter to input a text, PDF, Word or image -- file. Using a plain-text file in the Bytes parameter is -- equivelent to using the Text parameter (the Entities -- field in the response is identical). -- -- You can also use the Bytes parameter to input an Amazon -- Textract DetectDocumentText or AnalyzeDocument -- output file. -- -- Provide the input document as a sequence of base64-encoded bytes. If -- your code uses an Amazon Web Services SDK to detect entities, the SDK -- may encode the document file bytes for you. -- -- The maximum length of this field depends on the input document type. -- For details, see Inputs for real-time custom analysis in the -- Comprehend Developer Guide. -- -- If you use the Bytes parameter, do not use the Text -- parameter. [$sel:bytes:DetectEntities'] :: DetectEntities -> Maybe Base64 -- | Provides configuration parameters to override the default actions for -- extracting text from PDF documents and image files. [$sel:documentReaderConfig:DetectEntities'] :: DetectEntities -> Maybe DocumentReaderConfig -- | The Amazon Resource Name of an endpoint that is associated with a -- custom entity recognition model. Provide an endpoint if you want to -- detect entities by using your own custom model instead of the default -- model that is used by Amazon Comprehend. -- -- If you specify an endpoint, Amazon Comprehend uses the language of -- your custom model, and it ignores any language code that you provide -- in your request. -- -- For information about endpoints, see Managing endpoints. [$sel:endpointArn:DetectEntities'] :: DetectEntities -> Maybe Text -- | The language of the input documents. You can specify any of the -- primary languages supported by Amazon Comprehend. If your request -- includes the endpoint for a custom entity recognition model, Amazon -- Comprehend uses the language of your custom model, and it ignores any -- language code that you specify here. -- -- All input documents must be in the same language. [$sel:languageCode:DetectEntities'] :: DetectEntities -> Maybe LanguageCode -- | A UTF-8 text string. The maximum string size is 100 KB. If you enter -- text using this parameter, do not use the Bytes parameter. [$sel:text:DetectEntities'] :: DetectEntities -> Maybe (Sensitive Text) -- | Create a value of DetectEntities with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:bytes:DetectEntities', detectEntities_bytes - This -- field applies only when you use a custom entity recognition model that -- was trained with PDF annotations. For other cases, enter your text -- input in the Text field. -- -- Use the Bytes parameter to input a text, PDF, Word or image -- file. Using a plain-text file in the Bytes parameter is -- equivelent to using the Text parameter (the Entities -- field in the response is identical). -- -- You can also use the Bytes parameter to input an Amazon -- Textract DetectDocumentText or AnalyzeDocument -- output file. -- -- Provide the input document as a sequence of base64-encoded bytes. If -- your code uses an Amazon Web Services SDK to detect entities, the SDK -- may encode the document file bytes for you. -- -- The maximum length of this field depends on the input document type. -- For details, see Inputs for real-time custom analysis in the -- Comprehend Developer Guide. -- -- If you use the Bytes parameter, do not use the Text -- parameter.-- -- Note: This Lens automatically encodes -- and decodes Base64 data. -- The underlying isomorphism will encode to -- Base64 representation during -- serialisation, and decode from Base64 -- representation during deserialisation. -- This Lens accepts -- and returns only raw unencoded data. -- -- DetectEntities, detectEntities_documentReaderConfig - -- Provides configuration parameters to override the default actions for -- extracting text from PDF documents and image files. -- -- DetectEntities, detectEntities_endpointArn - The Amazon -- Resource Name of an endpoint that is associated with a custom entity -- recognition model. Provide an endpoint if you want to detect entities -- by using your own custom model instead of the default model that is -- used by Amazon Comprehend. -- -- If you specify an endpoint, Amazon Comprehend uses the language of -- your custom model, and it ignores any language code that you provide -- in your request. -- -- For information about endpoints, see Managing endpoints. -- -- DetectEntities, detectEntities_languageCode - The -- language of the input documents. You can specify any of the primary -- languages supported by Amazon Comprehend. If your request includes the -- endpoint for a custom entity recognition model, Amazon Comprehend uses -- the language of your custom model, and it ignores any language code -- that you specify here. -- -- All input documents must be in the same language. -- -- DetectEntities, detectEntities_text - A UTF-8 text -- string. The maximum string size is 100 KB. If you enter text using -- this parameter, do not use the Bytes parameter. newDetectEntities :: DetectEntities -- | This field applies only when you use a custom entity recognition model -- that was trained with PDF annotations. For other cases, enter your -- text input in the Text field. -- -- Use the Bytes parameter to input a text, PDF, Word or image -- file. Using a plain-text file in the Bytes parameter is -- equivelent to using the Text parameter (the Entities -- field in the response is identical). -- -- You can also use the Bytes parameter to input an Amazon -- Textract DetectDocumentText or AnalyzeDocument -- output file. -- -- Provide the input document as a sequence of base64-encoded bytes. If -- your code uses an Amazon Web Services SDK to detect entities, the SDK -- may encode the document file bytes for you. -- -- The maximum length of this field depends on the input document type. -- For details, see Inputs for real-time custom analysis in the -- Comprehend Developer Guide. -- -- If you use the Bytes parameter, do not use the Text -- parameter.-- -- Note: This Lens automatically encodes -- and decodes Base64 data. -- The underlying isomorphism will encode to -- Base64 representation during -- serialisation, and decode from Base64 -- representation during deserialisation. -- This Lens accepts -- and returns only raw unencoded data. detectEntities_bytes :: Lens' DetectEntities (Maybe ByteString) -- | Provides configuration parameters to override the default actions for -- extracting text from PDF documents and image files. detectEntities_documentReaderConfig :: Lens' DetectEntities (Maybe DocumentReaderConfig) -- | The Amazon Resource Name of an endpoint that is associated with a -- custom entity recognition model. Provide an endpoint if you want to -- detect entities by using your own custom model instead of the default -- model that is used by Amazon Comprehend. -- -- If you specify an endpoint, Amazon Comprehend uses the language of -- your custom model, and it ignores any language code that you provide -- in your request. -- -- For information about endpoints, see Managing endpoints. detectEntities_endpointArn :: Lens' DetectEntities (Maybe Text) -- | The language of the input documents. You can specify any of the -- primary languages supported by Amazon Comprehend. If your request -- includes the endpoint for a custom entity recognition model, Amazon -- Comprehend uses the language of your custom model, and it ignores any -- language code that you specify here. -- -- All input documents must be in the same language. detectEntities_languageCode :: Lens' DetectEntities (Maybe LanguageCode) -- | A UTF-8 text string. The maximum string size is 100 KB. If you enter -- text using this parameter, do not use the Bytes parameter. detectEntities_text :: Lens' DetectEntities (Maybe Text) -- | See: newDetectEntitiesResponse smart constructor. data DetectEntitiesResponse DetectEntitiesResponse' :: Maybe [Block] -> Maybe DocumentMetadata -> Maybe [DocumentTypeListItem] -> Maybe [Entity] -> Maybe [ErrorsListItem] -> Int -> DetectEntitiesResponse -- | Information about each block of text in the input document. Blocks are -- nested. A page block contains a block for each line of text, which -- contains a block for each word. -- -- The Block content for a Word input document does not include -- a Geometry field. -- -- The Block field is not present in the response for plain-text -- inputs. [$sel:blocks:DetectEntitiesResponse'] :: DetectEntitiesResponse -> Maybe [Block] -- | Information about the document, discovered during text extraction. -- This field is present in the response only if your request used the -- Byte parameter. [$sel:documentMetadata:DetectEntitiesResponse'] :: DetectEntitiesResponse -> Maybe DocumentMetadata -- | The document type for each page in the input document. This field is -- present in the response only if your request used the Byte -- parameter. [$sel:documentType:DetectEntitiesResponse'] :: DetectEntitiesResponse -> Maybe [DocumentTypeListItem] -- | A collection of entities identified in the input text. For each -- entity, the response provides the entity text, entity type, where the -- entity text begins and ends, and the level of confidence that Amazon -- Comprehend has in the detection. -- -- If your request uses a custom entity recognition model, Amazon -- Comprehend detects the entities that the model is trained to -- recognize. Otherwise, it detects the default entity types. For a list -- of default entity types, see Entities in the Comprehend -- Developer Guide. [$sel:entities:DetectEntitiesResponse'] :: DetectEntitiesResponse -> Maybe [Entity] -- | Page-level errors that the system detected while processing the input -- document. The field is empty if the system encountered no errors. [$sel:errors:DetectEntitiesResponse'] :: DetectEntitiesResponse -> Maybe [ErrorsListItem] -- | The response's http status code. [$sel:httpStatus:DetectEntitiesResponse'] :: DetectEntitiesResponse -> Int -- | Create a value of DetectEntitiesResponse with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:blocks:DetectEntitiesResponse', -- detectEntitiesResponse_blocks - Information about each block of -- text in the input document. Blocks are nested. A page block contains a -- block for each line of text, which contains a block for each word. -- -- The Block content for a Word input document does not include -- a Geometry field. -- -- The Block field is not present in the response for plain-text -- inputs. -- -- $sel:documentMetadata:DetectEntitiesResponse', -- detectEntitiesResponse_documentMetadata - Information about the -- document, discovered during text extraction. This field is present in -- the response only if your request used the Byte parameter. -- -- DetectEntitiesResponse, -- detectEntitiesResponse_documentType - The document type for -- each page in the input document. This field is present in the response -- only if your request used the Byte parameter. -- -- DetectEntitiesResponse, detectEntitiesResponse_entities -- - A collection of entities identified in the input text. For each -- entity, the response provides the entity text, entity type, where the -- entity text begins and ends, and the level of confidence that Amazon -- Comprehend has in the detection. -- -- If your request uses a custom entity recognition model, Amazon -- Comprehend detects the entities that the model is trained to -- recognize. Otherwise, it detects the default entity types. For a list -- of default entity types, see Entities in the Comprehend -- Developer Guide. -- -- $sel:errors:DetectEntitiesResponse', -- detectEntitiesResponse_errors - Page-level errors that the -- system detected while processing the input document. The field is -- empty if the system encountered no errors. -- -- $sel:httpStatus:DetectEntitiesResponse', -- detectEntitiesResponse_httpStatus - The response's http status -- code. newDetectEntitiesResponse :: Int -> DetectEntitiesResponse -- | Information about each block of text in the input document. Blocks are -- nested. A page block contains a block for each line of text, which -- contains a block for each word. -- -- The Block content for a Word input document does not include -- a Geometry field. -- -- The Block field is not present in the response for plain-text -- inputs. detectEntitiesResponse_blocks :: Lens' DetectEntitiesResponse (Maybe [Block]) -- | Information about the document, discovered during text extraction. -- This field is present in the response only if your request used the -- Byte parameter. detectEntitiesResponse_documentMetadata :: Lens' DetectEntitiesResponse (Maybe DocumentMetadata) -- | The document type for each page in the input document. This field is -- present in the response only if your request used the Byte -- parameter. detectEntitiesResponse_documentType :: Lens' DetectEntitiesResponse (Maybe [DocumentTypeListItem]) -- | A collection of entities identified in the input text. For each -- entity, the response provides the entity text, entity type, where the -- entity text begins and ends, and the level of confidence that Amazon -- Comprehend has in the detection. -- -- If your request uses a custom entity recognition model, Amazon -- Comprehend detects the entities that the model is trained to -- recognize. Otherwise, it detects the default entity types. For a list -- of default entity types, see Entities in the Comprehend -- Developer Guide. detectEntitiesResponse_entities :: Lens' DetectEntitiesResponse (Maybe [Entity]) -- | Page-level errors that the system detected while processing the input -- document. The field is empty if the system encountered no errors. detectEntitiesResponse_errors :: Lens' DetectEntitiesResponse (Maybe [ErrorsListItem]) -- | The response's http status code. detectEntitiesResponse_httpStatus :: Lens' DetectEntitiesResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.DetectEntities.DetectEntities instance GHC.Show.Show Amazonka.Comprehend.DetectEntities.DetectEntities instance GHC.Classes.Eq Amazonka.Comprehend.DetectEntities.DetectEntities instance GHC.Generics.Generic Amazonka.Comprehend.DetectEntities.DetectEntitiesResponse instance GHC.Show.Show Amazonka.Comprehend.DetectEntities.DetectEntitiesResponse instance GHC.Classes.Eq Amazonka.Comprehend.DetectEntities.DetectEntitiesResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.DetectEntities.DetectEntities instance Control.DeepSeq.NFData Amazonka.Comprehend.DetectEntities.DetectEntitiesResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.DetectEntities.DetectEntities instance Control.DeepSeq.NFData Amazonka.Comprehend.DetectEntities.DetectEntities instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.DetectEntities.DetectEntities instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.DetectEntities.DetectEntities instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.DetectEntities.DetectEntities instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.DetectEntities.DetectEntities -- | Determines the dominant language of the input text. For a list of -- languages that Amazon Comprehend can detect, see Amazon Comprehend -- Supported Languages. module Amazonka.Comprehend.DetectDominantLanguage -- | See: newDetectDominantLanguage smart constructor. data DetectDominantLanguage DetectDominantLanguage' :: Sensitive Text -> DetectDominantLanguage -- | A UTF-8 text string. The string must contain at least 20 characters. -- The maximum string size is 100 KB. [$sel:text:DetectDominantLanguage'] :: DetectDominantLanguage -> Sensitive Text -- | Create a value of DetectDominantLanguage with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DetectDominantLanguage, detectDominantLanguage_text - A -- UTF-8 text string. The string must contain at least 20 characters. The -- maximum string size is 100 KB. newDetectDominantLanguage :: Text -> DetectDominantLanguage -- | A UTF-8 text string. The string must contain at least 20 characters. -- The maximum string size is 100 KB. detectDominantLanguage_text :: Lens' DetectDominantLanguage Text -- | See: newDetectDominantLanguageResponse smart -- constructor. data DetectDominantLanguageResponse DetectDominantLanguageResponse' :: Maybe [DominantLanguage] -> Int -> DetectDominantLanguageResponse -- | The languages that Amazon Comprehend detected in the input text. For -- each language, the response returns the RFC 5646 language code and the -- level of confidence that Amazon Comprehend has in the accuracy of its -- inference. For more information about RFC 5646, see Tags for -- Identifying Languages on the IETF Tools web site. [$sel:languages:DetectDominantLanguageResponse'] :: DetectDominantLanguageResponse -> Maybe [DominantLanguage] -- | The response's http status code. [$sel:httpStatus:DetectDominantLanguageResponse'] :: DetectDominantLanguageResponse -> Int -- | Create a value of DetectDominantLanguageResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DetectDominantLanguageResponse, -- detectDominantLanguageResponse_languages - The languages that -- Amazon Comprehend detected in the input text. For each language, the -- response returns the RFC 5646 language code and the level of -- confidence that Amazon Comprehend has in the accuracy of its -- inference. For more information about RFC 5646, see Tags for -- Identifying Languages on the IETF Tools web site. -- -- $sel:httpStatus:DetectDominantLanguageResponse', -- detectDominantLanguageResponse_httpStatus - The response's http -- status code. newDetectDominantLanguageResponse :: Int -> DetectDominantLanguageResponse -- | The languages that Amazon Comprehend detected in the input text. For -- each language, the response returns the RFC 5646 language code and the -- level of confidence that Amazon Comprehend has in the accuracy of its -- inference. For more information about RFC 5646, see Tags for -- Identifying Languages on the IETF Tools web site. detectDominantLanguageResponse_languages :: Lens' DetectDominantLanguageResponse (Maybe [DominantLanguage]) -- | The response's http status code. detectDominantLanguageResponse_httpStatus :: Lens' DetectDominantLanguageResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.DetectDominantLanguage.DetectDominantLanguage instance GHC.Show.Show Amazonka.Comprehend.DetectDominantLanguage.DetectDominantLanguage instance GHC.Classes.Eq Amazonka.Comprehend.DetectDominantLanguage.DetectDominantLanguage instance GHC.Generics.Generic Amazonka.Comprehend.DetectDominantLanguage.DetectDominantLanguageResponse instance GHC.Show.Show Amazonka.Comprehend.DetectDominantLanguage.DetectDominantLanguageResponse instance GHC.Classes.Eq Amazonka.Comprehend.DetectDominantLanguage.DetectDominantLanguageResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.DetectDominantLanguage.DetectDominantLanguage instance Control.DeepSeq.NFData Amazonka.Comprehend.DetectDominantLanguage.DetectDominantLanguageResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.DetectDominantLanguage.DetectDominantLanguage instance Control.DeepSeq.NFData Amazonka.Comprehend.DetectDominantLanguage.DetectDominantLanguage instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.DetectDominantLanguage.DetectDominantLanguage instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.DetectDominantLanguage.DetectDominantLanguage instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.DetectDominantLanguage.DetectDominantLanguage instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.DetectDominantLanguage.DetectDominantLanguage -- | Gets the properties associated with a topic detection job. Use this -- operation to get the status of a detection job. module Amazonka.Comprehend.DescribeTopicsDetectionJob -- | See: newDescribeTopicsDetectionJob smart constructor. data DescribeTopicsDetectionJob DescribeTopicsDetectionJob' :: Text -> DescribeTopicsDetectionJob -- | The identifier assigned by the user to the detection job. [$sel:jobId:DescribeTopicsDetectionJob'] :: DescribeTopicsDetectionJob -> Text -- | Create a value of DescribeTopicsDetectionJob with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DescribeTopicsDetectionJob, -- describeTopicsDetectionJob_jobId - The identifier assigned by -- the user to the detection job. newDescribeTopicsDetectionJob :: Text -> DescribeTopicsDetectionJob -- | The identifier assigned by the user to the detection job. describeTopicsDetectionJob_jobId :: Lens' DescribeTopicsDetectionJob Text -- | See: newDescribeTopicsDetectionJobResponse smart -- constructor. data DescribeTopicsDetectionJobResponse DescribeTopicsDetectionJobResponse' :: Maybe TopicsDetectionJobProperties -> Int -> DescribeTopicsDetectionJobResponse -- | The list of properties for the requested job. [$sel:topicsDetectionJobProperties:DescribeTopicsDetectionJobResponse'] :: DescribeTopicsDetectionJobResponse -> Maybe TopicsDetectionJobProperties -- | The response's http status code. [$sel:httpStatus:DescribeTopicsDetectionJobResponse'] :: DescribeTopicsDetectionJobResponse -> Int -- | Create a value of DescribeTopicsDetectionJobResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:topicsDetectionJobProperties:DescribeTopicsDetectionJobResponse', -- describeTopicsDetectionJobResponse_topicsDetectionJobProperties -- - The list of properties for the requested job. -- -- $sel:httpStatus:DescribeTopicsDetectionJobResponse', -- describeTopicsDetectionJobResponse_httpStatus - The response's -- http status code. newDescribeTopicsDetectionJobResponse :: Int -> DescribeTopicsDetectionJobResponse -- | The list of properties for the requested job. describeTopicsDetectionJobResponse_topicsDetectionJobProperties :: Lens' DescribeTopicsDetectionJobResponse (Maybe TopicsDetectionJobProperties) -- | The response's http status code. describeTopicsDetectionJobResponse_httpStatus :: Lens' DescribeTopicsDetectionJobResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.DescribeTopicsDetectionJob.DescribeTopicsDetectionJob instance GHC.Show.Show Amazonka.Comprehend.DescribeTopicsDetectionJob.DescribeTopicsDetectionJob instance GHC.Read.Read Amazonka.Comprehend.DescribeTopicsDetectionJob.DescribeTopicsDetectionJob instance GHC.Classes.Eq Amazonka.Comprehend.DescribeTopicsDetectionJob.DescribeTopicsDetectionJob instance GHC.Generics.Generic Amazonka.Comprehend.DescribeTopicsDetectionJob.DescribeTopicsDetectionJobResponse instance GHC.Show.Show Amazonka.Comprehend.DescribeTopicsDetectionJob.DescribeTopicsDetectionJobResponse instance GHC.Read.Read Amazonka.Comprehend.DescribeTopicsDetectionJob.DescribeTopicsDetectionJobResponse instance GHC.Classes.Eq Amazonka.Comprehend.DescribeTopicsDetectionJob.DescribeTopicsDetectionJobResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.DescribeTopicsDetectionJob.DescribeTopicsDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.DescribeTopicsDetectionJob.DescribeTopicsDetectionJobResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.DescribeTopicsDetectionJob.DescribeTopicsDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.DescribeTopicsDetectionJob.DescribeTopicsDetectionJob instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.DescribeTopicsDetectionJob.DescribeTopicsDetectionJob instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.DescribeTopicsDetectionJob.DescribeTopicsDetectionJob instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.DescribeTopicsDetectionJob.DescribeTopicsDetectionJob instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.DescribeTopicsDetectionJob.DescribeTopicsDetectionJob -- | Gets the properties associated with a targeted sentiment detection -- job. Use this operation to get the status of the job. module Amazonka.Comprehend.DescribeTargetedSentimentDetectionJob -- | See: newDescribeTargetedSentimentDetectionJob smart -- constructor. data DescribeTargetedSentimentDetectionJob DescribeTargetedSentimentDetectionJob' :: Text -> DescribeTargetedSentimentDetectionJob -- | The identifier that Amazon Comprehend generated for the job. The -- operation returns this identifier in its response. [$sel:jobId:DescribeTargetedSentimentDetectionJob'] :: DescribeTargetedSentimentDetectionJob -> Text -- | Create a value of DescribeTargetedSentimentDetectionJob with -- all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DescribeTargetedSentimentDetectionJob, -- describeTargetedSentimentDetectionJob_jobId - The identifier -- that Amazon Comprehend generated for the job. The operation returns -- this identifier in its response. newDescribeTargetedSentimentDetectionJob :: Text -> DescribeTargetedSentimentDetectionJob -- | The identifier that Amazon Comprehend generated for the job. The -- operation returns this identifier in its response. describeTargetedSentimentDetectionJob_jobId :: Lens' DescribeTargetedSentimentDetectionJob Text -- | See: newDescribeTargetedSentimentDetectionJobResponse -- smart constructor. data DescribeTargetedSentimentDetectionJobResponse DescribeTargetedSentimentDetectionJobResponse' :: Maybe TargetedSentimentDetectionJobProperties -> Int -> DescribeTargetedSentimentDetectionJobResponse -- | An object that contains the properties associated with a targeted -- sentiment detection job. [$sel:targetedSentimentDetectionJobProperties:DescribeTargetedSentimentDetectionJobResponse'] :: DescribeTargetedSentimentDetectionJobResponse -> Maybe TargetedSentimentDetectionJobProperties -- | The response's http status code. [$sel:httpStatus:DescribeTargetedSentimentDetectionJobResponse'] :: DescribeTargetedSentimentDetectionJobResponse -> Int -- | Create a value of DescribeTargetedSentimentDetectionJobResponse -- with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:targetedSentimentDetectionJobProperties:DescribeTargetedSentimentDetectionJobResponse', -- describeTargetedSentimentDetectionJobResponse_targetedSentimentDetectionJobProperties -- - An object that contains the properties associated with a targeted -- sentiment detection job. -- -- $sel:httpStatus:DescribeTargetedSentimentDetectionJobResponse', -- describeTargetedSentimentDetectionJobResponse_httpStatus - The -- response's http status code. newDescribeTargetedSentimentDetectionJobResponse :: Int -> DescribeTargetedSentimentDetectionJobResponse -- | An object that contains the properties associated with a targeted -- sentiment detection job. describeTargetedSentimentDetectionJobResponse_targetedSentimentDetectionJobProperties :: Lens' DescribeTargetedSentimentDetectionJobResponse (Maybe TargetedSentimentDetectionJobProperties) -- | The response's http status code. describeTargetedSentimentDetectionJobResponse_httpStatus :: Lens' DescribeTargetedSentimentDetectionJobResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.DescribeTargetedSentimentDetectionJob.DescribeTargetedSentimentDetectionJob instance GHC.Show.Show Amazonka.Comprehend.DescribeTargetedSentimentDetectionJob.DescribeTargetedSentimentDetectionJob instance GHC.Read.Read Amazonka.Comprehend.DescribeTargetedSentimentDetectionJob.DescribeTargetedSentimentDetectionJob instance GHC.Classes.Eq Amazonka.Comprehend.DescribeTargetedSentimentDetectionJob.DescribeTargetedSentimentDetectionJob instance GHC.Generics.Generic Amazonka.Comprehend.DescribeTargetedSentimentDetectionJob.DescribeTargetedSentimentDetectionJobResponse instance GHC.Show.Show Amazonka.Comprehend.DescribeTargetedSentimentDetectionJob.DescribeTargetedSentimentDetectionJobResponse instance GHC.Read.Read Amazonka.Comprehend.DescribeTargetedSentimentDetectionJob.DescribeTargetedSentimentDetectionJobResponse instance GHC.Classes.Eq Amazonka.Comprehend.DescribeTargetedSentimentDetectionJob.DescribeTargetedSentimentDetectionJobResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.DescribeTargetedSentimentDetectionJob.DescribeTargetedSentimentDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.DescribeTargetedSentimentDetectionJob.DescribeTargetedSentimentDetectionJobResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.DescribeTargetedSentimentDetectionJob.DescribeTargetedSentimentDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.DescribeTargetedSentimentDetectionJob.DescribeTargetedSentimentDetectionJob instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.DescribeTargetedSentimentDetectionJob.DescribeTargetedSentimentDetectionJob instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.DescribeTargetedSentimentDetectionJob.DescribeTargetedSentimentDetectionJob instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.DescribeTargetedSentimentDetectionJob.DescribeTargetedSentimentDetectionJob instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.DescribeTargetedSentimentDetectionJob.DescribeTargetedSentimentDetectionJob -- | Gets the properties associated with a sentiment detection job. Use -- this operation to get the status of a detection job. module Amazonka.Comprehend.DescribeSentimentDetectionJob -- | See: newDescribeSentimentDetectionJob smart constructor. data DescribeSentimentDetectionJob DescribeSentimentDetectionJob' :: Text -> DescribeSentimentDetectionJob -- | The identifier that Amazon Comprehend generated for the job. The -- operation returns this identifier in its response. [$sel:jobId:DescribeSentimentDetectionJob'] :: DescribeSentimentDetectionJob -> Text -- | Create a value of DescribeSentimentDetectionJob with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DescribeSentimentDetectionJob, -- describeSentimentDetectionJob_jobId - The identifier that -- Amazon Comprehend generated for the job. The operation returns this -- identifier in its response. newDescribeSentimentDetectionJob :: Text -> DescribeSentimentDetectionJob -- | The identifier that Amazon Comprehend generated for the job. The -- operation returns this identifier in its response. describeSentimentDetectionJob_jobId :: Lens' DescribeSentimentDetectionJob Text -- | See: newDescribeSentimentDetectionJobResponse smart -- constructor. data DescribeSentimentDetectionJobResponse DescribeSentimentDetectionJobResponse' :: Maybe SentimentDetectionJobProperties -> Int -> DescribeSentimentDetectionJobResponse -- | An object that contains the properties associated with a sentiment -- detection job. [$sel:sentimentDetectionJobProperties:DescribeSentimentDetectionJobResponse'] :: DescribeSentimentDetectionJobResponse -> Maybe SentimentDetectionJobProperties -- | The response's http status code. [$sel:httpStatus:DescribeSentimentDetectionJobResponse'] :: DescribeSentimentDetectionJobResponse -> Int -- | Create a value of DescribeSentimentDetectionJobResponse with -- all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:sentimentDetectionJobProperties:DescribeSentimentDetectionJobResponse', -- describeSentimentDetectionJobResponse_sentimentDetectionJobProperties -- - An object that contains the properties associated with a sentiment -- detection job. -- -- $sel:httpStatus:DescribeSentimentDetectionJobResponse', -- describeSentimentDetectionJobResponse_httpStatus - The -- response's http status code. newDescribeSentimentDetectionJobResponse :: Int -> DescribeSentimentDetectionJobResponse -- | An object that contains the properties associated with a sentiment -- detection job. describeSentimentDetectionJobResponse_sentimentDetectionJobProperties :: Lens' DescribeSentimentDetectionJobResponse (Maybe SentimentDetectionJobProperties) -- | The response's http status code. describeSentimentDetectionJobResponse_httpStatus :: Lens' DescribeSentimentDetectionJobResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.DescribeSentimentDetectionJob.DescribeSentimentDetectionJob instance GHC.Show.Show Amazonka.Comprehend.DescribeSentimentDetectionJob.DescribeSentimentDetectionJob instance GHC.Read.Read Amazonka.Comprehend.DescribeSentimentDetectionJob.DescribeSentimentDetectionJob instance GHC.Classes.Eq Amazonka.Comprehend.DescribeSentimentDetectionJob.DescribeSentimentDetectionJob instance GHC.Generics.Generic Amazonka.Comprehend.DescribeSentimentDetectionJob.DescribeSentimentDetectionJobResponse instance GHC.Show.Show Amazonka.Comprehend.DescribeSentimentDetectionJob.DescribeSentimentDetectionJobResponse instance GHC.Read.Read Amazonka.Comprehend.DescribeSentimentDetectionJob.DescribeSentimentDetectionJobResponse instance GHC.Classes.Eq Amazonka.Comprehend.DescribeSentimentDetectionJob.DescribeSentimentDetectionJobResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.DescribeSentimentDetectionJob.DescribeSentimentDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.DescribeSentimentDetectionJob.DescribeSentimentDetectionJobResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.DescribeSentimentDetectionJob.DescribeSentimentDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.DescribeSentimentDetectionJob.DescribeSentimentDetectionJob instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.DescribeSentimentDetectionJob.DescribeSentimentDetectionJob instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.DescribeSentimentDetectionJob.DescribeSentimentDetectionJob instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.DescribeSentimentDetectionJob.DescribeSentimentDetectionJob instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.DescribeSentimentDetectionJob.DescribeSentimentDetectionJob -- | Gets the details of a resource-based policy that is attached to a -- custom model, including the JSON body of the policy. module Amazonka.Comprehend.DescribeResourcePolicy -- | See: newDescribeResourcePolicy smart constructor. data DescribeResourcePolicy DescribeResourcePolicy' :: Text -> DescribeResourcePolicy -- | The Amazon Resource Name (ARN) of the custom model version that has -- the resource policy. [$sel:resourceArn:DescribeResourcePolicy'] :: DescribeResourcePolicy -> Text -- | Create a value of DescribeResourcePolicy with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:resourceArn:DescribeResourcePolicy', -- describeResourcePolicy_resourceArn - The Amazon Resource Name -- (ARN) of the custom model version that has the resource policy. newDescribeResourcePolicy :: Text -> DescribeResourcePolicy -- | The Amazon Resource Name (ARN) of the custom model version that has -- the resource policy. describeResourcePolicy_resourceArn :: Lens' DescribeResourcePolicy Text -- | See: newDescribeResourcePolicyResponse smart -- constructor. data DescribeResourcePolicyResponse DescribeResourcePolicyResponse' :: Maybe POSIX -> Maybe POSIX -> Maybe Text -> Maybe Text -> Int -> DescribeResourcePolicyResponse -- | The time at which the policy was created. [$sel:creationTime:DescribeResourcePolicyResponse'] :: DescribeResourcePolicyResponse -> Maybe POSIX -- | The time at which the policy was last modified. [$sel:lastModifiedTime:DescribeResourcePolicyResponse'] :: DescribeResourcePolicyResponse -> Maybe POSIX -- | The revision ID of the policy. Each time you modify a policy, Amazon -- Comprehend assigns a new revision ID, and it deletes the prior version -- of the policy. [$sel:policyRevisionId:DescribeResourcePolicyResponse'] :: DescribeResourcePolicyResponse -> Maybe Text -- | The JSON body of the resource-based policy. [$sel:resourcePolicy:DescribeResourcePolicyResponse'] :: DescribeResourcePolicyResponse -> Maybe Text -- | The response's http status code. [$sel:httpStatus:DescribeResourcePolicyResponse'] :: DescribeResourcePolicyResponse -> Int -- | Create a value of DescribeResourcePolicyResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DescribeResourcePolicyResponse, -- describeResourcePolicyResponse_creationTime - The time at which -- the policy was created. -- -- DescribeResourcePolicyResponse, -- describeResourcePolicyResponse_lastModifiedTime - The time at -- which the policy was last modified. -- -- $sel:policyRevisionId:DescribeResourcePolicyResponse', -- describeResourcePolicyResponse_policyRevisionId - The revision -- ID of the policy. Each time you modify a policy, Amazon Comprehend -- assigns a new revision ID, and it deletes the prior version of the -- policy. -- -- $sel:resourcePolicy:DescribeResourcePolicyResponse', -- describeResourcePolicyResponse_resourcePolicy - The JSON body -- of the resource-based policy. -- -- $sel:httpStatus:DescribeResourcePolicyResponse', -- describeResourcePolicyResponse_httpStatus - The response's http -- status code. newDescribeResourcePolicyResponse :: Int -> DescribeResourcePolicyResponse -- | The time at which the policy was created. describeResourcePolicyResponse_creationTime :: Lens' DescribeResourcePolicyResponse (Maybe UTCTime) -- | The time at which the policy was last modified. describeResourcePolicyResponse_lastModifiedTime :: Lens' DescribeResourcePolicyResponse (Maybe UTCTime) -- | The revision ID of the policy. Each time you modify a policy, Amazon -- Comprehend assigns a new revision ID, and it deletes the prior version -- of the policy. describeResourcePolicyResponse_policyRevisionId :: Lens' DescribeResourcePolicyResponse (Maybe Text) -- | The JSON body of the resource-based policy. describeResourcePolicyResponse_resourcePolicy :: Lens' DescribeResourcePolicyResponse (Maybe Text) -- | The response's http status code. describeResourcePolicyResponse_httpStatus :: Lens' DescribeResourcePolicyResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.DescribeResourcePolicy.DescribeResourcePolicy instance GHC.Show.Show Amazonka.Comprehend.DescribeResourcePolicy.DescribeResourcePolicy instance GHC.Read.Read Amazonka.Comprehend.DescribeResourcePolicy.DescribeResourcePolicy instance GHC.Classes.Eq Amazonka.Comprehend.DescribeResourcePolicy.DescribeResourcePolicy instance GHC.Generics.Generic Amazonka.Comprehend.DescribeResourcePolicy.DescribeResourcePolicyResponse instance GHC.Show.Show Amazonka.Comprehend.DescribeResourcePolicy.DescribeResourcePolicyResponse instance GHC.Read.Read Amazonka.Comprehend.DescribeResourcePolicy.DescribeResourcePolicyResponse instance GHC.Classes.Eq Amazonka.Comprehend.DescribeResourcePolicy.DescribeResourcePolicyResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.DescribeResourcePolicy.DescribeResourcePolicy instance Control.DeepSeq.NFData Amazonka.Comprehend.DescribeResourcePolicy.DescribeResourcePolicyResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.DescribeResourcePolicy.DescribeResourcePolicy instance Control.DeepSeq.NFData Amazonka.Comprehend.DescribeResourcePolicy.DescribeResourcePolicy instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.DescribeResourcePolicy.DescribeResourcePolicy instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.DescribeResourcePolicy.DescribeResourcePolicy instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.DescribeResourcePolicy.DescribeResourcePolicy instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.DescribeResourcePolicy.DescribeResourcePolicy -- | Gets the properties associated with a PII entities detection job. For -- example, you can use this operation to get the job status. module Amazonka.Comprehend.DescribePiiEntitiesDetectionJob -- | See: newDescribePiiEntitiesDetectionJob smart -- constructor. data DescribePiiEntitiesDetectionJob DescribePiiEntitiesDetectionJob' :: Text -> DescribePiiEntitiesDetectionJob -- | The identifier that Amazon Comprehend generated for the job. The -- operation returns this identifier in its response. [$sel:jobId:DescribePiiEntitiesDetectionJob'] :: DescribePiiEntitiesDetectionJob -> Text -- | Create a value of DescribePiiEntitiesDetectionJob with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DescribePiiEntitiesDetectionJob, -- describePiiEntitiesDetectionJob_jobId - The identifier that -- Amazon Comprehend generated for the job. The operation returns this -- identifier in its response. newDescribePiiEntitiesDetectionJob :: Text -> DescribePiiEntitiesDetectionJob -- | The identifier that Amazon Comprehend generated for the job. The -- operation returns this identifier in its response. describePiiEntitiesDetectionJob_jobId :: Lens' DescribePiiEntitiesDetectionJob Text -- | See: newDescribePiiEntitiesDetectionJobResponse smart -- constructor. data DescribePiiEntitiesDetectionJobResponse DescribePiiEntitiesDetectionJobResponse' :: Maybe PiiEntitiesDetectionJobProperties -> Int -> DescribePiiEntitiesDetectionJobResponse [$sel:piiEntitiesDetectionJobProperties:DescribePiiEntitiesDetectionJobResponse'] :: DescribePiiEntitiesDetectionJobResponse -> Maybe PiiEntitiesDetectionJobProperties -- | The response's http status code. [$sel:httpStatus:DescribePiiEntitiesDetectionJobResponse'] :: DescribePiiEntitiesDetectionJobResponse -> Int -- | Create a value of DescribePiiEntitiesDetectionJobResponse with -- all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:piiEntitiesDetectionJobProperties:DescribePiiEntitiesDetectionJobResponse', -- describePiiEntitiesDetectionJobResponse_piiEntitiesDetectionJobProperties -- - Undocumented member. -- -- $sel:httpStatus:DescribePiiEntitiesDetectionJobResponse', -- describePiiEntitiesDetectionJobResponse_httpStatus - The -- response's http status code. newDescribePiiEntitiesDetectionJobResponse :: Int -> DescribePiiEntitiesDetectionJobResponse -- | Undocumented member. describePiiEntitiesDetectionJobResponse_piiEntitiesDetectionJobProperties :: Lens' DescribePiiEntitiesDetectionJobResponse (Maybe PiiEntitiesDetectionJobProperties) -- | The response's http status code. describePiiEntitiesDetectionJobResponse_httpStatus :: Lens' DescribePiiEntitiesDetectionJobResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.DescribePiiEntitiesDetectionJob.DescribePiiEntitiesDetectionJob instance GHC.Show.Show Amazonka.Comprehend.DescribePiiEntitiesDetectionJob.DescribePiiEntitiesDetectionJob instance GHC.Read.Read Amazonka.Comprehend.DescribePiiEntitiesDetectionJob.DescribePiiEntitiesDetectionJob instance GHC.Classes.Eq Amazonka.Comprehend.DescribePiiEntitiesDetectionJob.DescribePiiEntitiesDetectionJob instance GHC.Generics.Generic Amazonka.Comprehend.DescribePiiEntitiesDetectionJob.DescribePiiEntitiesDetectionJobResponse instance GHC.Show.Show Amazonka.Comprehend.DescribePiiEntitiesDetectionJob.DescribePiiEntitiesDetectionJobResponse instance GHC.Read.Read Amazonka.Comprehend.DescribePiiEntitiesDetectionJob.DescribePiiEntitiesDetectionJobResponse instance GHC.Classes.Eq Amazonka.Comprehend.DescribePiiEntitiesDetectionJob.DescribePiiEntitiesDetectionJobResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.DescribePiiEntitiesDetectionJob.DescribePiiEntitiesDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.DescribePiiEntitiesDetectionJob.DescribePiiEntitiesDetectionJobResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.DescribePiiEntitiesDetectionJob.DescribePiiEntitiesDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.DescribePiiEntitiesDetectionJob.DescribePiiEntitiesDetectionJob instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.DescribePiiEntitiesDetectionJob.DescribePiiEntitiesDetectionJob instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.DescribePiiEntitiesDetectionJob.DescribePiiEntitiesDetectionJob instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.DescribePiiEntitiesDetectionJob.DescribePiiEntitiesDetectionJob instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.DescribePiiEntitiesDetectionJob.DescribePiiEntitiesDetectionJob -- | Gets the properties associated with a key phrases detection job. Use -- this operation to get the status of a detection job. module Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob -- | See: newDescribeKeyPhrasesDetectionJob smart -- constructor. data DescribeKeyPhrasesDetectionJob DescribeKeyPhrasesDetectionJob' :: Text -> DescribeKeyPhrasesDetectionJob -- | The identifier that Amazon Comprehend generated for the job. The -- operation returns this identifier in its response. [$sel:jobId:DescribeKeyPhrasesDetectionJob'] :: DescribeKeyPhrasesDetectionJob -> Text -- | Create a value of DescribeKeyPhrasesDetectionJob with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DescribeKeyPhrasesDetectionJob, -- describeKeyPhrasesDetectionJob_jobId - The identifier that -- Amazon Comprehend generated for the job. The operation returns this -- identifier in its response. newDescribeKeyPhrasesDetectionJob :: Text -> DescribeKeyPhrasesDetectionJob -- | The identifier that Amazon Comprehend generated for the job. The -- operation returns this identifier in its response. describeKeyPhrasesDetectionJob_jobId :: Lens' DescribeKeyPhrasesDetectionJob Text -- | See: newDescribeKeyPhrasesDetectionJobResponse smart -- constructor. data DescribeKeyPhrasesDetectionJobResponse DescribeKeyPhrasesDetectionJobResponse' :: Maybe KeyPhrasesDetectionJobProperties -> Int -> DescribeKeyPhrasesDetectionJobResponse -- | An object that contains the properties associated with a key phrases -- detection job. [$sel:keyPhrasesDetectionJobProperties:DescribeKeyPhrasesDetectionJobResponse'] :: DescribeKeyPhrasesDetectionJobResponse -> Maybe KeyPhrasesDetectionJobProperties -- | The response's http status code. [$sel:httpStatus:DescribeKeyPhrasesDetectionJobResponse'] :: DescribeKeyPhrasesDetectionJobResponse -> Int -- | Create a value of DescribeKeyPhrasesDetectionJobResponse with -- all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:keyPhrasesDetectionJobProperties:DescribeKeyPhrasesDetectionJobResponse', -- describeKeyPhrasesDetectionJobResponse_keyPhrasesDetectionJobProperties -- - An object that contains the properties associated with a key phrases -- detection job. -- -- $sel:httpStatus:DescribeKeyPhrasesDetectionJobResponse', -- describeKeyPhrasesDetectionJobResponse_httpStatus - The -- response's http status code. newDescribeKeyPhrasesDetectionJobResponse :: Int -> DescribeKeyPhrasesDetectionJobResponse -- | An object that contains the properties associated with a key phrases -- detection job. describeKeyPhrasesDetectionJobResponse_keyPhrasesDetectionJobProperties :: Lens' DescribeKeyPhrasesDetectionJobResponse (Maybe KeyPhrasesDetectionJobProperties) -- | The response's http status code. describeKeyPhrasesDetectionJobResponse_httpStatus :: Lens' DescribeKeyPhrasesDetectionJobResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob.DescribeKeyPhrasesDetectionJob instance GHC.Show.Show Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob.DescribeKeyPhrasesDetectionJob instance GHC.Read.Read Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob.DescribeKeyPhrasesDetectionJob instance GHC.Classes.Eq Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob.DescribeKeyPhrasesDetectionJob instance GHC.Generics.Generic Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob.DescribeKeyPhrasesDetectionJobResponse instance GHC.Show.Show Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob.DescribeKeyPhrasesDetectionJobResponse instance GHC.Read.Read Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob.DescribeKeyPhrasesDetectionJobResponse instance GHC.Classes.Eq Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob.DescribeKeyPhrasesDetectionJobResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob.DescribeKeyPhrasesDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob.DescribeKeyPhrasesDetectionJobResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob.DescribeKeyPhrasesDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob.DescribeKeyPhrasesDetectionJob instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob.DescribeKeyPhrasesDetectionJob instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob.DescribeKeyPhrasesDetectionJob instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob.DescribeKeyPhrasesDetectionJob instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.DescribeKeyPhrasesDetectionJob.DescribeKeyPhrasesDetectionJob -- | Gets the status and details of an events detection job. module Amazonka.Comprehend.DescribeEventsDetectionJob -- | See: newDescribeEventsDetectionJob smart constructor. data DescribeEventsDetectionJob DescribeEventsDetectionJob' :: Text -> DescribeEventsDetectionJob -- | The identifier of the events detection job. [$sel:jobId:DescribeEventsDetectionJob'] :: DescribeEventsDetectionJob -> Text -- | Create a value of DescribeEventsDetectionJob with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DescribeEventsDetectionJob, -- describeEventsDetectionJob_jobId - The identifier of the events -- detection job. newDescribeEventsDetectionJob :: Text -> DescribeEventsDetectionJob -- | The identifier of the events detection job. describeEventsDetectionJob_jobId :: Lens' DescribeEventsDetectionJob Text -- | See: newDescribeEventsDetectionJobResponse smart -- constructor. data DescribeEventsDetectionJobResponse DescribeEventsDetectionJobResponse' :: Maybe EventsDetectionJobProperties -> Int -> DescribeEventsDetectionJobResponse -- | An object that contains the properties associated with an event -- detection job. [$sel:eventsDetectionJobProperties:DescribeEventsDetectionJobResponse'] :: DescribeEventsDetectionJobResponse -> Maybe EventsDetectionJobProperties -- | The response's http status code. [$sel:httpStatus:DescribeEventsDetectionJobResponse'] :: DescribeEventsDetectionJobResponse -> Int -- | Create a value of DescribeEventsDetectionJobResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:eventsDetectionJobProperties:DescribeEventsDetectionJobResponse', -- describeEventsDetectionJobResponse_eventsDetectionJobProperties -- - An object that contains the properties associated with an event -- detection job. -- -- $sel:httpStatus:DescribeEventsDetectionJobResponse', -- describeEventsDetectionJobResponse_httpStatus - The response's -- http status code. newDescribeEventsDetectionJobResponse :: Int -> DescribeEventsDetectionJobResponse -- | An object that contains the properties associated with an event -- detection job. describeEventsDetectionJobResponse_eventsDetectionJobProperties :: Lens' DescribeEventsDetectionJobResponse (Maybe EventsDetectionJobProperties) -- | The response's http status code. describeEventsDetectionJobResponse_httpStatus :: Lens' DescribeEventsDetectionJobResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.DescribeEventsDetectionJob.DescribeEventsDetectionJob instance GHC.Show.Show Amazonka.Comprehend.DescribeEventsDetectionJob.DescribeEventsDetectionJob instance GHC.Read.Read Amazonka.Comprehend.DescribeEventsDetectionJob.DescribeEventsDetectionJob instance GHC.Classes.Eq Amazonka.Comprehend.DescribeEventsDetectionJob.DescribeEventsDetectionJob instance GHC.Generics.Generic Amazonka.Comprehend.DescribeEventsDetectionJob.DescribeEventsDetectionJobResponse instance GHC.Show.Show Amazonka.Comprehend.DescribeEventsDetectionJob.DescribeEventsDetectionJobResponse instance GHC.Read.Read Amazonka.Comprehend.DescribeEventsDetectionJob.DescribeEventsDetectionJobResponse instance GHC.Classes.Eq Amazonka.Comprehend.DescribeEventsDetectionJob.DescribeEventsDetectionJobResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.DescribeEventsDetectionJob.DescribeEventsDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.DescribeEventsDetectionJob.DescribeEventsDetectionJobResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.DescribeEventsDetectionJob.DescribeEventsDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.DescribeEventsDetectionJob.DescribeEventsDetectionJob instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.DescribeEventsDetectionJob.DescribeEventsDetectionJob instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.DescribeEventsDetectionJob.DescribeEventsDetectionJob instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.DescribeEventsDetectionJob.DescribeEventsDetectionJob instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.DescribeEventsDetectionJob.DescribeEventsDetectionJob -- | Provides details about an entity recognizer including status, S3 -- buckets containing training data, recognizer metadata, metrics, and so -- on. module Amazonka.Comprehend.DescribeEntityRecognizer -- | See: newDescribeEntityRecognizer smart constructor. data DescribeEntityRecognizer DescribeEntityRecognizer' :: Text -> DescribeEntityRecognizer -- | The Amazon Resource Name (ARN) that identifies the entity recognizer. [$sel:entityRecognizerArn:DescribeEntityRecognizer'] :: DescribeEntityRecognizer -> Text -- | Create a value of DescribeEntityRecognizer with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DescribeEntityRecognizer, -- describeEntityRecognizer_entityRecognizerArn - The Amazon -- Resource Name (ARN) that identifies the entity recognizer. newDescribeEntityRecognizer :: Text -> DescribeEntityRecognizer -- | The Amazon Resource Name (ARN) that identifies the entity recognizer. describeEntityRecognizer_entityRecognizerArn :: Lens' DescribeEntityRecognizer Text -- | See: newDescribeEntityRecognizerResponse smart -- constructor. data DescribeEntityRecognizerResponse DescribeEntityRecognizerResponse' :: Maybe EntityRecognizerProperties -> Int -> DescribeEntityRecognizerResponse -- | Describes information associated with an entity recognizer. [$sel:entityRecognizerProperties:DescribeEntityRecognizerResponse'] :: DescribeEntityRecognizerResponse -> Maybe EntityRecognizerProperties -- | The response's http status code. [$sel:httpStatus:DescribeEntityRecognizerResponse'] :: DescribeEntityRecognizerResponse -> Int -- | Create a value of DescribeEntityRecognizerResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:entityRecognizerProperties:DescribeEntityRecognizerResponse', -- describeEntityRecognizerResponse_entityRecognizerProperties - -- Describes information associated with an entity recognizer. -- -- $sel:httpStatus:DescribeEntityRecognizerResponse', -- describeEntityRecognizerResponse_httpStatus - The response's -- http status code. newDescribeEntityRecognizerResponse :: Int -> DescribeEntityRecognizerResponse -- | Describes information associated with an entity recognizer. describeEntityRecognizerResponse_entityRecognizerProperties :: Lens' DescribeEntityRecognizerResponse (Maybe EntityRecognizerProperties) -- | The response's http status code. describeEntityRecognizerResponse_httpStatus :: Lens' DescribeEntityRecognizerResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.DescribeEntityRecognizer.DescribeEntityRecognizer instance GHC.Show.Show Amazonka.Comprehend.DescribeEntityRecognizer.DescribeEntityRecognizer instance GHC.Read.Read Amazonka.Comprehend.DescribeEntityRecognizer.DescribeEntityRecognizer instance GHC.Classes.Eq Amazonka.Comprehend.DescribeEntityRecognizer.DescribeEntityRecognizer instance GHC.Generics.Generic Amazonka.Comprehend.DescribeEntityRecognizer.DescribeEntityRecognizerResponse instance GHC.Show.Show Amazonka.Comprehend.DescribeEntityRecognizer.DescribeEntityRecognizerResponse instance GHC.Classes.Eq Amazonka.Comprehend.DescribeEntityRecognizer.DescribeEntityRecognizerResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.DescribeEntityRecognizer.DescribeEntityRecognizer instance Control.DeepSeq.NFData Amazonka.Comprehend.DescribeEntityRecognizer.DescribeEntityRecognizerResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.DescribeEntityRecognizer.DescribeEntityRecognizer instance Control.DeepSeq.NFData Amazonka.Comprehend.DescribeEntityRecognizer.DescribeEntityRecognizer instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.DescribeEntityRecognizer.DescribeEntityRecognizer instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.DescribeEntityRecognizer.DescribeEntityRecognizer instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.DescribeEntityRecognizer.DescribeEntityRecognizer instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.DescribeEntityRecognizer.DescribeEntityRecognizer -- | Gets the properties associated with an entities detection job. Use -- this operation to get the status of a detection job. module Amazonka.Comprehend.DescribeEntitiesDetectionJob -- | See: newDescribeEntitiesDetectionJob smart constructor. data DescribeEntitiesDetectionJob DescribeEntitiesDetectionJob' :: Text -> DescribeEntitiesDetectionJob -- | The identifier that Amazon Comprehend generated for the job. The -- operation returns this identifier in its response. [$sel:jobId:DescribeEntitiesDetectionJob'] :: DescribeEntitiesDetectionJob -> Text -- | Create a value of DescribeEntitiesDetectionJob with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DescribeEntitiesDetectionJob, -- describeEntitiesDetectionJob_jobId - The identifier that Amazon -- Comprehend generated for the job. The operation returns this -- identifier in its response. newDescribeEntitiesDetectionJob :: Text -> DescribeEntitiesDetectionJob -- | The identifier that Amazon Comprehend generated for the job. The -- operation returns this identifier in its response. describeEntitiesDetectionJob_jobId :: Lens' DescribeEntitiesDetectionJob Text -- | See: newDescribeEntitiesDetectionJobResponse smart -- constructor. data DescribeEntitiesDetectionJobResponse DescribeEntitiesDetectionJobResponse' :: Maybe EntitiesDetectionJobProperties -> Int -> DescribeEntitiesDetectionJobResponse -- | An object that contains the properties associated with an entities -- detection job. [$sel:entitiesDetectionJobProperties:DescribeEntitiesDetectionJobResponse'] :: DescribeEntitiesDetectionJobResponse -> Maybe EntitiesDetectionJobProperties -- | The response's http status code. [$sel:httpStatus:DescribeEntitiesDetectionJobResponse'] :: DescribeEntitiesDetectionJobResponse -> Int -- | Create a value of DescribeEntitiesDetectionJobResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:entitiesDetectionJobProperties:DescribeEntitiesDetectionJobResponse', -- describeEntitiesDetectionJobResponse_entitiesDetectionJobProperties -- - An object that contains the properties associated with an entities -- detection job. -- -- $sel:httpStatus:DescribeEntitiesDetectionJobResponse', -- describeEntitiesDetectionJobResponse_httpStatus - The -- response's http status code. newDescribeEntitiesDetectionJobResponse :: Int -> DescribeEntitiesDetectionJobResponse -- | An object that contains the properties associated with an entities -- detection job. describeEntitiesDetectionJobResponse_entitiesDetectionJobProperties :: Lens' DescribeEntitiesDetectionJobResponse (Maybe EntitiesDetectionJobProperties) -- | The response's http status code. describeEntitiesDetectionJobResponse_httpStatus :: Lens' DescribeEntitiesDetectionJobResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.DescribeEntitiesDetectionJob.DescribeEntitiesDetectionJob instance GHC.Show.Show Amazonka.Comprehend.DescribeEntitiesDetectionJob.DescribeEntitiesDetectionJob instance GHC.Read.Read Amazonka.Comprehend.DescribeEntitiesDetectionJob.DescribeEntitiesDetectionJob instance GHC.Classes.Eq Amazonka.Comprehend.DescribeEntitiesDetectionJob.DescribeEntitiesDetectionJob instance GHC.Generics.Generic Amazonka.Comprehend.DescribeEntitiesDetectionJob.DescribeEntitiesDetectionJobResponse instance GHC.Show.Show Amazonka.Comprehend.DescribeEntitiesDetectionJob.DescribeEntitiesDetectionJobResponse instance GHC.Read.Read Amazonka.Comprehend.DescribeEntitiesDetectionJob.DescribeEntitiesDetectionJobResponse instance GHC.Classes.Eq Amazonka.Comprehend.DescribeEntitiesDetectionJob.DescribeEntitiesDetectionJobResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.DescribeEntitiesDetectionJob.DescribeEntitiesDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.DescribeEntitiesDetectionJob.DescribeEntitiesDetectionJobResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.DescribeEntitiesDetectionJob.DescribeEntitiesDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.DescribeEntitiesDetectionJob.DescribeEntitiesDetectionJob instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.DescribeEntitiesDetectionJob.DescribeEntitiesDetectionJob instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.DescribeEntitiesDetectionJob.DescribeEntitiesDetectionJob instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.DescribeEntitiesDetectionJob.DescribeEntitiesDetectionJob instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.DescribeEntitiesDetectionJob.DescribeEntitiesDetectionJob -- | Gets the properties associated with a specific endpoint. Use this -- operation to get the status of an endpoint. For information about -- endpoints, see Managing endpoints. module Amazonka.Comprehend.DescribeEndpoint -- | See: newDescribeEndpoint smart constructor. data DescribeEndpoint DescribeEndpoint' :: Text -> DescribeEndpoint -- | The Amazon Resource Number (ARN) of the endpoint being described. [$sel:endpointArn:DescribeEndpoint'] :: DescribeEndpoint -> Text -- | Create a value of DescribeEndpoint with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DescribeEndpoint, describeEndpoint_endpointArn - The -- Amazon Resource Number (ARN) of the endpoint being described. newDescribeEndpoint :: Text -> DescribeEndpoint -- | The Amazon Resource Number (ARN) of the endpoint being described. describeEndpoint_endpointArn :: Lens' DescribeEndpoint Text -- | See: newDescribeEndpointResponse smart constructor. data DescribeEndpointResponse DescribeEndpointResponse' :: Maybe EndpointProperties -> Int -> DescribeEndpointResponse -- | Describes information associated with the specific endpoint. [$sel:endpointProperties:DescribeEndpointResponse'] :: DescribeEndpointResponse -> Maybe EndpointProperties -- | The response's http status code. [$sel:httpStatus:DescribeEndpointResponse'] :: DescribeEndpointResponse -> Int -- | Create a value of DescribeEndpointResponse with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:endpointProperties:DescribeEndpointResponse', -- describeEndpointResponse_endpointProperties - Describes -- information associated with the specific endpoint. -- -- $sel:httpStatus:DescribeEndpointResponse', -- describeEndpointResponse_httpStatus - The response's http -- status code. newDescribeEndpointResponse :: Int -> DescribeEndpointResponse -- | Describes information associated with the specific endpoint. describeEndpointResponse_endpointProperties :: Lens' DescribeEndpointResponse (Maybe EndpointProperties) -- | The response's http status code. describeEndpointResponse_httpStatus :: Lens' DescribeEndpointResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.DescribeEndpoint.DescribeEndpoint instance GHC.Show.Show Amazonka.Comprehend.DescribeEndpoint.DescribeEndpoint instance GHC.Read.Read Amazonka.Comprehend.DescribeEndpoint.DescribeEndpoint instance GHC.Classes.Eq Amazonka.Comprehend.DescribeEndpoint.DescribeEndpoint instance GHC.Generics.Generic Amazonka.Comprehend.DescribeEndpoint.DescribeEndpointResponse instance GHC.Show.Show Amazonka.Comprehend.DescribeEndpoint.DescribeEndpointResponse instance GHC.Read.Read Amazonka.Comprehend.DescribeEndpoint.DescribeEndpointResponse instance GHC.Classes.Eq Amazonka.Comprehend.DescribeEndpoint.DescribeEndpointResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.DescribeEndpoint.DescribeEndpoint instance Control.DeepSeq.NFData Amazonka.Comprehend.DescribeEndpoint.DescribeEndpointResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.DescribeEndpoint.DescribeEndpoint instance Control.DeepSeq.NFData Amazonka.Comprehend.DescribeEndpoint.DescribeEndpoint instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.DescribeEndpoint.DescribeEndpoint instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.DescribeEndpoint.DescribeEndpoint instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.DescribeEndpoint.DescribeEndpoint instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.DescribeEndpoint.DescribeEndpoint -- | Gets the properties associated with a dominant language detection job. -- Use this operation to get the status of a detection job. module Amazonka.Comprehend.DescribeDominantLanguageDetectionJob -- | See: newDescribeDominantLanguageDetectionJob smart -- constructor. data DescribeDominantLanguageDetectionJob DescribeDominantLanguageDetectionJob' :: Text -> DescribeDominantLanguageDetectionJob -- | The identifier that Amazon Comprehend generated for the job. The -- operation returns this identifier in its response. [$sel:jobId:DescribeDominantLanguageDetectionJob'] :: DescribeDominantLanguageDetectionJob -> Text -- | Create a value of DescribeDominantLanguageDetectionJob with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DescribeDominantLanguageDetectionJob, -- describeDominantLanguageDetectionJob_jobId - The identifier -- that Amazon Comprehend generated for the job. The operation returns -- this identifier in its response. newDescribeDominantLanguageDetectionJob :: Text -> DescribeDominantLanguageDetectionJob -- | The identifier that Amazon Comprehend generated for the job. The -- operation returns this identifier in its response. describeDominantLanguageDetectionJob_jobId :: Lens' DescribeDominantLanguageDetectionJob Text -- | See: newDescribeDominantLanguageDetectionJobResponse -- smart constructor. data DescribeDominantLanguageDetectionJobResponse DescribeDominantLanguageDetectionJobResponse' :: Maybe DominantLanguageDetectionJobProperties -> Int -> DescribeDominantLanguageDetectionJobResponse -- | An object that contains the properties associated with a dominant -- language detection job. [$sel:dominantLanguageDetectionJobProperties:DescribeDominantLanguageDetectionJobResponse'] :: DescribeDominantLanguageDetectionJobResponse -> Maybe DominantLanguageDetectionJobProperties -- | The response's http status code. [$sel:httpStatus:DescribeDominantLanguageDetectionJobResponse'] :: DescribeDominantLanguageDetectionJobResponse -> Int -- | Create a value of DescribeDominantLanguageDetectionJobResponse -- with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:dominantLanguageDetectionJobProperties:DescribeDominantLanguageDetectionJobResponse', -- describeDominantLanguageDetectionJobResponse_dominantLanguageDetectionJobProperties -- - An object that contains the properties associated with a dominant -- language detection job. -- -- $sel:httpStatus:DescribeDominantLanguageDetectionJobResponse', -- describeDominantLanguageDetectionJobResponse_httpStatus - The -- response's http status code. newDescribeDominantLanguageDetectionJobResponse :: Int -> DescribeDominantLanguageDetectionJobResponse -- | An object that contains the properties associated with a dominant -- language detection job. describeDominantLanguageDetectionJobResponse_dominantLanguageDetectionJobProperties :: Lens' DescribeDominantLanguageDetectionJobResponse (Maybe DominantLanguageDetectionJobProperties) -- | The response's http status code. describeDominantLanguageDetectionJobResponse_httpStatus :: Lens' DescribeDominantLanguageDetectionJobResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.DescribeDominantLanguageDetectionJob.DescribeDominantLanguageDetectionJob instance GHC.Show.Show Amazonka.Comprehend.DescribeDominantLanguageDetectionJob.DescribeDominantLanguageDetectionJob instance GHC.Read.Read Amazonka.Comprehend.DescribeDominantLanguageDetectionJob.DescribeDominantLanguageDetectionJob instance GHC.Classes.Eq Amazonka.Comprehend.DescribeDominantLanguageDetectionJob.DescribeDominantLanguageDetectionJob instance GHC.Generics.Generic Amazonka.Comprehend.DescribeDominantLanguageDetectionJob.DescribeDominantLanguageDetectionJobResponse instance GHC.Show.Show Amazonka.Comprehend.DescribeDominantLanguageDetectionJob.DescribeDominantLanguageDetectionJobResponse instance GHC.Read.Read Amazonka.Comprehend.DescribeDominantLanguageDetectionJob.DescribeDominantLanguageDetectionJobResponse instance GHC.Classes.Eq Amazonka.Comprehend.DescribeDominantLanguageDetectionJob.DescribeDominantLanguageDetectionJobResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.DescribeDominantLanguageDetectionJob.DescribeDominantLanguageDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.DescribeDominantLanguageDetectionJob.DescribeDominantLanguageDetectionJobResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.DescribeDominantLanguageDetectionJob.DescribeDominantLanguageDetectionJob instance Control.DeepSeq.NFData Amazonka.Comprehend.DescribeDominantLanguageDetectionJob.DescribeDominantLanguageDetectionJob instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.DescribeDominantLanguageDetectionJob.DescribeDominantLanguageDetectionJob instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.DescribeDominantLanguageDetectionJob.DescribeDominantLanguageDetectionJob instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.DescribeDominantLanguageDetectionJob.DescribeDominantLanguageDetectionJob instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.DescribeDominantLanguageDetectionJob.DescribeDominantLanguageDetectionJob -- | Gets the properties associated with a document classifier. module Amazonka.Comprehend.DescribeDocumentClassifier -- | See: newDescribeDocumentClassifier smart constructor. data DescribeDocumentClassifier DescribeDocumentClassifier' :: Text -> DescribeDocumentClassifier -- | The Amazon Resource Name (ARN) that identifies the document -- classifier. The operation returns this identifier in its response. [$sel:documentClassifierArn:DescribeDocumentClassifier'] :: DescribeDocumentClassifier -> Text -- | Create a value of DescribeDocumentClassifier with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DescribeDocumentClassifier, -- describeDocumentClassifier_documentClassifierArn - The Amazon -- Resource Name (ARN) that identifies the document classifier. The -- operation returns this identifier in its response. newDescribeDocumentClassifier :: Text -> DescribeDocumentClassifier -- | The Amazon Resource Name (ARN) that identifies the document -- classifier. The operation returns this identifier in its response. describeDocumentClassifier_documentClassifierArn :: Lens' DescribeDocumentClassifier Text -- | See: newDescribeDocumentClassifierResponse smart -- constructor. data DescribeDocumentClassifierResponse DescribeDocumentClassifierResponse' :: Maybe DocumentClassifierProperties -> Int -> DescribeDocumentClassifierResponse -- | An object that contains the properties associated with a document -- classifier. [$sel:documentClassifierProperties:DescribeDocumentClassifierResponse'] :: DescribeDocumentClassifierResponse -> Maybe DocumentClassifierProperties -- | The response's http status code. [$sel:httpStatus:DescribeDocumentClassifierResponse'] :: DescribeDocumentClassifierResponse -> Int -- | Create a value of DescribeDocumentClassifierResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:documentClassifierProperties:DescribeDocumentClassifierResponse', -- describeDocumentClassifierResponse_documentClassifierProperties -- - An object that contains the properties associated with a document -- classifier. -- -- $sel:httpStatus:DescribeDocumentClassifierResponse', -- describeDocumentClassifierResponse_httpStatus - The response's -- http status code. newDescribeDocumentClassifierResponse :: Int -> DescribeDocumentClassifierResponse -- | An object that contains the properties associated with a document -- classifier. describeDocumentClassifierResponse_documentClassifierProperties :: Lens' DescribeDocumentClassifierResponse (Maybe DocumentClassifierProperties) -- | The response's http status code. describeDocumentClassifierResponse_httpStatus :: Lens' DescribeDocumentClassifierResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.DescribeDocumentClassifier.DescribeDocumentClassifier instance GHC.Show.Show Amazonka.Comprehend.DescribeDocumentClassifier.DescribeDocumentClassifier instance GHC.Read.Read Amazonka.Comprehend.DescribeDocumentClassifier.DescribeDocumentClassifier instance GHC.Classes.Eq Amazonka.Comprehend.DescribeDocumentClassifier.DescribeDocumentClassifier instance GHC.Generics.Generic Amazonka.Comprehend.DescribeDocumentClassifier.DescribeDocumentClassifierResponse instance GHC.Show.Show Amazonka.Comprehend.DescribeDocumentClassifier.DescribeDocumentClassifierResponse instance GHC.Classes.Eq Amazonka.Comprehend.DescribeDocumentClassifier.DescribeDocumentClassifierResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.DescribeDocumentClassifier.DescribeDocumentClassifier instance Control.DeepSeq.NFData Amazonka.Comprehend.DescribeDocumentClassifier.DescribeDocumentClassifierResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.DescribeDocumentClassifier.DescribeDocumentClassifier instance Control.DeepSeq.NFData Amazonka.Comprehend.DescribeDocumentClassifier.DescribeDocumentClassifier instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.DescribeDocumentClassifier.DescribeDocumentClassifier instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.DescribeDocumentClassifier.DescribeDocumentClassifier instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.DescribeDocumentClassifier.DescribeDocumentClassifier instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.DescribeDocumentClassifier.DescribeDocumentClassifier -- | Gets the properties associated with a document classification job. Use -- this operation to get the status of a classification job. module Amazonka.Comprehend.DescribeDocumentClassificationJob -- | See: newDescribeDocumentClassificationJob smart -- constructor. data DescribeDocumentClassificationJob DescribeDocumentClassificationJob' :: Text -> DescribeDocumentClassificationJob -- | The identifier that Amazon Comprehend generated for the job. The -- operation returns this identifier in its response. [$sel:jobId:DescribeDocumentClassificationJob'] :: DescribeDocumentClassificationJob -> Text -- | Create a value of DescribeDocumentClassificationJob with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DescribeDocumentClassificationJob, -- describeDocumentClassificationJob_jobId - The identifier that -- Amazon Comprehend generated for the job. The operation returns this -- identifier in its response. newDescribeDocumentClassificationJob :: Text -> DescribeDocumentClassificationJob -- | The identifier that Amazon Comprehend generated for the job. The -- operation returns this identifier in its response. describeDocumentClassificationJob_jobId :: Lens' DescribeDocumentClassificationJob Text -- | See: newDescribeDocumentClassificationJobResponse smart -- constructor. data DescribeDocumentClassificationJobResponse DescribeDocumentClassificationJobResponse' :: Maybe DocumentClassificationJobProperties -> Int -> DescribeDocumentClassificationJobResponse -- | An object that describes the properties associated with the document -- classification job. [$sel:documentClassificationJobProperties:DescribeDocumentClassificationJobResponse'] :: DescribeDocumentClassificationJobResponse -> Maybe DocumentClassificationJobProperties -- | The response's http status code. [$sel:httpStatus:DescribeDocumentClassificationJobResponse'] :: DescribeDocumentClassificationJobResponse -> Int -- | Create a value of DescribeDocumentClassificationJobResponse -- with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:documentClassificationJobProperties:DescribeDocumentClassificationJobResponse', -- describeDocumentClassificationJobResponse_documentClassificationJobProperties -- - An object that describes the properties associated with the document -- classification job. -- -- $sel:httpStatus:DescribeDocumentClassificationJobResponse', -- describeDocumentClassificationJobResponse_httpStatus - The -- response's http status code. newDescribeDocumentClassificationJobResponse :: Int -> DescribeDocumentClassificationJobResponse -- | An object that describes the properties associated with the document -- classification job. describeDocumentClassificationJobResponse_documentClassificationJobProperties :: Lens' DescribeDocumentClassificationJobResponse (Maybe DocumentClassificationJobProperties) -- | The response's http status code. describeDocumentClassificationJobResponse_httpStatus :: Lens' DescribeDocumentClassificationJobResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.DescribeDocumentClassificationJob.DescribeDocumentClassificationJob instance GHC.Show.Show Amazonka.Comprehend.DescribeDocumentClassificationJob.DescribeDocumentClassificationJob instance GHC.Read.Read Amazonka.Comprehend.DescribeDocumentClassificationJob.DescribeDocumentClassificationJob instance GHC.Classes.Eq Amazonka.Comprehend.DescribeDocumentClassificationJob.DescribeDocumentClassificationJob instance GHC.Generics.Generic Amazonka.Comprehend.DescribeDocumentClassificationJob.DescribeDocumentClassificationJobResponse instance GHC.Show.Show Amazonka.Comprehend.DescribeDocumentClassificationJob.DescribeDocumentClassificationJobResponse instance GHC.Read.Read Amazonka.Comprehend.DescribeDocumentClassificationJob.DescribeDocumentClassificationJobResponse instance GHC.Classes.Eq Amazonka.Comprehend.DescribeDocumentClassificationJob.DescribeDocumentClassificationJobResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.DescribeDocumentClassificationJob.DescribeDocumentClassificationJob instance Control.DeepSeq.NFData Amazonka.Comprehend.DescribeDocumentClassificationJob.DescribeDocumentClassificationJobResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.DescribeDocumentClassificationJob.DescribeDocumentClassificationJob instance Control.DeepSeq.NFData Amazonka.Comprehend.DescribeDocumentClassificationJob.DescribeDocumentClassificationJob instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.DescribeDocumentClassificationJob.DescribeDocumentClassificationJob instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.DescribeDocumentClassificationJob.DescribeDocumentClassificationJob instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.DescribeDocumentClassificationJob.DescribeDocumentClassificationJob instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.DescribeDocumentClassificationJob.DescribeDocumentClassificationJob -- | Deletes a resource-based policy that is attached to a custom model. module Amazonka.Comprehend.DeleteResourcePolicy -- | See: newDeleteResourcePolicy smart constructor. data DeleteResourcePolicy DeleteResourcePolicy' :: Maybe Text -> Text -> DeleteResourcePolicy -- | The revision ID of the policy to delete. [$sel:policyRevisionId:DeleteResourcePolicy'] :: DeleteResourcePolicy -> Maybe Text -- | The Amazon Resource Name (ARN) of the custom model version that has -- the policy to delete. [$sel:resourceArn:DeleteResourcePolicy'] :: DeleteResourcePolicy -> Text -- | Create a value of DeleteResourcePolicy with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:policyRevisionId:DeleteResourcePolicy', -- deleteResourcePolicy_policyRevisionId - The revision ID of the -- policy to delete. -- -- $sel:resourceArn:DeleteResourcePolicy', -- deleteResourcePolicy_resourceArn - The Amazon Resource Name -- (ARN) of the custom model version that has the policy to delete. newDeleteResourcePolicy :: Text -> DeleteResourcePolicy -- | The revision ID of the policy to delete. deleteResourcePolicy_policyRevisionId :: Lens' DeleteResourcePolicy (Maybe Text) -- | The Amazon Resource Name (ARN) of the custom model version that has -- the policy to delete. deleteResourcePolicy_resourceArn :: Lens' DeleteResourcePolicy Text -- | See: newDeleteResourcePolicyResponse smart constructor. data DeleteResourcePolicyResponse DeleteResourcePolicyResponse' :: Int -> DeleteResourcePolicyResponse -- | The response's http status code. [$sel:httpStatus:DeleteResourcePolicyResponse'] :: DeleteResourcePolicyResponse -> Int -- | Create a value of DeleteResourcePolicyResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:httpStatus:DeleteResourcePolicyResponse', -- deleteResourcePolicyResponse_httpStatus - The response's http -- status code. newDeleteResourcePolicyResponse :: Int -> DeleteResourcePolicyResponse -- | The response's http status code. deleteResourcePolicyResponse_httpStatus :: Lens' DeleteResourcePolicyResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.DeleteResourcePolicy.DeleteResourcePolicy instance GHC.Show.Show Amazonka.Comprehend.DeleteResourcePolicy.DeleteResourcePolicy instance GHC.Read.Read Amazonka.Comprehend.DeleteResourcePolicy.DeleteResourcePolicy instance GHC.Classes.Eq Amazonka.Comprehend.DeleteResourcePolicy.DeleteResourcePolicy instance GHC.Generics.Generic Amazonka.Comprehend.DeleteResourcePolicy.DeleteResourcePolicyResponse instance GHC.Show.Show Amazonka.Comprehend.DeleteResourcePolicy.DeleteResourcePolicyResponse instance GHC.Read.Read Amazonka.Comprehend.DeleteResourcePolicy.DeleteResourcePolicyResponse instance GHC.Classes.Eq Amazonka.Comprehend.DeleteResourcePolicy.DeleteResourcePolicyResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.DeleteResourcePolicy.DeleteResourcePolicy instance Control.DeepSeq.NFData Amazonka.Comprehend.DeleteResourcePolicy.DeleteResourcePolicyResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.DeleteResourcePolicy.DeleteResourcePolicy instance Control.DeepSeq.NFData Amazonka.Comprehend.DeleteResourcePolicy.DeleteResourcePolicy instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.DeleteResourcePolicy.DeleteResourcePolicy instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.DeleteResourcePolicy.DeleteResourcePolicy instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.DeleteResourcePolicy.DeleteResourcePolicy instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.DeleteResourcePolicy.DeleteResourcePolicy -- | Deletes an entity recognizer. -- -- Only those recognizers that are in terminated states (IN_ERROR, -- TRAINED) will be deleted. If an active inference job is using the -- model, a ResourceInUseException will be returned. -- -- This is an asynchronous action that puts the recognizer into a -- DELETING state, and it is then removed by a background job. Once -- removed, the recognizer disappears from your account and is no longer -- available for use. module Amazonka.Comprehend.DeleteEntityRecognizer -- | See: newDeleteEntityRecognizer smart constructor. data DeleteEntityRecognizer DeleteEntityRecognizer' :: Text -> DeleteEntityRecognizer -- | The Amazon Resource Name (ARN) that identifies the entity recognizer. [$sel:entityRecognizerArn:DeleteEntityRecognizer'] :: DeleteEntityRecognizer -> Text -- | Create a value of DeleteEntityRecognizer with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DeleteEntityRecognizer, -- deleteEntityRecognizer_entityRecognizerArn - The Amazon -- Resource Name (ARN) that identifies the entity recognizer. newDeleteEntityRecognizer :: Text -> DeleteEntityRecognizer -- | The Amazon Resource Name (ARN) that identifies the entity recognizer. deleteEntityRecognizer_entityRecognizerArn :: Lens' DeleteEntityRecognizer Text -- | See: newDeleteEntityRecognizerResponse smart -- constructor. data DeleteEntityRecognizerResponse DeleteEntityRecognizerResponse' :: Int -> DeleteEntityRecognizerResponse -- | The response's http status code. [$sel:httpStatus:DeleteEntityRecognizerResponse'] :: DeleteEntityRecognizerResponse -> Int -- | Create a value of DeleteEntityRecognizerResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:httpStatus:DeleteEntityRecognizerResponse', -- deleteEntityRecognizerResponse_httpStatus - The response's http -- status code. newDeleteEntityRecognizerResponse :: Int -> DeleteEntityRecognizerResponse -- | The response's http status code. deleteEntityRecognizerResponse_httpStatus :: Lens' DeleteEntityRecognizerResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.DeleteEntityRecognizer.DeleteEntityRecognizer instance GHC.Show.Show Amazonka.Comprehend.DeleteEntityRecognizer.DeleteEntityRecognizer instance GHC.Read.Read Amazonka.Comprehend.DeleteEntityRecognizer.DeleteEntityRecognizer instance GHC.Classes.Eq Amazonka.Comprehend.DeleteEntityRecognizer.DeleteEntityRecognizer instance GHC.Generics.Generic Amazonka.Comprehend.DeleteEntityRecognizer.DeleteEntityRecognizerResponse instance GHC.Show.Show Amazonka.Comprehend.DeleteEntityRecognizer.DeleteEntityRecognizerResponse instance GHC.Read.Read Amazonka.Comprehend.DeleteEntityRecognizer.DeleteEntityRecognizerResponse instance GHC.Classes.Eq Amazonka.Comprehend.DeleteEntityRecognizer.DeleteEntityRecognizerResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.DeleteEntityRecognizer.DeleteEntityRecognizer instance Control.DeepSeq.NFData Amazonka.Comprehend.DeleteEntityRecognizer.DeleteEntityRecognizerResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.DeleteEntityRecognizer.DeleteEntityRecognizer instance Control.DeepSeq.NFData Amazonka.Comprehend.DeleteEntityRecognizer.DeleteEntityRecognizer instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.DeleteEntityRecognizer.DeleteEntityRecognizer instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.DeleteEntityRecognizer.DeleteEntityRecognizer instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.DeleteEntityRecognizer.DeleteEntityRecognizer instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.DeleteEntityRecognizer.DeleteEntityRecognizer -- | Deletes a model-specific endpoint for a previously-trained custom -- model. All endpoints must be deleted in order for the model to be -- deleted. For information about endpoints, see Managing -- endpoints. module Amazonka.Comprehend.DeleteEndpoint -- | See: newDeleteEndpoint smart constructor. data DeleteEndpoint DeleteEndpoint' :: Text -> DeleteEndpoint -- | The Amazon Resource Number (ARN) of the endpoint being deleted. [$sel:endpointArn:DeleteEndpoint'] :: DeleteEndpoint -> Text -- | Create a value of DeleteEndpoint with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DeleteEndpoint, deleteEndpoint_endpointArn - The Amazon -- Resource Number (ARN) of the endpoint being deleted. newDeleteEndpoint :: Text -> DeleteEndpoint -- | The Amazon Resource Number (ARN) of the endpoint being deleted. deleteEndpoint_endpointArn :: Lens' DeleteEndpoint Text -- | See: newDeleteEndpointResponse smart constructor. data DeleteEndpointResponse DeleteEndpointResponse' :: Int -> DeleteEndpointResponse -- | The response's http status code. [$sel:httpStatus:DeleteEndpointResponse'] :: DeleteEndpointResponse -> Int -- | Create a value of DeleteEndpointResponse with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:httpStatus:DeleteEndpointResponse', -- deleteEndpointResponse_httpStatus - The response's http status -- code. newDeleteEndpointResponse :: Int -> DeleteEndpointResponse -- | The response's http status code. deleteEndpointResponse_httpStatus :: Lens' DeleteEndpointResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.DeleteEndpoint.DeleteEndpoint instance GHC.Show.Show Amazonka.Comprehend.DeleteEndpoint.DeleteEndpoint instance GHC.Read.Read Amazonka.Comprehend.DeleteEndpoint.DeleteEndpoint instance GHC.Classes.Eq Amazonka.Comprehend.DeleteEndpoint.DeleteEndpoint instance GHC.Generics.Generic Amazonka.Comprehend.DeleteEndpoint.DeleteEndpointResponse instance GHC.Show.Show Amazonka.Comprehend.DeleteEndpoint.DeleteEndpointResponse instance GHC.Read.Read Amazonka.Comprehend.DeleteEndpoint.DeleteEndpointResponse instance GHC.Classes.Eq Amazonka.Comprehend.DeleteEndpoint.DeleteEndpointResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.DeleteEndpoint.DeleteEndpoint instance Control.DeepSeq.NFData Amazonka.Comprehend.DeleteEndpoint.DeleteEndpointResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.DeleteEndpoint.DeleteEndpoint instance Control.DeepSeq.NFData Amazonka.Comprehend.DeleteEndpoint.DeleteEndpoint instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.DeleteEndpoint.DeleteEndpoint instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.DeleteEndpoint.DeleteEndpoint instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.DeleteEndpoint.DeleteEndpoint instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.DeleteEndpoint.DeleteEndpoint -- | Deletes a previously created document classifier -- -- Only those classifiers that are in terminated states (IN_ERROR, -- TRAINED) will be deleted. If an active inference job is using the -- model, a ResourceInUseException will be returned. -- -- This is an asynchronous action that puts the classifier into a -- DELETING state, and it is then removed by a background job. Once -- removed, the classifier disappears from your account and is no longer -- available for use. module Amazonka.Comprehend.DeleteDocumentClassifier -- | See: newDeleteDocumentClassifier smart constructor. data DeleteDocumentClassifier DeleteDocumentClassifier' :: Text -> DeleteDocumentClassifier -- | The Amazon Resource Name (ARN) that identifies the document -- classifier. [$sel:documentClassifierArn:DeleteDocumentClassifier'] :: DeleteDocumentClassifier -> Text -- | Create a value of DeleteDocumentClassifier with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DeleteDocumentClassifier, -- deleteDocumentClassifier_documentClassifierArn - The Amazon -- Resource Name (ARN) that identifies the document classifier. newDeleteDocumentClassifier :: Text -> DeleteDocumentClassifier -- | The Amazon Resource Name (ARN) that identifies the document -- classifier. deleteDocumentClassifier_documentClassifierArn :: Lens' DeleteDocumentClassifier Text -- | See: newDeleteDocumentClassifierResponse smart -- constructor. data DeleteDocumentClassifierResponse DeleteDocumentClassifierResponse' :: Int -> DeleteDocumentClassifierResponse -- | The response's http status code. [$sel:httpStatus:DeleteDocumentClassifierResponse'] :: DeleteDocumentClassifierResponse -> Int -- | Create a value of DeleteDocumentClassifierResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:httpStatus:DeleteDocumentClassifierResponse', -- deleteDocumentClassifierResponse_httpStatus - The response's -- http status code. newDeleteDocumentClassifierResponse :: Int -> DeleteDocumentClassifierResponse -- | The response's http status code. deleteDocumentClassifierResponse_httpStatus :: Lens' DeleteDocumentClassifierResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.DeleteDocumentClassifier.DeleteDocumentClassifier instance GHC.Show.Show Amazonka.Comprehend.DeleteDocumentClassifier.DeleteDocumentClassifier instance GHC.Read.Read Amazonka.Comprehend.DeleteDocumentClassifier.DeleteDocumentClassifier instance GHC.Classes.Eq Amazonka.Comprehend.DeleteDocumentClassifier.DeleteDocumentClassifier instance GHC.Generics.Generic Amazonka.Comprehend.DeleteDocumentClassifier.DeleteDocumentClassifierResponse instance GHC.Show.Show Amazonka.Comprehend.DeleteDocumentClassifier.DeleteDocumentClassifierResponse instance GHC.Read.Read Amazonka.Comprehend.DeleteDocumentClassifier.DeleteDocumentClassifierResponse instance GHC.Classes.Eq Amazonka.Comprehend.DeleteDocumentClassifier.DeleteDocumentClassifierResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.DeleteDocumentClassifier.DeleteDocumentClassifier instance Control.DeepSeq.NFData Amazonka.Comprehend.DeleteDocumentClassifier.DeleteDocumentClassifierResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.DeleteDocumentClassifier.DeleteDocumentClassifier instance Control.DeepSeq.NFData Amazonka.Comprehend.DeleteDocumentClassifier.DeleteDocumentClassifier instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.DeleteDocumentClassifier.DeleteDocumentClassifier instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.DeleteDocumentClassifier.DeleteDocumentClassifier instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.DeleteDocumentClassifier.DeleteDocumentClassifier instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.DeleteDocumentClassifier.DeleteDocumentClassifier -- | Creates an entity recognizer using submitted files. After your -- CreateEntityRecognizer request is submitted, you can check -- job status using the API. module Amazonka.Comprehend.CreateEntityRecognizer -- | See: newCreateEntityRecognizer smart constructor. data CreateEntityRecognizer CreateEntityRecognizer' :: Maybe Text -> Maybe Text -> Maybe Text -> Maybe [Tag] -> Maybe Text -> Maybe Text -> Maybe VpcConfig -> Text -> Text -> EntityRecognizerInputDataConfig -> LanguageCode -> CreateEntityRecognizer -- | A unique identifier for the request. If you don't set the client -- request token, Amazon Comprehend generates one. [$sel:clientRequestToken:CreateEntityRecognizer'] :: CreateEntityRecognizer -> Maybe Text -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt trained custom models. The ModelKmsKeyId can be either -- of the following formats -- -- [$sel:modelKmsKeyId:CreateEntityRecognizer'] :: CreateEntityRecognizer -> Maybe Text -- | The JSON resource-based policy to attach to your custom entity -- recognizer model. You can use this policy to allow another AWS account -- to import your custom model. -- -- Provide your JSON as a UTF-8 encoded string without line breaks. To -- provide valid JSON for your policy, enclose the attribute names and -- values in double quotes. If the JSON body is also enclosed in double -- quotes, then you must escape the double quotes that are inside the -- policy: -- -- 
--   "{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
--
-- -- To avoid escaping quotes, you can use single quotes to enclose the -- policy and double quotes to enclose the JSON names and values: -- -- 
--   '{"attribute": "value", "attribute": ["value"]}'
--
[$sel:modelPolicy:CreateEntityRecognizer'] :: CreateEntityRecognizer -> Maybe Text -- | Tags to be associated with the entity recognizer being created. A tag -- is a key-value pair that adds as a metadata to a resource used by -- Amazon Comprehend. For example, a tag with "Sales" as the key might be -- added to a resource to indicate its use by the sales department. [$sel:tags:CreateEntityRecognizer'] :: CreateEntityRecognizer -> Maybe [Tag] -- | The version name given to the newly created recognizer. Version names -- can be a maximum of 256 characters. Alphanumeric characters, hyphens -- (-) and underscores (_) are allowed. The version name must be unique -- among all models with the same recognizer name in the account/ AWS -- Region. [$sel:versionName:CreateEntityRecognizer'] :: CreateEntityRecognizer -> Maybe Text -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- [$sel:volumeKmsKeyId:CreateEntityRecognizer'] :: CreateEntityRecognizer -> Maybe Text -- | Configuration parameters for an optional private Virtual Private Cloud -- (VPC) containing the resources you are using for your custom entity -- recognizer. For more information, see Amazon VPC. [$sel:vpcConfig:CreateEntityRecognizer'] :: CreateEntityRecognizer -> Maybe VpcConfig -- | The name given to the newly created recognizer. Recognizer names can -- be a maximum of 256 characters. Alphanumeric characters, hyphens (-) -- and underscores (_) are allowed. The name must be unique in the -- account/region. [$sel:recognizerName:CreateEntityRecognizer'] :: CreateEntityRecognizer -> Text -- | The Amazon Resource Name (ARN) of the AWS Identity and Management -- (IAM) role that grants Amazon Comprehend read access to your input -- data. [$sel:dataAccessRoleArn:CreateEntityRecognizer'] :: CreateEntityRecognizer -> Text -- | Specifies the format and location of the input data. The S3 bucket -- containing the input data must be located in the same region as the -- entity recognizer being created. [$sel:inputDataConfig:CreateEntityRecognizer'] :: CreateEntityRecognizer -> EntityRecognizerInputDataConfig -- | You can specify any of the following languages: English ("en"), -- Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or -- Portuguese ("pt"). If you plan to use this entity recognizer with PDF, -- Word, or image input files, you must specify English as the language. -- All training documents must be in the same language. [$sel:languageCode:CreateEntityRecognizer'] :: CreateEntityRecognizer -> LanguageCode -- | Create a value of CreateEntityRecognizer with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:clientRequestToken:CreateEntityRecognizer', -- createEntityRecognizer_clientRequestToken - A unique identifier -- for the request. If you don't set the client request token, Amazon -- Comprehend generates one. -- -- CreateEntityRecognizer, -- createEntityRecognizer_modelKmsKeyId - ID for the AWS Key -- Management Service (KMS) key that Amazon Comprehend uses to encrypt -- trained custom models. The ModelKmsKeyId can be either of the -- following formats -- -- -- -- $sel:modelPolicy:CreateEntityRecognizer', -- createEntityRecognizer_modelPolicy - The JSON resource-based -- policy to attach to your custom entity recognizer model. You can use -- this policy to allow another AWS account to import your custom model. -- -- Provide your JSON as a UTF-8 encoded string without line breaks. To -- provide valid JSON for your policy, enclose the attribute names and -- values in double quotes. If the JSON body is also enclosed in double -- quotes, then you must escape the double quotes that are inside the -- policy: -- -- 
--   "{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
--
-- -- To avoid escaping quotes, you can use single quotes to enclose the -- policy and double quotes to enclose the JSON names and values: -- -- 
--   '{"attribute": "value", "attribute": ["value"]}'
--
-- -- $sel:tags:CreateEntityRecognizer', -- createEntityRecognizer_tags - Tags to be associated with the -- entity recognizer being created. A tag is a key-value pair that adds -- as a metadata to a resource used by Amazon Comprehend. For example, a -- tag with "Sales" as the key might be added to a resource to indicate -- its use by the sales department. -- -- CreateEntityRecognizer, -- createEntityRecognizer_versionName - The version name given to -- the newly created recognizer. Version names can be a maximum of 256 -- characters. Alphanumeric characters, hyphens (-) and underscores (_) -- are allowed. The version name must be unique among all models with the -- same recognizer name in the account/ AWS Region. -- -- CreateEntityRecognizer, -- createEntityRecognizer_volumeKmsKeyId - ID for the AWS Key -- Management Service (KMS) key that Amazon Comprehend uses to encrypt -- data on the storage volume attached to the ML compute instance(s) that -- process the analysis job. The VolumeKmsKeyId can be either of the -- following formats: -- -- -- -- CreateEntityRecognizer, createEntityRecognizer_vpcConfig -- - Configuration parameters for an optional private Virtual Private -- Cloud (VPC) containing the resources you are using for your custom -- entity recognizer. For more information, see Amazon VPC. -- -- CreateEntityRecognizer, -- createEntityRecognizer_recognizerName - The name given to the -- newly created recognizer. Recognizer names can be a maximum of 256 -- characters. Alphanumeric characters, hyphens (-) and underscores (_) -- are allowed. The name must be unique in the account/region. -- -- CreateEntityRecognizer, -- createEntityRecognizer_dataAccessRoleArn - The Amazon Resource -- Name (ARN) of the AWS Identity and Management (IAM) role that grants -- Amazon Comprehend read access to your input data. -- -- CreateEntityRecognizer, -- createEntityRecognizer_inputDataConfig - Specifies the format -- and location of the input data. The S3 bucket containing the input -- data must be located in the same region as the entity recognizer being -- created. -- -- CreateEntityRecognizer, -- createEntityRecognizer_languageCode - You can specify any of -- the following languages: English ("en"), Spanish ("es"), French -- ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). If you -- plan to use this entity recognizer with PDF, Word, or image input -- files, you must specify English as the language. All training -- documents must be in the same language. newCreateEntityRecognizer :: Text -> Text -> EntityRecognizerInputDataConfig -> LanguageCode -> CreateEntityRecognizer -- | A unique identifier for the request. If you don't set the client -- request token, Amazon Comprehend generates one. createEntityRecognizer_clientRequestToken :: Lens' CreateEntityRecognizer (Maybe Text) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt trained custom models. The ModelKmsKeyId can be either -- of the following formats -- -- createEntityRecognizer_modelKmsKeyId :: Lens' CreateEntityRecognizer (Maybe Text) -- | The JSON resource-based policy to attach to your custom entity -- recognizer model. You can use this policy to allow another AWS account -- to import your custom model. -- -- Provide your JSON as a UTF-8 encoded string without line breaks. To -- provide valid JSON for your policy, enclose the attribute names and -- values in double quotes. If the JSON body is also enclosed in double -- quotes, then you must escape the double quotes that are inside the -- policy: -- -- 
--   "{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
--
-- -- To avoid escaping quotes, you can use single quotes to enclose the -- policy and double quotes to enclose the JSON names and values: -- -- 
--   '{"attribute": "value", "attribute": ["value"]}'
--
createEntityRecognizer_modelPolicy :: Lens' CreateEntityRecognizer (Maybe Text) -- | Tags to be associated with the entity recognizer being created. A tag -- is a key-value pair that adds as a metadata to a resource used by -- Amazon Comprehend. For example, a tag with "Sales" as the key might be -- added to a resource to indicate its use by the sales department. createEntityRecognizer_tags :: Lens' CreateEntityRecognizer (Maybe [Tag]) -- | The version name given to the newly created recognizer. Version names -- can be a maximum of 256 characters. Alphanumeric characters, hyphens -- (-) and underscores (_) are allowed. The version name must be unique -- among all models with the same recognizer name in the account/ AWS -- Region. createEntityRecognizer_versionName :: Lens' CreateEntityRecognizer (Maybe Text) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- createEntityRecognizer_volumeKmsKeyId :: Lens' CreateEntityRecognizer (Maybe Text) -- | Configuration parameters for an optional private Virtual Private Cloud -- (VPC) containing the resources you are using for your custom entity -- recognizer. For more information, see Amazon VPC. createEntityRecognizer_vpcConfig :: Lens' CreateEntityRecognizer (Maybe VpcConfig) -- | The name given to the newly created recognizer. Recognizer names can -- be a maximum of 256 characters. Alphanumeric characters, hyphens (-) -- and underscores (_) are allowed. The name must be unique in the -- account/region. createEntityRecognizer_recognizerName :: Lens' CreateEntityRecognizer Text -- | The Amazon Resource Name (ARN) of the AWS Identity and Management -- (IAM) role that grants Amazon Comprehend read access to your input -- data. createEntityRecognizer_dataAccessRoleArn :: Lens' CreateEntityRecognizer Text -- | Specifies the format and location of the input data. The S3 bucket -- containing the input data must be located in the same region as the -- entity recognizer being created. createEntityRecognizer_inputDataConfig :: Lens' CreateEntityRecognizer EntityRecognizerInputDataConfig -- | You can specify any of the following languages: English ("en"), -- Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or -- Portuguese ("pt"). If you plan to use this entity recognizer with PDF, -- Word, or image input files, you must specify English as the language. -- All training documents must be in the same language. createEntityRecognizer_languageCode :: Lens' CreateEntityRecognizer LanguageCode -- | See: newCreateEntityRecognizerResponse smart -- constructor. data CreateEntityRecognizerResponse CreateEntityRecognizerResponse' :: Maybe Text -> Int -> CreateEntityRecognizerResponse -- | The Amazon Resource Name (ARN) that identifies the entity recognizer. [$sel:entityRecognizerArn:CreateEntityRecognizerResponse'] :: CreateEntityRecognizerResponse -> Maybe Text -- | The response's http status code. [$sel:httpStatus:CreateEntityRecognizerResponse'] :: CreateEntityRecognizerResponse -> Int -- | Create a value of CreateEntityRecognizerResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- CreateEntityRecognizerResponse, -- createEntityRecognizerResponse_entityRecognizerArn - The Amazon -- Resource Name (ARN) that identifies the entity recognizer. -- -- $sel:httpStatus:CreateEntityRecognizerResponse', -- createEntityRecognizerResponse_httpStatus - The response's http -- status code. newCreateEntityRecognizerResponse :: Int -> CreateEntityRecognizerResponse -- | The Amazon Resource Name (ARN) that identifies the entity recognizer. createEntityRecognizerResponse_entityRecognizerArn :: Lens' CreateEntityRecognizerResponse (Maybe Text) -- | The response's http status code. createEntityRecognizerResponse_httpStatus :: Lens' CreateEntityRecognizerResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.CreateEntityRecognizer.CreateEntityRecognizer instance GHC.Show.Show Amazonka.Comprehend.CreateEntityRecognizer.CreateEntityRecognizer instance GHC.Read.Read Amazonka.Comprehend.CreateEntityRecognizer.CreateEntityRecognizer instance GHC.Classes.Eq Amazonka.Comprehend.CreateEntityRecognizer.CreateEntityRecognizer instance GHC.Generics.Generic Amazonka.Comprehend.CreateEntityRecognizer.CreateEntityRecognizerResponse instance GHC.Show.Show Amazonka.Comprehend.CreateEntityRecognizer.CreateEntityRecognizerResponse instance GHC.Read.Read Amazonka.Comprehend.CreateEntityRecognizer.CreateEntityRecognizerResponse instance GHC.Classes.Eq Amazonka.Comprehend.CreateEntityRecognizer.CreateEntityRecognizerResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.CreateEntityRecognizer.CreateEntityRecognizer instance Control.DeepSeq.NFData Amazonka.Comprehend.CreateEntityRecognizer.CreateEntityRecognizerResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.CreateEntityRecognizer.CreateEntityRecognizer instance Control.DeepSeq.NFData Amazonka.Comprehend.CreateEntityRecognizer.CreateEntityRecognizer instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.CreateEntityRecognizer.CreateEntityRecognizer instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.CreateEntityRecognizer.CreateEntityRecognizer instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.CreateEntityRecognizer.CreateEntityRecognizer instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.CreateEntityRecognizer.CreateEntityRecognizer -- | Creates a model-specific endpoint for synchronous inference for a -- previously trained custom model For information about endpoints, see -- Managing endpoints. module Amazonka.Comprehend.CreateEndpoint -- | See: newCreateEndpoint smart constructor. data CreateEndpoint CreateEndpoint' :: Maybe Text -> Maybe Text -> Maybe [Tag] -> Text -> Text -> Natural -> CreateEndpoint -- | An idempotency token provided by the customer. If this token matches a -- previous endpoint creation request, Amazon Comprehend will not return -- a ResourceInUseException. [$sel:clientRequestToken:CreateEndpoint'] :: CreateEndpoint -> Maybe Text -- | The Amazon Resource Name (ARN) of the AWS identity and Access -- Management (IAM) role that grants Amazon Comprehend read access to -- trained custom models encrypted with a customer managed key -- (ModelKmsKeyId). [$sel:dataAccessRoleArn:CreateEndpoint'] :: CreateEndpoint -> Maybe Text -- | Tags associated with the endpoint being created. A tag is a key-value -- pair that adds metadata to the endpoint. For example, a tag with -- "Sales" as the key might be added to an endpoint to indicate its use -- by the sales department. [$sel:tags:CreateEndpoint'] :: CreateEndpoint -> Maybe [Tag] -- | This is the descriptive suffix that becomes part of the -- EndpointArn used for all subsequent requests to this -- resource. [$sel:endpointName:CreateEndpoint'] :: CreateEndpoint -> Text -- | The Amazon Resource Number (ARN) of the model to which the endpoint -- will be attached. [$sel:modelArn:CreateEndpoint'] :: CreateEndpoint -> Text -- | The desired number of inference units to be used by the model using -- this endpoint. Each inference unit represents of a throughput of 100 -- characters per second. [$sel:desiredInferenceUnits:CreateEndpoint'] :: CreateEndpoint -> Natural -- | Create a value of CreateEndpoint with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:clientRequestToken:CreateEndpoint', -- createEndpoint_clientRequestToken - An idempotency token -- provided by the customer. If this token matches a previous endpoint -- creation request, Amazon Comprehend will not return a -- ResourceInUseException. -- -- CreateEndpoint, createEndpoint_dataAccessRoleArn - The -- Amazon Resource Name (ARN) of the AWS identity and Access Management -- (IAM) role that grants Amazon Comprehend read access to trained custom -- models encrypted with a customer managed key (ModelKmsKeyId). -- -- $sel:tags:CreateEndpoint', createEndpoint_tags - Tags -- associated with the endpoint being created. A tag is a key-value pair -- that adds metadata to the endpoint. For example, a tag with "Sales" as -- the key might be added to an endpoint to indicate its use by the sales -- department. -- -- $sel:endpointName:CreateEndpoint', -- createEndpoint_endpointName - This is the descriptive suffix -- that becomes part of the EndpointArn used for all subsequent -- requests to this resource. -- -- CreateEndpoint, createEndpoint_modelArn - The Amazon -- Resource Number (ARN) of the model to which the endpoint will be -- attached. -- -- CreateEndpoint, createEndpoint_desiredInferenceUnits - -- The desired number of inference units to be used by the model using -- this endpoint. Each inference unit represents of a throughput of 100 -- characters per second. newCreateEndpoint :: Text -> Text -> Natural -> CreateEndpoint -- | An idempotency token provided by the customer. If this token matches a -- previous endpoint creation request, Amazon Comprehend will not return -- a ResourceInUseException. createEndpoint_clientRequestToken :: Lens' CreateEndpoint (Maybe Text) -- | The Amazon Resource Name (ARN) of the AWS identity and Access -- Management (IAM) role that grants Amazon Comprehend read access to -- trained custom models encrypted with a customer managed key -- (ModelKmsKeyId). createEndpoint_dataAccessRoleArn :: Lens' CreateEndpoint (Maybe Text) -- | Tags associated with the endpoint being created. A tag is a key-value -- pair that adds metadata to the endpoint. For example, a tag with -- "Sales" as the key might be added to an endpoint to indicate its use -- by the sales department. createEndpoint_tags :: Lens' CreateEndpoint (Maybe [Tag]) -- | This is the descriptive suffix that becomes part of the -- EndpointArn used for all subsequent requests to this -- resource. createEndpoint_endpointName :: Lens' CreateEndpoint Text -- | The Amazon Resource Number (ARN) of the model to which the endpoint -- will be attached. createEndpoint_modelArn :: Lens' CreateEndpoint Text -- | The desired number of inference units to be used by the model using -- this endpoint. Each inference unit represents of a throughput of 100 -- characters per second. createEndpoint_desiredInferenceUnits :: Lens' CreateEndpoint Natural -- | See: newCreateEndpointResponse smart constructor. data CreateEndpointResponse CreateEndpointResponse' :: Maybe Text -> Int -> CreateEndpointResponse -- | The Amazon Resource Number (ARN) of the endpoint being created. [$sel:endpointArn:CreateEndpointResponse'] :: CreateEndpointResponse -> Maybe Text -- | The response's http status code. [$sel:httpStatus:CreateEndpointResponse'] :: CreateEndpointResponse -> Int -- | Create a value of CreateEndpointResponse with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- CreateEndpointResponse, -- createEndpointResponse_endpointArn - The Amazon Resource Number -- (ARN) of the endpoint being created. -- -- $sel:httpStatus:CreateEndpointResponse', -- createEndpointResponse_httpStatus - The response's http status -- code. newCreateEndpointResponse :: Int -> CreateEndpointResponse -- | The Amazon Resource Number (ARN) of the endpoint being created. createEndpointResponse_endpointArn :: Lens' CreateEndpointResponse (Maybe Text) -- | The response's http status code. createEndpointResponse_httpStatus :: Lens' CreateEndpointResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.CreateEndpoint.CreateEndpoint instance GHC.Show.Show Amazonka.Comprehend.CreateEndpoint.CreateEndpoint instance GHC.Read.Read Amazonka.Comprehend.CreateEndpoint.CreateEndpoint instance GHC.Classes.Eq Amazonka.Comprehend.CreateEndpoint.CreateEndpoint instance GHC.Generics.Generic Amazonka.Comprehend.CreateEndpoint.CreateEndpointResponse instance GHC.Show.Show Amazonka.Comprehend.CreateEndpoint.CreateEndpointResponse instance GHC.Read.Read Amazonka.Comprehend.CreateEndpoint.CreateEndpointResponse instance GHC.Classes.Eq Amazonka.Comprehend.CreateEndpoint.CreateEndpointResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.CreateEndpoint.CreateEndpoint instance Control.DeepSeq.NFData Amazonka.Comprehend.CreateEndpoint.CreateEndpointResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.CreateEndpoint.CreateEndpoint instance Control.DeepSeq.NFData Amazonka.Comprehend.CreateEndpoint.CreateEndpoint instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.CreateEndpoint.CreateEndpoint instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.CreateEndpoint.CreateEndpoint instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.CreateEndpoint.CreateEndpoint instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.CreateEndpoint.CreateEndpoint -- | Creates a new document classifier that you can use to categorize -- documents. To create a classifier, you provide a set of training -- documents that labeled with the categories that you want to use. After -- the classifier is trained you can use it to categorize a set of -- labeled documents into the categories. For more information, see -- Document Classification in the Comprehend Developer Guide. module Amazonka.Comprehend.CreateDocumentClassifier -- | See: newCreateDocumentClassifier smart constructor. data CreateDocumentClassifier CreateDocumentClassifier' :: Maybe Text -> Maybe DocumentClassifierMode -> Maybe Text -> Maybe Text -> Maybe DocumentClassifierOutputDataConfig -> Maybe [Tag] -> Maybe Text -> Maybe Text -> Maybe VpcConfig -> Text -> Text -> DocumentClassifierInputDataConfig -> LanguageCode -> CreateDocumentClassifier -- | A unique identifier for the request. If you don't set the client -- request token, Amazon Comprehend generates one. [$sel:clientRequestToken:CreateDocumentClassifier'] :: CreateDocumentClassifier -> Maybe Text -- | Indicates the mode in which the classifier will be trained. The -- classifier can be trained in multi-class mode, which identifies one -- and only one class for each document, or multi-label mode, which -- identifies one or more labels for each document. In multi-label mode, -- multiple labels for an individual document are separated by a -- delimiter. The default delimiter between labels is a pipe (|). [$sel:mode:CreateDocumentClassifier'] :: CreateDocumentClassifier -> Maybe DocumentClassifierMode -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt trained custom models. The ModelKmsKeyId can be either -- of the following formats: -- -- [$sel:modelKmsKeyId:CreateDocumentClassifier'] :: CreateDocumentClassifier -> Maybe Text -- | The resource-based policy to attach to your custom document classifier -- model. You can use this policy to allow another AWS account to import -- your custom model. -- -- Provide your policy as a JSON body that you enter as a UTF-8 encoded -- string without line breaks. To provide valid JSON, enclose the -- attribute names and values in double quotes. If the JSON body is also -- enclosed in double quotes, then you must escape the double quotes that -- are inside the policy: -- -- 
--   "{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
--
-- -- To avoid escaping quotes, you can use single quotes to enclose the -- policy and double quotes to enclose the JSON names and values: -- -- 
--   '{"attribute": "value", "attribute": ["value"]}'
--
[$sel:modelPolicy:CreateDocumentClassifier'] :: CreateDocumentClassifier -> Maybe Text -- | Enables the addition of output results configuration parameters for -- custom classifier jobs. [$sel:outputDataConfig:CreateDocumentClassifier'] :: CreateDocumentClassifier -> Maybe DocumentClassifierOutputDataConfig -- | Tags to be associated with the document classifier being created. A -- tag is a key-value pair that adds as a metadata to a resource used by -- Amazon Comprehend. For example, a tag with "Sales" as the key might be -- added to a resource to indicate its use by the sales department. [$sel:tags:CreateDocumentClassifier'] :: CreateDocumentClassifier -> Maybe [Tag] -- | The version name given to the newly created classifier. Version names -- can have a maximum of 256 characters. Alphanumeric characters, hyphens -- (-) and underscores (_) are allowed. The version name must be unique -- among all models with the same classifier name in the account/AWS -- Region. [$sel:versionName:CreateDocumentClassifier'] :: CreateDocumentClassifier -> Maybe Text -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- [$sel:volumeKmsKeyId:CreateDocumentClassifier'] :: CreateDocumentClassifier -> Maybe Text -- | Configuration parameters for an optional private Virtual Private Cloud -- (VPC) containing the resources you are using for your custom -- classifier. For more information, see Amazon VPC. [$sel:vpcConfig:CreateDocumentClassifier'] :: CreateDocumentClassifier -> Maybe VpcConfig -- | The name of the document classifier. [$sel:documentClassifierName:CreateDocumentClassifier'] :: CreateDocumentClassifier -> Text -- | The Amazon Resource Name (ARN) of the AWS Identity and Management -- (IAM) role that grants Amazon Comprehend read access to your input -- data. [$sel:dataAccessRoleArn:CreateDocumentClassifier'] :: CreateDocumentClassifier -> Text -- | Specifies the format and location of the input data for the job. [$sel:inputDataConfig:CreateDocumentClassifier'] :: CreateDocumentClassifier -> DocumentClassifierInputDataConfig -- | The language of the input documents. You can specify any of the -- following languages supported by Amazon Comprehend: German ("de"), -- English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or -- Portuguese ("pt"). All documents must be in the same language. [$sel:languageCode:CreateDocumentClassifier'] :: CreateDocumentClassifier -> LanguageCode -- | Create a value of CreateDocumentClassifier with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:clientRequestToken:CreateDocumentClassifier', -- createDocumentClassifier_clientRequestToken - A unique -- identifier for the request. If you don't set the client request token, -- Amazon Comprehend generates one. -- -- CreateDocumentClassifier, createDocumentClassifier_mode -- - Indicates the mode in which the classifier will be trained. The -- classifier can be trained in multi-class mode, which identifies one -- and only one class for each document, or multi-label mode, which -- identifies one or more labels for each document. In multi-label mode, -- multiple labels for an individual document are separated by a -- delimiter. The default delimiter between labels is a pipe (|). -- -- CreateDocumentClassifier, -- createDocumentClassifier_modelKmsKeyId - ID for the AWS Key -- Management Service (KMS) key that Amazon Comprehend uses to encrypt -- trained custom models. The ModelKmsKeyId can be either of the -- following formats: -- -- -- -- $sel:modelPolicy:CreateDocumentClassifier', -- createDocumentClassifier_modelPolicy - The resource-based -- policy to attach to your custom document classifier model. You can use -- this policy to allow another AWS account to import your custom model. -- -- Provide your policy as a JSON body that you enter as a UTF-8 encoded -- string without line breaks. To provide valid JSON, enclose the -- attribute names and values in double quotes. If the JSON body is also -- enclosed in double quotes, then you must escape the double quotes that -- are inside the policy: -- -- 
--   "{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
--
-- -- To avoid escaping quotes, you can use single quotes to enclose the -- policy and double quotes to enclose the JSON names and values: -- -- 
--   '{"attribute": "value", "attribute": ["value"]}'
--
-- -- CreateDocumentClassifier, -- createDocumentClassifier_outputDataConfig - Enables the -- addition of output results configuration parameters for custom -- classifier jobs. -- -- $sel:tags:CreateDocumentClassifier', -- createDocumentClassifier_tags - Tags to be associated with the -- document classifier being created. A tag is a key-value pair that adds -- as a metadata to a resource used by Amazon Comprehend. For example, a -- tag with "Sales" as the key might be added to a resource to indicate -- its use by the sales department. -- -- CreateDocumentClassifier, -- createDocumentClassifier_versionName - The version name given -- to the newly created classifier. Version names can have a maximum of -- 256 characters. Alphanumeric characters, hyphens (-) and underscores -- (_) are allowed. The version name must be unique among all models with -- the same classifier name in the account/AWS Region. -- -- CreateDocumentClassifier, -- createDocumentClassifier_volumeKmsKeyId - ID for the AWS Key -- Management Service (KMS) key that Amazon Comprehend uses to encrypt -- data on the storage volume attached to the ML compute instance(s) that -- process the analysis job. The VolumeKmsKeyId can be either of the -- following formats: -- -- -- -- CreateDocumentClassifier, -- createDocumentClassifier_vpcConfig - Configuration parameters -- for an optional private Virtual Private Cloud (VPC) containing the -- resources you are using for your custom classifier. For more -- information, see Amazon VPC. -- -- CreateDocumentClassifier, -- createDocumentClassifier_documentClassifierName - The name of -- the document classifier. -- -- CreateDocumentClassifier, -- createDocumentClassifier_dataAccessRoleArn - The Amazon -- Resource Name (ARN) of the AWS Identity and Management (IAM) role that -- grants Amazon Comprehend read access to your input data. -- -- CreateDocumentClassifier, -- createDocumentClassifier_inputDataConfig - Specifies the format -- and location of the input data for the job. -- -- CreateDocumentClassifier, -- createDocumentClassifier_languageCode - The language of the -- input documents. You can specify any of the following languages -- supported by Amazon Comprehend: German ("de"), English ("en"), Spanish -- ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All -- documents must be in the same language. newCreateDocumentClassifier :: Text -> Text -> DocumentClassifierInputDataConfig -> LanguageCode -> CreateDocumentClassifier -- | A unique identifier for the request. If you don't set the client -- request token, Amazon Comprehend generates one. createDocumentClassifier_clientRequestToken :: Lens' CreateDocumentClassifier (Maybe Text) -- | Indicates the mode in which the classifier will be trained. The -- classifier can be trained in multi-class mode, which identifies one -- and only one class for each document, or multi-label mode, which -- identifies one or more labels for each document. In multi-label mode, -- multiple labels for an individual document are separated by a -- delimiter. The default delimiter between labels is a pipe (|). createDocumentClassifier_mode :: Lens' CreateDocumentClassifier (Maybe DocumentClassifierMode) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt trained custom models. The ModelKmsKeyId can be either -- of the following formats: -- -- createDocumentClassifier_modelKmsKeyId :: Lens' CreateDocumentClassifier (Maybe Text) -- | The resource-based policy to attach to your custom document classifier -- model. You can use this policy to allow another AWS account to import -- your custom model. -- -- Provide your policy as a JSON body that you enter as a UTF-8 encoded -- string without line breaks. To provide valid JSON, enclose the -- attribute names and values in double quotes. If the JSON body is also -- enclosed in double quotes, then you must escape the double quotes that -- are inside the policy: -- -- 
--   "{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
--
-- -- To avoid escaping quotes, you can use single quotes to enclose the -- policy and double quotes to enclose the JSON names and values: -- -- 
--   '{"attribute": "value", "attribute": ["value"]}'
--
createDocumentClassifier_modelPolicy :: Lens' CreateDocumentClassifier (Maybe Text) -- | Enables the addition of output results configuration parameters for -- custom classifier jobs. createDocumentClassifier_outputDataConfig :: Lens' CreateDocumentClassifier (Maybe DocumentClassifierOutputDataConfig) -- | Tags to be associated with the document classifier being created. A -- tag is a key-value pair that adds as a metadata to a resource used by -- Amazon Comprehend. For example, a tag with "Sales" as the key might be -- added to a resource to indicate its use by the sales department. createDocumentClassifier_tags :: Lens' CreateDocumentClassifier (Maybe [Tag]) -- | The version name given to the newly created classifier. Version names -- can have a maximum of 256 characters. Alphanumeric characters, hyphens -- (-) and underscores (_) are allowed. The version name must be unique -- among all models with the same classifier name in the account/AWS -- Region. createDocumentClassifier_versionName :: Lens' CreateDocumentClassifier (Maybe Text) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- createDocumentClassifier_volumeKmsKeyId :: Lens' CreateDocumentClassifier (Maybe Text) -- | Configuration parameters for an optional private Virtual Private Cloud -- (VPC) containing the resources you are using for your custom -- classifier. For more information, see Amazon VPC. createDocumentClassifier_vpcConfig :: Lens' CreateDocumentClassifier (Maybe VpcConfig) -- | The name of the document classifier. createDocumentClassifier_documentClassifierName :: Lens' CreateDocumentClassifier Text -- | The Amazon Resource Name (ARN) of the AWS Identity and Management -- (IAM) role that grants Amazon Comprehend read access to your input -- data. createDocumentClassifier_dataAccessRoleArn :: Lens' CreateDocumentClassifier Text -- | Specifies the format and location of the input data for the job. createDocumentClassifier_inputDataConfig :: Lens' CreateDocumentClassifier DocumentClassifierInputDataConfig -- | The language of the input documents. You can specify any of the -- following languages supported by Amazon Comprehend: German ("de"), -- English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or -- Portuguese ("pt"). All documents must be in the same language. createDocumentClassifier_languageCode :: Lens' CreateDocumentClassifier LanguageCode -- | See: newCreateDocumentClassifierResponse smart -- constructor. data CreateDocumentClassifierResponse CreateDocumentClassifierResponse' :: Maybe Text -> Int -> CreateDocumentClassifierResponse -- | The Amazon Resource Name (ARN) that identifies the document -- classifier. [$sel:documentClassifierArn:CreateDocumentClassifierResponse'] :: CreateDocumentClassifierResponse -> Maybe Text -- | The response's http status code. [$sel:httpStatus:CreateDocumentClassifierResponse'] :: CreateDocumentClassifierResponse -> Int -- | Create a value of CreateDocumentClassifierResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- CreateDocumentClassifierResponse, -- createDocumentClassifierResponse_documentClassifierArn - The -- Amazon Resource Name (ARN) that identifies the document classifier. -- -- $sel:httpStatus:CreateDocumentClassifierResponse', -- createDocumentClassifierResponse_httpStatus - The response's -- http status code. newCreateDocumentClassifierResponse :: Int -> CreateDocumentClassifierResponse -- | The Amazon Resource Name (ARN) that identifies the document -- classifier. createDocumentClassifierResponse_documentClassifierArn :: Lens' CreateDocumentClassifierResponse (Maybe Text) -- | The response's http status code. createDocumentClassifierResponse_httpStatus :: Lens' CreateDocumentClassifierResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.CreateDocumentClassifier.CreateDocumentClassifier instance GHC.Show.Show Amazonka.Comprehend.CreateDocumentClassifier.CreateDocumentClassifier instance GHC.Read.Read Amazonka.Comprehend.CreateDocumentClassifier.CreateDocumentClassifier instance GHC.Classes.Eq Amazonka.Comprehend.CreateDocumentClassifier.CreateDocumentClassifier instance GHC.Generics.Generic Amazonka.Comprehend.CreateDocumentClassifier.CreateDocumentClassifierResponse instance GHC.Show.Show Amazonka.Comprehend.CreateDocumentClassifier.CreateDocumentClassifierResponse instance GHC.Read.Read Amazonka.Comprehend.CreateDocumentClassifier.CreateDocumentClassifierResponse instance GHC.Classes.Eq Amazonka.Comprehend.CreateDocumentClassifier.CreateDocumentClassifierResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.CreateDocumentClassifier.CreateDocumentClassifier instance Control.DeepSeq.NFData Amazonka.Comprehend.CreateDocumentClassifier.CreateDocumentClassifierResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.CreateDocumentClassifier.CreateDocumentClassifier instance Control.DeepSeq.NFData Amazonka.Comprehend.CreateDocumentClassifier.CreateDocumentClassifier instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.CreateDocumentClassifier.CreateDocumentClassifier instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.CreateDocumentClassifier.CreateDocumentClassifier instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.CreateDocumentClassifier.CreateDocumentClassifier instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.CreateDocumentClassifier.CreateDocumentClassifier -- | Analyzes input text for the presence of personally identifiable -- information (PII) and returns the labels of identified PII entity -- types such as name, address, bank account number, or phone number. module Amazonka.Comprehend.ContainsPiiEntities -- | See: newContainsPiiEntities smart constructor. data ContainsPiiEntities ContainsPiiEntities' :: Text -> LanguageCode -> ContainsPiiEntities -- | A UTF-8 text string. The maximum string size is 100 KB. [$sel:text:ContainsPiiEntities'] :: ContainsPiiEntities -> Text -- | The language of the input documents. Currently, English is the only -- valid language. [$sel:languageCode:ContainsPiiEntities'] :: ContainsPiiEntities -> LanguageCode -- | Create a value of ContainsPiiEntities with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- ContainsPiiEntities, containsPiiEntities_text - A UTF-8 -- text string. The maximum string size is 100 KB. -- -- ContainsPiiEntities, containsPiiEntities_languageCode - -- The language of the input documents. Currently, English is the only -- valid language. newContainsPiiEntities :: Text -> LanguageCode -> ContainsPiiEntities -- | A UTF-8 text string. The maximum string size is 100 KB. containsPiiEntities_text :: Lens' ContainsPiiEntities Text -- | The language of the input documents. Currently, English is the only -- valid language. containsPiiEntities_languageCode :: Lens' ContainsPiiEntities LanguageCode -- | See: newContainsPiiEntitiesResponse smart constructor. data ContainsPiiEntitiesResponse ContainsPiiEntitiesResponse' :: Maybe [EntityLabel] -> Int -> ContainsPiiEntitiesResponse -- | The labels used in the document being analyzed. Individual labels -- represent personally identifiable information (PII) entity types. [$sel:labels:ContainsPiiEntitiesResponse'] :: ContainsPiiEntitiesResponse -> Maybe [EntityLabel] -- | The response's http status code. [$sel:httpStatus:ContainsPiiEntitiesResponse'] :: ContainsPiiEntitiesResponse -> Int -- | Create a value of ContainsPiiEntitiesResponse with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:labels:ContainsPiiEntitiesResponse', -- containsPiiEntitiesResponse_labels - The labels used in the -- document being analyzed. Individual labels represent personally -- identifiable information (PII) entity types. -- -- $sel:httpStatus:ContainsPiiEntitiesResponse', -- containsPiiEntitiesResponse_httpStatus - The response's http -- status code. newContainsPiiEntitiesResponse :: Int -> ContainsPiiEntitiesResponse -- | The labels used in the document being analyzed. Individual labels -- represent personally identifiable information (PII) entity types. containsPiiEntitiesResponse_labels :: Lens' ContainsPiiEntitiesResponse (Maybe [EntityLabel]) -- | The response's http status code. containsPiiEntitiesResponse_httpStatus :: Lens' ContainsPiiEntitiesResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.ContainsPiiEntities.ContainsPiiEntities instance GHC.Show.Show Amazonka.Comprehend.ContainsPiiEntities.ContainsPiiEntities instance GHC.Read.Read Amazonka.Comprehend.ContainsPiiEntities.ContainsPiiEntities instance GHC.Classes.Eq Amazonka.Comprehend.ContainsPiiEntities.ContainsPiiEntities instance GHC.Generics.Generic Amazonka.Comprehend.ContainsPiiEntities.ContainsPiiEntitiesResponse instance GHC.Show.Show Amazonka.Comprehend.ContainsPiiEntities.ContainsPiiEntitiesResponse instance GHC.Read.Read Amazonka.Comprehend.ContainsPiiEntities.ContainsPiiEntitiesResponse instance GHC.Classes.Eq Amazonka.Comprehend.ContainsPiiEntities.ContainsPiiEntitiesResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.ContainsPiiEntities.ContainsPiiEntities instance Control.DeepSeq.NFData Amazonka.Comprehend.ContainsPiiEntities.ContainsPiiEntitiesResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.ContainsPiiEntities.ContainsPiiEntities instance Control.DeepSeq.NFData Amazonka.Comprehend.ContainsPiiEntities.ContainsPiiEntities instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.ContainsPiiEntities.ContainsPiiEntities instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.ContainsPiiEntities.ContainsPiiEntities instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.ContainsPiiEntities.ContainsPiiEntities instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.ContainsPiiEntities.ContainsPiiEntities -- | Creates a new document classification request to analyze a single -- document in real-time, using a previously created and trained custom -- model and an endpoint. -- -- You can input plain text or you can upload a single-page input -- document (text, PDF, Word, or image). -- -- If the system detects errors while processing a page in the input -- document, the API response includes an entry in Errors that -- describes the errors. -- -- If the system detects a document-level error in your input document, -- the API returns an InvalidRequestException error response. -- For details about this exception, see Errors in semi-structured -- documents in the Comprehend Developer Guide. module Amazonka.Comprehend.ClassifyDocument -- | See: newClassifyDocument smart constructor. data ClassifyDocument ClassifyDocument' :: Maybe Base64 -> Maybe DocumentReaderConfig -> Maybe (Sensitive Text) -> Text -> ClassifyDocument -- | Use the Bytes parameter to input a text, PDF, Word or image -- file. You can also use the Bytes parameter to input an Amazon -- Textract DetectDocumentText or AnalyzeDocument -- output file. -- -- Provide the input document as a sequence of base64-encoded bytes. If -- your code uses an Amazon Web Services SDK to classify documents, the -- SDK may encode the document file bytes for you. -- -- The maximum length of this field depends on the input document type. -- For details, see Inputs for real-time custom analysis in the -- Comprehend Developer Guide. -- -- If you use the Bytes parameter, do not use the Text -- parameter. [$sel:bytes:ClassifyDocument'] :: ClassifyDocument -> Maybe Base64 -- | Provides configuration parameters to override the default actions for -- extracting text from PDF documents and image files. [$sel:documentReaderConfig:ClassifyDocument'] :: ClassifyDocument -> Maybe DocumentReaderConfig -- | The document text to be analyzed. If you enter text using this -- parameter, do not use the Bytes parameter. [$sel:text:ClassifyDocument'] :: ClassifyDocument -> Maybe (Sensitive Text) -- | The Amazon Resource Number (ARN) of the endpoint. For information -- about endpoints, see Managing endpoints. [$sel:endpointArn:ClassifyDocument'] :: ClassifyDocument -> Text -- | Create a value of ClassifyDocument with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:bytes:ClassifyDocument', classifyDocument_bytes - -- Use the Bytes parameter to input a text, PDF, Word or image -- file. You can also use the Bytes parameter to input an Amazon -- Textract DetectDocumentText or AnalyzeDocument -- output file. -- -- Provide the input document as a sequence of base64-encoded bytes. If -- your code uses an Amazon Web Services SDK to classify documents, the -- SDK may encode the document file bytes for you. -- -- The maximum length of this field depends on the input document type. -- For details, see Inputs for real-time custom analysis in the -- Comprehend Developer Guide. -- -- If you use the Bytes parameter, do not use the Text -- parameter.-- -- Note: This Lens automatically encodes -- and decodes Base64 data. -- The underlying isomorphism will encode to -- Base64 representation during -- serialisation, and decode from Base64 -- representation during deserialisation. -- This Lens accepts -- and returns only raw unencoded data. -- -- ClassifyDocument, classifyDocument_documentReaderConfig -- - Provides configuration parameters to override the default actions -- for extracting text from PDF documents and image files. -- -- ClassifyDocument, classifyDocument_text - The document -- text to be analyzed. If you enter text using this parameter, do not -- use the Bytes parameter. -- -- ClassifyDocument, classifyDocument_endpointArn - The -- Amazon Resource Number (ARN) of the endpoint. For information about -- endpoints, see Managing endpoints. newClassifyDocument :: Text -> ClassifyDocument -- | Use the Bytes parameter to input a text, PDF, Word or image -- file. You can also use the Bytes parameter to input an Amazon -- Textract DetectDocumentText or AnalyzeDocument -- output file. -- -- Provide the input document as a sequence of base64-encoded bytes. If -- your code uses an Amazon Web Services SDK to classify documents, the -- SDK may encode the document file bytes for you. -- -- The maximum length of this field depends on the input document type. -- For details, see Inputs for real-time custom analysis in the -- Comprehend Developer Guide. -- -- If you use the Bytes parameter, do not use the Text -- parameter.-- -- Note: This Lens automatically encodes -- and decodes Base64 data. -- The underlying isomorphism will encode to -- Base64 representation during -- serialisation, and decode from Base64 -- representation during deserialisation. -- This Lens accepts -- and returns only raw unencoded data. classifyDocument_bytes :: Lens' ClassifyDocument (Maybe ByteString) -- | Provides configuration parameters to override the default actions for -- extracting text from PDF documents and image files. classifyDocument_documentReaderConfig :: Lens' ClassifyDocument (Maybe DocumentReaderConfig) -- | The document text to be analyzed. If you enter text using this -- parameter, do not use the Bytes parameter. classifyDocument_text :: Lens' ClassifyDocument (Maybe Text) -- | The Amazon Resource Number (ARN) of the endpoint. For information -- about endpoints, see Managing endpoints. classifyDocument_endpointArn :: Lens' ClassifyDocument Text -- | See: newClassifyDocumentResponse smart constructor. data ClassifyDocumentResponse ClassifyDocumentResponse' :: Maybe [DocumentClass] -> Maybe DocumentMetadata -> Maybe [DocumentTypeListItem] -> Maybe [ErrorsListItem] -> Maybe [DocumentLabel] -> Int -> ClassifyDocumentResponse -- | The classes used by the document being analyzed. These are used for -- multi-class trained models. Individual classes are mutually exclusive -- and each document is expected to have only a single class assigned to -- it. For example, an animal can be a dog or a cat, but not both at the -- same time. [$sel:classes:ClassifyDocumentResponse'] :: ClassifyDocumentResponse -> Maybe [DocumentClass] -- | Extraction information about the document. This field is present in -- the response only if your request includes the Byte -- parameter. [$sel:documentMetadata:ClassifyDocumentResponse'] :: ClassifyDocumentResponse -> Maybe DocumentMetadata -- | The document type for each page in the input document. This field is -- present in the response only if your request includes the -- Byte parameter. [$sel:documentType:ClassifyDocumentResponse'] :: ClassifyDocumentResponse -> Maybe [DocumentTypeListItem] -- | Page-level errors that the system detected while processing the input -- document. The field is empty if the system encountered no errors. [$sel:errors:ClassifyDocumentResponse'] :: ClassifyDocumentResponse -> Maybe [ErrorsListItem] -- | The labels used the document being analyzed. These are used for -- multi-label trained models. Individual labels represent different -- categories that are related in some manner and are not mutually -- exclusive. For example, a movie can be just an action movie, or it can -- be an action movie, a science fiction movie, and a comedy, all at the -- same time. [$sel:labels:ClassifyDocumentResponse'] :: ClassifyDocumentResponse -> Maybe [DocumentLabel] -- | The response's http status code. [$sel:httpStatus:ClassifyDocumentResponse'] :: ClassifyDocumentResponse -> Int -- | Create a value of ClassifyDocumentResponse with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:classes:ClassifyDocumentResponse', -- classifyDocumentResponse_classes - The classes used by the -- document being analyzed. These are used for multi-class trained -- models. Individual classes are mutually exclusive and each document is -- expected to have only a single class assigned to it. For example, an -- animal can be a dog or a cat, but not both at the same time. -- -- $sel:documentMetadata:ClassifyDocumentResponse', -- classifyDocumentResponse_documentMetadata - Extraction -- information about the document. This field is present in the response -- only if your request includes the Byte parameter. -- -- ClassifyDocumentResponse, -- classifyDocumentResponse_documentType - The document type for -- each page in the input document. This field is present in the response -- only if your request includes the Byte parameter. -- -- $sel:errors:ClassifyDocumentResponse', -- classifyDocumentResponse_errors - Page-level errors that the -- system detected while processing the input document. The field is -- empty if the system encountered no errors. -- -- $sel:labels:ClassifyDocumentResponse', -- classifyDocumentResponse_labels - The labels used the document -- being analyzed. These are used for multi-label trained models. -- Individual labels represent different categories that are related in -- some manner and are not mutually exclusive. For example, a movie can -- be just an action movie, or it can be an action movie, a science -- fiction movie, and a comedy, all at the same time. -- -- $sel:httpStatus:ClassifyDocumentResponse', -- classifyDocumentResponse_httpStatus - The response's http -- status code. newClassifyDocumentResponse :: Int -> ClassifyDocumentResponse -- | The classes used by the document being analyzed. These are used for -- multi-class trained models. Individual classes are mutually exclusive -- and each document is expected to have only a single class assigned to -- it. For example, an animal can be a dog or a cat, but not both at the -- same time. classifyDocumentResponse_classes :: Lens' ClassifyDocumentResponse (Maybe [DocumentClass]) -- | Extraction information about the document. This field is present in -- the response only if your request includes the Byte -- parameter. classifyDocumentResponse_documentMetadata :: Lens' ClassifyDocumentResponse (Maybe DocumentMetadata) -- | The document type for each page in the input document. This field is -- present in the response only if your request includes the -- Byte parameter. classifyDocumentResponse_documentType :: Lens' ClassifyDocumentResponse (Maybe [DocumentTypeListItem]) -- | Page-level errors that the system detected while processing the input -- document. The field is empty if the system encountered no errors. classifyDocumentResponse_errors :: Lens' ClassifyDocumentResponse (Maybe [ErrorsListItem]) -- | The labels used the document being analyzed. These are used for -- multi-label trained models. Individual labels represent different -- categories that are related in some manner and are not mutually -- exclusive. For example, a movie can be just an action movie, or it can -- be an action movie, a science fiction movie, and a comedy, all at the -- same time. classifyDocumentResponse_labels :: Lens' ClassifyDocumentResponse (Maybe [DocumentLabel]) -- | The response's http status code. classifyDocumentResponse_httpStatus :: Lens' ClassifyDocumentResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.ClassifyDocument.ClassifyDocument instance GHC.Show.Show Amazonka.Comprehend.ClassifyDocument.ClassifyDocument instance GHC.Classes.Eq Amazonka.Comprehend.ClassifyDocument.ClassifyDocument instance GHC.Generics.Generic Amazonka.Comprehend.ClassifyDocument.ClassifyDocumentResponse instance GHC.Show.Show Amazonka.Comprehend.ClassifyDocument.ClassifyDocumentResponse instance GHC.Classes.Eq Amazonka.Comprehend.ClassifyDocument.ClassifyDocumentResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.ClassifyDocument.ClassifyDocument instance Control.DeepSeq.NFData Amazonka.Comprehend.ClassifyDocument.ClassifyDocumentResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.ClassifyDocument.ClassifyDocument instance Control.DeepSeq.NFData Amazonka.Comprehend.ClassifyDocument.ClassifyDocument instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.ClassifyDocument.ClassifyDocument instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.ClassifyDocument.ClassifyDocument instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.ClassifyDocument.ClassifyDocument instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.ClassifyDocument.ClassifyDocument -- | Inspects a batch of documents and returns a sentiment analysis for -- each entity identified in the documents. -- -- For more information about targeted sentiment, see Targeted -- sentiment. module Amazonka.Comprehend.BatchDetectTargetedSentiment -- | See: newBatchDetectTargetedSentiment smart constructor. data BatchDetectTargetedSentiment BatchDetectTargetedSentiment' :: Sensitive (NonEmpty (Sensitive Text)) -> LanguageCode -> BatchDetectTargetedSentiment -- | A list containing the UTF-8 encoded text of the input documents. The -- list can contain a maximum of 25 documents. The maximum size of each -- document is 5 KB. [$sel:textList:BatchDetectTargetedSentiment'] :: BatchDetectTargetedSentiment -> Sensitive (NonEmpty (Sensitive Text)) -- | The language of the input documents. Currently, English is the only -- supported language. [$sel:languageCode:BatchDetectTargetedSentiment'] :: BatchDetectTargetedSentiment -> LanguageCode -- | Create a value of BatchDetectTargetedSentiment with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:textList:BatchDetectTargetedSentiment', -- batchDetectTargetedSentiment_textList - A list containing the -- UTF-8 encoded text of the input documents. The list can contain a -- maximum of 25 documents. The maximum size of each document is 5 KB. -- -- BatchDetectTargetedSentiment, -- batchDetectTargetedSentiment_languageCode - The language of the -- input documents. Currently, English is the only supported language. newBatchDetectTargetedSentiment :: NonEmpty Text -> LanguageCode -> BatchDetectTargetedSentiment -- | A list containing the UTF-8 encoded text of the input documents. The -- list can contain a maximum of 25 documents. The maximum size of each -- document is 5 KB. batchDetectTargetedSentiment_textList :: Lens' BatchDetectTargetedSentiment (NonEmpty Text) -- | The language of the input documents. Currently, English is the only -- supported language. batchDetectTargetedSentiment_languageCode :: Lens' BatchDetectTargetedSentiment LanguageCode -- | See: newBatchDetectTargetedSentimentResponse smart -- constructor. data BatchDetectTargetedSentimentResponse BatchDetectTargetedSentimentResponse' :: Int -> [BatchDetectTargetedSentimentItemResult] -> [BatchItemError] -> BatchDetectTargetedSentimentResponse -- | The response's http status code. [$sel:httpStatus:BatchDetectTargetedSentimentResponse'] :: BatchDetectTargetedSentimentResponse -> Int -- | A list of objects containing the results of the operation. The results -- are sorted in ascending order by the Index field and match -- the order of the documents in the input list. If all of the documents -- contain an error, the ResultList is empty. [$sel:resultList:BatchDetectTargetedSentimentResponse'] :: BatchDetectTargetedSentimentResponse -> [BatchDetectTargetedSentimentItemResult] -- | List of errors that the operation can return. [$sel:errorList:BatchDetectTargetedSentimentResponse'] :: BatchDetectTargetedSentimentResponse -> [BatchItemError] -- | Create a value of BatchDetectTargetedSentimentResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:httpStatus:BatchDetectTargetedSentimentResponse', -- batchDetectTargetedSentimentResponse_httpStatus - The -- response's http status code. -- -- $sel:resultList:BatchDetectTargetedSentimentResponse', -- batchDetectTargetedSentimentResponse_resultList - A list of -- objects containing the results of the operation. The results are -- sorted in ascending order by the Index field and match the -- order of the documents in the input list. If all of the documents -- contain an error, the ResultList is empty. -- -- $sel:errorList:BatchDetectTargetedSentimentResponse', -- batchDetectTargetedSentimentResponse_errorList - List of errors -- that the operation can return. newBatchDetectTargetedSentimentResponse :: Int -> BatchDetectTargetedSentimentResponse -- | The response's http status code. batchDetectTargetedSentimentResponse_httpStatus :: Lens' BatchDetectTargetedSentimentResponse Int -- | A list of objects containing the results of the operation. The results -- are sorted in ascending order by the Index field and match -- the order of the documents in the input list. If all of the documents -- contain an error, the ResultList is empty. batchDetectTargetedSentimentResponse_resultList :: Lens' BatchDetectTargetedSentimentResponse [BatchDetectTargetedSentimentItemResult] -- | List of errors that the operation can return. batchDetectTargetedSentimentResponse_errorList :: Lens' BatchDetectTargetedSentimentResponse [BatchItemError] instance GHC.Generics.Generic Amazonka.Comprehend.BatchDetectTargetedSentiment.BatchDetectTargetedSentiment instance GHC.Show.Show Amazonka.Comprehend.BatchDetectTargetedSentiment.BatchDetectTargetedSentiment instance GHC.Classes.Eq Amazonka.Comprehend.BatchDetectTargetedSentiment.BatchDetectTargetedSentiment instance GHC.Generics.Generic Amazonka.Comprehend.BatchDetectTargetedSentiment.BatchDetectTargetedSentimentResponse instance GHC.Show.Show Amazonka.Comprehend.BatchDetectTargetedSentiment.BatchDetectTargetedSentimentResponse instance GHC.Classes.Eq Amazonka.Comprehend.BatchDetectTargetedSentiment.BatchDetectTargetedSentimentResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.BatchDetectTargetedSentiment.BatchDetectTargetedSentiment instance Control.DeepSeq.NFData Amazonka.Comprehend.BatchDetectTargetedSentiment.BatchDetectTargetedSentimentResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.BatchDetectTargetedSentiment.BatchDetectTargetedSentiment instance Control.DeepSeq.NFData Amazonka.Comprehend.BatchDetectTargetedSentiment.BatchDetectTargetedSentiment instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.BatchDetectTargetedSentiment.BatchDetectTargetedSentiment instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.BatchDetectTargetedSentiment.BatchDetectTargetedSentiment instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.BatchDetectTargetedSentiment.BatchDetectTargetedSentiment instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.BatchDetectTargetedSentiment.BatchDetectTargetedSentiment -- | Inspects the text of a batch of documents for the syntax and part of -- speech of the words in the document and returns information about -- them. For more information, see Syntax in the Comprehend -- Developer Guide. module Amazonka.Comprehend.BatchDetectSyntax -- | See: newBatchDetectSyntax smart constructor. data BatchDetectSyntax BatchDetectSyntax' :: Sensitive (NonEmpty (Sensitive Text)) -> SyntaxLanguageCode -> BatchDetectSyntax -- | A list containing the UTF-8 encoded text of the input documents. The -- list can contain a maximum of 25 documents. The maximum size for each -- document is 5 KB. [$sel:textList:BatchDetectSyntax'] :: BatchDetectSyntax -> Sensitive (NonEmpty (Sensitive Text)) -- | The language of the input documents. You can specify any of the -- following languages supported by Amazon Comprehend: German ("de"), -- English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or -- Portuguese ("pt"). All documents must be in the same language. [$sel:languageCode:BatchDetectSyntax'] :: BatchDetectSyntax -> SyntaxLanguageCode -- | Create a value of BatchDetectSyntax with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:textList:BatchDetectSyntax', -- batchDetectSyntax_textList - A list containing the UTF-8 -- encoded text of the input documents. The list can contain a maximum of -- 25 documents. The maximum size for each document is 5 KB. -- -- BatchDetectSyntax, batchDetectSyntax_languageCode - The -- language of the input documents. You can specify any of the following -- languages supported by Amazon Comprehend: German ("de"), English -- ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese -- ("pt"). All documents must be in the same language. newBatchDetectSyntax :: NonEmpty Text -> SyntaxLanguageCode -> BatchDetectSyntax -- | A list containing the UTF-8 encoded text of the input documents. The -- list can contain a maximum of 25 documents. The maximum size for each -- document is 5 KB. batchDetectSyntax_textList :: Lens' BatchDetectSyntax (NonEmpty Text) -- | The language of the input documents. You can specify any of the -- following languages supported by Amazon Comprehend: German ("de"), -- English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or -- Portuguese ("pt"). All documents must be in the same language. batchDetectSyntax_languageCode :: Lens' BatchDetectSyntax SyntaxLanguageCode -- | See: newBatchDetectSyntaxResponse smart constructor. data BatchDetectSyntaxResponse BatchDetectSyntaxResponse' :: Int -> [BatchDetectSyntaxItemResult] -> [BatchItemError] -> BatchDetectSyntaxResponse -- | The response's http status code. [$sel:httpStatus:BatchDetectSyntaxResponse'] :: BatchDetectSyntaxResponse -> Int -- | A list of objects containing the results of the operation. The results -- are sorted in ascending order by the Index field and match -- the order of the documents in the input list. If all of the documents -- contain an error, the ResultList is empty. [$sel:resultList:BatchDetectSyntaxResponse'] :: BatchDetectSyntaxResponse -> [BatchDetectSyntaxItemResult] -- | A list containing one object for each document that contained an -- error. The results are sorted in ascending order by the Index -- field and match the order of the documents in the input list. If there -- are no errors in the batch, the ErrorList is empty. [$sel:errorList:BatchDetectSyntaxResponse'] :: BatchDetectSyntaxResponse -> [BatchItemError] -- | Create a value of BatchDetectSyntaxResponse with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:httpStatus:BatchDetectSyntaxResponse', -- batchDetectSyntaxResponse_httpStatus - The response's http -- status code. -- -- $sel:resultList:BatchDetectSyntaxResponse', -- batchDetectSyntaxResponse_resultList - A list of objects -- containing the results of the operation. The results are sorted in -- ascending order by the Index field and match the order of the -- documents in the input list. If all of the documents contain an error, -- the ResultList is empty. -- -- $sel:errorList:BatchDetectSyntaxResponse', -- batchDetectSyntaxResponse_errorList - A list containing one -- object for each document that contained an error. The results are -- sorted in ascending order by the Index field and match the -- order of the documents in the input list. If there are no errors in -- the batch, the ErrorList is empty. newBatchDetectSyntaxResponse :: Int -> BatchDetectSyntaxResponse -- | The response's http status code. batchDetectSyntaxResponse_httpStatus :: Lens' BatchDetectSyntaxResponse Int -- | A list of objects containing the results of the operation. The results -- are sorted in ascending order by the Index field and match -- the order of the documents in the input list. If all of the documents -- contain an error, the ResultList is empty. batchDetectSyntaxResponse_resultList :: Lens' BatchDetectSyntaxResponse [BatchDetectSyntaxItemResult] -- | A list containing one object for each document that contained an -- error. The results are sorted in ascending order by the Index -- field and match the order of the documents in the input list. If there -- are no errors in the batch, the ErrorList is empty. batchDetectSyntaxResponse_errorList :: Lens' BatchDetectSyntaxResponse [BatchItemError] instance GHC.Generics.Generic Amazonka.Comprehend.BatchDetectSyntax.BatchDetectSyntax instance GHC.Show.Show Amazonka.Comprehend.BatchDetectSyntax.BatchDetectSyntax instance GHC.Classes.Eq Amazonka.Comprehend.BatchDetectSyntax.BatchDetectSyntax instance GHC.Generics.Generic Amazonka.Comprehend.BatchDetectSyntax.BatchDetectSyntaxResponse instance GHC.Show.Show Amazonka.Comprehend.BatchDetectSyntax.BatchDetectSyntaxResponse instance GHC.Classes.Eq Amazonka.Comprehend.BatchDetectSyntax.BatchDetectSyntaxResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.BatchDetectSyntax.BatchDetectSyntax instance Control.DeepSeq.NFData Amazonka.Comprehend.BatchDetectSyntax.BatchDetectSyntaxResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.BatchDetectSyntax.BatchDetectSyntax instance Control.DeepSeq.NFData Amazonka.Comprehend.BatchDetectSyntax.BatchDetectSyntax instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.BatchDetectSyntax.BatchDetectSyntax instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.BatchDetectSyntax.BatchDetectSyntax instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.BatchDetectSyntax.BatchDetectSyntax instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.BatchDetectSyntax.BatchDetectSyntax -- | Inspects a batch of documents and returns an inference of the -- prevailing sentiment, POSITIVE, NEUTRAL, -- MIXED, or NEGATIVE, in each one. module Amazonka.Comprehend.BatchDetectSentiment -- | See: newBatchDetectSentiment smart constructor. data BatchDetectSentiment BatchDetectSentiment' :: Sensitive (NonEmpty (Sensitive Text)) -> LanguageCode -> BatchDetectSentiment -- | A list containing the UTF-8 encoded text of the input documents. The -- list can contain a maximum of 25 documents. The maximum size of each -- document is 5 KB. -- -- Amazon Comprehend performs real-time sentiment analysis on the first -- 500 characters of the input text and ignores any additional text in -- the input. [$sel:textList:BatchDetectSentiment'] :: BatchDetectSentiment -> Sensitive (NonEmpty (Sensitive Text)) -- | The language of the input documents. You can specify any of the -- primary languages supported by Amazon Comprehend. All documents must -- be in the same language. [$sel:languageCode:BatchDetectSentiment'] :: BatchDetectSentiment -> LanguageCode -- | Create a value of BatchDetectSentiment with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:textList:BatchDetectSentiment', -- batchDetectSentiment_textList - A list containing the UTF-8 -- encoded text of the input documents. The list can contain a maximum of -- 25 documents. The maximum size of each document is 5 KB. -- -- Amazon Comprehend performs real-time sentiment analysis on the first -- 500 characters of the input text and ignores any additional text in -- the input. -- -- BatchDetectSentiment, batchDetectSentiment_languageCode -- - The language of the input documents. You can specify any of the -- primary languages supported by Amazon Comprehend. All documents must -- be in the same language. newBatchDetectSentiment :: NonEmpty Text -> LanguageCode -> BatchDetectSentiment -- | A list containing the UTF-8 encoded text of the input documents. The -- list can contain a maximum of 25 documents. The maximum size of each -- document is 5 KB. -- -- Amazon Comprehend performs real-time sentiment analysis on the first -- 500 characters of the input text and ignores any additional text in -- the input. batchDetectSentiment_textList :: Lens' BatchDetectSentiment (NonEmpty Text) -- | The language of the input documents. You can specify any of the -- primary languages supported by Amazon Comprehend. All documents must -- be in the same language. batchDetectSentiment_languageCode :: Lens' BatchDetectSentiment LanguageCode -- | See: newBatchDetectSentimentResponse smart constructor. data BatchDetectSentimentResponse BatchDetectSentimentResponse' :: Int -> [BatchDetectSentimentItemResult] -> [BatchItemError] -> BatchDetectSentimentResponse -- | The response's http status code. [$sel:httpStatus:BatchDetectSentimentResponse'] :: BatchDetectSentimentResponse -> Int -- | A list of objects containing the results of the operation. The results -- are sorted in ascending order by the Index field and match -- the order of the documents in the input list. If all of the documents -- contain an error, the ResultList is empty. [$sel:resultList:BatchDetectSentimentResponse'] :: BatchDetectSentimentResponse -> [BatchDetectSentimentItemResult] -- | A list containing one object for each document that contained an -- error. The results are sorted in ascending order by the Index -- field and match the order of the documents in the input list. If there -- are no errors in the batch, the ErrorList is empty. [$sel:errorList:BatchDetectSentimentResponse'] :: BatchDetectSentimentResponse -> [BatchItemError] -- | Create a value of BatchDetectSentimentResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:httpStatus:BatchDetectSentimentResponse', -- batchDetectSentimentResponse_httpStatus - The response's http -- status code. -- -- $sel:resultList:BatchDetectSentimentResponse', -- batchDetectSentimentResponse_resultList - A list of objects -- containing the results of the operation. The results are sorted in -- ascending order by the Index field and match the order of the -- documents in the input list. If all of the documents contain an error, -- the ResultList is empty. -- -- $sel:errorList:BatchDetectSentimentResponse', -- batchDetectSentimentResponse_errorList - A list containing one -- object for each document that contained an error. The results are -- sorted in ascending order by the Index field and match the -- order of the documents in the input list. If there are no errors in -- the batch, the ErrorList is empty. newBatchDetectSentimentResponse :: Int -> BatchDetectSentimentResponse -- | The response's http status code. batchDetectSentimentResponse_httpStatus :: Lens' BatchDetectSentimentResponse Int -- | A list of objects containing the results of the operation. The results -- are sorted in ascending order by the Index field and match -- the order of the documents in the input list. If all of the documents -- contain an error, the ResultList is empty. batchDetectSentimentResponse_resultList :: Lens' BatchDetectSentimentResponse [BatchDetectSentimentItemResult] -- | A list containing one object for each document that contained an -- error. The results are sorted in ascending order by the Index -- field and match the order of the documents in the input list. If there -- are no errors in the batch, the ErrorList is empty. batchDetectSentimentResponse_errorList :: Lens' BatchDetectSentimentResponse [BatchItemError] instance GHC.Generics.Generic Amazonka.Comprehend.BatchDetectSentiment.BatchDetectSentiment instance GHC.Show.Show Amazonka.Comprehend.BatchDetectSentiment.BatchDetectSentiment instance GHC.Classes.Eq Amazonka.Comprehend.BatchDetectSentiment.BatchDetectSentiment instance GHC.Generics.Generic Amazonka.Comprehend.BatchDetectSentiment.BatchDetectSentimentResponse instance GHC.Show.Show Amazonka.Comprehend.BatchDetectSentiment.BatchDetectSentimentResponse instance GHC.Classes.Eq Amazonka.Comprehend.BatchDetectSentiment.BatchDetectSentimentResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.BatchDetectSentiment.BatchDetectSentiment instance Control.DeepSeq.NFData Amazonka.Comprehend.BatchDetectSentiment.BatchDetectSentimentResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.BatchDetectSentiment.BatchDetectSentiment instance Control.DeepSeq.NFData Amazonka.Comprehend.BatchDetectSentiment.BatchDetectSentiment instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.BatchDetectSentiment.BatchDetectSentiment instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.BatchDetectSentiment.BatchDetectSentiment instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.BatchDetectSentiment.BatchDetectSentiment instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.BatchDetectSentiment.BatchDetectSentiment -- | Detects the key noun phrases found in a batch of documents. module Amazonka.Comprehend.BatchDetectKeyPhrases -- | See: newBatchDetectKeyPhrases smart constructor. data BatchDetectKeyPhrases BatchDetectKeyPhrases' :: Sensitive (NonEmpty (Sensitive Text)) -> LanguageCode -> BatchDetectKeyPhrases -- | A list containing the UTF-8 encoded text of the input documents. The -- list can contain a maximum of 25 documents. The maximum size of each -- document is 5 KB. [$sel:textList:BatchDetectKeyPhrases'] :: BatchDetectKeyPhrases -> Sensitive (NonEmpty (Sensitive Text)) -- | The language of the input documents. You can specify any of the -- primary languages supported by Amazon Comprehend. All documents must -- be in the same language. [$sel:languageCode:BatchDetectKeyPhrases'] :: BatchDetectKeyPhrases -> LanguageCode -- | Create a value of BatchDetectKeyPhrases with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:textList:BatchDetectKeyPhrases', -- batchDetectKeyPhrases_textList - A list containing the UTF-8 -- encoded text of the input documents. The list can contain a maximum of -- 25 documents. The maximum size of each document is 5 KB. -- -- BatchDetectKeyPhrases, -- batchDetectKeyPhrases_languageCode - The language of the input -- documents. You can specify any of the primary languages supported by -- Amazon Comprehend. All documents must be in the same language. newBatchDetectKeyPhrases :: NonEmpty Text -> LanguageCode -> BatchDetectKeyPhrases -- | A list containing the UTF-8 encoded text of the input documents. The -- list can contain a maximum of 25 documents. The maximum size of each -- document is 5 KB. batchDetectKeyPhrases_textList :: Lens' BatchDetectKeyPhrases (NonEmpty Text) -- | The language of the input documents. You can specify any of the -- primary languages supported by Amazon Comprehend. All documents must -- be in the same language. batchDetectKeyPhrases_languageCode :: Lens' BatchDetectKeyPhrases LanguageCode -- | See: newBatchDetectKeyPhrasesResponse smart constructor. data BatchDetectKeyPhrasesResponse BatchDetectKeyPhrasesResponse' :: Int -> [BatchDetectKeyPhrasesItemResult] -> [BatchItemError] -> BatchDetectKeyPhrasesResponse -- | The response's http status code. [$sel:httpStatus:BatchDetectKeyPhrasesResponse'] :: BatchDetectKeyPhrasesResponse -> Int -- | A list of objects containing the results of the operation. The results -- are sorted in ascending order by the Index field and match -- the order of the documents in the input list. If all of the documents -- contain an error, the ResultList is empty. [$sel:resultList:BatchDetectKeyPhrasesResponse'] :: BatchDetectKeyPhrasesResponse -> [BatchDetectKeyPhrasesItemResult] -- | A list containing one object for each document that contained an -- error. The results are sorted in ascending order by the Index -- field and match the order of the documents in the input list. If there -- are no errors in the batch, the ErrorList is empty. [$sel:errorList:BatchDetectKeyPhrasesResponse'] :: BatchDetectKeyPhrasesResponse -> [BatchItemError] -- | Create a value of BatchDetectKeyPhrasesResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:httpStatus:BatchDetectKeyPhrasesResponse', -- batchDetectKeyPhrasesResponse_httpStatus - The response's http -- status code. -- -- $sel:resultList:BatchDetectKeyPhrasesResponse', -- batchDetectKeyPhrasesResponse_resultList - A list of objects -- containing the results of the operation. The results are sorted in -- ascending order by the Index field and match the order of the -- documents in the input list. If all of the documents contain an error, -- the ResultList is empty. -- -- $sel:errorList:BatchDetectKeyPhrasesResponse', -- batchDetectKeyPhrasesResponse_errorList - A list containing one -- object for each document that contained an error. The results are -- sorted in ascending order by the Index field and match the -- order of the documents in the input list. If there are no errors in -- the batch, the ErrorList is empty. newBatchDetectKeyPhrasesResponse :: Int -> BatchDetectKeyPhrasesResponse -- | The response's http status code. batchDetectKeyPhrasesResponse_httpStatus :: Lens' BatchDetectKeyPhrasesResponse Int -- | A list of objects containing the results of the operation. The results -- are sorted in ascending order by the Index field and match -- the order of the documents in the input list. If all of the documents -- contain an error, the ResultList is empty. batchDetectKeyPhrasesResponse_resultList :: Lens' BatchDetectKeyPhrasesResponse [BatchDetectKeyPhrasesItemResult] -- | A list containing one object for each document that contained an -- error. The results are sorted in ascending order by the Index -- field and match the order of the documents in the input list. If there -- are no errors in the batch, the ErrorList is empty. batchDetectKeyPhrasesResponse_errorList :: Lens' BatchDetectKeyPhrasesResponse [BatchItemError] instance GHC.Generics.Generic Amazonka.Comprehend.BatchDetectKeyPhrases.BatchDetectKeyPhrases instance GHC.Show.Show Amazonka.Comprehend.BatchDetectKeyPhrases.BatchDetectKeyPhrases instance GHC.Classes.Eq Amazonka.Comprehend.BatchDetectKeyPhrases.BatchDetectKeyPhrases instance GHC.Generics.Generic Amazonka.Comprehend.BatchDetectKeyPhrases.BatchDetectKeyPhrasesResponse instance GHC.Show.Show Amazonka.Comprehend.BatchDetectKeyPhrases.BatchDetectKeyPhrasesResponse instance GHC.Classes.Eq Amazonka.Comprehend.BatchDetectKeyPhrases.BatchDetectKeyPhrasesResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.BatchDetectKeyPhrases.BatchDetectKeyPhrases instance Control.DeepSeq.NFData Amazonka.Comprehend.BatchDetectKeyPhrases.BatchDetectKeyPhrasesResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.BatchDetectKeyPhrases.BatchDetectKeyPhrases instance Control.DeepSeq.NFData Amazonka.Comprehend.BatchDetectKeyPhrases.BatchDetectKeyPhrases instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.BatchDetectKeyPhrases.BatchDetectKeyPhrases instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.BatchDetectKeyPhrases.BatchDetectKeyPhrases instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.BatchDetectKeyPhrases.BatchDetectKeyPhrases instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.BatchDetectKeyPhrases.BatchDetectKeyPhrases -- | Inspects the text of a batch of documents for named entities and -- returns information about them. For more information about named -- entities, see Entities in the Comprehend Developer Guide. module Amazonka.Comprehend.BatchDetectEntities -- | See: newBatchDetectEntities smart constructor. data BatchDetectEntities BatchDetectEntities' :: Sensitive (NonEmpty (Sensitive Text)) -> LanguageCode -> BatchDetectEntities -- | A list containing the UTF-8 encoded text of the input documents. The -- list can contain a maximum of 25 documents. The maximum size of each -- document is 5 KB. [$sel:textList:BatchDetectEntities'] :: BatchDetectEntities -> Sensitive (NonEmpty (Sensitive Text)) -- | The language of the input documents. You can specify any of the -- primary languages supported by Amazon Comprehend. All documents must -- be in the same language. [$sel:languageCode:BatchDetectEntities'] :: BatchDetectEntities -> LanguageCode -- | Create a value of BatchDetectEntities with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:textList:BatchDetectEntities', -- batchDetectEntities_textList - A list containing the UTF-8 -- encoded text of the input documents. The list can contain a maximum of -- 25 documents. The maximum size of each document is 5 KB. -- -- BatchDetectEntities, batchDetectEntities_languageCode - -- The language of the input documents. You can specify any of the -- primary languages supported by Amazon Comprehend. All documents must -- be in the same language. newBatchDetectEntities :: NonEmpty Text -> LanguageCode -> BatchDetectEntities -- | A list containing the UTF-8 encoded text of the input documents. The -- list can contain a maximum of 25 documents. The maximum size of each -- document is 5 KB. batchDetectEntities_textList :: Lens' BatchDetectEntities (NonEmpty Text) -- | The language of the input documents. You can specify any of the -- primary languages supported by Amazon Comprehend. All documents must -- be in the same language. batchDetectEntities_languageCode :: Lens' BatchDetectEntities LanguageCode -- | See: newBatchDetectEntitiesResponse smart constructor. data BatchDetectEntitiesResponse BatchDetectEntitiesResponse' :: Int -> [BatchDetectEntitiesItemResult] -> [BatchItemError] -> BatchDetectEntitiesResponse -- | The response's http status code. [$sel:httpStatus:BatchDetectEntitiesResponse'] :: BatchDetectEntitiesResponse -> Int -- | A list of objects containing the results of the operation. The results -- are sorted in ascending order by the Index field and match -- the order of the documents in the input list. If all of the documents -- contain an error, the ResultList is empty. [$sel:resultList:BatchDetectEntitiesResponse'] :: BatchDetectEntitiesResponse -> [BatchDetectEntitiesItemResult] -- | A list containing one object for each document that contained an -- error. The results are sorted in ascending order by the Index -- field and match the order of the documents in the input list. If there -- are no errors in the batch, the ErrorList is empty. [$sel:errorList:BatchDetectEntitiesResponse'] :: BatchDetectEntitiesResponse -> [BatchItemError] -- | Create a value of BatchDetectEntitiesResponse with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:httpStatus:BatchDetectEntitiesResponse', -- batchDetectEntitiesResponse_httpStatus - The response's http -- status code. -- -- $sel:resultList:BatchDetectEntitiesResponse', -- batchDetectEntitiesResponse_resultList - A list of objects -- containing the results of the operation. The results are sorted in -- ascending order by the Index field and match the order of the -- documents in the input list. If all of the documents contain an error, -- the ResultList is empty. -- -- $sel:errorList:BatchDetectEntitiesResponse', -- batchDetectEntitiesResponse_errorList - A list containing one -- object for each document that contained an error. The results are -- sorted in ascending order by the Index field and match the -- order of the documents in the input list. If there are no errors in -- the batch, the ErrorList is empty. newBatchDetectEntitiesResponse :: Int -> BatchDetectEntitiesResponse -- | The response's http status code. batchDetectEntitiesResponse_httpStatus :: Lens' BatchDetectEntitiesResponse Int -- | A list of objects containing the results of the operation. The results -- are sorted in ascending order by the Index field and match -- the order of the documents in the input list. If all of the documents -- contain an error, the ResultList is empty. batchDetectEntitiesResponse_resultList :: Lens' BatchDetectEntitiesResponse [BatchDetectEntitiesItemResult] -- | A list containing one object for each document that contained an -- error. The results are sorted in ascending order by the Index -- field and match the order of the documents in the input list. If there -- are no errors in the batch, the ErrorList is empty. batchDetectEntitiesResponse_errorList :: Lens' BatchDetectEntitiesResponse [BatchItemError] instance GHC.Generics.Generic Amazonka.Comprehend.BatchDetectEntities.BatchDetectEntities instance GHC.Show.Show Amazonka.Comprehend.BatchDetectEntities.BatchDetectEntities instance GHC.Classes.Eq Amazonka.Comprehend.BatchDetectEntities.BatchDetectEntities instance GHC.Generics.Generic Amazonka.Comprehend.BatchDetectEntities.BatchDetectEntitiesResponse instance GHC.Show.Show Amazonka.Comprehend.BatchDetectEntities.BatchDetectEntitiesResponse instance GHC.Classes.Eq Amazonka.Comprehend.BatchDetectEntities.BatchDetectEntitiesResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.BatchDetectEntities.BatchDetectEntities instance Control.DeepSeq.NFData Amazonka.Comprehend.BatchDetectEntities.BatchDetectEntitiesResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.BatchDetectEntities.BatchDetectEntities instance Control.DeepSeq.NFData Amazonka.Comprehend.BatchDetectEntities.BatchDetectEntities instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.BatchDetectEntities.BatchDetectEntities instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.BatchDetectEntities.BatchDetectEntities instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.BatchDetectEntities.BatchDetectEntities instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.BatchDetectEntities.BatchDetectEntities -- | Determines the dominant language of the input text for a batch of -- documents. For a list of languages that Amazon Comprehend can detect, -- see Amazon Comprehend Supported Languages. module Amazonka.Comprehend.BatchDetectDominantLanguage -- | See: newBatchDetectDominantLanguage smart constructor. data BatchDetectDominantLanguage BatchDetectDominantLanguage' :: Sensitive (NonEmpty (Sensitive Text)) -> BatchDetectDominantLanguage -- | A list containing the UTF-8 encoded text of the input documents. The -- list can contain a maximum of 25 documents. Each document should -- contain at least 20 characters. The maximum size of each document is 5 -- KB. [$sel:textList:BatchDetectDominantLanguage'] :: BatchDetectDominantLanguage -> Sensitive (NonEmpty (Sensitive Text)) -- | Create a value of BatchDetectDominantLanguage with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:textList:BatchDetectDominantLanguage', -- batchDetectDominantLanguage_textList - A list containing the -- UTF-8 encoded text of the input documents. The list can contain a -- maximum of 25 documents. Each document should contain at least 20 -- characters. The maximum size of each document is 5 KB. newBatchDetectDominantLanguage :: NonEmpty Text -> BatchDetectDominantLanguage -- | A list containing the UTF-8 encoded text of the input documents. The -- list can contain a maximum of 25 documents. Each document should -- contain at least 20 characters. The maximum size of each document is 5 -- KB. batchDetectDominantLanguage_textList :: Lens' BatchDetectDominantLanguage (NonEmpty Text) -- | See: newBatchDetectDominantLanguageResponse smart -- constructor. data BatchDetectDominantLanguageResponse BatchDetectDominantLanguageResponse' :: Int -> [BatchDetectDominantLanguageItemResult] -> [BatchItemError] -> BatchDetectDominantLanguageResponse -- | The response's http status code. [$sel:httpStatus:BatchDetectDominantLanguageResponse'] :: BatchDetectDominantLanguageResponse -> Int -- | A list of objects containing the results of the operation. The results -- are sorted in ascending order by the Index field and match -- the order of the documents in the input list. If all of the documents -- contain an error, the ResultList is empty. [$sel:resultList:BatchDetectDominantLanguageResponse'] :: BatchDetectDominantLanguageResponse -> [BatchDetectDominantLanguageItemResult] -- | A list containing one object for each document that contained an -- error. The results are sorted in ascending order by the Index -- field and match the order of the documents in the input list. If there -- are no errors in the batch, the ErrorList is empty. [$sel:errorList:BatchDetectDominantLanguageResponse'] :: BatchDetectDominantLanguageResponse -> [BatchItemError] -- | Create a value of BatchDetectDominantLanguageResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:httpStatus:BatchDetectDominantLanguageResponse', -- batchDetectDominantLanguageResponse_httpStatus - The response's -- http status code. -- -- $sel:resultList:BatchDetectDominantLanguageResponse', -- batchDetectDominantLanguageResponse_resultList - A list of -- objects containing the results of the operation. The results are -- sorted in ascending order by the Index field and match the -- order of the documents in the input list. If all of the documents -- contain an error, the ResultList is empty. -- -- $sel:errorList:BatchDetectDominantLanguageResponse', -- batchDetectDominantLanguageResponse_errorList - A list -- containing one object for each document that contained an error. The -- results are sorted in ascending order by the Index field and -- match the order of the documents in the input list. If there are no -- errors in the batch, the ErrorList is empty. newBatchDetectDominantLanguageResponse :: Int -> BatchDetectDominantLanguageResponse -- | The response's http status code. batchDetectDominantLanguageResponse_httpStatus :: Lens' BatchDetectDominantLanguageResponse Int -- | A list of objects containing the results of the operation. The results -- are sorted in ascending order by the Index field and match -- the order of the documents in the input list. If all of the documents -- contain an error, the ResultList is empty. batchDetectDominantLanguageResponse_resultList :: Lens' BatchDetectDominantLanguageResponse [BatchDetectDominantLanguageItemResult] -- | A list containing one object for each document that contained an -- error. The results are sorted in ascending order by the Index -- field and match the order of the documents in the input list. If there -- are no errors in the batch, the ErrorList is empty. batchDetectDominantLanguageResponse_errorList :: Lens' BatchDetectDominantLanguageResponse [BatchItemError] instance GHC.Generics.Generic Amazonka.Comprehend.BatchDetectDominantLanguage.BatchDetectDominantLanguage instance GHC.Show.Show Amazonka.Comprehend.BatchDetectDominantLanguage.BatchDetectDominantLanguage instance GHC.Classes.Eq Amazonka.Comprehend.BatchDetectDominantLanguage.BatchDetectDominantLanguage instance GHC.Generics.Generic Amazonka.Comprehend.BatchDetectDominantLanguage.BatchDetectDominantLanguageResponse instance GHC.Show.Show Amazonka.Comprehend.BatchDetectDominantLanguage.BatchDetectDominantLanguageResponse instance GHC.Classes.Eq Amazonka.Comprehend.BatchDetectDominantLanguage.BatchDetectDominantLanguageResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.BatchDetectDominantLanguage.BatchDetectDominantLanguage instance Control.DeepSeq.NFData Amazonka.Comprehend.BatchDetectDominantLanguage.BatchDetectDominantLanguageResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.BatchDetectDominantLanguage.BatchDetectDominantLanguage instance Control.DeepSeq.NFData Amazonka.Comprehend.BatchDetectDominantLanguage.BatchDetectDominantLanguage instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.BatchDetectDominantLanguage.BatchDetectDominantLanguage instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.BatchDetectDominantLanguage.BatchDetectDominantLanguage instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.BatchDetectDominantLanguage.BatchDetectDominantLanguage instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.BatchDetectDominantLanguage.BatchDetectDominantLanguage -- | Removes a specific tag associated with an Amazon Comprehend resource. module Amazonka.Comprehend.UntagResource -- | See: newUntagResource smart constructor. data UntagResource UntagResource' :: Text -> [Text] -> UntagResource -- | The Amazon Resource Name (ARN) of the given Amazon Comprehend resource -- from which you want to remove the tags. [$sel:resourceArn:UntagResource'] :: UntagResource -> Text -- | The initial part of a key-value pair that forms a tag being removed -- from a given resource. For example, a tag with "Sales" as the key -- might be added to a resource to indicate its use by the sales -- department. Keys must be unique and cannot be duplicated for a -- particular resource. [$sel:tagKeys:UntagResource'] :: UntagResource -> [Text] -- | Create a value of UntagResource with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:resourceArn:UntagResource', -- untagResource_resourceArn - The Amazon Resource Name (ARN) of -- the given Amazon Comprehend resource from which you want to remove the -- tags. -- -- $sel:tagKeys:UntagResource', untagResource_tagKeys - The -- initial part of a key-value pair that forms a tag being removed from a -- given resource. For example, a tag with "Sales" as the key might be -- added to a resource to indicate its use by the sales department. Keys -- must be unique and cannot be duplicated for a particular resource. newUntagResource :: Text -> UntagResource -- | The Amazon Resource Name (ARN) of the given Amazon Comprehend resource -- from which you want to remove the tags. untagResource_resourceArn :: Lens' UntagResource Text -- | The initial part of a key-value pair that forms a tag being removed -- from a given resource. For example, a tag with "Sales" as the key -- might be added to a resource to indicate its use by the sales -- department. Keys must be unique and cannot be duplicated for a -- particular resource. untagResource_tagKeys :: Lens' UntagResource [Text] -- | See: newUntagResourceResponse smart constructor. data UntagResourceResponse UntagResourceResponse' :: Int -> UntagResourceResponse -- | The response's http status code. [$sel:httpStatus:UntagResourceResponse'] :: UntagResourceResponse -> Int -- | Create a value of UntagResourceResponse with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:httpStatus:UntagResourceResponse', -- untagResourceResponse_httpStatus - The response's http status -- code. newUntagResourceResponse :: Int -> UntagResourceResponse -- | The response's http status code. untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.UntagResource.UntagResource instance GHC.Show.Show Amazonka.Comprehend.UntagResource.UntagResource instance GHC.Read.Read Amazonka.Comprehend.UntagResource.UntagResource instance GHC.Classes.Eq Amazonka.Comprehend.UntagResource.UntagResource instance GHC.Generics.Generic Amazonka.Comprehend.UntagResource.UntagResourceResponse instance GHC.Show.Show Amazonka.Comprehend.UntagResource.UntagResourceResponse instance GHC.Read.Read Amazonka.Comprehend.UntagResource.UntagResourceResponse instance GHC.Classes.Eq Amazonka.Comprehend.UntagResource.UntagResourceResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.UntagResource.UntagResource instance Control.DeepSeq.NFData Amazonka.Comprehend.UntagResource.UntagResourceResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.UntagResource.UntagResource instance Control.DeepSeq.NFData Amazonka.Comprehend.UntagResource.UntagResource instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.UntagResource.UntagResource instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.UntagResource.UntagResource instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.UntagResource.UntagResource instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.UntagResource.UntagResource -- | Updates information about the specified endpoint. For information -- about endpoints, see Managing endpoints. module Amazonka.Comprehend.UpdateEndpoint -- | See: newUpdateEndpoint smart constructor. data UpdateEndpoint UpdateEndpoint' :: Maybe Text -> Maybe Natural -> Maybe Text -> Text -> UpdateEndpoint -- | Data access role ARN to use in case the new model is encrypted with a -- customer CMK. [$sel:desiredDataAccessRoleArn:UpdateEndpoint'] :: UpdateEndpoint -> Maybe Text -- | The desired number of inference units to be used by the model using -- this endpoint. Each inference unit represents of a throughput of 100 -- characters per second. [$sel:desiredInferenceUnits:UpdateEndpoint'] :: UpdateEndpoint -> Maybe Natural -- | The ARN of the new model to use when updating an existing endpoint. [$sel:desiredModelArn:UpdateEndpoint'] :: UpdateEndpoint -> Maybe Text -- | The Amazon Resource Number (ARN) of the endpoint being updated. [$sel:endpointArn:UpdateEndpoint'] :: UpdateEndpoint -> Text -- | Create a value of UpdateEndpoint with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- UpdateEndpoint, updateEndpoint_desiredDataAccessRoleArn -- - Data access role ARN to use in case the new model is encrypted with -- a customer CMK. -- -- UpdateEndpoint, updateEndpoint_desiredInferenceUnits - -- The desired number of inference units to be used by the model using -- this endpoint. Each inference unit represents of a throughput of 100 -- characters per second. -- -- UpdateEndpoint, updateEndpoint_desiredModelArn - The ARN -- of the new model to use when updating an existing endpoint. -- -- UpdateEndpoint, updateEndpoint_endpointArn - The Amazon -- Resource Number (ARN) of the endpoint being updated. newUpdateEndpoint :: Text -> UpdateEndpoint -- | Data access role ARN to use in case the new model is encrypted with a -- customer CMK. updateEndpoint_desiredDataAccessRoleArn :: Lens' UpdateEndpoint (Maybe Text) -- | The desired number of inference units to be used by the model using -- this endpoint. Each inference unit represents of a throughput of 100 -- characters per second. updateEndpoint_desiredInferenceUnits :: Lens' UpdateEndpoint (Maybe Natural) -- | The ARN of the new model to use when updating an existing endpoint. updateEndpoint_desiredModelArn :: Lens' UpdateEndpoint (Maybe Text) -- | The Amazon Resource Number (ARN) of the endpoint being updated. updateEndpoint_endpointArn :: Lens' UpdateEndpoint Text -- | See: newUpdateEndpointResponse smart constructor. data UpdateEndpointResponse UpdateEndpointResponse' :: Int -> UpdateEndpointResponse -- | The response's http status code. [$sel:httpStatus:UpdateEndpointResponse'] :: UpdateEndpointResponse -> Int -- | Create a value of UpdateEndpointResponse with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:httpStatus:UpdateEndpointResponse', -- updateEndpointResponse_httpStatus - The response's http status -- code. newUpdateEndpointResponse :: Int -> UpdateEndpointResponse -- | The response's http status code. updateEndpointResponse_httpStatus :: Lens' UpdateEndpointResponse Int instance GHC.Generics.Generic Amazonka.Comprehend.UpdateEndpoint.UpdateEndpoint instance GHC.Show.Show Amazonka.Comprehend.UpdateEndpoint.UpdateEndpoint instance GHC.Read.Read Amazonka.Comprehend.UpdateEndpoint.UpdateEndpoint instance GHC.Classes.Eq Amazonka.Comprehend.UpdateEndpoint.UpdateEndpoint instance GHC.Generics.Generic Amazonka.Comprehend.UpdateEndpoint.UpdateEndpointResponse instance GHC.Show.Show Amazonka.Comprehend.UpdateEndpoint.UpdateEndpointResponse instance GHC.Read.Read Amazonka.Comprehend.UpdateEndpoint.UpdateEndpointResponse instance GHC.Classes.Eq Amazonka.Comprehend.UpdateEndpoint.UpdateEndpointResponse instance Amazonka.Types.AWSRequest Amazonka.Comprehend.UpdateEndpoint.UpdateEndpoint instance Control.DeepSeq.NFData Amazonka.Comprehend.UpdateEndpoint.UpdateEndpointResponse instance Data.Hashable.Class.Hashable Amazonka.Comprehend.UpdateEndpoint.UpdateEndpoint instance Control.DeepSeq.NFData Amazonka.Comprehend.UpdateEndpoint.UpdateEndpoint instance Amazonka.Data.Headers.ToHeaders Amazonka.Comprehend.UpdateEndpoint.UpdateEndpoint instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.Comprehend.UpdateEndpoint.UpdateEndpoint instance Amazonka.Data.Path.ToPath Amazonka.Comprehend.UpdateEndpoint.UpdateEndpoint instance Amazonka.Data.Query.ToQuery Amazonka.Comprehend.UpdateEndpoint.UpdateEndpoint module Amazonka.Comprehend.Lens -- | A list containing the UTF-8 encoded text of the input documents. The -- list can contain a maximum of 25 documents. Each document should -- contain at least 20 characters. The maximum size of each document is 5 -- KB. batchDetectDominantLanguage_textList :: Lens' BatchDetectDominantLanguage (NonEmpty Text) -- | The response's http status code. batchDetectDominantLanguageResponse_httpStatus :: Lens' BatchDetectDominantLanguageResponse Int -- | A list of objects containing the results of the operation. The results -- are sorted in ascending order by the Index field and match -- the order of the documents in the input list. If all of the documents -- contain an error, the ResultList is empty. batchDetectDominantLanguageResponse_resultList :: Lens' BatchDetectDominantLanguageResponse [BatchDetectDominantLanguageItemResult] -- | A list containing one object for each document that contained an -- error. The results are sorted in ascending order by the Index -- field and match the order of the documents in the input list. If there -- are no errors in the batch, the ErrorList is empty. batchDetectDominantLanguageResponse_errorList :: Lens' BatchDetectDominantLanguageResponse [BatchItemError] -- | A list containing the UTF-8 encoded text of the input documents. The -- list can contain a maximum of 25 documents. The maximum size of each -- document is 5 KB. batchDetectEntities_textList :: Lens' BatchDetectEntities (NonEmpty Text) -- | The language of the input documents. You can specify any of the -- primary languages supported by Amazon Comprehend. All documents must -- be in the same language. batchDetectEntities_languageCode :: Lens' BatchDetectEntities LanguageCode -- | The response's http status code. batchDetectEntitiesResponse_httpStatus :: Lens' BatchDetectEntitiesResponse Int -- | A list of objects containing the results of the operation. The results -- are sorted in ascending order by the Index field and match -- the order of the documents in the input list. If all of the documents -- contain an error, the ResultList is empty. batchDetectEntitiesResponse_resultList :: Lens' BatchDetectEntitiesResponse [BatchDetectEntitiesItemResult] -- | A list containing one object for each document that contained an -- error. The results are sorted in ascending order by the Index -- field and match the order of the documents in the input list. If there -- are no errors in the batch, the ErrorList is empty. batchDetectEntitiesResponse_errorList :: Lens' BatchDetectEntitiesResponse [BatchItemError] -- | A list containing the UTF-8 encoded text of the input documents. The -- list can contain a maximum of 25 documents. The maximum size of each -- document is 5 KB. batchDetectKeyPhrases_textList :: Lens' BatchDetectKeyPhrases (NonEmpty Text) -- | The language of the input documents. You can specify any of the -- primary languages supported by Amazon Comprehend. All documents must -- be in the same language. batchDetectKeyPhrases_languageCode :: Lens' BatchDetectKeyPhrases LanguageCode -- | The response's http status code. batchDetectKeyPhrasesResponse_httpStatus :: Lens' BatchDetectKeyPhrasesResponse Int -- | A list of objects containing the results of the operation. The results -- are sorted in ascending order by the Index field and match -- the order of the documents in the input list. If all of the documents -- contain an error, the ResultList is empty. batchDetectKeyPhrasesResponse_resultList :: Lens' BatchDetectKeyPhrasesResponse [BatchDetectKeyPhrasesItemResult] -- | A list containing one object for each document that contained an -- error. The results are sorted in ascending order by the Index -- field and match the order of the documents in the input list. If there -- are no errors in the batch, the ErrorList is empty. batchDetectKeyPhrasesResponse_errorList :: Lens' BatchDetectKeyPhrasesResponse [BatchItemError] -- | A list containing the UTF-8 encoded text of the input documents. The -- list can contain a maximum of 25 documents. The maximum size of each -- document is 5 KB. -- -- Amazon Comprehend performs real-time sentiment analysis on the first -- 500 characters of the input text and ignores any additional text in -- the input. batchDetectSentiment_textList :: Lens' BatchDetectSentiment (NonEmpty Text) -- | The language of the input documents. You can specify any of the -- primary languages supported by Amazon Comprehend. All documents must -- be in the same language. batchDetectSentiment_languageCode :: Lens' BatchDetectSentiment LanguageCode -- | The response's http status code. batchDetectSentimentResponse_httpStatus :: Lens' BatchDetectSentimentResponse Int -- | A list of objects containing the results of the operation. The results -- are sorted in ascending order by the Index field and match -- the order of the documents in the input list. If all of the documents -- contain an error, the ResultList is empty. batchDetectSentimentResponse_resultList :: Lens' BatchDetectSentimentResponse [BatchDetectSentimentItemResult] -- | A list containing one object for each document that contained an -- error. The results are sorted in ascending order by the Index -- field and match the order of the documents in the input list. If there -- are no errors in the batch, the ErrorList is empty. batchDetectSentimentResponse_errorList :: Lens' BatchDetectSentimentResponse [BatchItemError] -- | A list containing the UTF-8 encoded text of the input documents. The -- list can contain a maximum of 25 documents. The maximum size for each -- document is 5 KB. batchDetectSyntax_textList :: Lens' BatchDetectSyntax (NonEmpty Text) -- | The language of the input documents. You can specify any of the -- following languages supported by Amazon Comprehend: German ("de"), -- English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or -- Portuguese ("pt"). All documents must be in the same language. batchDetectSyntax_languageCode :: Lens' BatchDetectSyntax SyntaxLanguageCode -- | The response's http status code. batchDetectSyntaxResponse_httpStatus :: Lens' BatchDetectSyntaxResponse Int -- | A list of objects containing the results of the operation. The results -- are sorted in ascending order by the Index field and match -- the order of the documents in the input list. If all of the documents -- contain an error, the ResultList is empty. batchDetectSyntaxResponse_resultList :: Lens' BatchDetectSyntaxResponse [BatchDetectSyntaxItemResult] -- | A list containing one object for each document that contained an -- error. The results are sorted in ascending order by the Index -- field and match the order of the documents in the input list. If there -- are no errors in the batch, the ErrorList is empty. batchDetectSyntaxResponse_errorList :: Lens' BatchDetectSyntaxResponse [BatchItemError] -- | A list containing the UTF-8 encoded text of the input documents. The -- list can contain a maximum of 25 documents. The maximum size of each -- document is 5 KB. batchDetectTargetedSentiment_textList :: Lens' BatchDetectTargetedSentiment (NonEmpty Text) -- | The language of the input documents. Currently, English is the only -- supported language. batchDetectTargetedSentiment_languageCode :: Lens' BatchDetectTargetedSentiment LanguageCode -- | The response's http status code. batchDetectTargetedSentimentResponse_httpStatus :: Lens' BatchDetectTargetedSentimentResponse Int -- | A list of objects containing the results of the operation. The results -- are sorted in ascending order by the Index field and match -- the order of the documents in the input list. If all of the documents -- contain an error, the ResultList is empty. batchDetectTargetedSentimentResponse_resultList :: Lens' BatchDetectTargetedSentimentResponse [BatchDetectTargetedSentimentItemResult] -- | List of errors that the operation can return. batchDetectTargetedSentimentResponse_errorList :: Lens' BatchDetectTargetedSentimentResponse [BatchItemError] -- | Use the Bytes parameter to input a text, PDF, Word or image -- file. You can also use the Bytes parameter to input an Amazon -- Textract DetectDocumentText or AnalyzeDocument -- output file. -- -- Provide the input document as a sequence of base64-encoded bytes. If -- your code uses an Amazon Web Services SDK to classify documents, the -- SDK may encode the document file bytes for you. -- -- The maximum length of this field depends on the input document type. -- For details, see Inputs for real-time custom analysis in the -- Comprehend Developer Guide. -- -- If you use the Bytes parameter, do not use the Text -- parameter.-- -- Note: This Lens automatically encodes -- and decodes Base64 data. -- The underlying isomorphism will encode to -- Base64 representation during -- serialisation, and decode from Base64 -- representation during deserialisation. -- This Lens accepts -- and returns only raw unencoded data. classifyDocument_bytes :: Lens' ClassifyDocument (Maybe ByteString) -- | Provides configuration parameters to override the default actions for -- extracting text from PDF documents and image files. classifyDocument_documentReaderConfig :: Lens' ClassifyDocument (Maybe DocumentReaderConfig) -- | The document text to be analyzed. If you enter text using this -- parameter, do not use the Bytes parameter. classifyDocument_text :: Lens' ClassifyDocument (Maybe Text) -- | The Amazon Resource Number (ARN) of the endpoint. For information -- about endpoints, see Managing endpoints. classifyDocument_endpointArn :: Lens' ClassifyDocument Text -- | The classes used by the document being analyzed. These are used for -- multi-class trained models. Individual classes are mutually exclusive -- and each document is expected to have only a single class assigned to -- it. For example, an animal can be a dog or a cat, but not both at the -- same time. classifyDocumentResponse_classes :: Lens' ClassifyDocumentResponse (Maybe [DocumentClass]) -- | Extraction information about the document. This field is present in -- the response only if your request includes the Byte -- parameter. classifyDocumentResponse_documentMetadata :: Lens' ClassifyDocumentResponse (Maybe DocumentMetadata) -- | The document type for each page in the input document. This field is -- present in the response only if your request includes the -- Byte parameter. classifyDocumentResponse_documentType :: Lens' ClassifyDocumentResponse (Maybe [DocumentTypeListItem]) -- | Page-level errors that the system detected while processing the input -- document. The field is empty if the system encountered no errors. classifyDocumentResponse_errors :: Lens' ClassifyDocumentResponse (Maybe [ErrorsListItem]) -- | The labels used the document being analyzed. These are used for -- multi-label trained models. Individual labels represent different -- categories that are related in some manner and are not mutually -- exclusive. For example, a movie can be just an action movie, or it can -- be an action movie, a science fiction movie, and a comedy, all at the -- same time. classifyDocumentResponse_labels :: Lens' ClassifyDocumentResponse (Maybe [DocumentLabel]) -- | The response's http status code. classifyDocumentResponse_httpStatus :: Lens' ClassifyDocumentResponse Int -- | A UTF-8 text string. The maximum string size is 100 KB. containsPiiEntities_text :: Lens' ContainsPiiEntities Text -- | The language of the input documents. Currently, English is the only -- valid language. containsPiiEntities_languageCode :: Lens' ContainsPiiEntities LanguageCode -- | The labels used in the document being analyzed. Individual labels -- represent personally identifiable information (PII) entity types. containsPiiEntitiesResponse_labels :: Lens' ContainsPiiEntitiesResponse (Maybe [EntityLabel]) -- | The response's http status code. containsPiiEntitiesResponse_httpStatus :: Lens' ContainsPiiEntitiesResponse Int -- | A unique identifier for the request. If you don't set the client -- request token, Amazon Comprehend generates one. createDocumentClassifier_clientRequestToken :: Lens' CreateDocumentClassifier (Maybe Text) -- | Indicates the mode in which the classifier will be trained. The -- classifier can be trained in multi-class mode, which identifies one -- and only one class for each document, or multi-label mode, which -- identifies one or more labels for each document. In multi-label mode, -- multiple labels for an individual document are separated by a -- delimiter. The default delimiter between labels is a pipe (|). createDocumentClassifier_mode :: Lens' CreateDocumentClassifier (Maybe DocumentClassifierMode) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt trained custom models. The ModelKmsKeyId can be either -- of the following formats: -- -- createDocumentClassifier_modelKmsKeyId :: Lens' CreateDocumentClassifier (Maybe Text) -- | The resource-based policy to attach to your custom document classifier -- model. You can use this policy to allow another AWS account to import -- your custom model. -- -- Provide your policy as a JSON body that you enter as a UTF-8 encoded -- string without line breaks. To provide valid JSON, enclose the -- attribute names and values in double quotes. If the JSON body is also -- enclosed in double quotes, then you must escape the double quotes that -- are inside the policy: -- -- 
--   "{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
--
-- -- To avoid escaping quotes, you can use single quotes to enclose the -- policy and double quotes to enclose the JSON names and values: -- -- 
--   '{"attribute": "value", "attribute": ["value"]}'
--
createDocumentClassifier_modelPolicy :: Lens' CreateDocumentClassifier (Maybe Text) -- | Enables the addition of output results configuration parameters for -- custom classifier jobs. createDocumentClassifier_outputDataConfig :: Lens' CreateDocumentClassifier (Maybe DocumentClassifierOutputDataConfig) -- | Tags to be associated with the document classifier being created. A -- tag is a key-value pair that adds as a metadata to a resource used by -- Amazon Comprehend. For example, a tag with "Sales" as the key might be -- added to a resource to indicate its use by the sales department. createDocumentClassifier_tags :: Lens' CreateDocumentClassifier (Maybe [Tag]) -- | The version name given to the newly created classifier. Version names -- can have a maximum of 256 characters. Alphanumeric characters, hyphens -- (-) and underscores (_) are allowed. The version name must be unique -- among all models with the same classifier name in the account/AWS -- Region. createDocumentClassifier_versionName :: Lens' CreateDocumentClassifier (Maybe Text) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- createDocumentClassifier_volumeKmsKeyId :: Lens' CreateDocumentClassifier (Maybe Text) -- | Configuration parameters for an optional private Virtual Private Cloud -- (VPC) containing the resources you are using for your custom -- classifier. For more information, see Amazon VPC. createDocumentClassifier_vpcConfig :: Lens' CreateDocumentClassifier (Maybe VpcConfig) -- | The name of the document classifier. createDocumentClassifier_documentClassifierName :: Lens' CreateDocumentClassifier Text -- | The Amazon Resource Name (ARN) of the AWS Identity and Management -- (IAM) role that grants Amazon Comprehend read access to your input -- data. createDocumentClassifier_dataAccessRoleArn :: Lens' CreateDocumentClassifier Text -- | Specifies the format and location of the input data for the job. createDocumentClassifier_inputDataConfig :: Lens' CreateDocumentClassifier DocumentClassifierInputDataConfig -- | The language of the input documents. You can specify any of the -- following languages supported by Amazon Comprehend: German ("de"), -- English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or -- Portuguese ("pt"). All documents must be in the same language. createDocumentClassifier_languageCode :: Lens' CreateDocumentClassifier LanguageCode -- | The Amazon Resource Name (ARN) that identifies the document -- classifier. createDocumentClassifierResponse_documentClassifierArn :: Lens' CreateDocumentClassifierResponse (Maybe Text) -- | The response's http status code. createDocumentClassifierResponse_httpStatus :: Lens' CreateDocumentClassifierResponse Int -- | An idempotency token provided by the customer. If this token matches a -- previous endpoint creation request, Amazon Comprehend will not return -- a ResourceInUseException. createEndpoint_clientRequestToken :: Lens' CreateEndpoint (Maybe Text) -- | The Amazon Resource Name (ARN) of the AWS identity and Access -- Management (IAM) role that grants Amazon Comprehend read access to -- trained custom models encrypted with a customer managed key -- (ModelKmsKeyId). createEndpoint_dataAccessRoleArn :: Lens' CreateEndpoint (Maybe Text) -- | Tags associated with the endpoint being created. A tag is a key-value -- pair that adds metadata to the endpoint. For example, a tag with -- "Sales" as the key might be added to an endpoint to indicate its use -- by the sales department. createEndpoint_tags :: Lens' CreateEndpoint (Maybe [Tag]) -- | This is the descriptive suffix that becomes part of the -- EndpointArn used for all subsequent requests to this -- resource. createEndpoint_endpointName :: Lens' CreateEndpoint Text -- | The Amazon Resource Number (ARN) of the model to which the endpoint -- will be attached. createEndpoint_modelArn :: Lens' CreateEndpoint Text -- | The desired number of inference units to be used by the model using -- this endpoint. Each inference unit represents of a throughput of 100 -- characters per second. createEndpoint_desiredInferenceUnits :: Lens' CreateEndpoint Natural -- | The Amazon Resource Number (ARN) of the endpoint being created. createEndpointResponse_endpointArn :: Lens' CreateEndpointResponse (Maybe Text) -- | The response's http status code. createEndpointResponse_httpStatus :: Lens' CreateEndpointResponse Int -- | A unique identifier for the request. If you don't set the client -- request token, Amazon Comprehend generates one. createEntityRecognizer_clientRequestToken :: Lens' CreateEntityRecognizer (Maybe Text) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt trained custom models. The ModelKmsKeyId can be either -- of the following formats -- -- createEntityRecognizer_modelKmsKeyId :: Lens' CreateEntityRecognizer (Maybe Text) -- | The JSON resource-based policy to attach to your custom entity -- recognizer model. You can use this policy to allow another AWS account -- to import your custom model. -- -- Provide your JSON as a UTF-8 encoded string without line breaks. To -- provide valid JSON for your policy, enclose the attribute names and -- values in double quotes. If the JSON body is also enclosed in double -- quotes, then you must escape the double quotes that are inside the -- policy: -- -- 
--   "{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
--
-- -- To avoid escaping quotes, you can use single quotes to enclose the -- policy and double quotes to enclose the JSON names and values: -- -- 
--   '{"attribute": "value", "attribute": ["value"]}'
--
createEntityRecognizer_modelPolicy :: Lens' CreateEntityRecognizer (Maybe Text) -- | Tags to be associated with the entity recognizer being created. A tag -- is a key-value pair that adds as a metadata to a resource used by -- Amazon Comprehend. For example, a tag with "Sales" as the key might be -- added to a resource to indicate its use by the sales department. createEntityRecognizer_tags :: Lens' CreateEntityRecognizer (Maybe [Tag]) -- | The version name given to the newly created recognizer. Version names -- can be a maximum of 256 characters. Alphanumeric characters, hyphens -- (-) and underscores (_) are allowed. The version name must be unique -- among all models with the same recognizer name in the account/ AWS -- Region. createEntityRecognizer_versionName :: Lens' CreateEntityRecognizer (Maybe Text) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- createEntityRecognizer_volumeKmsKeyId :: Lens' CreateEntityRecognizer (Maybe Text) -- | Configuration parameters for an optional private Virtual Private Cloud -- (VPC) containing the resources you are using for your custom entity -- recognizer. For more information, see Amazon VPC. createEntityRecognizer_vpcConfig :: Lens' CreateEntityRecognizer (Maybe VpcConfig) -- | The name given to the newly created recognizer. Recognizer names can -- be a maximum of 256 characters. Alphanumeric characters, hyphens (-) -- and underscores (_) are allowed. The name must be unique in the -- account/region. createEntityRecognizer_recognizerName :: Lens' CreateEntityRecognizer Text -- | The Amazon Resource Name (ARN) of the AWS Identity and Management -- (IAM) role that grants Amazon Comprehend read access to your input -- data. createEntityRecognizer_dataAccessRoleArn :: Lens' CreateEntityRecognizer Text -- | Specifies the format and location of the input data. The S3 bucket -- containing the input data must be located in the same region as the -- entity recognizer being created. createEntityRecognizer_inputDataConfig :: Lens' CreateEntityRecognizer EntityRecognizerInputDataConfig -- | You can specify any of the following languages: English ("en"), -- Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or -- Portuguese ("pt"). If you plan to use this entity recognizer with PDF, -- Word, or image input files, you must specify English as the language. -- All training documents must be in the same language. createEntityRecognizer_languageCode :: Lens' CreateEntityRecognizer LanguageCode -- | The Amazon Resource Name (ARN) that identifies the entity recognizer. createEntityRecognizerResponse_entityRecognizerArn :: Lens' CreateEntityRecognizerResponse (Maybe Text) -- | The response's http status code. createEntityRecognizerResponse_httpStatus :: Lens' CreateEntityRecognizerResponse Int -- | The Amazon Resource Name (ARN) that identifies the document -- classifier. deleteDocumentClassifier_documentClassifierArn :: Lens' DeleteDocumentClassifier Text -- | The response's http status code. deleteDocumentClassifierResponse_httpStatus :: Lens' DeleteDocumentClassifierResponse Int -- | The Amazon Resource Number (ARN) of the endpoint being deleted. deleteEndpoint_endpointArn :: Lens' DeleteEndpoint Text -- | The response's http status code. deleteEndpointResponse_httpStatus :: Lens' DeleteEndpointResponse Int -- | The Amazon Resource Name (ARN) that identifies the entity recognizer. deleteEntityRecognizer_entityRecognizerArn :: Lens' DeleteEntityRecognizer Text -- | The response's http status code. deleteEntityRecognizerResponse_httpStatus :: Lens' DeleteEntityRecognizerResponse Int -- | The revision ID of the policy to delete. deleteResourcePolicy_policyRevisionId :: Lens' DeleteResourcePolicy (Maybe Text) -- | The Amazon Resource Name (ARN) of the custom model version that has -- the policy to delete. deleteResourcePolicy_resourceArn :: Lens' DeleteResourcePolicy Text -- | The response's http status code. deleteResourcePolicyResponse_httpStatus :: Lens' DeleteResourcePolicyResponse Int -- | The identifier that Amazon Comprehend generated for the job. The -- operation returns this identifier in its response. describeDocumentClassificationJob_jobId :: Lens' DescribeDocumentClassificationJob Text -- | An object that describes the properties associated with the document -- classification job. describeDocumentClassificationJobResponse_documentClassificationJobProperties :: Lens' DescribeDocumentClassificationJobResponse (Maybe DocumentClassificationJobProperties) -- | The response's http status code. describeDocumentClassificationJobResponse_httpStatus :: Lens' DescribeDocumentClassificationJobResponse Int -- | The Amazon Resource Name (ARN) that identifies the document -- classifier. The operation returns this identifier in its response. describeDocumentClassifier_documentClassifierArn :: Lens' DescribeDocumentClassifier Text -- | An object that contains the properties associated with a document -- classifier. describeDocumentClassifierResponse_documentClassifierProperties :: Lens' DescribeDocumentClassifierResponse (Maybe DocumentClassifierProperties) -- | The response's http status code. describeDocumentClassifierResponse_httpStatus :: Lens' DescribeDocumentClassifierResponse Int -- | The identifier that Amazon Comprehend generated for the job. The -- operation returns this identifier in its response. describeDominantLanguageDetectionJob_jobId :: Lens' DescribeDominantLanguageDetectionJob Text -- | An object that contains the properties associated with a dominant -- language detection job. describeDominantLanguageDetectionJobResponse_dominantLanguageDetectionJobProperties :: Lens' DescribeDominantLanguageDetectionJobResponse (Maybe DominantLanguageDetectionJobProperties) -- | The response's http status code. describeDominantLanguageDetectionJobResponse_httpStatus :: Lens' DescribeDominantLanguageDetectionJobResponse Int -- | The Amazon Resource Number (ARN) of the endpoint being described. describeEndpoint_endpointArn :: Lens' DescribeEndpoint Text -- | Describes information associated with the specific endpoint. describeEndpointResponse_endpointProperties :: Lens' DescribeEndpointResponse (Maybe EndpointProperties) -- | The response's http status code. describeEndpointResponse_httpStatus :: Lens' DescribeEndpointResponse Int -- | The identifier that Amazon Comprehend generated for the job. The -- operation returns this identifier in its response. describeEntitiesDetectionJob_jobId :: Lens' DescribeEntitiesDetectionJob Text -- | An object that contains the properties associated with an entities -- detection job. describeEntitiesDetectionJobResponse_entitiesDetectionJobProperties :: Lens' DescribeEntitiesDetectionJobResponse (Maybe EntitiesDetectionJobProperties) -- | The response's http status code. describeEntitiesDetectionJobResponse_httpStatus :: Lens' DescribeEntitiesDetectionJobResponse Int -- | The Amazon Resource Name (ARN) that identifies the entity recognizer. describeEntityRecognizer_entityRecognizerArn :: Lens' DescribeEntityRecognizer Text -- | Describes information associated with an entity recognizer. describeEntityRecognizerResponse_entityRecognizerProperties :: Lens' DescribeEntityRecognizerResponse (Maybe EntityRecognizerProperties) -- | The response's http status code. describeEntityRecognizerResponse_httpStatus :: Lens' DescribeEntityRecognizerResponse Int -- | The identifier of the events detection job. describeEventsDetectionJob_jobId :: Lens' DescribeEventsDetectionJob Text -- | An object that contains the properties associated with an event -- detection job. describeEventsDetectionJobResponse_eventsDetectionJobProperties :: Lens' DescribeEventsDetectionJobResponse (Maybe EventsDetectionJobProperties) -- | The response's http status code. describeEventsDetectionJobResponse_httpStatus :: Lens' DescribeEventsDetectionJobResponse Int -- | The identifier that Amazon Comprehend generated for the job. The -- operation returns this identifier in its response. describeKeyPhrasesDetectionJob_jobId :: Lens' DescribeKeyPhrasesDetectionJob Text -- | An object that contains the properties associated with a key phrases -- detection job. describeKeyPhrasesDetectionJobResponse_keyPhrasesDetectionJobProperties :: Lens' DescribeKeyPhrasesDetectionJobResponse (Maybe KeyPhrasesDetectionJobProperties) -- | The response's http status code. describeKeyPhrasesDetectionJobResponse_httpStatus :: Lens' DescribeKeyPhrasesDetectionJobResponse Int -- | The identifier that Amazon Comprehend generated for the job. The -- operation returns this identifier in its response. describePiiEntitiesDetectionJob_jobId :: Lens' DescribePiiEntitiesDetectionJob Text -- | Undocumented member. describePiiEntitiesDetectionJobResponse_piiEntitiesDetectionJobProperties :: Lens' DescribePiiEntitiesDetectionJobResponse (Maybe PiiEntitiesDetectionJobProperties) -- | The response's http status code. describePiiEntitiesDetectionJobResponse_httpStatus :: Lens' DescribePiiEntitiesDetectionJobResponse Int -- | The Amazon Resource Name (ARN) of the custom model version that has -- the resource policy. describeResourcePolicy_resourceArn :: Lens' DescribeResourcePolicy Text -- | The time at which the policy was created. describeResourcePolicyResponse_creationTime :: Lens' DescribeResourcePolicyResponse (Maybe UTCTime) -- | The time at which the policy was last modified. describeResourcePolicyResponse_lastModifiedTime :: Lens' DescribeResourcePolicyResponse (Maybe UTCTime) -- | The revision ID of the policy. Each time you modify a policy, Amazon -- Comprehend assigns a new revision ID, and it deletes the prior version -- of the policy. describeResourcePolicyResponse_policyRevisionId :: Lens' DescribeResourcePolicyResponse (Maybe Text) -- | The JSON body of the resource-based policy. describeResourcePolicyResponse_resourcePolicy :: Lens' DescribeResourcePolicyResponse (Maybe Text) -- | The response's http status code. describeResourcePolicyResponse_httpStatus :: Lens' DescribeResourcePolicyResponse Int -- | The identifier that Amazon Comprehend generated for the job. The -- operation returns this identifier in its response. describeSentimentDetectionJob_jobId :: Lens' DescribeSentimentDetectionJob Text -- | An object that contains the properties associated with a sentiment -- detection job. describeSentimentDetectionJobResponse_sentimentDetectionJobProperties :: Lens' DescribeSentimentDetectionJobResponse (Maybe SentimentDetectionJobProperties) -- | The response's http status code. describeSentimentDetectionJobResponse_httpStatus :: Lens' DescribeSentimentDetectionJobResponse Int -- | The identifier that Amazon Comprehend generated for the job. The -- operation returns this identifier in its response. describeTargetedSentimentDetectionJob_jobId :: Lens' DescribeTargetedSentimentDetectionJob Text -- | An object that contains the properties associated with a targeted -- sentiment detection job. describeTargetedSentimentDetectionJobResponse_targetedSentimentDetectionJobProperties :: Lens' DescribeTargetedSentimentDetectionJobResponse (Maybe TargetedSentimentDetectionJobProperties) -- | The response's http status code. describeTargetedSentimentDetectionJobResponse_httpStatus :: Lens' DescribeTargetedSentimentDetectionJobResponse Int -- | The identifier assigned by the user to the detection job. describeTopicsDetectionJob_jobId :: Lens' DescribeTopicsDetectionJob Text -- | The list of properties for the requested job. describeTopicsDetectionJobResponse_topicsDetectionJobProperties :: Lens' DescribeTopicsDetectionJobResponse (Maybe TopicsDetectionJobProperties) -- | The response's http status code. describeTopicsDetectionJobResponse_httpStatus :: Lens' DescribeTopicsDetectionJobResponse Int -- | A UTF-8 text string. The string must contain at least 20 characters. -- The maximum string size is 100 KB. detectDominantLanguage_text :: Lens' DetectDominantLanguage Text -- | The languages that Amazon Comprehend detected in the input text. For -- each language, the response returns the RFC 5646 language code and the -- level of confidence that Amazon Comprehend has in the accuracy of its -- inference. For more information about RFC 5646, see Tags for -- Identifying Languages on the IETF Tools web site. detectDominantLanguageResponse_languages :: Lens' DetectDominantLanguageResponse (Maybe [DominantLanguage]) -- | The response's http status code. detectDominantLanguageResponse_httpStatus :: Lens' DetectDominantLanguageResponse Int -- | This field applies only when you use a custom entity recognition model -- that was trained with PDF annotations. For other cases, enter your -- text input in the Text field. -- -- Use the Bytes parameter to input a text, PDF, Word or image -- file. Using a plain-text file in the Bytes parameter is -- equivelent to using the Text parameter (the Entities -- field in the response is identical). -- -- You can also use the Bytes parameter to input an Amazon -- Textract DetectDocumentText or AnalyzeDocument -- output file. -- -- Provide the input document as a sequence of base64-encoded bytes. If -- your code uses an Amazon Web Services SDK to detect entities, the SDK -- may encode the document file bytes for you. -- -- The maximum length of this field depends on the input document type. -- For details, see Inputs for real-time custom analysis in the -- Comprehend Developer Guide. -- -- If you use the Bytes parameter, do not use the Text -- parameter.-- -- Note: This Lens automatically encodes -- and decodes Base64 data. -- The underlying isomorphism will encode to -- Base64 representation during -- serialisation, and decode from Base64 -- representation during deserialisation. -- This Lens accepts -- and returns only raw unencoded data. detectEntities_bytes :: Lens' DetectEntities (Maybe ByteString) -- | Provides configuration parameters to override the default actions for -- extracting text from PDF documents and image files. detectEntities_documentReaderConfig :: Lens' DetectEntities (Maybe DocumentReaderConfig) -- | The Amazon Resource Name of an endpoint that is associated with a -- custom entity recognition model. Provide an endpoint if you want to -- detect entities by using your own custom model instead of the default -- model that is used by Amazon Comprehend. -- -- If you specify an endpoint, Amazon Comprehend uses the language of -- your custom model, and it ignores any language code that you provide -- in your request. -- -- For information about endpoints, see Managing endpoints. detectEntities_endpointArn :: Lens' DetectEntities (Maybe Text) -- | The language of the input documents. You can specify any of the -- primary languages supported by Amazon Comprehend. If your request -- includes the endpoint for a custom entity recognition model, Amazon -- Comprehend uses the language of your custom model, and it ignores any -- language code that you specify here. -- -- All input documents must be in the same language. detectEntities_languageCode :: Lens' DetectEntities (Maybe LanguageCode) -- | A UTF-8 text string. The maximum string size is 100 KB. If you enter -- text using this parameter, do not use the Bytes parameter. detectEntities_text :: Lens' DetectEntities (Maybe Text) -- | Information about each block of text in the input document. Blocks are -- nested. A page block contains a block for each line of text, which -- contains a block for each word. -- -- The Block content for a Word input document does not include -- a Geometry field. -- -- The Block field is not present in the response for plain-text -- inputs. detectEntitiesResponse_blocks :: Lens' DetectEntitiesResponse (Maybe [Block]) -- | Information about the document, discovered during text extraction. -- This field is present in the response only if your request used the -- Byte parameter. detectEntitiesResponse_documentMetadata :: Lens' DetectEntitiesResponse (Maybe DocumentMetadata) -- | The document type for each page in the input document. This field is -- present in the response only if your request used the Byte -- parameter. detectEntitiesResponse_documentType :: Lens' DetectEntitiesResponse (Maybe [DocumentTypeListItem]) -- | A collection of entities identified in the input text. For each -- entity, the response provides the entity text, entity type, where the -- entity text begins and ends, and the level of confidence that Amazon -- Comprehend has in the detection. -- -- If your request uses a custom entity recognition model, Amazon -- Comprehend detects the entities that the model is trained to -- recognize. Otherwise, it detects the default entity types. For a list -- of default entity types, see Entities in the Comprehend -- Developer Guide. detectEntitiesResponse_entities :: Lens' DetectEntitiesResponse (Maybe [Entity]) -- | Page-level errors that the system detected while processing the input -- document. The field is empty if the system encountered no errors. detectEntitiesResponse_errors :: Lens' DetectEntitiesResponse (Maybe [ErrorsListItem]) -- | The response's http status code. detectEntitiesResponse_httpStatus :: Lens' DetectEntitiesResponse Int -- | A UTF-8 text string. The string must contain less than 100 KB of UTF-8 -- encoded characters. detectKeyPhrases_text :: Lens' DetectKeyPhrases Text -- | The language of the input documents. You can specify any of the -- primary languages supported by Amazon Comprehend. All documents must -- be in the same language. detectKeyPhrases_languageCode :: Lens' DetectKeyPhrases LanguageCode -- | A collection of key phrases that Amazon Comprehend identified in the -- input text. For each key phrase, the response provides the text of the -- key phrase, where the key phrase begins and ends, and the level of -- confidence that Amazon Comprehend has in the accuracy of the -- detection. detectKeyPhrasesResponse_keyPhrases :: Lens' DetectKeyPhrasesResponse (Maybe [KeyPhrase]) -- | The response's http status code. detectKeyPhrasesResponse_httpStatus :: Lens' DetectKeyPhrasesResponse Int -- | A UTF-8 text string. The maximum string size is 100 KB. detectPiiEntities_text :: Lens' DetectPiiEntities Text -- | The language of the input documents. Currently, English is the only -- valid language. detectPiiEntities_languageCode :: Lens' DetectPiiEntities LanguageCode -- | A collection of PII entities identified in the input text. For each -- entity, the response provides the entity type, where the entity text -- begins and ends, and the level of confidence that Amazon Comprehend -- has in the detection. detectPiiEntitiesResponse_entities :: Lens' DetectPiiEntitiesResponse (Maybe [PiiEntity]) -- | The response's http status code. detectPiiEntitiesResponse_httpStatus :: Lens' DetectPiiEntitiesResponse Int -- | A UTF-8 text string. The maximum string size is 5 KB. -- -- Amazon Comprehend performs real-time sentiment analysis on the first -- 500 characters of the input text and ignores any additional text in -- the input. detectSentiment_text :: Lens' DetectSentiment Text -- | The language of the input documents. You can specify any of the -- primary languages supported by Amazon Comprehend. All documents must -- be in the same language. detectSentiment_languageCode :: Lens' DetectSentiment LanguageCode -- | The inferred sentiment that Amazon Comprehend has the highest level of -- confidence in. detectSentimentResponse_sentiment :: Lens' DetectSentimentResponse (Maybe SentimentType) -- | An object that lists the sentiments, and their corresponding -- confidence levels. detectSentimentResponse_sentimentScore :: Lens' DetectSentimentResponse (Maybe SentimentScore) -- | The response's http status code. detectSentimentResponse_httpStatus :: Lens' DetectSentimentResponse Int -- | A UTF-8 string. The maximum string size is 5 KB. detectSyntax_text :: Lens' DetectSyntax Text -- | The language code of the input documents. You can specify any of the -- following languages supported by Amazon Comprehend: German ("de"), -- English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or -- Portuguese ("pt"). detectSyntax_languageCode :: Lens' DetectSyntax SyntaxLanguageCode -- | A collection of syntax tokens describing the text. For each token, the -- response provides the text, the token type, where the text begins and -- ends, and the level of confidence that Amazon Comprehend has that the -- token is correct. For a list of token types, see Syntax in the -- Comprehend Developer Guide. detectSyntaxResponse_syntaxTokens :: Lens' DetectSyntaxResponse (Maybe [SyntaxToken]) -- | The response's http status code. detectSyntaxResponse_httpStatus :: Lens' DetectSyntaxResponse Int -- | A UTF-8 text string. The maximum string length is 5 KB. detectTargetedSentiment_text :: Lens' DetectTargetedSentiment Text -- | The language of the input documents. Currently, English is the only -- supported language. detectTargetedSentiment_languageCode :: Lens' DetectTargetedSentiment LanguageCode -- | Targeted sentiment analysis for each of the entities identified in the -- input text. detectTargetedSentimentResponse_entities :: Lens' DetectTargetedSentimentResponse (Maybe [TargetedSentimentEntity]) -- | The response's http status code. detectTargetedSentimentResponse_httpStatus :: Lens' DetectTargetedSentimentResponse Int -- | The Amazon Resource Name (ARN) of the AWS Identity and Management -- (IAM) role that allows Amazon Comprehend to use Amazon Key Management -- Service (KMS) to encrypt or decrypt the custom model. importModel_dataAccessRoleArn :: Lens' ImportModel (Maybe Text) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt trained custom models. The ModelKmsKeyId can be either -- of the following formats: -- -- importModel_modelKmsKeyId :: Lens' ImportModel (Maybe Text) -- | The name to assign to the custom model that is created in Amazon -- Comprehend by this import. importModel_modelName :: Lens' ImportModel (Maybe Text) -- | Tags to be associated with the custom model that is created by this -- import. A tag is a key-value pair that adds as a metadata to a -- resource used by Amazon Comprehend. For example, a tag with "Sales" as -- the key might be added to a resource to indicate its use by the sales -- department. importModel_tags :: Lens' ImportModel (Maybe [Tag]) -- | The version name given to the custom model that is created by this -- import. Version names can have a maximum of 256 characters. -- Alphanumeric characters, hyphens (-) and underscores (_) are allowed. -- The version name must be unique among all models with the same -- classifier name in the account/AWS Region. importModel_versionName :: Lens' ImportModel (Maybe Text) -- | The Amazon Resource Name (ARN) of the custom model to import. importModel_sourceModelArn :: Lens' ImportModel Text -- | The Amazon Resource Name (ARN) of the custom model being imported. importModelResponse_modelArn :: Lens' ImportModelResponse (Maybe Text) -- | The response's http status code. importModelResponse_httpStatus :: Lens' ImportModelResponse Int -- | Filters the jobs that are returned. You can filter jobs on their -- names, status, or the date and time that they were submitted. You can -- only set one filter at a time. listDocumentClassificationJobs_filter :: Lens' ListDocumentClassificationJobs (Maybe DocumentClassificationJobFilter) -- | The maximum number of results to return in each page. The default is -- 100. listDocumentClassificationJobs_maxResults :: Lens' ListDocumentClassificationJobs (Maybe Natural) -- | Identifies the next page of results to return. listDocumentClassificationJobs_nextToken :: Lens' ListDocumentClassificationJobs (Maybe Text) -- | A list containing the properties of each job returned. listDocumentClassificationJobsResponse_documentClassificationJobPropertiesList :: Lens' ListDocumentClassificationJobsResponse (Maybe [DocumentClassificationJobProperties]) -- | Identifies the next page of results to return. listDocumentClassificationJobsResponse_nextToken :: Lens' ListDocumentClassificationJobsResponse (Maybe Text) -- | The response's http status code. listDocumentClassificationJobsResponse_httpStatus :: Lens' ListDocumentClassificationJobsResponse Int -- | The maximum number of results to return on each page. The default is -- 100. listDocumentClassifierSummaries_maxResults :: Lens' ListDocumentClassifierSummaries (Maybe Natural) -- | Identifies the next page of results to return. listDocumentClassifierSummaries_nextToken :: Lens' ListDocumentClassifierSummaries (Maybe Text) -- | The list of summaries of document classifiers. listDocumentClassifierSummariesResponse_documentClassifierSummariesList :: Lens' ListDocumentClassifierSummariesResponse (Maybe [DocumentClassifierSummary]) -- | Identifies the next page of results to return. listDocumentClassifierSummariesResponse_nextToken :: Lens' ListDocumentClassifierSummariesResponse (Maybe Text) -- | The response's http status code. listDocumentClassifierSummariesResponse_httpStatus :: Lens' ListDocumentClassifierSummariesResponse Int -- | Filters the jobs that are returned. You can filter jobs on their name, -- status, or the date and time that they were submitted. You can only -- set one filter at a time. listDocumentClassifiers_filter :: Lens' ListDocumentClassifiers (Maybe DocumentClassifierFilter) -- | The maximum number of results to return in each page. The default is -- 100. listDocumentClassifiers_maxResults :: Lens' ListDocumentClassifiers (Maybe Natural) -- | Identifies the next page of results to return. listDocumentClassifiers_nextToken :: Lens' ListDocumentClassifiers (Maybe Text) -- | A list containing the properties of each job returned. listDocumentClassifiersResponse_documentClassifierPropertiesList :: Lens' ListDocumentClassifiersResponse (Maybe [DocumentClassifierProperties]) -- | Identifies the next page of results to return. listDocumentClassifiersResponse_nextToken :: Lens' ListDocumentClassifiersResponse (Maybe Text) -- | The response's http status code. listDocumentClassifiersResponse_httpStatus :: Lens' ListDocumentClassifiersResponse Int -- | Filters that jobs that are returned. You can filter jobs on their -- name, status, or the date and time that they were submitted. You can -- only set one filter at a time. listDominantLanguageDetectionJobs_filter :: Lens' ListDominantLanguageDetectionJobs (Maybe DominantLanguageDetectionJobFilter) -- | The maximum number of results to return in each page. The default is -- 100. listDominantLanguageDetectionJobs_maxResults :: Lens' ListDominantLanguageDetectionJobs (Maybe Natural) -- | Identifies the next page of results to return. listDominantLanguageDetectionJobs_nextToken :: Lens' ListDominantLanguageDetectionJobs (Maybe Text) -- | A list containing the properties of each job that is returned. listDominantLanguageDetectionJobsResponse_dominantLanguageDetectionJobPropertiesList :: Lens' ListDominantLanguageDetectionJobsResponse (Maybe [DominantLanguageDetectionJobProperties]) -- | Identifies the next page of results to return. listDominantLanguageDetectionJobsResponse_nextToken :: Lens' ListDominantLanguageDetectionJobsResponse (Maybe Text) -- | The response's http status code. listDominantLanguageDetectionJobsResponse_httpStatus :: Lens' ListDominantLanguageDetectionJobsResponse Int -- | Filters the endpoints that are returned. You can filter endpoints on -- their name, model, status, or the date and time that they were -- created. You can only set one filter at a time. listEndpoints_filter :: Lens' ListEndpoints (Maybe EndpointFilter) -- | The maximum number of results to return in each page. The default is -- 100. listEndpoints_maxResults :: Lens' ListEndpoints (Maybe Natural) -- | Identifies the next page of results to return. listEndpoints_nextToken :: Lens' ListEndpoints (Maybe Text) -- | Displays a list of endpoint properties being retrieved by the service -- in response to the request. listEndpointsResponse_endpointPropertiesList :: Lens' ListEndpointsResponse (Maybe [EndpointProperties]) -- | Identifies the next page of results to return. listEndpointsResponse_nextToken :: Lens' ListEndpointsResponse (Maybe Text) -- | The response's http status code. listEndpointsResponse_httpStatus :: Lens' ListEndpointsResponse Int -- | Filters the jobs that are returned. You can filter jobs on their name, -- status, or the date and time that they were submitted. You can only -- set one filter at a time. listEntitiesDetectionJobs_filter :: Lens' ListEntitiesDetectionJobs (Maybe EntitiesDetectionJobFilter) -- | The maximum number of results to return in each page. The default is -- 100. listEntitiesDetectionJobs_maxResults :: Lens' ListEntitiesDetectionJobs (Maybe Natural) -- | Identifies the next page of results to return. listEntitiesDetectionJobs_nextToken :: Lens' ListEntitiesDetectionJobs (Maybe Text) -- | A list containing the properties of each job that is returned. listEntitiesDetectionJobsResponse_entitiesDetectionJobPropertiesList :: Lens' ListEntitiesDetectionJobsResponse (Maybe [EntitiesDetectionJobProperties]) -- | Identifies the next page of results to return. listEntitiesDetectionJobsResponse_nextToken :: Lens' ListEntitiesDetectionJobsResponse (Maybe Text) -- | The response's http status code. listEntitiesDetectionJobsResponse_httpStatus :: Lens' ListEntitiesDetectionJobsResponse Int -- | The maximum number of results to return on each page. The default is -- 100. listEntityRecognizerSummaries_maxResults :: Lens' ListEntityRecognizerSummaries (Maybe Natural) -- | Identifies the next page of results to return. listEntityRecognizerSummaries_nextToken :: Lens' ListEntityRecognizerSummaries (Maybe Text) -- | The list entity recognizer summaries. listEntityRecognizerSummariesResponse_entityRecognizerSummariesList :: Lens' ListEntityRecognizerSummariesResponse (Maybe [EntityRecognizerSummary]) -- | The list entity recognizer summaries. listEntityRecognizerSummariesResponse_nextToken :: Lens' ListEntityRecognizerSummariesResponse (Maybe Text) -- | The response's http status code. listEntityRecognizerSummariesResponse_httpStatus :: Lens' ListEntityRecognizerSummariesResponse Int -- | Filters the list of entities returned. You can filter on -- Status, SubmitTimeBefore, or -- SubmitTimeAfter. You can only set one filter at a time. listEntityRecognizers_filter :: Lens' ListEntityRecognizers (Maybe EntityRecognizerFilter) -- | The maximum number of results to return on each page. The default is -- 100. listEntityRecognizers_maxResults :: Lens' ListEntityRecognizers (Maybe Natural) -- | Identifies the next page of results to return. listEntityRecognizers_nextToken :: Lens' ListEntityRecognizers (Maybe Text) -- | The list of properties of an entity recognizer. listEntityRecognizersResponse_entityRecognizerPropertiesList :: Lens' ListEntityRecognizersResponse (Maybe [EntityRecognizerProperties]) -- | Identifies the next page of results to return. listEntityRecognizersResponse_nextToken :: Lens' ListEntityRecognizersResponse (Maybe Text) -- | The response's http status code. listEntityRecognizersResponse_httpStatus :: Lens' ListEntityRecognizersResponse Int -- | Filters the jobs that are returned. You can filter jobs on their name, -- status, or the date and time that they were submitted. You can only -- set one filter at a time. listEventsDetectionJobs_filter :: Lens' ListEventsDetectionJobs (Maybe EventsDetectionJobFilter) -- | The maximum number of results to return in each page. listEventsDetectionJobs_maxResults :: Lens' ListEventsDetectionJobs (Maybe Natural) -- | Identifies the next page of results to return. listEventsDetectionJobs_nextToken :: Lens' ListEventsDetectionJobs (Maybe Text) -- | A list containing the properties of each job that is returned. listEventsDetectionJobsResponse_eventsDetectionJobPropertiesList :: Lens' ListEventsDetectionJobsResponse (Maybe [EventsDetectionJobProperties]) -- | Identifies the next page of results to return. listEventsDetectionJobsResponse_nextToken :: Lens' ListEventsDetectionJobsResponse (Maybe Text) -- | The response's http status code. listEventsDetectionJobsResponse_httpStatus :: Lens' ListEventsDetectionJobsResponse Int -- | Filters the jobs that are returned. You can filter jobs on their name, -- status, or the date and time that they were submitted. You can only -- set one filter at a time. listKeyPhrasesDetectionJobs_filter :: Lens' ListKeyPhrasesDetectionJobs (Maybe KeyPhrasesDetectionJobFilter) -- | The maximum number of results to return in each page. The default is -- 100. listKeyPhrasesDetectionJobs_maxResults :: Lens' ListKeyPhrasesDetectionJobs (Maybe Natural) -- | Identifies the next page of results to return. listKeyPhrasesDetectionJobs_nextToken :: Lens' ListKeyPhrasesDetectionJobs (Maybe Text) -- | A list containing the properties of each job that is returned. listKeyPhrasesDetectionJobsResponse_keyPhrasesDetectionJobPropertiesList :: Lens' ListKeyPhrasesDetectionJobsResponse (Maybe [KeyPhrasesDetectionJobProperties]) -- | Identifies the next page of results to return. listKeyPhrasesDetectionJobsResponse_nextToken :: Lens' ListKeyPhrasesDetectionJobsResponse (Maybe Text) -- | The response's http status code. listKeyPhrasesDetectionJobsResponse_httpStatus :: Lens' ListKeyPhrasesDetectionJobsResponse Int -- | Filters the jobs that are returned. You can filter jobs on their name, -- status, or the date and time that they were submitted. You can only -- set one filter at a time. listPiiEntitiesDetectionJobs_filter :: Lens' ListPiiEntitiesDetectionJobs (Maybe PiiEntitiesDetectionJobFilter) -- | The maximum number of results to return in each page. listPiiEntitiesDetectionJobs_maxResults :: Lens' ListPiiEntitiesDetectionJobs (Maybe Natural) -- | Identifies the next page of results to return. listPiiEntitiesDetectionJobs_nextToken :: Lens' ListPiiEntitiesDetectionJobs (Maybe Text) -- | Identifies the next page of results to return. listPiiEntitiesDetectionJobsResponse_nextToken :: Lens' ListPiiEntitiesDetectionJobsResponse (Maybe Text) -- | A list containing the properties of each job that is returned. listPiiEntitiesDetectionJobsResponse_piiEntitiesDetectionJobPropertiesList :: Lens' ListPiiEntitiesDetectionJobsResponse (Maybe [PiiEntitiesDetectionJobProperties]) -- | The response's http status code. listPiiEntitiesDetectionJobsResponse_httpStatus :: Lens' ListPiiEntitiesDetectionJobsResponse Int -- | Filters the jobs that are returned. You can filter jobs on their name, -- status, or the date and time that they were submitted. You can only -- set one filter at a time. listSentimentDetectionJobs_filter :: Lens' ListSentimentDetectionJobs (Maybe SentimentDetectionJobFilter) -- | The maximum number of results to return in each page. The default is -- 100. listSentimentDetectionJobs_maxResults :: Lens' ListSentimentDetectionJobs (Maybe Natural) -- | Identifies the next page of results to return. listSentimentDetectionJobs_nextToken :: Lens' ListSentimentDetectionJobs (Maybe Text) -- | Identifies the next page of results to return. listSentimentDetectionJobsResponse_nextToken :: Lens' ListSentimentDetectionJobsResponse (Maybe Text) -- | A list containing the properties of each job that is returned. listSentimentDetectionJobsResponse_sentimentDetectionJobPropertiesList :: Lens' ListSentimentDetectionJobsResponse (Maybe [SentimentDetectionJobProperties]) -- | The response's http status code. listSentimentDetectionJobsResponse_httpStatus :: Lens' ListSentimentDetectionJobsResponse Int -- | The Amazon Resource Name (ARN) of the given Amazon Comprehend resource -- you are querying. listTagsForResource_resourceArn :: Lens' ListTagsForResource Text -- | The Amazon Resource Name (ARN) of the given Amazon Comprehend resource -- you are querying. listTagsForResourceResponse_resourceArn :: Lens' ListTagsForResourceResponse (Maybe Text) -- | Tags associated with the Amazon Comprehend resource being queried. A -- tag is a key-value pair that adds as a metadata to a resource used by -- Amazon Comprehend. For example, a tag with "Sales" as the key might be -- added to a resource to indicate its use by the sales department. listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag]) -- | The response's http status code. listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int -- | Filters the jobs that are returned. You can filter jobs on their name, -- status, or the date and time that they were submitted. You can only -- set one filter at a time. listTargetedSentimentDetectionJobs_filter :: Lens' ListTargetedSentimentDetectionJobs (Maybe TargetedSentimentDetectionJobFilter) -- | The maximum number of results to return in each page. The default is -- 100. listTargetedSentimentDetectionJobs_maxResults :: Lens' ListTargetedSentimentDetectionJobs (Maybe Natural) -- | Identifies the next page of results to return. listTargetedSentimentDetectionJobs_nextToken :: Lens' ListTargetedSentimentDetectionJobs (Maybe Text) -- | Identifies the next page of results to return. listTargetedSentimentDetectionJobsResponse_nextToken :: Lens' ListTargetedSentimentDetectionJobsResponse (Maybe Text) -- | A list containing the properties of each job that is returned. listTargetedSentimentDetectionJobsResponse_targetedSentimentDetectionJobPropertiesList :: Lens' ListTargetedSentimentDetectionJobsResponse (Maybe [TargetedSentimentDetectionJobProperties]) -- | The response's http status code. listTargetedSentimentDetectionJobsResponse_httpStatus :: Lens' ListTargetedSentimentDetectionJobsResponse Int -- | Filters the jobs that are returned. Jobs can be filtered on their -- name, status, or the date and time that they were submitted. You can -- set only one filter at a time. listTopicsDetectionJobs_filter :: Lens' ListTopicsDetectionJobs (Maybe TopicsDetectionJobFilter) -- | The maximum number of results to return in each page. The default is -- 100. listTopicsDetectionJobs_maxResults :: Lens' ListTopicsDetectionJobs (Maybe Natural) -- | Identifies the next page of results to return. listTopicsDetectionJobs_nextToken :: Lens' ListTopicsDetectionJobs (Maybe Text) -- | Identifies the next page of results to return. listTopicsDetectionJobsResponse_nextToken :: Lens' ListTopicsDetectionJobsResponse (Maybe Text) -- | A list containing the properties of each job that is returned. listTopicsDetectionJobsResponse_topicsDetectionJobPropertiesList :: Lens' ListTopicsDetectionJobsResponse (Maybe [TopicsDetectionJobProperties]) -- | The response's http status code. listTopicsDetectionJobsResponse_httpStatus :: Lens' ListTopicsDetectionJobsResponse Int -- | The revision ID that Amazon Comprehend assigned to the policy that you -- are updating. If you are creating a new policy that has no prior -- version, don't use this parameter. Amazon Comprehend creates the -- revision ID for you. putResourcePolicy_policyRevisionId :: Lens' PutResourcePolicy (Maybe Text) -- | The Amazon Resource Name (ARN) of the custom model to attach the -- policy to. putResourcePolicy_resourceArn :: Lens' PutResourcePolicy Text -- | The JSON resource-based policy to attach to your custom model. Provide -- your JSON as a UTF-8 encoded string without line breaks. To provide -- valid JSON for your policy, enclose the attribute names and values in -- double quotes. If the JSON body is also enclosed in double quotes, -- then you must escape the double quotes that are inside the policy: -- -- 
--   "{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
--
-- -- To avoid escaping quotes, you can use single quotes to enclose the -- policy and double quotes to enclose the JSON names and values: -- -- 
--   '{"attribute": "value", "attribute": ["value"]}'
--
putResourcePolicy_resourcePolicy :: Lens' PutResourcePolicy Text -- | The revision ID of the policy. Each time you modify a policy, Amazon -- Comprehend assigns a new revision ID, and it deletes the prior version -- of the policy. putResourcePolicyResponse_policyRevisionId :: Lens' PutResourcePolicyResponse (Maybe Text) -- | The response's http status code. putResourcePolicyResponse_httpStatus :: Lens' PutResourcePolicyResponse Int -- | A unique identifier for the request. If you do not set the client -- request token, Amazon Comprehend generates one. startDocumentClassificationJob_clientRequestToken :: Lens' StartDocumentClassificationJob (Maybe Text) -- | The identifier of the job. startDocumentClassificationJob_jobName :: Lens' StartDocumentClassificationJob (Maybe Text) -- | Tags to be associated with the document classification job. A tag is a -- key-value pair that adds metadata to a resource used by Amazon -- Comprehend. For example, a tag with "Sales" as the key might be added -- to a resource to indicate its use by the sales department. startDocumentClassificationJob_tags :: Lens' StartDocumentClassificationJob (Maybe [Tag]) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- startDocumentClassificationJob_volumeKmsKeyId :: Lens' StartDocumentClassificationJob (Maybe Text) -- | Configuration parameters for an optional private Virtual Private Cloud -- (VPC) containing the resources you are using for your document -- classification job. For more information, see Amazon VPC. startDocumentClassificationJob_vpcConfig :: Lens' StartDocumentClassificationJob (Maybe VpcConfig) -- | The Amazon Resource Name (ARN) of the document classifier to use to -- process the job. startDocumentClassificationJob_documentClassifierArn :: Lens' StartDocumentClassificationJob Text -- | Specifies the format and location of the input data for the job. startDocumentClassificationJob_inputDataConfig :: Lens' StartDocumentClassificationJob InputDataConfig -- | Specifies where to send the output files. startDocumentClassificationJob_outputDataConfig :: Lens' StartDocumentClassificationJob OutputDataConfig -- | The Amazon Resource Name (ARN) of the AWS Identity and Access -- Management (IAM) role that grants Amazon Comprehend read access to -- your input data. startDocumentClassificationJob_dataAccessRoleArn :: Lens' StartDocumentClassificationJob Text -- | The Amazon Resource Name (ARN) of the document classification job. It -- is a unique, fully qualified identifier for the job. It includes the -- AWS account, Region, and the job ID. The format of the ARN is as -- follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
--
startDocumentClassificationJobResponse_jobArn :: Lens' StartDocumentClassificationJobResponse (Maybe Text) -- | The identifier generated for the job. To get the status of the job, -- use this identifier with the operation. startDocumentClassificationJobResponse_jobId :: Lens' StartDocumentClassificationJobResponse (Maybe Text) -- | The status of the job: -- -- startDocumentClassificationJobResponse_jobStatus :: Lens' StartDocumentClassificationJobResponse (Maybe JobStatus) -- | The response's http status code. startDocumentClassificationJobResponse_httpStatus :: Lens' StartDocumentClassificationJobResponse Int -- | A unique identifier for the request. If you do not set the client -- request token, Amazon Comprehend generates one. startDominantLanguageDetectionJob_clientRequestToken :: Lens' StartDominantLanguageDetectionJob (Maybe Text) -- | An identifier for the job. startDominantLanguageDetectionJob_jobName :: Lens' StartDominantLanguageDetectionJob (Maybe Text) -- | Tags to be associated with the dominant language detection job. A tag -- is a key-value pair that adds metadata to a resource used by Amazon -- Comprehend. For example, a tag with "Sales" as the key might be added -- to a resource to indicate its use by the sales department. startDominantLanguageDetectionJob_tags :: Lens' StartDominantLanguageDetectionJob (Maybe [Tag]) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- startDominantLanguageDetectionJob_volumeKmsKeyId :: Lens' StartDominantLanguageDetectionJob (Maybe Text) -- | Configuration parameters for an optional private Virtual Private Cloud -- (VPC) containing the resources you are using for your dominant -- language detection job. For more information, see Amazon VPC. startDominantLanguageDetectionJob_vpcConfig :: Lens' StartDominantLanguageDetectionJob (Maybe VpcConfig) -- | Specifies the format and location of the input data for the job. startDominantLanguageDetectionJob_inputDataConfig :: Lens' StartDominantLanguageDetectionJob InputDataConfig -- | Specifies where to send the output files. startDominantLanguageDetectionJob_outputDataConfig :: Lens' StartDominantLanguageDetectionJob OutputDataConfig -- | The Amazon Resource Name (ARN) of the AWS Identity and Access -- Management (IAM) role 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. startDominantLanguageDetectionJob_dataAccessRoleArn :: Lens' StartDominantLanguageDetectionJob Text -- | The Amazon Resource Name (ARN) of the dominant language detection job. -- It is a unique, fully qualified identifier for the job. It includes -- the AWS account, Region, and the job ID. The format of the ARN is as -- follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
--
startDominantLanguageDetectionJobResponse_jobArn :: Lens' StartDominantLanguageDetectionJobResponse (Maybe Text) -- | The identifier generated for the job. To get the status of a job, use -- this identifier with the operation. startDominantLanguageDetectionJobResponse_jobId :: Lens' StartDominantLanguageDetectionJobResponse (Maybe Text) -- | The status of the job. -- -- startDominantLanguageDetectionJobResponse_jobStatus :: Lens' StartDominantLanguageDetectionJobResponse (Maybe JobStatus) -- | The response's http status code. startDominantLanguageDetectionJobResponse_httpStatus :: Lens' StartDominantLanguageDetectionJobResponse Int -- | A unique identifier for the request. If you don't set the client -- request token, Amazon Comprehend generates one. startEntitiesDetectionJob_clientRequestToken :: Lens' StartEntitiesDetectionJob (Maybe Text) -- | The Amazon Resource Name (ARN) that identifies the specific entity -- recognizer to be used by the StartEntitiesDetectionJob. This -- ARN is optional and is only used for a custom entity recognition job. startEntitiesDetectionJob_entityRecognizerArn :: Lens' StartEntitiesDetectionJob (Maybe Text) -- | The identifier of the job. startEntitiesDetectionJob_jobName :: Lens' StartEntitiesDetectionJob (Maybe Text) -- | Tags to be associated with the entities detection job. A tag is a -- key-value pair that adds metadata to a resource used by Amazon -- Comprehend. For example, a tag with "Sales" as the key might be added -- to a resource to indicate its use by the sales department. startEntitiesDetectionJob_tags :: Lens' StartEntitiesDetectionJob (Maybe [Tag]) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- startEntitiesDetectionJob_volumeKmsKeyId :: Lens' StartEntitiesDetectionJob (Maybe Text) -- | Configuration parameters for an optional private Virtual Private Cloud -- (VPC) containing the resources you are using for your entity detection -- job. For more information, see Amazon VPC. startEntitiesDetectionJob_vpcConfig :: Lens' StartEntitiesDetectionJob (Maybe VpcConfig) -- | Specifies the format and location of the input data for the job. startEntitiesDetectionJob_inputDataConfig :: Lens' StartEntitiesDetectionJob InputDataConfig -- | Specifies where to send the output files. startEntitiesDetectionJob_outputDataConfig :: Lens' StartEntitiesDetectionJob OutputDataConfig -- | The Amazon Resource Name (ARN) of the AWS Identity and Access -- Management (IAM) role 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. startEntitiesDetectionJob_dataAccessRoleArn :: Lens' StartEntitiesDetectionJob Text -- | The language of the input documents. All documents must be in the same -- language. You can specify any of the languages supported by Amazon -- Comprehend. If custom entities recognition is used, this parameter is -- ignored and the language used for training the model is used instead. startEntitiesDetectionJob_languageCode :: Lens' StartEntitiesDetectionJob LanguageCode -- | The Amazon Resource Name (ARN) of the entities detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
--
startEntitiesDetectionJobResponse_jobArn :: Lens' StartEntitiesDetectionJobResponse (Maybe Text) -- | The identifier generated for the job. To get the status of job, use -- this identifier with the operation. startEntitiesDetectionJobResponse_jobId :: Lens' StartEntitiesDetectionJobResponse (Maybe Text) -- | The status of the job. -- -- startEntitiesDetectionJobResponse_jobStatus :: Lens' StartEntitiesDetectionJobResponse (Maybe JobStatus) -- | The response's http status code. startEntitiesDetectionJobResponse_httpStatus :: Lens' StartEntitiesDetectionJobResponse Int -- | An unique identifier for the request. If you don't set the client -- request token, Amazon Comprehend generates one. startEventsDetectionJob_clientRequestToken :: Lens' StartEventsDetectionJob (Maybe Text) -- | The identifier of the events detection job. startEventsDetectionJob_jobName :: Lens' StartEventsDetectionJob (Maybe Text) -- | Tags to be associated with the events detection job. A tag is a -- key-value pair that adds metadata to a resource used by Amazon -- Comprehend. For example, a tag with "Sales" as the key might be added -- to a resource to indicate its use by the sales department. startEventsDetectionJob_tags :: Lens' StartEventsDetectionJob (Maybe [Tag]) -- | Specifies the format and location of the input data for the job. startEventsDetectionJob_inputDataConfig :: Lens' StartEventsDetectionJob InputDataConfig -- | Specifies where to send the output files. startEventsDetectionJob_outputDataConfig :: Lens' StartEventsDetectionJob OutputDataConfig -- | The Amazon Resource Name (ARN) of the AWS Identity and Access -- Management (IAM) role that grants Amazon Comprehend read access to -- your input data. startEventsDetectionJob_dataAccessRoleArn :: Lens' StartEventsDetectionJob Text -- | The language code of the input documents. startEventsDetectionJob_languageCode :: Lens' StartEventsDetectionJob LanguageCode -- | The types of events to detect in the input documents. startEventsDetectionJob_targetEventTypes :: Lens' StartEventsDetectionJob (NonEmpty Text) -- | The Amazon Resource Name (ARN) of the events detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
--
startEventsDetectionJobResponse_jobArn :: Lens' StartEventsDetectionJobResponse (Maybe Text) -- | An unique identifier for the request. If you don't set the client -- request token, Amazon Comprehend generates one. startEventsDetectionJobResponse_jobId :: Lens' StartEventsDetectionJobResponse (Maybe Text) -- | The status of the events detection job. startEventsDetectionJobResponse_jobStatus :: Lens' StartEventsDetectionJobResponse (Maybe JobStatus) -- | The response's http status code. startEventsDetectionJobResponse_httpStatus :: Lens' StartEventsDetectionJobResponse Int -- | A unique identifier for the request. If you don't set the client -- request token, Amazon Comprehend generates one. startKeyPhrasesDetectionJob_clientRequestToken :: Lens' StartKeyPhrasesDetectionJob (Maybe Text) -- | The identifier of the job. startKeyPhrasesDetectionJob_jobName :: Lens' StartKeyPhrasesDetectionJob (Maybe Text) -- | Tags to be associated with the key phrases detection job. A tag is a -- key-value pair that adds metadata to a resource used by Amazon -- Comprehend. For example, a tag with "Sales" as the key might be added -- to a resource to indicate its use by the sales department. startKeyPhrasesDetectionJob_tags :: Lens' StartKeyPhrasesDetectionJob (Maybe [Tag]) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- startKeyPhrasesDetectionJob_volumeKmsKeyId :: Lens' StartKeyPhrasesDetectionJob (Maybe Text) -- | Configuration parameters for an optional private Virtual Private Cloud -- (VPC) containing the resources you are using for your key phrases -- detection job. For more information, see Amazon VPC. startKeyPhrasesDetectionJob_vpcConfig :: Lens' StartKeyPhrasesDetectionJob (Maybe VpcConfig) -- | Specifies the format and location of the input data for the job. startKeyPhrasesDetectionJob_inputDataConfig :: Lens' StartKeyPhrasesDetectionJob InputDataConfig -- | Specifies where to send the output files. startKeyPhrasesDetectionJob_outputDataConfig :: Lens' StartKeyPhrasesDetectionJob OutputDataConfig -- | The Amazon Resource Name (ARN) of the AWS Identity and Access -- Management (IAM) role 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. startKeyPhrasesDetectionJob_dataAccessRoleArn :: Lens' StartKeyPhrasesDetectionJob Text -- | The language of the input documents. You can specify any of the -- primary languages supported by Amazon Comprehend. All documents must -- be in the same language. startKeyPhrasesDetectionJob_languageCode :: Lens' StartKeyPhrasesDetectionJob LanguageCode -- | The Amazon Resource Name (ARN) of the key phrase detection job. It is -- a unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
--
startKeyPhrasesDetectionJobResponse_jobArn :: Lens' StartKeyPhrasesDetectionJobResponse (Maybe Text) -- | The identifier generated for the job. To get the status of a job, use -- this identifier with the operation. startKeyPhrasesDetectionJobResponse_jobId :: Lens' StartKeyPhrasesDetectionJobResponse (Maybe Text) -- | The status of the job. -- -- startKeyPhrasesDetectionJobResponse_jobStatus :: Lens' StartKeyPhrasesDetectionJobResponse (Maybe JobStatus) -- | The response's http status code. startKeyPhrasesDetectionJobResponse_httpStatus :: Lens' StartKeyPhrasesDetectionJobResponse Int -- | A unique identifier for the request. If you don't set the client -- request token, Amazon Comprehend generates one. startPiiEntitiesDetectionJob_clientRequestToken :: Lens' StartPiiEntitiesDetectionJob (Maybe Text) -- | The identifier of the job. startPiiEntitiesDetectionJob_jobName :: Lens' StartPiiEntitiesDetectionJob (Maybe Text) -- | Provides configuration parameters for PII entity redaction. -- -- This parameter is required if you set the Mode parameter to -- ONLY_REDACTION. In that case, you must provide a -- RedactionConfig definition that includes the -- PiiEntityTypes parameter. startPiiEntitiesDetectionJob_redactionConfig :: Lens' StartPiiEntitiesDetectionJob (Maybe RedactionConfig) -- | Tags to be associated with the PII entities detection job. A tag is a -- key-value pair that adds metadata to a resource used by Amazon -- Comprehend. For example, a tag with "Sales" as the key might be added -- to a resource to indicate its use by the sales department. startPiiEntitiesDetectionJob_tags :: Lens' StartPiiEntitiesDetectionJob (Maybe [Tag]) -- | The input properties for a PII entities detection job. startPiiEntitiesDetectionJob_inputDataConfig :: Lens' StartPiiEntitiesDetectionJob InputDataConfig -- | Provides configuration parameters for the output of PII entity -- detection jobs. startPiiEntitiesDetectionJob_outputDataConfig :: Lens' StartPiiEntitiesDetectionJob OutputDataConfig -- | Specifies whether the output provides the locations (offsets) of PII -- entities or a file in which PII entities are redacted. startPiiEntitiesDetectionJob_mode :: Lens' StartPiiEntitiesDetectionJob PiiEntitiesDetectionMode -- | The Amazon Resource Name (ARN) of the AWS Identity and Access -- Management (IAM) role that grants Amazon Comprehend read access to -- your input data. startPiiEntitiesDetectionJob_dataAccessRoleArn :: Lens' StartPiiEntitiesDetectionJob Text -- | The language of the input documents. Currently, English is the only -- valid language. startPiiEntitiesDetectionJob_languageCode :: Lens' StartPiiEntitiesDetectionJob LanguageCode -- | The Amazon Resource Name (ARN) of the PII entity detection job. It is -- a unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
--
startPiiEntitiesDetectionJobResponse_jobArn :: Lens' StartPiiEntitiesDetectionJobResponse (Maybe Text) -- | The identifier generated for the job. startPiiEntitiesDetectionJobResponse_jobId :: Lens' StartPiiEntitiesDetectionJobResponse (Maybe Text) -- | The status of the job. startPiiEntitiesDetectionJobResponse_jobStatus :: Lens' StartPiiEntitiesDetectionJobResponse (Maybe JobStatus) -- | The response's http status code. startPiiEntitiesDetectionJobResponse_httpStatus :: Lens' StartPiiEntitiesDetectionJobResponse Int -- | A unique identifier for the request. If you don't set the client -- request token, Amazon Comprehend generates one. startSentimentDetectionJob_clientRequestToken :: Lens' StartSentimentDetectionJob (Maybe Text) -- | The identifier of the job. startSentimentDetectionJob_jobName :: Lens' StartSentimentDetectionJob (Maybe Text) -- | Tags to be associated with the sentiment detection job. A tag is a -- key-value pair that adds metadata to a resource used by Amazon -- Comprehend. For example, a tag with "Sales" as the key might be added -- to a resource to indicate its use by the sales department. startSentimentDetectionJob_tags :: Lens' StartSentimentDetectionJob (Maybe [Tag]) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- startSentimentDetectionJob_volumeKmsKeyId :: Lens' StartSentimentDetectionJob (Maybe Text) -- | Configuration parameters for an optional private Virtual Private Cloud -- (VPC) containing the resources you are using for your sentiment -- detection job. For more information, see Amazon VPC. startSentimentDetectionJob_vpcConfig :: Lens' StartSentimentDetectionJob (Maybe VpcConfig) -- | Specifies the format and location of the input data for the job. startSentimentDetectionJob_inputDataConfig :: Lens' StartSentimentDetectionJob InputDataConfig -- | Specifies where to send the output files. startSentimentDetectionJob_outputDataConfig :: Lens' StartSentimentDetectionJob OutputDataConfig -- | The Amazon Resource Name (ARN) of the AWS Identity and Access -- Management (IAM) role 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. startSentimentDetectionJob_dataAccessRoleArn :: Lens' StartSentimentDetectionJob Text -- | The language of the input documents. You can specify any of the -- primary languages supported by Amazon Comprehend. All documents must -- be in the same language. startSentimentDetectionJob_languageCode :: Lens' StartSentimentDetectionJob LanguageCode -- | The Amazon Resource Name (ARN) of the sentiment detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
--
startSentimentDetectionJobResponse_jobArn :: Lens' StartSentimentDetectionJobResponse (Maybe Text) -- | The identifier generated for the job. To get the status of a job, use -- this identifier with the operation. startSentimentDetectionJobResponse_jobId :: Lens' StartSentimentDetectionJobResponse (Maybe Text) -- | The status of the job. -- -- startSentimentDetectionJobResponse_jobStatus :: Lens' StartSentimentDetectionJobResponse (Maybe JobStatus) -- | The response's http status code. startSentimentDetectionJobResponse_httpStatus :: Lens' StartSentimentDetectionJobResponse Int -- | A unique identifier for the request. If you don't set the client -- request token, Amazon Comprehend generates one. startTargetedSentimentDetectionJob_clientRequestToken :: Lens' StartTargetedSentimentDetectionJob (Maybe Text) -- | The identifier of the job. startTargetedSentimentDetectionJob_jobName :: Lens' StartTargetedSentimentDetectionJob (Maybe Text) -- | Tags to be associated with the targeted sentiment detection job. A tag -- is a key-value pair that adds metadata to a resource used by Amazon -- Comprehend. For example, a tag with "Sales" as the key might be added -- to a resource to indicate its use by the sales department. startTargetedSentimentDetectionJob_tags :: Lens' StartTargetedSentimentDetectionJob (Maybe [Tag]) -- | ID for the KMS key that Amazon Comprehend uses to encrypt data on the -- storage volume attached to the ML compute instance(s) that process the -- analysis job. The VolumeKmsKeyId can be either of the following -- formats: -- -- startTargetedSentimentDetectionJob_volumeKmsKeyId :: Lens' StartTargetedSentimentDetectionJob (Maybe Text) -- | Undocumented member. startTargetedSentimentDetectionJob_vpcConfig :: Lens' StartTargetedSentimentDetectionJob (Maybe VpcConfig) -- | Undocumented member. startTargetedSentimentDetectionJob_inputDataConfig :: Lens' StartTargetedSentimentDetectionJob InputDataConfig -- | Specifies where to send the output files. startTargetedSentimentDetectionJob_outputDataConfig :: Lens' StartTargetedSentimentDetectionJob OutputDataConfig -- | The Amazon Resource Name (ARN) of the AWS Identity and Access -- Management (IAM) role that grants Amazon Comprehend read access to -- your input data. For more information, see Role-based -- permissions. startTargetedSentimentDetectionJob_dataAccessRoleArn :: Lens' StartTargetedSentimentDetectionJob Text -- | The language of the input documents. Currently, English is the only -- supported language. startTargetedSentimentDetectionJob_languageCode :: Lens' StartTargetedSentimentDetectionJob LanguageCode -- | The Amazon Resource Name (ARN) of the targeted sentiment detection -- job. It is a unique, fully qualified identifier for the job. It -- includes the AWS account, Region, and the job ID. The format of the -- ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
--
startTargetedSentimentDetectionJobResponse_jobArn :: Lens' StartTargetedSentimentDetectionJobResponse (Maybe Text) -- | The identifier generated for the job. To get the status of a job, use -- this identifier with the operation. startTargetedSentimentDetectionJobResponse_jobId :: Lens' StartTargetedSentimentDetectionJobResponse (Maybe Text) -- | The status of the job. -- -- startTargetedSentimentDetectionJobResponse_jobStatus :: Lens' StartTargetedSentimentDetectionJobResponse (Maybe JobStatus) -- | The response's http status code. startTargetedSentimentDetectionJobResponse_httpStatus :: Lens' StartTargetedSentimentDetectionJobResponse Int -- | A unique identifier for the request. If you do not set the client -- request token, Amazon Comprehend generates one. startTopicsDetectionJob_clientRequestToken :: Lens' StartTopicsDetectionJob (Maybe Text) -- | The identifier of the job. startTopicsDetectionJob_jobName :: Lens' StartTopicsDetectionJob (Maybe Text) -- | The number of topics to detect. startTopicsDetectionJob_numberOfTopics :: Lens' StartTopicsDetectionJob (Maybe Natural) -- | Tags to be associated with the topics detection job. A tag is a -- key-value pair that adds metadata to a resource used by Amazon -- Comprehend. For example, a tag with "Sales" as the key might be added -- to a resource to indicate its use by the sales department. startTopicsDetectionJob_tags :: Lens' StartTopicsDetectionJob (Maybe [Tag]) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- startTopicsDetectionJob_volumeKmsKeyId :: Lens' StartTopicsDetectionJob (Maybe Text) -- | Configuration parameters for an optional private Virtual Private Cloud -- (VPC) containing the resources you are using for your topic detection -- job. For more information, see Amazon VPC. startTopicsDetectionJob_vpcConfig :: Lens' StartTopicsDetectionJob (Maybe VpcConfig) -- | Specifies the format and location of the input data for the job. startTopicsDetectionJob_inputDataConfig :: Lens' StartTopicsDetectionJob InputDataConfig -- | Specifies where to send the output files. The output is a compressed -- archive with two files, topic-terms.csv that lists the terms -- associated with each topic, and doc-topics.csv that lists the -- documents associated with each topic startTopicsDetectionJob_outputDataConfig :: Lens' StartTopicsDetectionJob OutputDataConfig -- | The Amazon Resource Name (ARN) of the AWS Identity and Access -- Management (IAM) role 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. startTopicsDetectionJob_dataAccessRoleArn :: Lens' StartTopicsDetectionJob Text -- | The Amazon Resource Name (ARN) of the topics detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
--
startTopicsDetectionJobResponse_jobArn :: Lens' StartTopicsDetectionJobResponse (Maybe Text) -- | The identifier generated for the job. To get the status of the job, -- use this identifier with the DescribeTopicDetectionJob -- operation. startTopicsDetectionJobResponse_jobId :: Lens' StartTopicsDetectionJobResponse (Maybe Text) -- | The status of the job: -- -- startTopicsDetectionJobResponse_jobStatus :: Lens' StartTopicsDetectionJobResponse (Maybe JobStatus) -- | The response's http status code. startTopicsDetectionJobResponse_httpStatus :: Lens' StartTopicsDetectionJobResponse Int -- | The identifier of the dominant language detection job to stop. stopDominantLanguageDetectionJob_jobId :: Lens' StopDominantLanguageDetectionJob Text -- | The identifier of the dominant language detection job to stop. stopDominantLanguageDetectionJobResponse_jobId :: Lens' StopDominantLanguageDetectionJobResponse (Maybe Text) -- | Either STOP_REQUESTED if the job is currently running, or -- STOPPED if the job was previously stopped with the -- StopDominantLanguageDetectionJob operation. stopDominantLanguageDetectionJobResponse_jobStatus :: Lens' StopDominantLanguageDetectionJobResponse (Maybe JobStatus) -- | The response's http status code. stopDominantLanguageDetectionJobResponse_httpStatus :: Lens' StopDominantLanguageDetectionJobResponse Int -- | The identifier of the entities detection job to stop. stopEntitiesDetectionJob_jobId :: Lens' StopEntitiesDetectionJob Text -- | The identifier of the entities detection job to stop. stopEntitiesDetectionJobResponse_jobId :: Lens' StopEntitiesDetectionJobResponse (Maybe Text) -- | Either STOP_REQUESTED if the job is currently running, or -- STOPPED if the job was previously stopped with the -- StopEntitiesDetectionJob operation. stopEntitiesDetectionJobResponse_jobStatus :: Lens' StopEntitiesDetectionJobResponse (Maybe JobStatus) -- | The response's http status code. stopEntitiesDetectionJobResponse_httpStatus :: Lens' StopEntitiesDetectionJobResponse Int -- | The identifier of the events detection job to stop. stopEventsDetectionJob_jobId :: Lens' StopEventsDetectionJob Text -- | The identifier of the events detection job to stop. stopEventsDetectionJobResponse_jobId :: Lens' StopEventsDetectionJobResponse (Maybe Text) -- | The status of the events detection job. stopEventsDetectionJobResponse_jobStatus :: Lens' StopEventsDetectionJobResponse (Maybe JobStatus) -- | The response's http status code. stopEventsDetectionJobResponse_httpStatus :: Lens' StopEventsDetectionJobResponse Int -- | The identifier of the key phrases detection job to stop. stopKeyPhrasesDetectionJob_jobId :: Lens' StopKeyPhrasesDetectionJob Text -- | The identifier of the key phrases detection job to stop. stopKeyPhrasesDetectionJobResponse_jobId :: Lens' StopKeyPhrasesDetectionJobResponse (Maybe Text) -- | Either STOP_REQUESTED if the job is currently running, or -- STOPPED if the job was previously stopped with the -- StopKeyPhrasesDetectionJob operation. stopKeyPhrasesDetectionJobResponse_jobStatus :: Lens' StopKeyPhrasesDetectionJobResponse (Maybe JobStatus) -- | The response's http status code. stopKeyPhrasesDetectionJobResponse_httpStatus :: Lens' StopKeyPhrasesDetectionJobResponse Int -- | The identifier of the PII entities detection job to stop. stopPiiEntitiesDetectionJob_jobId :: Lens' StopPiiEntitiesDetectionJob Text -- | The identifier of the PII entities detection job to stop. stopPiiEntitiesDetectionJobResponse_jobId :: Lens' StopPiiEntitiesDetectionJobResponse (Maybe Text) -- | The status of the PII entities detection job. stopPiiEntitiesDetectionJobResponse_jobStatus :: Lens' StopPiiEntitiesDetectionJobResponse (Maybe JobStatus) -- | The response's http status code. stopPiiEntitiesDetectionJobResponse_httpStatus :: Lens' StopPiiEntitiesDetectionJobResponse Int -- | The identifier of the sentiment detection job to stop. stopSentimentDetectionJob_jobId :: Lens' StopSentimentDetectionJob Text -- | The identifier of the sentiment detection job to stop. stopSentimentDetectionJobResponse_jobId :: Lens' StopSentimentDetectionJobResponse (Maybe Text) -- | Either STOP_REQUESTED if the job is currently running, or -- STOPPED if the job was previously stopped with the -- StopSentimentDetectionJob operation. stopSentimentDetectionJobResponse_jobStatus :: Lens' StopSentimentDetectionJobResponse (Maybe JobStatus) -- | The response's http status code. stopSentimentDetectionJobResponse_httpStatus :: Lens' StopSentimentDetectionJobResponse Int -- | The identifier of the targeted sentiment detection job to stop. stopTargetedSentimentDetectionJob_jobId :: Lens' StopTargetedSentimentDetectionJob Text -- | The identifier of the targeted sentiment detection job to stop. stopTargetedSentimentDetectionJobResponse_jobId :: Lens' StopTargetedSentimentDetectionJobResponse (Maybe Text) -- | Either STOP_REQUESTED if the job is currently running, or -- STOPPED if the job was previously stopped with the -- StopSentimentDetectionJob operation. stopTargetedSentimentDetectionJobResponse_jobStatus :: Lens' StopTargetedSentimentDetectionJobResponse (Maybe JobStatus) -- | The response's http status code. stopTargetedSentimentDetectionJobResponse_httpStatus :: Lens' StopTargetedSentimentDetectionJobResponse Int -- | The Amazon Resource Name (ARN) that identifies the document classifier -- currently being trained. stopTrainingDocumentClassifier_documentClassifierArn :: Lens' StopTrainingDocumentClassifier Text -- | The response's http status code. stopTrainingDocumentClassifierResponse_httpStatus :: Lens' StopTrainingDocumentClassifierResponse Int -- | The Amazon Resource Name (ARN) that identifies the entity recognizer -- currently being trained. stopTrainingEntityRecognizer_entityRecognizerArn :: Lens' StopTrainingEntityRecognizer Text -- | The response's http status code. stopTrainingEntityRecognizerResponse_httpStatus :: Lens' StopTrainingEntityRecognizerResponse Int -- | The Amazon Resource Name (ARN) of the given Amazon Comprehend resource -- to which you want to associate the tags. tagResource_resourceArn :: Lens' TagResource Text -- | Tags being associated with a specific Amazon Comprehend resource. -- There can be a maximum of 50 tags (both existing and pending) -- associated with a specific resource. tagResource_tags :: Lens' TagResource [Tag] -- | The response's http status code. tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int -- | The Amazon Resource Name (ARN) of the given Amazon Comprehend resource -- from which you want to remove the tags. untagResource_resourceArn :: Lens' UntagResource Text -- | The initial part of a key-value pair that forms a tag being removed -- from a given resource. For example, a tag with "Sales" as the key -- might be added to a resource to indicate its use by the sales -- department. Keys must be unique and cannot be duplicated for a -- particular resource. untagResource_tagKeys :: Lens' UntagResource [Text] -- | The response's http status code. untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int -- | Data access role ARN to use in case the new model is encrypted with a -- customer CMK. updateEndpoint_desiredDataAccessRoleArn :: Lens' UpdateEndpoint (Maybe Text) -- | The desired number of inference units to be used by the model using -- this endpoint. Each inference unit represents of a throughput of 100 -- characters per second. updateEndpoint_desiredInferenceUnits :: Lens' UpdateEndpoint (Maybe Natural) -- | The ARN of the new model to use when updating an existing endpoint. updateEndpoint_desiredModelArn :: Lens' UpdateEndpoint (Maybe Text) -- | The Amazon Resource Number (ARN) of the endpoint being updated. updateEndpoint_endpointArn :: Lens' UpdateEndpoint Text -- | The response's http status code. updateEndpointResponse_httpStatus :: Lens' UpdateEndpointResponse Int -- | The S3 prefix to the annotation files that are referred in the -- augmented manifest file. augmentedManifestsListItem_annotationDataS3Uri :: Lens' AugmentedManifestsListItem (Maybe Text) -- | The type of augmented manifest. PlainTextDocument or -- SemiStructuredDocument. If you don't specify, the default is -- PlainTextDocument. -- -- augmentedManifestsListItem_documentType :: Lens' AugmentedManifestsListItem (Maybe AugmentedManifestsDocumentTypeFormat) -- | The S3 prefix to the source files (PDFs) that are referred to in the -- augmented manifest file. augmentedManifestsListItem_sourceDocumentsS3Uri :: Lens' AugmentedManifestsListItem (Maybe Text) -- | The purpose of the data you've provided in the augmented manifest. You -- can either train or test this data. If you don't specify, the default -- is train. -- -- TRAIN - all of the documents in the manifest will be used for -- training. If no test documents are provided, Amazon Comprehend will -- automatically reserve a portion of the training documents for testing. -- -- TEST - all of the documents in the manifest will be used for testing. augmentedManifestsListItem_split :: Lens' AugmentedManifestsListItem (Maybe Split) -- | The Amazon S3 location of the augmented manifest file. augmentedManifestsListItem_s3Uri :: Lens' AugmentedManifestsListItem Text -- | The JSON attribute that contains the annotations for your training -- documents. The number of attribute names that you specify depends on -- whether your augmented manifest file is the output of a single -- labeling job or a chained labeling job. -- -- If your file is the output of a single labeling job, specify the -- LabelAttributeName key that was used when the job was created in -- Ground Truth. -- -- If your file is the output of a chained labeling job, specify the -- LabelAttributeName key for one or more jobs in the chain. Each -- LabelAttributeName key provides the annotations from an individual -- job. augmentedManifestsListItem_attributeNames :: Lens' AugmentedManifestsListItem [Text] -- | The zero-based index of the document in the input list. batchDetectDominantLanguageItemResult_index :: Lens' BatchDetectDominantLanguageItemResult (Maybe Int) -- | One or more DominantLanguage objects describing the dominant languages -- in the document. batchDetectDominantLanguageItemResult_languages :: Lens' BatchDetectDominantLanguageItemResult (Maybe [DominantLanguage]) -- | One or more Entity objects, one for each entity detected in the -- document. batchDetectEntitiesItemResult_entities :: Lens' BatchDetectEntitiesItemResult (Maybe [Entity]) -- | The zero-based index of the document in the input list. batchDetectEntitiesItemResult_index :: Lens' BatchDetectEntitiesItemResult (Maybe Int) -- | The zero-based index of the document in the input list. batchDetectKeyPhrasesItemResult_index :: Lens' BatchDetectKeyPhrasesItemResult (Maybe Int) -- | One or more KeyPhrase objects, one for each key phrase detected in the -- document. batchDetectKeyPhrasesItemResult_keyPhrases :: Lens' BatchDetectKeyPhrasesItemResult (Maybe [KeyPhrase]) -- | The zero-based index of the document in the input list. batchDetectSentimentItemResult_index :: Lens' BatchDetectSentimentItemResult (Maybe Int) -- | The sentiment detected in the document. batchDetectSentimentItemResult_sentiment :: Lens' BatchDetectSentimentItemResult (Maybe SentimentType) -- | The level of confidence that Amazon Comprehend has in the accuracy of -- its sentiment detection. batchDetectSentimentItemResult_sentimentScore :: Lens' BatchDetectSentimentItemResult (Maybe SentimentScore) -- | The zero-based index of the document in the input list. batchDetectSyntaxItemResult_index :: Lens' BatchDetectSyntaxItemResult (Maybe Int) -- | The syntax tokens for the words in the document, one token for each -- word. batchDetectSyntaxItemResult_syntaxTokens :: Lens' BatchDetectSyntaxItemResult (Maybe [SyntaxToken]) -- | An array of targeted sentiment entities. batchDetectTargetedSentimentItemResult_entities :: Lens' BatchDetectTargetedSentimentItemResult (Maybe [TargetedSentimentEntity]) -- | The zero-based index of this result in the input list. batchDetectTargetedSentimentItemResult_index :: Lens' BatchDetectTargetedSentimentItemResult (Maybe Int) -- | The numeric error code of the error. batchItemError_errorCode :: Lens' BatchItemError (Maybe Text) -- | A text description of the error. batchItemError_errorMessage :: Lens' BatchItemError (Maybe Text) -- | The zero-based index of the document in the input list. batchItemError_index :: Lens' BatchItemError (Maybe Int) -- | The block represents a line of text or one word of text. -- -- block_blockType :: Lens' Block (Maybe BlockType) -- | Co-ordinates of the rectangle or polygon that contains the text. block_geometry :: Lens' Block (Maybe Geometry) -- | Unique identifier for the block. block_id :: Lens' Block (Maybe Text) -- | Page number where the block appears. block_page :: Lens' Block (Maybe Int) -- | A list of child blocks of the current block. For example, a LINE -- object has child blocks for each WORD block that's part of the line of -- text. block_relationships :: Lens' Block (Maybe [RelationshipsListItem]) -- | The word or line of text extracted from the block. block_text :: Lens' Block (Maybe Text) -- | Offset of the start of the block within its parent block. blockReference_beginOffset :: Lens' BlockReference (Maybe Int) -- | Unique identifier for the block. blockReference_blockId :: Lens' BlockReference (Maybe Text) -- | List of child blocks within this block. blockReference_childBlocks :: Lens' BlockReference (Maybe [ChildBlock]) -- | Offset of the end of the block within its parent block. blockReference_endOffset :: Lens' BlockReference (Maybe Int) -- | The height of the bounding box as a ratio of the overall document page -- height. boundingBox_height :: Lens' BoundingBox (Maybe Double) -- | The left coordinate of the bounding box as a ratio of overall document -- page width. boundingBox_left :: Lens' BoundingBox (Maybe Double) -- | The top coordinate of the bounding box as a ratio of overall document -- page height. boundingBox_top :: Lens' BoundingBox (Maybe Double) -- | The width of the bounding box as a ratio of the overall document page -- width. boundingBox_width :: Lens' BoundingBox (Maybe Double) -- | Offset of the start of the child block within its parent block. childBlock_beginOffset :: Lens' ChildBlock (Maybe Int) -- | Unique identifier for the child block. childBlock_childBlockId :: Lens' ChildBlock (Maybe Text) -- | Offset of the end of the child block within its parent block. childBlock_endOffset :: Lens' ChildBlock (Maybe Int) -- | The fraction of the labels that were correct recognized. It is -- computed by dividing the number of labels in the test documents that -- were correctly recognized by the total number of labels in the test -- documents. classifierEvaluationMetrics_accuracy :: Lens' ClassifierEvaluationMetrics (Maybe Double) -- | A measure of how accurate the classifier results are for the test -- data. It is derived from the Precision and Recall -- values. The F1Score is the harmonic average of the two -- scores. The highest score is 1, and the worst score is 0. classifierEvaluationMetrics_f1Score :: Lens' ClassifierEvaluationMetrics (Maybe Double) -- | Indicates the fraction of labels that are incorrectly predicted. Also -- seen as the fraction of wrong labels compared to the total number of -- labels. Scores closer to zero are better. classifierEvaluationMetrics_hammingLoss :: Lens' ClassifierEvaluationMetrics (Maybe Double) -- | A measure of how accurate the classifier results are for the test -- data. It is a combination of the Micro Precision and -- Micro Recall values. The Micro F1Score is the -- harmonic mean of the two scores. The highest score is 1, and the worst -- score is 0. classifierEvaluationMetrics_microF1Score :: Lens' ClassifierEvaluationMetrics (Maybe Double) -- | A measure of the usefulness of the recognizer results in the test -- data. High precision means that the recognizer returned substantially -- more relevant results than irrelevant ones. Unlike the Precision -- metric which comes from averaging the precision of all available -- labels, this is based on the overall score of all precision scores -- added together. classifierEvaluationMetrics_microPrecision :: Lens' ClassifierEvaluationMetrics (Maybe Double) -- | A measure of how complete the classifier results are for the test -- data. High recall means that the classifier returned most of the -- relevant results. Specifically, this indicates how many of the correct -- categories in the text that the model can predict. It is a percentage -- of correct categories in the text that can found. Instead of averaging -- the recall scores of all labels (as with Recall), micro Recall is -- based on the overall score of all recall scores added together. classifierEvaluationMetrics_microRecall :: Lens' ClassifierEvaluationMetrics (Maybe Double) -- | A measure of the usefulness of the classifier results in the test -- data. High precision means that the classifier returned substantially -- more relevant results than irrelevant ones. classifierEvaluationMetrics_precision :: Lens' ClassifierEvaluationMetrics (Maybe Double) -- | A measure of how complete the classifier results are for the test -- data. High recall means that the classifier returned most of the -- relevant results. classifierEvaluationMetrics_recall :: Lens' ClassifierEvaluationMetrics (Maybe Double) -- | Describes the result metrics for the test data associated with an -- documentation classifier. classifierMetadata_evaluationMetrics :: Lens' ClassifierMetadata (Maybe ClassifierEvaluationMetrics) -- | The number of labels in the input data. classifierMetadata_numberOfLabels :: Lens' ClassifierMetadata (Maybe Int) -- | The number of documents in the input data that were used to test the -- classifier. Typically this is 10 to 20 percent of the input documents, -- up to 10,000 documents. classifierMetadata_numberOfTestDocuments :: Lens' ClassifierMetadata (Maybe Int) -- | The number of documents in the input data that were used to train the -- classifier. Typically this is 80 to 90 percent of the input documents. classifierMetadata_numberOfTrainedDocuments :: Lens' ClassifierMetadata (Maybe Int) -- | The name of the class. documentClass_name :: Lens' DocumentClass (Maybe Text) -- | Page number in the input document. This field is present in the -- response only if your request includes the Byte parameter. documentClass_page :: Lens' DocumentClass (Maybe Int) -- | The confidence score that Amazon Comprehend has this class correctly -- attributed. documentClass_score :: Lens' DocumentClass (Maybe Double) -- | Filters on the name of the job. documentClassificationJobFilter_jobName :: Lens' DocumentClassificationJobFilter (Maybe Text) -- | Filters the list based on job status. Returns only jobs with the -- specified status. documentClassificationJobFilter_jobStatus :: Lens' DocumentClassificationJobFilter (Maybe JobStatus) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. documentClassificationJobFilter_submitTimeAfter :: Lens' DocumentClassificationJobFilter (Maybe UTCTime) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. documentClassificationJobFilter_submitTimeBefore :: Lens' DocumentClassificationJobFilter (Maybe UTCTime) -- | The Amazon Resource Name (ARN) of the AWS identity and Access -- Management (IAM) role that grants Amazon Comprehend read access to -- your input data. documentClassificationJobProperties_dataAccessRoleArn :: Lens' DocumentClassificationJobProperties (Maybe Text) -- | The Amazon Resource Name (ARN) that identifies the document -- classifier. documentClassificationJobProperties_documentClassifierArn :: Lens' DocumentClassificationJobProperties (Maybe Text) -- | The time that the document classification job completed. documentClassificationJobProperties_endTime :: Lens' DocumentClassificationJobProperties (Maybe UTCTime) -- | The input data configuration that you supplied when you created the -- document classification job. documentClassificationJobProperties_inputDataConfig :: Lens' DocumentClassificationJobProperties (Maybe InputDataConfig) -- | The Amazon Resource Name (ARN) of the document classification job. It -- is a unique, fully qualified identifier for the job. It includes the -- AWS account, Region, and the job ID. The format of the ARN is as -- follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
--
documentClassificationJobProperties_jobArn :: Lens' DocumentClassificationJobProperties (Maybe Text) -- | The identifier assigned to the document classification job. documentClassificationJobProperties_jobId :: Lens' DocumentClassificationJobProperties (Maybe Text) -- | The name that you assigned to the document classification job. documentClassificationJobProperties_jobName :: Lens' DocumentClassificationJobProperties (Maybe Text) -- | The current status of the document classification job. If the status -- is FAILED, the Message field shows the reason for -- the failure. documentClassificationJobProperties_jobStatus :: Lens' DocumentClassificationJobProperties (Maybe JobStatus) -- | A description of the status of the job. documentClassificationJobProperties_message :: Lens' DocumentClassificationJobProperties (Maybe Text) -- | The output data configuration that you supplied when you created the -- document classification job. documentClassificationJobProperties_outputDataConfig :: Lens' DocumentClassificationJobProperties (Maybe OutputDataConfig) -- | The time that the document classification job was submitted for -- processing. documentClassificationJobProperties_submitTime :: Lens' DocumentClassificationJobProperties (Maybe UTCTime) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- documentClassificationJobProperties_volumeKmsKeyId :: Lens' DocumentClassificationJobProperties (Maybe Text) -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your document -- classification job. For more information, see Amazon VPC. documentClassificationJobProperties_vpcConfig :: Lens' DocumentClassificationJobProperties (Maybe VpcConfig) -- | The name that you assigned to the document classifier documentClassifierFilter_documentClassifierName :: Lens' DocumentClassifierFilter (Maybe Text) -- | Filters the list of classifiers based on status. documentClassifierFilter_status :: Lens' DocumentClassifierFilter (Maybe ModelStatus) -- | Filters the list of classifiers based on the time that the classifier -- was submitted for processing. Returns only classifiers submitted after -- the specified time. Classifiers are returned in descending order, -- newest to oldest. documentClassifierFilter_submitTimeAfter :: Lens' DocumentClassifierFilter (Maybe UTCTime) -- | Filters the list of classifiers based on the time that the classifier -- was submitted for processing. Returns only classifiers submitted -- before the specified time. Classifiers are returned in ascending -- order, oldest to newest. documentClassifierFilter_submitTimeBefore :: Lens' DocumentClassifierFilter (Maybe UTCTime) -- | A list of augmented manifest files that provide training data for your -- custom model. An augmented manifest file is a labeled dataset that is -- produced by Amazon SageMaker Ground Truth. -- -- This parameter is required if you set DataFormat to -- AUGMENTED_MANIFEST. documentClassifierInputDataConfig_augmentedManifests :: Lens' DocumentClassifierInputDataConfig (Maybe [AugmentedManifestsListItem]) -- | The format of your training data: -- -- -- -- If you don't specify a value, Amazon Comprehend uses -- COMPREHEND_CSV as the default. documentClassifierInputDataConfig_dataFormat :: Lens' DocumentClassifierInputDataConfig (Maybe DocumentClassifierDataFormat) -- | Indicates the delimiter used to separate each label for training a -- multi-label classifier. The default delimiter between labels is a pipe -- (|). You can use a different character as a delimiter (if it's an -- allowed character) by specifying it under Delimiter for labels. If the -- training documents use a delimiter other than the default or the -- delimiter you specify, the labels on that line will be combined to -- make a single unique label, such as LABELLABELLABEL. documentClassifierInputDataConfig_labelDelimiter :: Lens' DocumentClassifierInputDataConfig (Maybe Text) -- | The Amazon S3 URI for the input data. The S3 bucket must be in the -- same region as the API endpoint that you are calling. The URI can -- point to a single input file or it can provide the prefix for a -- collection of input files. -- -- For example, if you use the URI S3://bucketName/prefix, if -- the prefix is a single file, Amazon Comprehend uses that file as -- input. If more than one file begins with the prefix, Amazon Comprehend -- uses all of them as input. -- -- This parameter is required if you set DataFormat to -- COMPREHEND_CSV. documentClassifierInputDataConfig_s3Uri :: Lens' DocumentClassifierInputDataConfig (Maybe Text) -- | This specifies the Amazon S3 location where the test annotations for -- an entity recognizer are located. The URI must be in the same AWS -- Region as the API endpoint that you are calling. documentClassifierInputDataConfig_testS3Uri :: Lens' DocumentClassifierInputDataConfig (Maybe Text) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt the output results from an analysis job. The KmsKeyId -- can be one of the following formats: -- -- documentClassifierOutputDataConfig_kmsKeyId :: Lens' DocumentClassifierOutputDataConfig (Maybe Text) -- | When you use the OutputDataConfig object while creating a -- custom classifier, you specify the Amazon S3 location where you want -- to write the confusion matrix. The URI must be in the same region as -- the API endpoint that you are calling. The location is 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 directory specific to the job. The S3Uri -- field contains the location of the output file, called -- output.tar.gz. It is a compressed archive that contains the -- confusion matrix. documentClassifierOutputDataConfig_s3Uri :: Lens' DocumentClassifierOutputDataConfig (Maybe Text) -- | Information about the document classifier, including the number of -- documents used for training the classifier, the number of documents -- used for test the classifier, and an accuracy rating. documentClassifierProperties_classifierMetadata :: Lens' DocumentClassifierProperties (Maybe ClassifierMetadata) -- | The Amazon Resource Name (ARN) of the AWS Identity and Management -- (IAM) role that grants Amazon Comprehend read access to your input -- data. documentClassifierProperties_dataAccessRoleArn :: Lens' DocumentClassifierProperties (Maybe Text) -- | The Amazon Resource Name (ARN) that identifies the document -- classifier. documentClassifierProperties_documentClassifierArn :: Lens' DocumentClassifierProperties (Maybe Text) -- | The time that training the document classifier completed. documentClassifierProperties_endTime :: Lens' DocumentClassifierProperties (Maybe UTCTime) -- | The input data configuration that you supplied when you created the -- document classifier for training. documentClassifierProperties_inputDataConfig :: Lens' DocumentClassifierProperties (Maybe DocumentClassifierInputDataConfig) -- | The language code for the language of the documents that the -- classifier was trained on. documentClassifierProperties_languageCode :: Lens' DocumentClassifierProperties (Maybe LanguageCode) -- | Additional information about the status of the classifier. documentClassifierProperties_message :: Lens' DocumentClassifierProperties (Maybe Text) -- | Indicates the mode in which the specific classifier was trained. This -- also indicates the format of input documents and the format of the -- confusion matrix. Each classifier can only be trained in one mode and -- this cannot be changed once the classifier is trained. documentClassifierProperties_mode :: Lens' DocumentClassifierProperties (Maybe DocumentClassifierMode) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt trained custom models. The ModelKmsKeyId can be either -- of the following formats: -- -- documentClassifierProperties_modelKmsKeyId :: Lens' DocumentClassifierProperties (Maybe Text) -- | Provides output results configuration parameters for custom classifier -- jobs. documentClassifierProperties_outputDataConfig :: Lens' DocumentClassifierProperties (Maybe DocumentClassifierOutputDataConfig) -- | The Amazon Resource Name (ARN) of the source model. This model was -- imported from a different AWS account to create the document -- classifier model in your AWS account. documentClassifierProperties_sourceModelArn :: Lens' DocumentClassifierProperties (Maybe Text) -- | The status of the document classifier. If the status is -- TRAINED the classifier is ready to use. If the status is -- FAILED you can see additional information about why the -- classifier wasn't trained in the Message field. documentClassifierProperties_status :: Lens' DocumentClassifierProperties (Maybe ModelStatus) -- | The time that the document classifier was submitted for training. documentClassifierProperties_submitTime :: Lens' DocumentClassifierProperties (Maybe UTCTime) -- | The time that training of the document classifier was completed. -- Indicates the time when the training completes on documentation -- classifiers. You are billed for the time interval between this time -- and the value of TrainingStartTime. documentClassifierProperties_trainingEndTime :: Lens' DocumentClassifierProperties (Maybe UTCTime) -- | Indicates the time when the training starts on documentation -- classifiers. You are billed for the time interval between this time -- and the value of TrainingEndTime. documentClassifierProperties_trainingStartTime :: Lens' DocumentClassifierProperties (Maybe UTCTime) -- | The version name that you assigned to the document classifier. documentClassifierProperties_versionName :: Lens' DocumentClassifierProperties (Maybe Text) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- documentClassifierProperties_volumeKmsKeyId :: Lens' DocumentClassifierProperties (Maybe Text) -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your custom classifier. For -- more information, see Amazon VPC. documentClassifierProperties_vpcConfig :: Lens' DocumentClassifierProperties (Maybe VpcConfig) -- | The name that you assigned the document classifier. documentClassifierSummary_documentClassifierName :: Lens' DocumentClassifierSummary (Maybe Text) -- | The time that the latest document classifier version was submitted for -- processing. documentClassifierSummary_latestVersionCreatedAt :: Lens' DocumentClassifierSummary (Maybe UTCTime) -- | The version name you assigned to the latest document classifier -- version. documentClassifierSummary_latestVersionName :: Lens' DocumentClassifierSummary (Maybe Text) -- | Provides the status of the latest document classifier version. documentClassifierSummary_latestVersionStatus :: Lens' DocumentClassifierSummary (Maybe ModelStatus) -- | The number of versions you created. documentClassifierSummary_numberOfVersions :: Lens' DocumentClassifierSummary (Maybe Int) -- | The name of the label. documentLabel_name :: Lens' DocumentLabel (Maybe Text) -- | Page number where the label occurs. This field is present in the -- response only if your request includes the Byte parameter. documentLabel_page :: Lens' DocumentLabel (Maybe Int) -- | The confidence score that Amazon Comprehend has this label correctly -- attributed. documentLabel_score :: Lens' DocumentLabel (Maybe Double) -- | List of pages in the document, with the number of characters extracted -- from each page. documentMetadata_extractedCharacters :: Lens' DocumentMetadata (Maybe [ExtractedCharactersListItem]) -- | Number of pages in the document. documentMetadata_pages :: Lens' DocumentMetadata (Maybe Int) -- | Determines the text extraction actions for PDF files. Enter one of the -- following values: -- -- documentReaderConfig_documentReadMode :: Lens' DocumentReaderConfig (Maybe DocumentReadMode) -- | Specifies the type of Amazon Textract features to apply. If you chose -- TEXTRACT_ANALYZE_DOCUMENT as the read action, you must -- specify one or both of the following values: -- -- documentReaderConfig_featureTypes :: Lens' DocumentReaderConfig (Maybe (NonEmpty DocumentReadFeatureTypes)) -- | This field defines the Amazon Textract API operation that Amazon -- Comprehend uses to extract text from PDF files and image files. Enter -- one of the following values: -- -- documentReaderConfig_documentReadAction :: Lens' DocumentReaderConfig DocumentReadAction -- | Page number. documentTypeListItem_page :: Lens' DocumentTypeListItem (Maybe Int) -- | Document type. documentTypeListItem_type :: Lens' DocumentTypeListItem (Maybe DocumentType) -- | The RFC 5646 language code for the dominant language. For more -- information about RFC 5646, see Tags for Identifying Languages -- on the IETF Tools web site. dominantLanguage_languageCode :: Lens' DominantLanguage (Maybe Text) -- | The level of confidence that Amazon Comprehend has in the accuracy of -- the detection. dominantLanguage_score :: Lens' DominantLanguage (Maybe Double) -- | Filters on the name of the job. dominantLanguageDetectionJobFilter_jobName :: Lens' DominantLanguageDetectionJobFilter (Maybe Text) -- | Filters the list of jobs based on job status. Returns only jobs with -- the specified status. dominantLanguageDetectionJobFilter_jobStatus :: Lens' DominantLanguageDetectionJobFilter (Maybe JobStatus) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. dominantLanguageDetectionJobFilter_submitTimeAfter :: Lens' DominantLanguageDetectionJobFilter (Maybe UTCTime) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. dominantLanguageDetectionJobFilter_submitTimeBefore :: Lens' DominantLanguageDetectionJobFilter (Maybe UTCTime) -- | The Amazon Resource Name (ARN) that gives Amazon Comprehend read -- access to your input data. dominantLanguageDetectionJobProperties_dataAccessRoleArn :: Lens' DominantLanguageDetectionJobProperties (Maybe Text) -- | The time that the dominant language detection job completed. dominantLanguageDetectionJobProperties_endTime :: Lens' DominantLanguageDetectionJobProperties (Maybe UTCTime) -- | The input data configuration that you supplied when you created the -- dominant language detection job. dominantLanguageDetectionJobProperties_inputDataConfig :: Lens' DominantLanguageDetectionJobProperties (Maybe InputDataConfig) -- | The Amazon Resource Name (ARN) of the dominant language detection job. -- It is a unique, fully qualified identifier for the job. It includes -- the AWS account, Region, and the job ID. The format of the ARN is as -- follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
--
dominantLanguageDetectionJobProperties_jobArn :: Lens' DominantLanguageDetectionJobProperties (Maybe Text) -- | The identifier assigned to the dominant language detection job. dominantLanguageDetectionJobProperties_jobId :: Lens' DominantLanguageDetectionJobProperties (Maybe Text) -- | The name that you assigned to the dominant language detection job. dominantLanguageDetectionJobProperties_jobName :: Lens' DominantLanguageDetectionJobProperties (Maybe Text) -- | The current status of the dominant language detection job. If the -- status is FAILED, the Message field shows the reason -- for the failure. dominantLanguageDetectionJobProperties_jobStatus :: Lens' DominantLanguageDetectionJobProperties (Maybe JobStatus) -- | A description for the status of a job. dominantLanguageDetectionJobProperties_message :: Lens' DominantLanguageDetectionJobProperties (Maybe Text) -- | The output data configuration that you supplied when you created the -- dominant language detection job. dominantLanguageDetectionJobProperties_outputDataConfig :: Lens' DominantLanguageDetectionJobProperties (Maybe OutputDataConfig) -- | The time that the dominant language detection job was submitted for -- processing. dominantLanguageDetectionJobProperties_submitTime :: Lens' DominantLanguageDetectionJobProperties (Maybe UTCTime) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- dominantLanguageDetectionJobProperties_volumeKmsKeyId :: Lens' DominantLanguageDetectionJobProperties (Maybe Text) -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your dominant language -- detection job. For more information, see Amazon VPC. dominantLanguageDetectionJobProperties_vpcConfig :: Lens' DominantLanguageDetectionJobProperties (Maybe VpcConfig) -- | Specifies a date after which the returned endpoint or endpoints were -- created. endpointFilter_creationTimeAfter :: Lens' EndpointFilter (Maybe UTCTime) -- | Specifies a date before which the returned endpoint or endpoints were -- created. endpointFilter_creationTimeBefore :: Lens' EndpointFilter (Maybe UTCTime) -- | The Amazon Resource Number (ARN) of the model to which the endpoint is -- attached. endpointFilter_modelArn :: Lens' EndpointFilter (Maybe Text) -- | Specifies the status of the endpoint being returned. Possible values -- are: Creating, Ready, Updating, Deleting, Failed. endpointFilter_status :: Lens' EndpointFilter (Maybe EndpointStatus) -- | The creation date and time of the endpoint. endpointProperties_creationTime :: Lens' EndpointProperties (Maybe UTCTime) -- | The number of inference units currently used by the model using this -- endpoint. endpointProperties_currentInferenceUnits :: Lens' EndpointProperties (Maybe Natural) -- | The Amazon Resource Name (ARN) of the AWS identity and Access -- Management (IAM) role that grants Amazon Comprehend read access to -- trained custom models encrypted with a customer managed key -- (ModelKmsKeyId). endpointProperties_dataAccessRoleArn :: Lens' EndpointProperties (Maybe Text) -- | Data access role ARN to use in case the new model is encrypted with a -- customer KMS key. endpointProperties_desiredDataAccessRoleArn :: Lens' EndpointProperties (Maybe Text) -- | The desired number of inference units to be used by the model using -- this endpoint. Each inference unit represents of a throughput of 100 -- characters per second. endpointProperties_desiredInferenceUnits :: Lens' EndpointProperties (Maybe Natural) -- | ARN of the new model to use for updating an existing endpoint. This -- ARN is going to be different from the model ARN when the update is in -- progress endpointProperties_desiredModelArn :: Lens' EndpointProperties (Maybe Text) -- | The Amazon Resource Number (ARN) of the endpoint. endpointProperties_endpointArn :: Lens' EndpointProperties (Maybe Text) -- | The date and time that the endpoint was last modified. endpointProperties_lastModifiedTime :: Lens' EndpointProperties (Maybe UTCTime) -- | Specifies a reason for failure in cases of Failed status. endpointProperties_message :: Lens' EndpointProperties (Maybe Text) -- | The Amazon Resource Number (ARN) of the model to which the endpoint is -- attached. endpointProperties_modelArn :: Lens' EndpointProperties (Maybe Text) -- | Specifies the status of the endpoint. Because the endpoint updates and -- creation are asynchronous, so customers will need to wait for the -- endpoint to be Ready status before making inference requests. endpointProperties_status :: Lens' EndpointProperties (Maybe EndpointStatus) -- | Filters on the name of the job. entitiesDetectionJobFilter_jobName :: Lens' EntitiesDetectionJobFilter (Maybe Text) -- | Filters the list of jobs based on job status. Returns only jobs with -- the specified status. entitiesDetectionJobFilter_jobStatus :: Lens' EntitiesDetectionJobFilter (Maybe JobStatus) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. entitiesDetectionJobFilter_submitTimeAfter :: Lens' EntitiesDetectionJobFilter (Maybe UTCTime) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. entitiesDetectionJobFilter_submitTimeBefore :: Lens' EntitiesDetectionJobFilter (Maybe UTCTime) -- | The Amazon Resource Name (ARN) that gives Amazon Comprehend read -- access to your input data. entitiesDetectionJobProperties_dataAccessRoleArn :: Lens' EntitiesDetectionJobProperties (Maybe Text) -- | The time that the entities detection job completed entitiesDetectionJobProperties_endTime :: Lens' EntitiesDetectionJobProperties (Maybe UTCTime) -- | The Amazon Resource Name (ARN) that identifies the entity recognizer. entitiesDetectionJobProperties_entityRecognizerArn :: Lens' EntitiesDetectionJobProperties (Maybe Text) -- | The input data configuration that you supplied when you created the -- entities detection job. entitiesDetectionJobProperties_inputDataConfig :: Lens' EntitiesDetectionJobProperties (Maybe InputDataConfig) -- | The Amazon Resource Name (ARN) of the entities detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
--
entitiesDetectionJobProperties_jobArn :: Lens' EntitiesDetectionJobProperties (Maybe Text) -- | The identifier assigned to the entities detection job. entitiesDetectionJobProperties_jobId :: Lens' EntitiesDetectionJobProperties (Maybe Text) -- | The name that you assigned the entities detection job. entitiesDetectionJobProperties_jobName :: Lens' EntitiesDetectionJobProperties (Maybe Text) -- | The current status of the entities detection job. If the status is -- FAILED, the Message field shows the reason for the -- failure. entitiesDetectionJobProperties_jobStatus :: Lens' EntitiesDetectionJobProperties (Maybe JobStatus) -- | The language code of the input documents. entitiesDetectionJobProperties_languageCode :: Lens' EntitiesDetectionJobProperties (Maybe LanguageCode) -- | A description of the status of a job. entitiesDetectionJobProperties_message :: Lens' EntitiesDetectionJobProperties (Maybe Text) -- | The output data configuration that you supplied when you created the -- entities detection job. entitiesDetectionJobProperties_outputDataConfig :: Lens' EntitiesDetectionJobProperties (Maybe OutputDataConfig) -- | The time that the entities detection job was submitted for processing. entitiesDetectionJobProperties_submitTime :: Lens' EntitiesDetectionJobProperties (Maybe UTCTime) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- entitiesDetectionJobProperties_volumeKmsKeyId :: Lens' EntitiesDetectionJobProperties (Maybe Text) -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your entity detection job. -- For more information, see Amazon VPC. entitiesDetectionJobProperties_vpcConfig :: Lens' EntitiesDetectionJobProperties (Maybe VpcConfig) -- | The zero-based offset from the beginning of the source text to the -- first character in the entity. -- -- This field is empty for non-text input. entity_beginOffset :: Lens' Entity (Maybe Int) -- | A reference to each block for this entity. This field is empty for -- plain-text input. entity_blockReferences :: Lens' Entity (Maybe [BlockReference]) -- | The zero-based offset from the beginning of the source text to the -- last character in the entity. -- -- This field is empty for non-text input. entity_endOffset :: Lens' Entity (Maybe Int) -- | The level of confidence that Amazon Comprehend has in the accuracy of -- the detection. entity_score :: Lens' Entity (Maybe Double) -- | The text of the entity. entity_text :: Lens' Entity (Maybe Text) -- | The entity type. For entity detection using the built-in model, this -- field contains one of the standard entity types listed below. -- -- For custom entity detection, this field contains one of the entity -- types that you specified when you trained your custom model. entity_type :: Lens' Entity (Maybe EntityType) -- | The name of the label. entityLabel_name :: Lens' EntityLabel (Maybe PiiEntityType) -- | The level of confidence that Amazon Comprehend has in the accuracy of -- the detection. entityLabel_score :: Lens' EntityLabel (Maybe Double) -- | Specifies the Amazon S3 location where the test annotations for an -- entity recognizer are located. The URI must be in the same region as -- the API endpoint that you are calling. entityRecognizerAnnotations_testS3Uri :: Lens' EntityRecognizerAnnotations (Maybe Text) -- | Specifies the Amazon S3 location where the annotations for an entity -- recognizer are located. The URI must be in the same region as the API -- endpoint that you are calling. entityRecognizerAnnotations_s3Uri :: Lens' EntityRecognizerAnnotations Text -- | Specifies how the text in an input file should be processed. This is -- optional, and the default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each -- file is considered a separate document. Use this option when you are -- processing large documents, such as newspaper articles or scientific -- papers. ONE_DOC_PER_LINE - Each line in a file is considered a -- separate document. Use this option when you are processing many short -- documents, such as text messages. entityRecognizerDocuments_inputFormat :: Lens' EntityRecognizerDocuments (Maybe InputFormat) -- | Specifies the Amazon S3 location where the test documents for an -- entity recognizer are located. The URI must be in the same AWS Region -- as the API endpoint that you are calling. entityRecognizerDocuments_testS3Uri :: Lens' EntityRecognizerDocuments (Maybe Text) -- | Specifies the Amazon S3 location where the training documents for an -- entity recognizer are located. The URI must be in the same region as -- the API endpoint that you are calling. entityRecognizerDocuments_s3Uri :: Lens' EntityRecognizerDocuments Text -- | Specifies the Amazon S3 location where the entity list is located. The -- URI must be in the same region as the API endpoint that you are -- calling. entityRecognizerEntityList_s3Uri :: Lens' EntityRecognizerEntityList Text -- | A measure of how accurate the recognizer results are for the test -- data. It is derived from the Precision and Recall -- values. The F1Score is the harmonic average of the two -- scores. For plain text entity recognizer models, the range is 0 to -- 100, where 100 is the best score. For PDF/Word entity recognizer -- models, the range is 0 to 1, where 1 is the best score. entityRecognizerEvaluationMetrics_f1Score :: Lens' EntityRecognizerEvaluationMetrics (Maybe Double) -- | A measure of the usefulness of the recognizer results in the test -- data. High precision means that the recognizer returned substantially -- more relevant results than irrelevant ones. entityRecognizerEvaluationMetrics_precision :: Lens' EntityRecognizerEvaluationMetrics (Maybe Double) -- | A measure of how complete the recognizer results are for the test -- data. High recall means that the recognizer returned most of the -- relevant results. entityRecognizerEvaluationMetrics_recall :: Lens' EntityRecognizerEvaluationMetrics (Maybe Double) -- | The name that you assigned the entity recognizer. entityRecognizerFilter_recognizerName :: Lens' EntityRecognizerFilter (Maybe Text) -- | The status of an entity recognizer. entityRecognizerFilter_status :: Lens' EntityRecognizerFilter (Maybe ModelStatus) -- | Filters the list of entities based on the time that the list was -- submitted for processing. Returns only jobs submitted after the -- specified time. Jobs are returned in ascending order, oldest to -- newest. entityRecognizerFilter_submitTimeAfter :: Lens' EntityRecognizerFilter (Maybe UTCTime) -- | Filters the list of entities based on the time that the list was -- submitted for processing. Returns only jobs submitted before the -- specified time. Jobs are returned in descending order, newest to -- oldest. entityRecognizerFilter_submitTimeBefore :: Lens' EntityRecognizerFilter (Maybe UTCTime) -- | The S3 location of the CSV file that annotates your training -- documents. entityRecognizerInputDataConfig_annotations :: Lens' EntityRecognizerInputDataConfig (Maybe EntityRecognizerAnnotations) -- | A list of augmented manifest files that provide training data for your -- custom model. An augmented manifest file is a labeled dataset that is -- produced by Amazon SageMaker Ground Truth. -- -- This parameter is required if you set DataFormat to -- AUGMENTED_MANIFEST. entityRecognizerInputDataConfig_augmentedManifests :: Lens' EntityRecognizerInputDataConfig (Maybe [AugmentedManifestsListItem]) -- | The format of your training data: -- -- -- -- If you don't specify a value, Amazon Comprehend uses -- COMPREHEND_CSV as the default. entityRecognizerInputDataConfig_dataFormat :: Lens' EntityRecognizerInputDataConfig (Maybe EntityRecognizerDataFormat) -- | The S3 location of the folder that contains the training documents for -- your custom entity recognizer. -- -- This parameter is required if you set DataFormat to -- COMPREHEND_CSV. entityRecognizerInputDataConfig_documents :: Lens' EntityRecognizerInputDataConfig (Maybe EntityRecognizerDocuments) -- | The S3 location of the CSV file that has the entity list for your -- custom entity recognizer. entityRecognizerInputDataConfig_entityList :: Lens' EntityRecognizerInputDataConfig (Maybe EntityRecognizerEntityList) -- | The entity types in the labeled training data that Amazon Comprehend -- uses to train the custom entity recognizer. Any entity types that you -- don't specify are ignored. -- -- A maximum of 25 entity types can be used at one time to train an -- entity recognizer. Entity types must not contain the following invalid -- characters: \n (line break), \\n (escaped line break), \r (carriage -- return), \\r (escaped carriage return), \t (tab), \\t (escaped tab), -- space, and , (comma). entityRecognizerInputDataConfig_entityTypes :: Lens' EntityRecognizerInputDataConfig [EntityTypesListItem] -- | Entity types from the metadata of an entity recognizer. entityRecognizerMetadata_entityTypes :: Lens' EntityRecognizerMetadata (Maybe [EntityRecognizerMetadataEntityTypesListItem]) -- | Detailed information about the accuracy of an entity recognizer. entityRecognizerMetadata_evaluationMetrics :: Lens' EntityRecognizerMetadata (Maybe EntityRecognizerEvaluationMetrics) -- | The number of documents in the input data that were used to test the -- entity recognizer. Typically this is 10 to 20 percent of the input -- documents. entityRecognizerMetadata_numberOfTestDocuments :: Lens' EntityRecognizerMetadata (Maybe Int) -- | The number of documents in the input data that were used to train the -- entity recognizer. Typically this is 80 to 90 percent of the input -- documents. entityRecognizerMetadata_numberOfTrainedDocuments :: Lens' EntityRecognizerMetadata (Maybe Int) -- | Detailed information about the accuracy of the entity recognizer for a -- specific item on the list of entity types. entityRecognizerMetadataEntityTypesListItem_evaluationMetrics :: Lens' EntityRecognizerMetadataEntityTypesListItem (Maybe EntityTypesEvaluationMetrics) -- | Indicates the number of times the given entity type was seen in the -- training data. entityRecognizerMetadataEntityTypesListItem_numberOfTrainMentions :: Lens' EntityRecognizerMetadataEntityTypesListItem (Maybe Int) -- | Type of entity from the list of entity types in the metadata of an -- entity recognizer. entityRecognizerMetadataEntityTypesListItem_type :: Lens' EntityRecognizerMetadataEntityTypesListItem (Maybe Text) -- | The Amazon Resource Name (ARN) of the AWS Identity and Management -- (IAM) role that grants Amazon Comprehend read access to your input -- data. entityRecognizerProperties_dataAccessRoleArn :: Lens' EntityRecognizerProperties (Maybe Text) -- | The time that the recognizer creation completed. entityRecognizerProperties_endTime :: Lens' EntityRecognizerProperties (Maybe UTCTime) -- | The Amazon Resource Name (ARN) that identifies the entity recognizer. entityRecognizerProperties_entityRecognizerArn :: Lens' EntityRecognizerProperties (Maybe Text) -- | The input data properties of an entity recognizer. entityRecognizerProperties_inputDataConfig :: Lens' EntityRecognizerProperties (Maybe EntityRecognizerInputDataConfig) -- | The language of the input documents. All documents must be in the same -- language. Only English ("en") is currently supported. entityRecognizerProperties_languageCode :: Lens' EntityRecognizerProperties (Maybe LanguageCode) -- | A description of the status of the recognizer. entityRecognizerProperties_message :: Lens' EntityRecognizerProperties (Maybe Text) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt trained custom models. The ModelKmsKeyId can be either -- of the following formats: -- -- entityRecognizerProperties_modelKmsKeyId :: Lens' EntityRecognizerProperties (Maybe Text) -- | Provides information about an entity recognizer. entityRecognizerProperties_recognizerMetadata :: Lens' EntityRecognizerProperties (Maybe EntityRecognizerMetadata) -- | The Amazon Resource Name (ARN) of the source model. This model was -- imported from a different AWS account to create the entity recognizer -- model in your AWS account. entityRecognizerProperties_sourceModelArn :: Lens' EntityRecognizerProperties (Maybe Text) -- | Provides the status of the entity recognizer. entityRecognizerProperties_status :: Lens' EntityRecognizerProperties (Maybe ModelStatus) -- | The time that the recognizer was submitted for processing. entityRecognizerProperties_submitTime :: Lens' EntityRecognizerProperties (Maybe UTCTime) -- | The time that training of the entity recognizer was completed. entityRecognizerProperties_trainingEndTime :: Lens' EntityRecognizerProperties (Maybe UTCTime) -- | The time that training of the entity recognizer started. entityRecognizerProperties_trainingStartTime :: Lens' EntityRecognizerProperties (Maybe UTCTime) -- | The version name you assigned to the entity recognizer. entityRecognizerProperties_versionName :: Lens' EntityRecognizerProperties (Maybe Text) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- entityRecognizerProperties_volumeKmsKeyId :: Lens' EntityRecognizerProperties (Maybe Text) -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your custom entity -- recognizer. For more information, see Amazon VPC. entityRecognizerProperties_vpcConfig :: Lens' EntityRecognizerProperties (Maybe VpcConfig) -- | The time that the latest entity recognizer version was submitted for -- processing. entityRecognizerSummary_latestVersionCreatedAt :: Lens' EntityRecognizerSummary (Maybe UTCTime) -- | The version name you assigned to the latest entity recognizer version. entityRecognizerSummary_latestVersionName :: Lens' EntityRecognizerSummary (Maybe Text) -- | Provides the status of the latest entity recognizer version. entityRecognizerSummary_latestVersionStatus :: Lens' EntityRecognizerSummary (Maybe ModelStatus) -- | The number of versions you created. entityRecognizerSummary_numberOfVersions :: Lens' EntityRecognizerSummary (Maybe Int) -- | The name that you assigned the entity recognizer. entityRecognizerSummary_recognizerName :: Lens' EntityRecognizerSummary (Maybe Text) -- | A measure of how accurate the recognizer results are for a specific -- entity type in the test data. It is derived from the -- Precision and Recall values. The F1Score is -- the harmonic average of the two scores. The highest score is 1, and -- the worst score is 0. entityTypesEvaluationMetrics_f1Score :: Lens' EntityTypesEvaluationMetrics (Maybe Double) -- | A measure of the usefulness of the recognizer results for a specific -- entity type in the test data. High precision means that the recognizer -- returned substantially more relevant results than irrelevant ones. entityTypesEvaluationMetrics_precision :: Lens' EntityTypesEvaluationMetrics (Maybe Double) -- | A measure of how complete the recognizer results are for a specific -- entity type in the test data. High recall means that the recognizer -- returned most of the relevant results. entityTypesEvaluationMetrics_recall :: Lens' EntityTypesEvaluationMetrics (Maybe Double) -- | An entity type within a labeled training dataset that Amazon -- Comprehend uses to train a custom entity recognizer. -- -- Entity types must not contain the following invalid characters: \n -- (line break), \\n (escaped line break, \r (carriage return), \\r -- (escaped carriage return), \t (tab), \\t (escaped tab), space, and , -- (comma). entityTypesListItem_type :: Lens' EntityTypesListItem Text -- | Error code for the cause of the error. errorsListItem_errorCode :: Lens' ErrorsListItem (Maybe PageBasedErrorCode) -- | Text message explaining the reason for the error. errorsListItem_errorMessage :: Lens' ErrorsListItem (Maybe Text) -- | Page number where the error occurred. errorsListItem_page :: Lens' ErrorsListItem (Maybe Int) -- | Filters on the name of the events detection job. eventsDetectionJobFilter_jobName :: Lens' EventsDetectionJobFilter (Maybe Text) -- | Filters the list of jobs based on job status. Returns only jobs with -- the specified status. eventsDetectionJobFilter_jobStatus :: Lens' EventsDetectionJobFilter (Maybe JobStatus) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. eventsDetectionJobFilter_submitTimeAfter :: Lens' EventsDetectionJobFilter (Maybe UTCTime) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. eventsDetectionJobFilter_submitTimeBefore :: Lens' EventsDetectionJobFilter (Maybe UTCTime) -- | The Amazon Resource Name (ARN) of the AWS Identify and Access -- Management (IAM) role that grants Amazon Comprehend read access to -- your input data. eventsDetectionJobProperties_dataAccessRoleArn :: Lens' EventsDetectionJobProperties (Maybe Text) -- | The time that the events detection job completed. eventsDetectionJobProperties_endTime :: Lens' EventsDetectionJobProperties (Maybe UTCTime) -- | The input data configuration that you supplied when you created the -- events detection job. eventsDetectionJobProperties_inputDataConfig :: Lens' EventsDetectionJobProperties (Maybe InputDataConfig) -- | The Amazon Resource Name (ARN) of the events detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
--
eventsDetectionJobProperties_jobArn :: Lens' EventsDetectionJobProperties (Maybe Text) -- | The identifier assigned to the events detection job. eventsDetectionJobProperties_jobId :: Lens' EventsDetectionJobProperties (Maybe Text) -- | The name you assigned the events detection job. eventsDetectionJobProperties_jobName :: Lens' EventsDetectionJobProperties (Maybe Text) -- | The current status of the events detection job. eventsDetectionJobProperties_jobStatus :: Lens' EventsDetectionJobProperties (Maybe JobStatus) -- | The language code of the input documents. eventsDetectionJobProperties_languageCode :: Lens' EventsDetectionJobProperties (Maybe LanguageCode) -- | A description of the status of the events detection job. eventsDetectionJobProperties_message :: Lens' EventsDetectionJobProperties (Maybe Text) -- | The output data configuration that you supplied when you created the -- events detection job. eventsDetectionJobProperties_outputDataConfig :: Lens' EventsDetectionJobProperties (Maybe OutputDataConfig) -- | The time that the events detection job was submitted for processing. eventsDetectionJobProperties_submitTime :: Lens' EventsDetectionJobProperties (Maybe UTCTime) -- | The types of events that are detected by the job. eventsDetectionJobProperties_targetEventTypes :: Lens' EventsDetectionJobProperties (Maybe (NonEmpty Text)) -- | Number of characters extracted from each page. extractedCharactersListItem_count :: Lens' ExtractedCharactersListItem (Maybe Int) -- | Page number. extractedCharactersListItem_page :: Lens' ExtractedCharactersListItem (Maybe Int) -- | An axis-aligned coarse representation of the location of the -- recognized item on the document page. geometry_boundingBox :: Lens' Geometry (Maybe BoundingBox) -- | Within the bounding box, a fine-grained polygon around the recognized -- item. geometry_polygon :: Lens' Geometry (Maybe [Point]) -- | Provides configuration parameters to override the default actions for -- extracting text from PDF documents and image files. inputDataConfig_documentReaderConfig :: Lens' InputDataConfig (Maybe DocumentReaderConfig) -- | Specifies how the text in an input file should be processed: -- -- inputDataConfig_inputFormat :: Lens' InputDataConfig (Maybe InputFormat) -- | The Amazon S3 URI for the input data. The URI must be in same region -- as the API endpoint that you are calling. The URI can point to a -- single input file or it can provide the prefix for a collection of -- data files. -- -- For example, if you use the URI S3://bucketName/prefix, if -- the prefix is a single file, Amazon Comprehend uses that file as -- input. If more than one file begins with the prefix, Amazon Comprehend -- uses all of them as input. inputDataConfig_s3Uri :: Lens' InputDataConfig Text -- | The zero-based offset from the beginning of the source text to the -- first character in the key phrase. keyPhrase_beginOffset :: Lens' KeyPhrase (Maybe Int) -- | The zero-based offset from the beginning of the source text to the -- last character in the key phrase. keyPhrase_endOffset :: Lens' KeyPhrase (Maybe Int) -- | The level of confidence that Amazon Comprehend has in the accuracy of -- the detection. keyPhrase_score :: Lens' KeyPhrase (Maybe Double) -- | The text of a key noun phrase. keyPhrase_text :: Lens' KeyPhrase (Maybe Text) -- | Filters on the name of the job. keyPhrasesDetectionJobFilter_jobName :: Lens' KeyPhrasesDetectionJobFilter (Maybe Text) -- | Filters the list of jobs based on job status. Returns only jobs with -- the specified status. keyPhrasesDetectionJobFilter_jobStatus :: Lens' KeyPhrasesDetectionJobFilter (Maybe JobStatus) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. keyPhrasesDetectionJobFilter_submitTimeAfter :: Lens' KeyPhrasesDetectionJobFilter (Maybe UTCTime) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. keyPhrasesDetectionJobFilter_submitTimeBefore :: Lens' KeyPhrasesDetectionJobFilter (Maybe UTCTime) -- | The Amazon Resource Name (ARN) that gives Amazon Comprehend read -- access to your input data. keyPhrasesDetectionJobProperties_dataAccessRoleArn :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text) -- | The time that the key phrases detection job completed. keyPhrasesDetectionJobProperties_endTime :: Lens' KeyPhrasesDetectionJobProperties (Maybe UTCTime) -- | The input data configuration that you supplied when you created the -- key phrases detection job. keyPhrasesDetectionJobProperties_inputDataConfig :: Lens' KeyPhrasesDetectionJobProperties (Maybe InputDataConfig) -- | The Amazon Resource Name (ARN) of the key phrases detection job. It is -- a unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
--
keyPhrasesDetectionJobProperties_jobArn :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text) -- | The identifier assigned to the key phrases detection job. keyPhrasesDetectionJobProperties_jobId :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text) -- | The name that you assigned the key phrases detection job. keyPhrasesDetectionJobProperties_jobName :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text) -- | The current status of the key phrases detection job. If the status is -- FAILED, the Message field shows the reason for the -- failure. keyPhrasesDetectionJobProperties_jobStatus :: Lens' KeyPhrasesDetectionJobProperties (Maybe JobStatus) -- | The language code of the input documents. keyPhrasesDetectionJobProperties_languageCode :: Lens' KeyPhrasesDetectionJobProperties (Maybe LanguageCode) -- | A description of the status of a job. keyPhrasesDetectionJobProperties_message :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text) -- | The output data configuration that you supplied when you created the -- key phrases detection job. keyPhrasesDetectionJobProperties_outputDataConfig :: Lens' KeyPhrasesDetectionJobProperties (Maybe OutputDataConfig) -- | The time that the key phrases detection job was submitted for -- processing. keyPhrasesDetectionJobProperties_submitTime :: Lens' KeyPhrasesDetectionJobProperties (Maybe UTCTime) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- keyPhrasesDetectionJobProperties_volumeKmsKeyId :: Lens' KeyPhrasesDetectionJobProperties (Maybe Text) -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your key phrases detection -- job. For more information, see Amazon VPC. keyPhrasesDetectionJobProperties_vpcConfig :: Lens' KeyPhrasesDetectionJobProperties (Maybe VpcConfig) -- | The sentiment of the mention. mentionSentiment_sentiment :: Lens' MentionSentiment (Maybe SentimentType) -- | Undocumented member. mentionSentiment_sentimentScore :: Lens' MentionSentiment (Maybe SentimentScore) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt the output results from an analysis job. The KmsKeyId -- can be one of the following formats: -- -- outputDataConfig_kmsKeyId :: Lens' OutputDataConfig (Maybe Text) -- | When you use the OutputDataConfig object with asynchronous -- operations, you specify the Amazon S3 location where you want to write -- the output data. The URI must be in the same region as the API -- endpoint that you are calling. The location is used as the prefix for -- the actual location of the output file. -- -- When the topic detection job is finished, the service creates an -- output file in a directory specific to the job. The S3Uri -- field contains the location of the output file, called -- output.tar.gz. It is a compressed archive that contains the -- ouput of the operation. -- -- For a PII entity detection job, the output file is plain text, not a -- compressed archive. The output file name is the same as the input -- file, with .out appended at the end. outputDataConfig_s3Uri :: Lens' OutputDataConfig Text -- | The confidence that Amazon Comprehend has that the part of speech was -- correctly identified. partOfSpeechTag_score :: Lens' PartOfSpeechTag (Maybe Double) -- | Identifies the part of speech that the token represents. partOfSpeechTag_tag :: Lens' PartOfSpeechTag (Maybe PartOfSpeechTagType) -- | Filters on the name of the job. piiEntitiesDetectionJobFilter_jobName :: Lens' PiiEntitiesDetectionJobFilter (Maybe Text) -- | Filters the list of jobs based on job status. Returns only jobs with -- the specified status. piiEntitiesDetectionJobFilter_jobStatus :: Lens' PiiEntitiesDetectionJobFilter (Maybe JobStatus) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. piiEntitiesDetectionJobFilter_submitTimeAfter :: Lens' PiiEntitiesDetectionJobFilter (Maybe UTCTime) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. piiEntitiesDetectionJobFilter_submitTimeBefore :: Lens' PiiEntitiesDetectionJobFilter (Maybe UTCTime) -- | The Amazon Resource Name (ARN) that gives Amazon Comprehend read -- access to your input data. piiEntitiesDetectionJobProperties_dataAccessRoleArn :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text) -- | The time that the PII entities detection job completed. piiEntitiesDetectionJobProperties_endTime :: Lens' PiiEntitiesDetectionJobProperties (Maybe UTCTime) -- | The input properties for a PII entities detection job. piiEntitiesDetectionJobProperties_inputDataConfig :: Lens' PiiEntitiesDetectionJobProperties (Maybe InputDataConfig) -- | The Amazon Resource Name (ARN) of the PII entities detection job. It -- is a unique, fully qualified identifier for the job. It includes the -- AWS account, Region, and the job ID. The format of the ARN is as -- follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
--
piiEntitiesDetectionJobProperties_jobArn :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text) -- | The identifier assigned to the PII entities detection job. piiEntitiesDetectionJobProperties_jobId :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text) -- | The name that you assigned the PII entities detection job. piiEntitiesDetectionJobProperties_jobName :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text) -- | The current status of the PII entities detection job. If the status is -- FAILED, the Message field shows the reason for the -- failure. piiEntitiesDetectionJobProperties_jobStatus :: Lens' PiiEntitiesDetectionJobProperties (Maybe JobStatus) -- | The language code of the input documents piiEntitiesDetectionJobProperties_languageCode :: Lens' PiiEntitiesDetectionJobProperties (Maybe LanguageCode) -- | A description of the status of a job. piiEntitiesDetectionJobProperties_message :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text) -- | Specifies whether the output provides the locations (offsets) of PII -- entities or a file in which PII entities are redacted. piiEntitiesDetectionJobProperties_mode :: Lens' PiiEntitiesDetectionJobProperties (Maybe PiiEntitiesDetectionMode) -- | The output data configuration that you supplied when you created the -- PII entities detection job. piiEntitiesDetectionJobProperties_outputDataConfig :: Lens' PiiEntitiesDetectionJobProperties (Maybe PiiOutputDataConfig) -- | Provides configuration parameters for PII entity redaction. -- -- This parameter is required if you set the Mode parameter to -- ONLY_REDACTION. In that case, you must provide a -- RedactionConfig definition that includes the -- PiiEntityTypes parameter. piiEntitiesDetectionJobProperties_redactionConfig :: Lens' PiiEntitiesDetectionJobProperties (Maybe RedactionConfig) -- | The time that the PII entities detection job was submitted for -- processing. piiEntitiesDetectionJobProperties_submitTime :: Lens' PiiEntitiesDetectionJobProperties (Maybe UTCTime) -- | The zero-based offset from the beginning of the source text to the -- first character in the entity. piiEntity_beginOffset :: Lens' PiiEntity (Maybe Int) -- | The zero-based offset from the beginning of the source text to the -- last character in the entity. piiEntity_endOffset :: Lens' PiiEntity (Maybe Int) -- | The level of confidence that Amazon Comprehend has in the accuracy of -- the detection. piiEntity_score :: Lens' PiiEntity (Maybe Double) -- | The entity's type. piiEntity_type :: Lens' PiiEntity (Maybe PiiEntityType) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt the output results from an analysis job. piiOutputDataConfig_kmsKeyId :: Lens' PiiOutputDataConfig (Maybe Text) -- | When you use the PiiOutputDataConfig object with asynchronous -- operations, you specify the Amazon S3 location where you want to write -- the output data. -- -- For a PII entity detection job, the output file is plain text, not a -- compressed archive. The output file name is the same as the input -- file, with .out appended at the end. piiOutputDataConfig_s3Uri :: Lens' PiiOutputDataConfig Text -- | The value of the X coordinate for a point on a polygon point_x :: Lens' Point (Maybe Double) -- | The value of the Y coordinate for a point on a polygon point_y :: Lens' Point (Maybe Double) -- | A character that replaces each character in the redacted PII entity. redactionConfig_maskCharacter :: Lens' RedactionConfig (Maybe Text) -- | Specifies whether the PII entity is redacted with the mask character -- or the entity type. redactionConfig_maskMode :: Lens' RedactionConfig (Maybe PiiEntitiesDetectionMaskMode) -- | An array of the types of PII entities that Amazon Comprehend detects -- in the input text for your request. redactionConfig_piiEntityTypes :: Lens' RedactionConfig (Maybe [PiiEntityType]) -- | Identifers of the child blocks. relationshipsListItem_ids :: Lens' RelationshipsListItem (Maybe [Text]) -- | Only supported relationship is a child relationship. relationshipsListItem_type :: Lens' RelationshipsListItem (Maybe RelationshipType) -- | Filters on the name of the job. sentimentDetectionJobFilter_jobName :: Lens' SentimentDetectionJobFilter (Maybe Text) -- | Filters the list of jobs based on job status. Returns only jobs with -- the specified status. sentimentDetectionJobFilter_jobStatus :: Lens' SentimentDetectionJobFilter (Maybe JobStatus) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. sentimentDetectionJobFilter_submitTimeAfter :: Lens' SentimentDetectionJobFilter (Maybe UTCTime) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. sentimentDetectionJobFilter_submitTimeBefore :: Lens' SentimentDetectionJobFilter (Maybe UTCTime) -- | The Amazon Resource Name (ARN) that gives Amazon Comprehend read -- access to your input data. sentimentDetectionJobProperties_dataAccessRoleArn :: Lens' SentimentDetectionJobProperties (Maybe Text) -- | The time that the sentiment detection job ended. sentimentDetectionJobProperties_endTime :: Lens' SentimentDetectionJobProperties (Maybe UTCTime) -- | The input data configuration that you supplied when you created the -- sentiment detection job. sentimentDetectionJobProperties_inputDataConfig :: Lens' SentimentDetectionJobProperties (Maybe InputDataConfig) -- | The Amazon Resource Name (ARN) of the sentiment detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
--
sentimentDetectionJobProperties_jobArn :: Lens' SentimentDetectionJobProperties (Maybe Text) -- | The identifier assigned to the sentiment detection job. sentimentDetectionJobProperties_jobId :: Lens' SentimentDetectionJobProperties (Maybe Text) -- | The name that you assigned to the sentiment detection job sentimentDetectionJobProperties_jobName :: Lens' SentimentDetectionJobProperties (Maybe Text) -- | The current status of the sentiment detection job. If the status is -- FAILED, the Messages field shows the reason for the -- failure. sentimentDetectionJobProperties_jobStatus :: Lens' SentimentDetectionJobProperties (Maybe JobStatus) -- | The language code of the input documents. sentimentDetectionJobProperties_languageCode :: Lens' SentimentDetectionJobProperties (Maybe LanguageCode) -- | A description of the status of a job. sentimentDetectionJobProperties_message :: Lens' SentimentDetectionJobProperties (Maybe Text) -- | The output data configuration that you supplied when you created the -- sentiment detection job. sentimentDetectionJobProperties_outputDataConfig :: Lens' SentimentDetectionJobProperties (Maybe OutputDataConfig) -- | The time that the sentiment detection job was submitted for -- processing. sentimentDetectionJobProperties_submitTime :: Lens' SentimentDetectionJobProperties (Maybe UTCTime) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- sentimentDetectionJobProperties_volumeKmsKeyId :: Lens' SentimentDetectionJobProperties (Maybe Text) -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your sentiment detection -- job. For more information, see Amazon VPC. sentimentDetectionJobProperties_vpcConfig :: Lens' SentimentDetectionJobProperties (Maybe VpcConfig) -- | The level of confidence that Amazon Comprehend has in the accuracy of -- its detection of the MIXED sentiment. sentimentScore_mixed :: Lens' SentimentScore (Maybe Double) -- | The level of confidence that Amazon Comprehend has in the accuracy of -- its detection of the NEGATIVE sentiment. sentimentScore_negative :: Lens' SentimentScore (Maybe Double) -- | The level of confidence that Amazon Comprehend has in the accuracy of -- its detection of the NEUTRAL sentiment. sentimentScore_neutral :: Lens' SentimentScore (Maybe Double) -- | The level of confidence that Amazon Comprehend has in the accuracy of -- its detection of the POSITIVE sentiment. sentimentScore_positive :: Lens' SentimentScore (Maybe Double) -- | The zero-based offset from the beginning of the source text to the -- first character in the word. syntaxToken_beginOffset :: Lens' SyntaxToken (Maybe Int) -- | The zero-based offset from the beginning of the source text to the -- last character in the word. syntaxToken_endOffset :: Lens' SyntaxToken (Maybe Int) -- | Provides the part of speech label and the confidence level that Amazon -- Comprehend has that the part of speech was correctly identified. For -- more information, see Syntax in the Comprehend Developer Guide. syntaxToken_partOfSpeech :: Lens' SyntaxToken (Maybe PartOfSpeechTag) -- | The word that was recognized in the source text. syntaxToken_text :: Lens' SyntaxToken (Maybe Text) -- | A unique identifier for a token. syntaxToken_tokenId :: Lens' SyntaxToken (Maybe Int) -- | The second part of a key-value pair that forms a tag associated with a -- given resource. For instance, if you want to show which resources are -- used by which departments, you might use “Department” as the initial -- (key) portion of the pair, with a value of “sales” to indicate the -- sales department. tag_value :: Lens' Tag (Maybe Text) -- | The initial part of a key-value pair that forms a tag associated with -- a given resource. For instance, if you want to show which resources -- are used by which departments, you might use “Department” as the key -- portion of the pair, with multiple possible values such as “sales,” -- “legal,” and “administration.” tag_key :: Lens' Tag Text -- | Filters on the name of the job. targetedSentimentDetectionJobFilter_jobName :: Lens' TargetedSentimentDetectionJobFilter (Maybe Text) -- | Filters the list of jobs based on job status. Returns only jobs with -- the specified status. targetedSentimentDetectionJobFilter_jobStatus :: Lens' TargetedSentimentDetectionJobFilter (Maybe JobStatus) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted after the specified time. -- Jobs are returned in descending order, newest to oldest. targetedSentimentDetectionJobFilter_submitTimeAfter :: Lens' TargetedSentimentDetectionJobFilter (Maybe UTCTime) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. targetedSentimentDetectionJobFilter_submitTimeBefore :: Lens' TargetedSentimentDetectionJobFilter (Maybe UTCTime) -- | The Amazon Resource Name (ARN) that gives Amazon Comprehend read -- access to your input data. targetedSentimentDetectionJobProperties_dataAccessRoleArn :: Lens' TargetedSentimentDetectionJobProperties (Maybe Text) -- | The time that the targeted sentiment detection job ended. targetedSentimentDetectionJobProperties_endTime :: Lens' TargetedSentimentDetectionJobProperties (Maybe UTCTime) -- | Undocumented member. targetedSentimentDetectionJobProperties_inputDataConfig :: Lens' TargetedSentimentDetectionJobProperties (Maybe InputDataConfig) -- | The Amazon Resource Name (ARN) of the targeted sentiment detection -- job. It is a unique, fully qualified identifier for the job. It -- includes the AWS account, Region, and the job ID. The format of the -- ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
--
targetedSentimentDetectionJobProperties_jobArn :: Lens' TargetedSentimentDetectionJobProperties (Maybe Text) -- | The identifier assigned to the targeted sentiment detection job. targetedSentimentDetectionJobProperties_jobId :: Lens' TargetedSentimentDetectionJobProperties (Maybe Text) -- | The name that you assigned to the targeted sentiment detection job. targetedSentimentDetectionJobProperties_jobName :: Lens' TargetedSentimentDetectionJobProperties (Maybe Text) -- | The current status of the targeted sentiment detection job. If the -- status is FAILED, the Messages field shows the -- reason for the failure. targetedSentimentDetectionJobProperties_jobStatus :: Lens' TargetedSentimentDetectionJobProperties (Maybe JobStatus) -- | The language code of the input documents. targetedSentimentDetectionJobProperties_languageCode :: Lens' TargetedSentimentDetectionJobProperties (Maybe LanguageCode) -- | A description of the status of a job. targetedSentimentDetectionJobProperties_message :: Lens' TargetedSentimentDetectionJobProperties (Maybe Text) -- | Undocumented member. targetedSentimentDetectionJobProperties_outputDataConfig :: Lens' TargetedSentimentDetectionJobProperties (Maybe OutputDataConfig) -- | The time that the targeted sentiment detection job was submitted for -- processing. targetedSentimentDetectionJobProperties_submitTime :: Lens' TargetedSentimentDetectionJobProperties (Maybe UTCTime) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the targeted sentiment detection job. The -- VolumeKmsKeyId can be either of the following formats: -- -- targetedSentimentDetectionJobProperties_volumeKmsKeyId :: Lens' TargetedSentimentDetectionJobProperties (Maybe Text) -- | Undocumented member. targetedSentimentDetectionJobProperties_vpcConfig :: Lens' TargetedSentimentDetectionJobProperties (Maybe VpcConfig) -- | One or more index into the Mentions array that provides the best name -- for the entity group. targetedSentimentEntity_descriptiveMentionIndex :: Lens' TargetedSentimentEntity (Maybe [Int]) -- | An array of mentions of the entity in the document. The array -- represents a co-reference group. See Co-reference group for an -- example. targetedSentimentEntity_mentions :: Lens' TargetedSentimentEntity (Maybe [TargetedSentimentMention]) -- | The offset into the document text where the mention begins. targetedSentimentMention_beginOffset :: Lens' TargetedSentimentMention (Maybe Int) -- | The offset into the document text where the mention ends. targetedSentimentMention_endOffset :: Lens' TargetedSentimentMention (Maybe Int) -- | The confidence that all the entities mentioned in the group relate to -- the same entity. targetedSentimentMention_groupScore :: Lens' TargetedSentimentMention (Maybe Double) -- | Contains the sentiment and sentiment score for the mention. targetedSentimentMention_mentionSentiment :: Lens' TargetedSentimentMention (Maybe MentionSentiment) -- | Model confidence that the entity is relevant. Value range is zero to -- one, where one is highest confidence. targetedSentimentMention_score :: Lens' TargetedSentimentMention (Maybe Double) -- | The text in the document that identifies the entity. targetedSentimentMention_text :: Lens' TargetedSentimentMention (Maybe Text) -- | The type of the entity. Amazon Comprehend supports a variety of -- entity types. targetedSentimentMention_type :: Lens' TargetedSentimentMention (Maybe TargetedSentimentEntityType) topicsDetectionJobFilter_jobName :: Lens' TopicsDetectionJobFilter (Maybe Text) -- | Filters the list of topic detection jobs based on job status. Returns -- only jobs with the specified status. topicsDetectionJobFilter_jobStatus :: Lens' TopicsDetectionJobFilter (Maybe JobStatus) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Only returns jobs submitted after the specified time. -- Jobs are returned in ascending order, oldest to newest. topicsDetectionJobFilter_submitTimeAfter :: Lens' TopicsDetectionJobFilter (Maybe UTCTime) -- | Filters the list of jobs based on the time that the job was submitted -- for processing. Only returns jobs submitted before the specified time. -- Jobs are returned in descending order, newest to oldest. topicsDetectionJobFilter_submitTimeBefore :: Lens' TopicsDetectionJobFilter (Maybe UTCTime) -- | The Amazon Resource Name (ARN) of the AWS Identity and Management -- (IAM) role that grants Amazon Comprehend read access to your job data. topicsDetectionJobProperties_dataAccessRoleArn :: Lens' TopicsDetectionJobProperties (Maybe Text) -- | The time that the topic detection job was completed. topicsDetectionJobProperties_endTime :: Lens' TopicsDetectionJobProperties (Maybe UTCTime) -- | The input data configuration supplied when you created the topic -- detection job. topicsDetectionJobProperties_inputDataConfig :: Lens' TopicsDetectionJobProperties (Maybe InputDataConfig) -- | The Amazon Resource Name (ARN) of the topics detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab
--
topicsDetectionJobProperties_jobArn :: Lens' TopicsDetectionJobProperties (Maybe Text) -- | The identifier assigned to the topic detection job. topicsDetectionJobProperties_jobId :: Lens' TopicsDetectionJobProperties (Maybe Text) -- | The name of the topic detection job. topicsDetectionJobProperties_jobName :: Lens' TopicsDetectionJobProperties (Maybe Text) -- | The current status of the topic detection job. If the status is -- Failed, the reason for the failure is shown in the -- Message field. topicsDetectionJobProperties_jobStatus :: Lens' TopicsDetectionJobProperties (Maybe JobStatus) -- | A description for the status of a job. topicsDetectionJobProperties_message :: Lens' TopicsDetectionJobProperties (Maybe Text) -- | The number of topics to detect supplied when you created the topic -- detection job. The default is 10. topicsDetectionJobProperties_numberOfTopics :: Lens' TopicsDetectionJobProperties (Maybe Int) -- | The output data configuration supplied when you created the topic -- detection job. topicsDetectionJobProperties_outputDataConfig :: Lens' TopicsDetectionJobProperties (Maybe OutputDataConfig) -- | The time that the topic detection job was submitted for processing. topicsDetectionJobProperties_submitTime :: Lens' TopicsDetectionJobProperties (Maybe UTCTime) -- | ID for the AWS Key Management Service (KMS) key that Amazon Comprehend -- uses to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- topicsDetectionJobProperties_volumeKmsKeyId :: Lens' TopicsDetectionJobProperties (Maybe Text) -- | Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your topic detection job. -- For more information, see Amazon VPC. topicsDetectionJobProperties_vpcConfig :: Lens' TopicsDetectionJobProperties (Maybe VpcConfig) -- | The ID number for a security group on an instance of your private VPC. -- Security groups on your VPC function serve as a virtual firewall to -- control inbound and outbound traffic and provides security for the -- resources that you’ll be accessing on the VPC. This ID number is -- preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more -- information, see Security Groups for your VPC. vpcConfig_securityGroupIds :: Lens' VpcConfig (NonEmpty Text) -- | The ID for each subnet being used in your private VPC. This subnet is -- a subset of the a range of IPv4 addresses used by the VPC and is -- specific to a given availability zone in the VPC’s region. This ID -- number is preceded by "subnet-", for instance: -- "subnet-04ccf456919e69055". For more information, see VPCs and -- Subnets. vpcConfig_subnets :: Lens' VpcConfig (NonEmpty Text) module Amazonka.Comprehend.Waiters -- | Derived from API version 2017-11-27 of the AWS service -- descriptions, licensed under Apache 2.0. -- -- Amazon Comprehend is an AWS service for gaining insight into the -- content of documents. Use these actions to determine the topics -- contained in your documents, the topics they discuss, the predominant -- sentiment expressed in them, the predominant language used, and more. module Amazonka.Comprehend -- | API version 2017-11-27 of the Amazon Comprehend SDK -- configuration. defaultService :: Service -- | The number of documents in the request exceeds the limit of 25. Try -- your request again with fewer documents. _BatchSizeLimitExceededException :: AsError a => Fold a ServiceError -- | Concurrent modification of the tags associated with an Amazon -- Comprehend resource is not supported. _ConcurrentModificationException :: AsError a => Fold a ServiceError -- | An internal server error occurred. Retry your request. _InternalServerException :: AsError a => Fold a ServiceError -- | The filter specified for the operation is invalid. Specify a different -- filter. _InvalidFilterException :: AsError a => Fold a ServiceError -- | The request is invalid. _InvalidRequestException :: AsError a => Fold a ServiceError -- | The specified job was not found. Check the job ID and try again. _JobNotFoundException :: AsError a => Fold a ServiceError -- | The KMS customer managed key (CMK) entered cannot be validated. Verify -- the key and re-enter it. _KmsKeyValidationException :: AsError a => Fold a ServiceError -- | The specified resource name is already in use. Use a different name -- and try your request again. _ResourceInUseException :: AsError a => Fold a ServiceError -- | The maximum number of resources per account has been exceeded. Review -- the resources, and then try your request again. _ResourceLimitExceededException :: AsError a => Fold a ServiceError -- | The specified resource ARN was not found. Check the ARN and try your -- request again. _ResourceNotFoundException :: AsError a => Fold a ServiceError -- | The specified resource is not available. Check the resource and try -- your request again. _ResourceUnavailableException :: AsError a => Fold a ServiceError -- | The size of the input text exceeds the limit. Use a smaller document. _TextSizeLimitExceededException :: AsError a => Fold a ServiceError -- | The number of requests exceeds the limit. Resubmit your request later. _TooManyRequestsException :: AsError a => Fold a ServiceError -- | The request contains more tag keys than can be associated with a -- resource (50 tag keys per resource). _TooManyTagKeysException :: AsError a => Fold a ServiceError -- | The request contains more tags than can be associated with a resource -- (50 tags per resource). The maximum number of tags includes both -- existing tags and those included in your current request. _TooManyTagsException :: AsError a => Fold a ServiceError -- | Amazon Comprehend can't process the language of the input text. For -- custom entity recognition APIs, only English, Spanish, French, -- Italian, German, or Portuguese are accepted. For a list of supported -- languages, Supported languages in the Comprehend Developer -- Guide. _UnsupportedLanguageException :: AsError a => Fold a ServiceError -- | See: newBatchDetectDominantLanguage smart constructor. data BatchDetectDominantLanguage BatchDetectDominantLanguage' :: Sensitive (NonEmpty (Sensitive Text)) -> BatchDetectDominantLanguage -- | Create a value of BatchDetectDominantLanguage with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:textList:BatchDetectDominantLanguage', -- batchDetectDominantLanguage_textList - A list containing the -- UTF-8 encoded text of the input documents. The list can contain a -- maximum of 25 documents. Each document should contain at least 20 -- characters. The maximum size of each document is 5 KB. newBatchDetectDominantLanguage :: NonEmpty Text -> BatchDetectDominantLanguage -- | See: newBatchDetectDominantLanguageResponse smart -- constructor. data BatchDetectDominantLanguageResponse BatchDetectDominantLanguageResponse' :: Int -> [BatchDetectDominantLanguageItemResult] -> [BatchItemError] -> BatchDetectDominantLanguageResponse -- | Create a value of BatchDetectDominantLanguageResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:httpStatus:BatchDetectDominantLanguageResponse', -- batchDetectDominantLanguageResponse_httpStatus - The response's -- http status code. -- -- $sel:resultList:BatchDetectDominantLanguageResponse', -- batchDetectDominantLanguageResponse_resultList - A list of -- objects containing the results of the operation. The results are -- sorted in ascending order by the Index field and match the -- order of the documents in the input list. If all of the documents -- contain an error, the ResultList is empty. -- -- $sel:errorList:BatchDetectDominantLanguageResponse', -- batchDetectDominantLanguageResponse_errorList - A list -- containing one object for each document that contained an error. The -- results are sorted in ascending order by the Index field and -- match the order of the documents in the input list. If there are no -- errors in the batch, the ErrorList is empty. newBatchDetectDominantLanguageResponse :: Int -> BatchDetectDominantLanguageResponse -- | See: newBatchDetectEntities smart constructor. data BatchDetectEntities BatchDetectEntities' :: Sensitive (NonEmpty (Sensitive Text)) -> LanguageCode -> BatchDetectEntities -- | Create a value of BatchDetectEntities with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:textList:BatchDetectEntities', -- batchDetectEntities_textList - A list containing the UTF-8 -- encoded text of the input documents. The list can contain a maximum of -- 25 documents. The maximum size of each document is 5 KB. -- -- BatchDetectEntities, batchDetectEntities_languageCode - -- The language of the input documents. You can specify any of the -- primary languages supported by Amazon Comprehend. All documents must -- be in the same language. newBatchDetectEntities :: NonEmpty Text -> LanguageCode -> BatchDetectEntities -- | See: newBatchDetectEntitiesResponse smart constructor. data BatchDetectEntitiesResponse BatchDetectEntitiesResponse' :: Int -> [BatchDetectEntitiesItemResult] -> [BatchItemError] -> BatchDetectEntitiesResponse -- | Create a value of BatchDetectEntitiesResponse with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:httpStatus:BatchDetectEntitiesResponse', -- batchDetectEntitiesResponse_httpStatus - The response's http -- status code. -- -- $sel:resultList:BatchDetectEntitiesResponse', -- batchDetectEntitiesResponse_resultList - A list of objects -- containing the results of the operation. The results are sorted in -- ascending order by the Index field and match the order of the -- documents in the input list. If all of the documents contain an error, -- the ResultList is empty. -- -- $sel:errorList:BatchDetectEntitiesResponse', -- batchDetectEntitiesResponse_errorList - A list containing one -- object for each document that contained an error. The results are -- sorted in ascending order by the Index field and match the -- order of the documents in the input list. If there are no errors in -- the batch, the ErrorList is empty. newBatchDetectEntitiesResponse :: Int -> BatchDetectEntitiesResponse -- | See: newBatchDetectKeyPhrases smart constructor. data BatchDetectKeyPhrases BatchDetectKeyPhrases' :: Sensitive (NonEmpty (Sensitive Text)) -> LanguageCode -> BatchDetectKeyPhrases -- | Create a value of BatchDetectKeyPhrases with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:textList:BatchDetectKeyPhrases', -- batchDetectKeyPhrases_textList - A list containing the UTF-8 -- encoded text of the input documents. The list can contain a maximum of -- 25 documents. The maximum size of each document is 5 KB. -- -- BatchDetectKeyPhrases, -- batchDetectKeyPhrases_languageCode - The language of the input -- documents. You can specify any of the primary languages supported by -- Amazon Comprehend. All documents must be in the same language. newBatchDetectKeyPhrases :: NonEmpty Text -> LanguageCode -> BatchDetectKeyPhrases -- | See: newBatchDetectKeyPhrasesResponse smart constructor. data BatchDetectKeyPhrasesResponse BatchDetectKeyPhrasesResponse' :: Int -> [BatchDetectKeyPhrasesItemResult] -> [BatchItemError] -> BatchDetectKeyPhrasesResponse -- | Create a value of BatchDetectKeyPhrasesResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:httpStatus:BatchDetectKeyPhrasesResponse', -- batchDetectKeyPhrasesResponse_httpStatus - The response's http -- status code. -- -- $sel:resultList:BatchDetectKeyPhrasesResponse', -- batchDetectKeyPhrasesResponse_resultList - A list of objects -- containing the results of the operation. The results are sorted in -- ascending order by the Index field and match the order of the -- documents in the input list. If all of the documents contain an error, -- the ResultList is empty. -- -- $sel:errorList:BatchDetectKeyPhrasesResponse', -- batchDetectKeyPhrasesResponse_errorList - A list containing one -- object for each document that contained an error. The results are -- sorted in ascending order by the Index field and match the -- order of the documents in the input list. If there are no errors in -- the batch, the ErrorList is empty. newBatchDetectKeyPhrasesResponse :: Int -> BatchDetectKeyPhrasesResponse -- | See: newBatchDetectSentiment smart constructor. data BatchDetectSentiment BatchDetectSentiment' :: Sensitive (NonEmpty (Sensitive Text)) -> LanguageCode -> BatchDetectSentiment -- | Create a value of BatchDetectSentiment with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:textList:BatchDetectSentiment', -- batchDetectSentiment_textList - A list containing the UTF-8 -- encoded text of the input documents. The list can contain a maximum of -- 25 documents. The maximum size of each document is 5 KB. -- -- Amazon Comprehend performs real-time sentiment analysis on the first -- 500 characters of the input text and ignores any additional text in -- the input. -- -- BatchDetectSentiment, batchDetectSentiment_languageCode -- - The language of the input documents. You can specify any of the -- primary languages supported by Amazon Comprehend. All documents must -- be in the same language. newBatchDetectSentiment :: NonEmpty Text -> LanguageCode -> BatchDetectSentiment -- | See: newBatchDetectSentimentResponse smart constructor. data BatchDetectSentimentResponse BatchDetectSentimentResponse' :: Int -> [BatchDetectSentimentItemResult] -> [BatchItemError] -> BatchDetectSentimentResponse -- | Create a value of BatchDetectSentimentResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:httpStatus:BatchDetectSentimentResponse', -- batchDetectSentimentResponse_httpStatus - The response's http -- status code. -- -- $sel:resultList:BatchDetectSentimentResponse', -- batchDetectSentimentResponse_resultList - A list of objects -- containing the results of the operation. The results are sorted in -- ascending order by the Index field and match the order of the -- documents in the input list. If all of the documents contain an error, -- the ResultList is empty. -- -- $sel:errorList:BatchDetectSentimentResponse', -- batchDetectSentimentResponse_errorList - A list containing one -- object for each document that contained an error. The results are -- sorted in ascending order by the Index field and match the -- order of the documents in the input list. If there are no errors in -- the batch, the ErrorList is empty. newBatchDetectSentimentResponse :: Int -> BatchDetectSentimentResponse -- | See: newBatchDetectSyntax smart constructor. data BatchDetectSyntax BatchDetectSyntax' :: Sensitive (NonEmpty (Sensitive Text)) -> SyntaxLanguageCode -> BatchDetectSyntax -- | Create a value of BatchDetectSyntax with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:textList:BatchDetectSyntax', -- batchDetectSyntax_textList - A list containing the UTF-8 -- encoded text of the input documents. The list can contain a maximum of -- 25 documents. The maximum size for each document is 5 KB. -- -- BatchDetectSyntax, batchDetectSyntax_languageCode - The -- language of the input documents. You can specify any of the following -- languages supported by Amazon Comprehend: German ("de"), English -- ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese -- ("pt"). All documents must be in the same language. newBatchDetectSyntax :: NonEmpty Text -> SyntaxLanguageCode -> BatchDetectSyntax -- | See: newBatchDetectSyntaxResponse smart constructor. data BatchDetectSyntaxResponse BatchDetectSyntaxResponse' :: Int -> [BatchDetectSyntaxItemResult] -> [BatchItemError] -> BatchDetectSyntaxResponse -- | Create a value of BatchDetectSyntaxResponse with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:httpStatus:BatchDetectSyntaxResponse', -- batchDetectSyntaxResponse_httpStatus - The response's http -- status code. -- -- $sel:resultList:BatchDetectSyntaxResponse', -- batchDetectSyntaxResponse_resultList - A list of objects -- containing the results of the operation. The results are sorted in -- ascending order by the Index field and match the order of the -- documents in the input list. If all of the documents contain an error, -- the ResultList is empty. -- -- $sel:errorList:BatchDetectSyntaxResponse', -- batchDetectSyntaxResponse_errorList - A list containing one -- object for each document that contained an error. The results are -- sorted in ascending order by the Index field and match the -- order of the documents in the input list. If there are no errors in -- the batch, the ErrorList is empty. newBatchDetectSyntaxResponse :: Int -> BatchDetectSyntaxResponse -- | See: newBatchDetectTargetedSentiment smart constructor. data BatchDetectTargetedSentiment BatchDetectTargetedSentiment' :: Sensitive (NonEmpty (Sensitive Text)) -> LanguageCode -> BatchDetectTargetedSentiment -- | Create a value of BatchDetectTargetedSentiment with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:textList:BatchDetectTargetedSentiment', -- batchDetectTargetedSentiment_textList - A list containing the -- UTF-8 encoded text of the input documents. The list can contain a -- maximum of 25 documents. The maximum size of each document is 5 KB. -- -- BatchDetectTargetedSentiment, -- batchDetectTargetedSentiment_languageCode - The language of the -- input documents. Currently, English is the only supported language. newBatchDetectTargetedSentiment :: NonEmpty Text -> LanguageCode -> BatchDetectTargetedSentiment -- | See: newBatchDetectTargetedSentimentResponse smart -- constructor. data BatchDetectTargetedSentimentResponse BatchDetectTargetedSentimentResponse' :: Int -> [BatchDetectTargetedSentimentItemResult] -> [BatchItemError] -> BatchDetectTargetedSentimentResponse -- | Create a value of BatchDetectTargetedSentimentResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:httpStatus:BatchDetectTargetedSentimentResponse', -- batchDetectTargetedSentimentResponse_httpStatus - The -- response's http status code. -- -- $sel:resultList:BatchDetectTargetedSentimentResponse', -- batchDetectTargetedSentimentResponse_resultList - A list of -- objects containing the results of the operation. The results are -- sorted in ascending order by the Index field and match the -- order of the documents in the input list. If all of the documents -- contain an error, the ResultList is empty. -- -- $sel:errorList:BatchDetectTargetedSentimentResponse', -- batchDetectTargetedSentimentResponse_errorList - List of errors -- that the operation can return. newBatchDetectTargetedSentimentResponse :: Int -> BatchDetectTargetedSentimentResponse -- | See: newClassifyDocument smart constructor. data ClassifyDocument ClassifyDocument' :: Maybe Base64 -> Maybe DocumentReaderConfig -> Maybe (Sensitive Text) -> Text -> ClassifyDocument -- | Create a value of ClassifyDocument with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:bytes:ClassifyDocument', classifyDocument_bytes - -- Use the Bytes parameter to input a text, PDF, Word or image -- file. You can also use the Bytes parameter to input an Amazon -- Textract DetectDocumentText or AnalyzeDocument -- output file. -- -- Provide the input document as a sequence of base64-encoded bytes. If -- your code uses an Amazon Web Services SDK to classify documents, the -- SDK may encode the document file bytes for you. -- -- The maximum length of this field depends on the input document type. -- For details, see Inputs for real-time custom analysis in the -- Comprehend Developer Guide. -- -- If you use the Bytes parameter, do not use the Text -- parameter.-- -- Note: This Lens automatically encodes -- and decodes Base64 data. -- The underlying isomorphism will encode to -- Base64 representation during -- serialisation, and decode from Base64 -- representation during deserialisation. -- This Lens accepts -- and returns only raw unencoded data. -- -- ClassifyDocument, classifyDocument_documentReaderConfig -- - Provides configuration parameters to override the default actions -- for extracting text from PDF documents and image files. -- -- ClassifyDocument, classifyDocument_text - The document -- text to be analyzed. If you enter text using this parameter, do not -- use the Bytes parameter. -- -- ClassifyDocument, classifyDocument_endpointArn - The -- Amazon Resource Number (ARN) of the endpoint. For information about -- endpoints, see Managing endpoints. newClassifyDocument :: Text -> ClassifyDocument -- | See: newClassifyDocumentResponse smart constructor. data ClassifyDocumentResponse ClassifyDocumentResponse' :: Maybe [DocumentClass] -> Maybe DocumentMetadata -> Maybe [DocumentTypeListItem] -> Maybe [ErrorsListItem] -> Maybe [DocumentLabel] -> Int -> ClassifyDocumentResponse -- | Create a value of ClassifyDocumentResponse with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:classes:ClassifyDocumentResponse', -- classifyDocumentResponse_classes - The classes used by the -- document being analyzed. These are used for multi-class trained -- models. Individual classes are mutually exclusive and each document is -- expected to have only a single class assigned to it. For example, an -- animal can be a dog or a cat, but not both at the same time. -- -- $sel:documentMetadata:ClassifyDocumentResponse', -- classifyDocumentResponse_documentMetadata - Extraction -- information about the document. This field is present in the response -- only if your request includes the Byte parameter. -- -- ClassifyDocumentResponse, -- classifyDocumentResponse_documentType - The document type for -- each page in the input document. This field is present in the response -- only if your request includes the Byte parameter. -- -- $sel:errors:ClassifyDocumentResponse', -- classifyDocumentResponse_errors - Page-level errors that the -- system detected while processing the input document. The field is -- empty if the system encountered no errors. -- -- $sel:labels:ClassifyDocumentResponse', -- classifyDocumentResponse_labels - The labels used the document -- being analyzed. These are used for multi-label trained models. -- Individual labels represent different categories that are related in -- some manner and are not mutually exclusive. For example, a movie can -- be just an action movie, or it can be an action movie, a science -- fiction movie, and a comedy, all at the same time. -- -- $sel:httpStatus:ClassifyDocumentResponse', -- classifyDocumentResponse_httpStatus - The response's http -- status code. newClassifyDocumentResponse :: Int -> ClassifyDocumentResponse -- | See: newContainsPiiEntities smart constructor. data ContainsPiiEntities ContainsPiiEntities' :: Text -> LanguageCode -> ContainsPiiEntities -- | Create a value of ContainsPiiEntities with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- ContainsPiiEntities, containsPiiEntities_text - A UTF-8 -- text string. The maximum string size is 100 KB. -- -- ContainsPiiEntities, containsPiiEntities_languageCode - -- The language of the input documents. Currently, English is the only -- valid language. newContainsPiiEntities :: Text -> LanguageCode -> ContainsPiiEntities -- | See: newContainsPiiEntitiesResponse smart constructor. data ContainsPiiEntitiesResponse ContainsPiiEntitiesResponse' :: Maybe [EntityLabel] -> Int -> ContainsPiiEntitiesResponse -- | Create a value of ContainsPiiEntitiesResponse with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:labels:ContainsPiiEntitiesResponse', -- containsPiiEntitiesResponse_labels - The labels used in the -- document being analyzed. Individual labels represent personally -- identifiable information (PII) entity types. -- -- $sel:httpStatus:ContainsPiiEntitiesResponse', -- containsPiiEntitiesResponse_httpStatus - The response's http -- status code. newContainsPiiEntitiesResponse :: Int -> ContainsPiiEntitiesResponse -- | See: newCreateDocumentClassifier smart constructor. data CreateDocumentClassifier CreateDocumentClassifier' :: Maybe Text -> Maybe DocumentClassifierMode -> Maybe Text -> Maybe Text -> Maybe DocumentClassifierOutputDataConfig -> Maybe [Tag] -> Maybe Text -> Maybe Text -> Maybe VpcConfig -> Text -> Text -> DocumentClassifierInputDataConfig -> LanguageCode -> CreateDocumentClassifier -- | Create a value of CreateDocumentClassifier with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:clientRequestToken:CreateDocumentClassifier', -- createDocumentClassifier_clientRequestToken - A unique -- identifier for the request. If you don't set the client request token, -- Amazon Comprehend generates one. -- -- CreateDocumentClassifier, createDocumentClassifier_mode -- - Indicates the mode in which the classifier will be trained. The -- classifier can be trained in multi-class mode, which identifies one -- and only one class for each document, or multi-label mode, which -- identifies one or more labels for each document. In multi-label mode, -- multiple labels for an individual document are separated by a -- delimiter. The default delimiter between labels is a pipe (|). -- -- CreateDocumentClassifier, -- createDocumentClassifier_modelKmsKeyId - ID for the AWS Key -- Management Service (KMS) key that Amazon Comprehend uses to encrypt -- trained custom models. The ModelKmsKeyId can be either of the -- following formats: -- -- -- -- $sel:modelPolicy:CreateDocumentClassifier', -- createDocumentClassifier_modelPolicy - The resource-based -- policy to attach to your custom document classifier model. You can use -- this policy to allow another AWS account to import your custom model. -- -- Provide your policy as a JSON body that you enter as a UTF-8 encoded -- string without line breaks. To provide valid JSON, enclose the -- attribute names and values in double quotes. If the JSON body is also -- enclosed in double quotes, then you must escape the double quotes that -- are inside the policy: -- -- 
--   "{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
--
-- -- To avoid escaping quotes, you can use single quotes to enclose the -- policy and double quotes to enclose the JSON names and values: -- -- 
--   '{"attribute": "value", "attribute": ["value"]}'
--
-- -- CreateDocumentClassifier, -- createDocumentClassifier_outputDataConfig - Enables the -- addition of output results configuration parameters for custom -- classifier jobs. -- -- $sel:tags:CreateDocumentClassifier', -- createDocumentClassifier_tags - Tags to be associated with the -- document classifier being created. A tag is a key-value pair that adds -- as a metadata to a resource used by Amazon Comprehend. For example, a -- tag with "Sales" as the key might be added to a resource to indicate -- its use by the sales department. -- -- CreateDocumentClassifier, -- createDocumentClassifier_versionName - The version name given -- to the newly created classifier. Version names can have a maximum of -- 256 characters. Alphanumeric characters, hyphens (-) and underscores -- (_) are allowed. The version name must be unique among all models with -- the same classifier name in the account/AWS Region. -- -- CreateDocumentClassifier, -- createDocumentClassifier_volumeKmsKeyId - ID for the AWS Key -- Management Service (KMS) key that Amazon Comprehend uses to encrypt -- data on the storage volume attached to the ML compute instance(s) that -- process the analysis job. The VolumeKmsKeyId can be either of the -- following formats: -- -- -- -- CreateDocumentClassifier, -- createDocumentClassifier_vpcConfig - Configuration parameters -- for an optional private Virtual Private Cloud (VPC) containing the -- resources you are using for your custom classifier. For more -- information, see Amazon VPC. -- -- CreateDocumentClassifier, -- createDocumentClassifier_documentClassifierName - The name of -- the document classifier. -- -- CreateDocumentClassifier, -- createDocumentClassifier_dataAccessRoleArn - The Amazon -- Resource Name (ARN) of the AWS Identity and Management (IAM) role that -- grants Amazon Comprehend read access to your input data. -- -- CreateDocumentClassifier, -- createDocumentClassifier_inputDataConfig - Specifies the format -- and location of the input data for the job. -- -- CreateDocumentClassifier, -- createDocumentClassifier_languageCode - The language of the -- input documents. You can specify any of the following languages -- supported by Amazon Comprehend: German ("de"), English ("en"), Spanish -- ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All -- documents must be in the same language. newCreateDocumentClassifier :: Text -> Text -> DocumentClassifierInputDataConfig -> LanguageCode -> CreateDocumentClassifier -- | See: newCreateDocumentClassifierResponse smart -- constructor. data CreateDocumentClassifierResponse CreateDocumentClassifierResponse' :: Maybe Text -> Int -> CreateDocumentClassifierResponse -- | Create a value of CreateDocumentClassifierResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- CreateDocumentClassifierResponse, -- createDocumentClassifierResponse_documentClassifierArn - The -- Amazon Resource Name (ARN) that identifies the document classifier. -- -- $sel:httpStatus:CreateDocumentClassifierResponse', -- createDocumentClassifierResponse_httpStatus - The response's -- http status code. newCreateDocumentClassifierResponse :: Int -> CreateDocumentClassifierResponse -- | See: newCreateEndpoint smart constructor. data CreateEndpoint CreateEndpoint' :: Maybe Text -> Maybe Text -> Maybe [Tag] -> Text -> Text -> Natural -> CreateEndpoint -- | Create a value of CreateEndpoint with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:clientRequestToken:CreateEndpoint', -- createEndpoint_clientRequestToken - An idempotency token -- provided by the customer. If this token matches a previous endpoint -- creation request, Amazon Comprehend will not return a -- ResourceInUseException. -- -- CreateEndpoint, createEndpoint_dataAccessRoleArn - The -- Amazon Resource Name (ARN) of the AWS identity and Access Management -- (IAM) role that grants Amazon Comprehend read access to trained custom -- models encrypted with a customer managed key (ModelKmsKeyId). -- -- $sel:tags:CreateEndpoint', createEndpoint_tags - Tags -- associated with the endpoint being created. A tag is a key-value pair -- that adds metadata to the endpoint. For example, a tag with "Sales" as -- the key might be added to an endpoint to indicate its use by the sales -- department. -- -- $sel:endpointName:CreateEndpoint', -- createEndpoint_endpointName - This is the descriptive suffix -- that becomes part of the EndpointArn used for all subsequent -- requests to this resource. -- -- CreateEndpoint, createEndpoint_modelArn - The Amazon -- Resource Number (ARN) of the model to which the endpoint will be -- attached. -- -- CreateEndpoint, createEndpoint_desiredInferenceUnits - -- The desired number of inference units to be used by the model using -- this endpoint. Each inference unit represents of a throughput of 100 -- characters per second. newCreateEndpoint :: Text -> Text -> Natural -> CreateEndpoint -- | See: newCreateEndpointResponse smart constructor. data CreateEndpointResponse CreateEndpointResponse' :: Maybe Text -> Int -> CreateEndpointResponse -- | Create a value of CreateEndpointResponse with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- CreateEndpointResponse, -- createEndpointResponse_endpointArn - The Amazon Resource Number -- (ARN) of the endpoint being created. -- -- $sel:httpStatus:CreateEndpointResponse', -- createEndpointResponse_httpStatus - The response's http status -- code. newCreateEndpointResponse :: Int -> CreateEndpointResponse -- | See: newCreateEntityRecognizer smart constructor. data CreateEntityRecognizer CreateEntityRecognizer' :: Maybe Text -> Maybe Text -> Maybe Text -> Maybe [Tag] -> Maybe Text -> Maybe Text -> Maybe VpcConfig -> Text -> Text -> EntityRecognizerInputDataConfig -> LanguageCode -> CreateEntityRecognizer -- | Create a value of CreateEntityRecognizer with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:clientRequestToken:CreateEntityRecognizer', -- createEntityRecognizer_clientRequestToken - A unique identifier -- for the request. If you don't set the client request token, Amazon -- Comprehend generates one. -- -- CreateEntityRecognizer, -- createEntityRecognizer_modelKmsKeyId - ID for the AWS Key -- Management Service (KMS) key that Amazon Comprehend uses to encrypt -- trained custom models. The ModelKmsKeyId can be either of the -- following formats -- -- -- -- $sel:modelPolicy:CreateEntityRecognizer', -- createEntityRecognizer_modelPolicy - The JSON resource-based -- policy to attach to your custom entity recognizer model. You can use -- this policy to allow another AWS account to import your custom model. -- -- Provide your JSON as a UTF-8 encoded string without line breaks. To -- provide valid JSON for your policy, enclose the attribute names and -- values in double quotes. If the JSON body is also enclosed in double -- quotes, then you must escape the double quotes that are inside the -- policy: -- -- 
--   "{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
--
-- -- To avoid escaping quotes, you can use single quotes to enclose the -- policy and double quotes to enclose the JSON names and values: -- -- 
--   '{"attribute": "value", "attribute": ["value"]}'
--
-- -- $sel:tags:CreateEntityRecognizer', -- createEntityRecognizer_tags - Tags to be associated with the -- entity recognizer being created. A tag is a key-value pair that adds -- as a metadata to a resource used by Amazon Comprehend. For example, a -- tag with "Sales" as the key might be added to a resource to indicate -- its use by the sales department. -- -- CreateEntityRecognizer, -- createEntityRecognizer_versionName - The version name given to -- the newly created recognizer. Version names can be a maximum of 256 -- characters. Alphanumeric characters, hyphens (-) and underscores (_) -- are allowed. The version name must be unique among all models with the -- same recognizer name in the account/ AWS Region. -- -- CreateEntityRecognizer, -- createEntityRecognizer_volumeKmsKeyId - ID for the AWS Key -- Management Service (KMS) key that Amazon Comprehend uses to encrypt -- data on the storage volume attached to the ML compute instance(s) that -- process the analysis job. The VolumeKmsKeyId can be either of the -- following formats: -- -- -- -- CreateEntityRecognizer, createEntityRecognizer_vpcConfig -- - Configuration parameters for an optional private Virtual Private -- Cloud (VPC) containing the resources you are using for your custom -- entity recognizer. For more information, see Amazon VPC. -- -- CreateEntityRecognizer, -- createEntityRecognizer_recognizerName - The name given to the -- newly created recognizer. Recognizer names can be a maximum of 256 -- characters. Alphanumeric characters, hyphens (-) and underscores (_) -- are allowed. The name must be unique in the account/region. -- -- CreateEntityRecognizer, -- createEntityRecognizer_dataAccessRoleArn - The Amazon Resource -- Name (ARN) of the AWS Identity and Management (IAM) role that grants -- Amazon Comprehend read access to your input data. -- -- CreateEntityRecognizer, -- createEntityRecognizer_inputDataConfig - Specifies the format -- and location of the input data. The S3 bucket containing the input -- data must be located in the same region as the entity recognizer being -- created. -- -- CreateEntityRecognizer, -- createEntityRecognizer_languageCode - You can specify any of -- the following languages: English ("en"), Spanish ("es"), French -- ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). If you -- plan to use this entity recognizer with PDF, Word, or image input -- files, you must specify English as the language. All training -- documents must be in the same language. newCreateEntityRecognizer :: Text -> Text -> EntityRecognizerInputDataConfig -> LanguageCode -> CreateEntityRecognizer -- | See: newCreateEntityRecognizerResponse smart -- constructor. data CreateEntityRecognizerResponse CreateEntityRecognizerResponse' :: Maybe Text -> Int -> CreateEntityRecognizerResponse -- | Create a value of CreateEntityRecognizerResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- CreateEntityRecognizerResponse, -- createEntityRecognizerResponse_entityRecognizerArn - The Amazon -- Resource Name (ARN) that identifies the entity recognizer. -- -- $sel:httpStatus:CreateEntityRecognizerResponse', -- createEntityRecognizerResponse_httpStatus - The response's http -- status code. newCreateEntityRecognizerResponse :: Int -> CreateEntityRecognizerResponse -- | See: newDeleteDocumentClassifier smart constructor. data DeleteDocumentClassifier DeleteDocumentClassifier' :: Text -> DeleteDocumentClassifier -- | Create a value of DeleteDocumentClassifier with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DeleteDocumentClassifier, -- deleteDocumentClassifier_documentClassifierArn - The Amazon -- Resource Name (ARN) that identifies the document classifier. newDeleteDocumentClassifier :: Text -> DeleteDocumentClassifier -- | See: newDeleteDocumentClassifierResponse smart -- constructor. data DeleteDocumentClassifierResponse DeleteDocumentClassifierResponse' :: Int -> DeleteDocumentClassifierResponse -- | Create a value of DeleteDocumentClassifierResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:httpStatus:DeleteDocumentClassifierResponse', -- deleteDocumentClassifierResponse_httpStatus - The response's -- http status code. newDeleteDocumentClassifierResponse :: Int -> DeleteDocumentClassifierResponse -- | See: newDeleteEndpoint smart constructor. data DeleteEndpoint DeleteEndpoint' :: Text -> DeleteEndpoint -- | Create a value of DeleteEndpoint with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DeleteEndpoint, deleteEndpoint_endpointArn - The Amazon -- Resource Number (ARN) of the endpoint being deleted. newDeleteEndpoint :: Text -> DeleteEndpoint -- | See: newDeleteEndpointResponse smart constructor. data DeleteEndpointResponse DeleteEndpointResponse' :: Int -> DeleteEndpointResponse -- | Create a value of DeleteEndpointResponse with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:httpStatus:DeleteEndpointResponse', -- deleteEndpointResponse_httpStatus - The response's http status -- code. newDeleteEndpointResponse :: Int -> DeleteEndpointResponse -- | See: newDeleteEntityRecognizer smart constructor. data DeleteEntityRecognizer DeleteEntityRecognizer' :: Text -> DeleteEntityRecognizer -- | Create a value of DeleteEntityRecognizer with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DeleteEntityRecognizer, -- deleteEntityRecognizer_entityRecognizerArn - The Amazon -- Resource Name (ARN) that identifies the entity recognizer. newDeleteEntityRecognizer :: Text -> DeleteEntityRecognizer -- | See: newDeleteEntityRecognizerResponse smart -- constructor. data DeleteEntityRecognizerResponse DeleteEntityRecognizerResponse' :: Int -> DeleteEntityRecognizerResponse -- | Create a value of DeleteEntityRecognizerResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:httpStatus:DeleteEntityRecognizerResponse', -- deleteEntityRecognizerResponse_httpStatus - The response's http -- status code. newDeleteEntityRecognizerResponse :: Int -> DeleteEntityRecognizerResponse -- | See: newDeleteResourcePolicy smart constructor. data DeleteResourcePolicy DeleteResourcePolicy' :: Maybe Text -> Text -> DeleteResourcePolicy -- | Create a value of DeleteResourcePolicy with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:policyRevisionId:DeleteResourcePolicy', -- deleteResourcePolicy_policyRevisionId - The revision ID of the -- policy to delete. -- -- $sel:resourceArn:DeleteResourcePolicy', -- deleteResourcePolicy_resourceArn - The Amazon Resource Name -- (ARN) of the custom model version that has the policy to delete. newDeleteResourcePolicy :: Text -> DeleteResourcePolicy -- | See: newDeleteResourcePolicyResponse smart constructor. data DeleteResourcePolicyResponse DeleteResourcePolicyResponse' :: Int -> DeleteResourcePolicyResponse -- | Create a value of DeleteResourcePolicyResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:httpStatus:DeleteResourcePolicyResponse', -- deleteResourcePolicyResponse_httpStatus - The response's http -- status code. newDeleteResourcePolicyResponse :: Int -> DeleteResourcePolicyResponse -- | See: newDescribeDocumentClassificationJob smart -- constructor. data DescribeDocumentClassificationJob DescribeDocumentClassificationJob' :: Text -> DescribeDocumentClassificationJob -- | Create a value of DescribeDocumentClassificationJob with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DescribeDocumentClassificationJob, -- describeDocumentClassificationJob_jobId - The identifier that -- Amazon Comprehend generated for the job. The operation returns this -- identifier in its response. newDescribeDocumentClassificationJob :: Text -> DescribeDocumentClassificationJob -- | See: newDescribeDocumentClassificationJobResponse smart -- constructor. data DescribeDocumentClassificationJobResponse DescribeDocumentClassificationJobResponse' :: Maybe DocumentClassificationJobProperties -> Int -> DescribeDocumentClassificationJobResponse -- | Create a value of DescribeDocumentClassificationJobResponse -- with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:documentClassificationJobProperties:DescribeDocumentClassificationJobResponse', -- describeDocumentClassificationJobResponse_documentClassificationJobProperties -- - An object that describes the properties associated with the document -- classification job. -- -- $sel:httpStatus:DescribeDocumentClassificationJobResponse', -- describeDocumentClassificationJobResponse_httpStatus - The -- response's http status code. newDescribeDocumentClassificationJobResponse :: Int -> DescribeDocumentClassificationJobResponse -- | See: newDescribeDocumentClassifier smart constructor. data DescribeDocumentClassifier DescribeDocumentClassifier' :: Text -> DescribeDocumentClassifier -- | Create a value of DescribeDocumentClassifier with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DescribeDocumentClassifier, -- describeDocumentClassifier_documentClassifierArn - The Amazon -- Resource Name (ARN) that identifies the document classifier. The -- operation returns this identifier in its response. newDescribeDocumentClassifier :: Text -> DescribeDocumentClassifier -- | See: newDescribeDocumentClassifierResponse smart -- constructor. data DescribeDocumentClassifierResponse DescribeDocumentClassifierResponse' :: Maybe DocumentClassifierProperties -> Int -> DescribeDocumentClassifierResponse -- | Create a value of DescribeDocumentClassifierResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:documentClassifierProperties:DescribeDocumentClassifierResponse', -- describeDocumentClassifierResponse_documentClassifierProperties -- - An object that contains the properties associated with a document -- classifier. -- -- $sel:httpStatus:DescribeDocumentClassifierResponse', -- describeDocumentClassifierResponse_httpStatus - The response's -- http status code. newDescribeDocumentClassifierResponse :: Int -> DescribeDocumentClassifierResponse -- | See: newDescribeDominantLanguageDetectionJob smart -- constructor. data DescribeDominantLanguageDetectionJob DescribeDominantLanguageDetectionJob' :: Text -> DescribeDominantLanguageDetectionJob -- | Create a value of DescribeDominantLanguageDetectionJob with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DescribeDominantLanguageDetectionJob, -- describeDominantLanguageDetectionJob_jobId - The identifier -- that Amazon Comprehend generated for the job. The operation returns -- this identifier in its response. newDescribeDominantLanguageDetectionJob :: Text -> DescribeDominantLanguageDetectionJob -- | See: newDescribeDominantLanguageDetectionJobResponse -- smart constructor. data DescribeDominantLanguageDetectionJobResponse DescribeDominantLanguageDetectionJobResponse' :: Maybe DominantLanguageDetectionJobProperties -> Int -> DescribeDominantLanguageDetectionJobResponse -- | Create a value of DescribeDominantLanguageDetectionJobResponse -- with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:dominantLanguageDetectionJobProperties:DescribeDominantLanguageDetectionJobResponse', -- describeDominantLanguageDetectionJobResponse_dominantLanguageDetectionJobProperties -- - An object that contains the properties associated with a dominant -- language detection job. -- -- $sel:httpStatus:DescribeDominantLanguageDetectionJobResponse', -- describeDominantLanguageDetectionJobResponse_httpStatus - The -- response's http status code. newDescribeDominantLanguageDetectionJobResponse :: Int -> DescribeDominantLanguageDetectionJobResponse -- | See: newDescribeEndpoint smart constructor. data DescribeEndpoint DescribeEndpoint' :: Text -> DescribeEndpoint -- | Create a value of DescribeEndpoint with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DescribeEndpoint, describeEndpoint_endpointArn - The -- Amazon Resource Number (ARN) of the endpoint being described. newDescribeEndpoint :: Text -> DescribeEndpoint -- | See: newDescribeEndpointResponse smart constructor. data DescribeEndpointResponse DescribeEndpointResponse' :: Maybe EndpointProperties -> Int -> DescribeEndpointResponse -- | Create a value of DescribeEndpointResponse with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:endpointProperties:DescribeEndpointResponse', -- describeEndpointResponse_endpointProperties - Describes -- information associated with the specific endpoint. -- -- $sel:httpStatus:DescribeEndpointResponse', -- describeEndpointResponse_httpStatus - The response's http -- status code. newDescribeEndpointResponse :: Int -> DescribeEndpointResponse -- | See: newDescribeEntitiesDetectionJob smart constructor. data DescribeEntitiesDetectionJob DescribeEntitiesDetectionJob' :: Text -> DescribeEntitiesDetectionJob -- | Create a value of DescribeEntitiesDetectionJob with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DescribeEntitiesDetectionJob, -- describeEntitiesDetectionJob_jobId - The identifier that Amazon -- Comprehend generated for the job. The operation returns this -- identifier in its response. newDescribeEntitiesDetectionJob :: Text -> DescribeEntitiesDetectionJob -- | See: newDescribeEntitiesDetectionJobResponse smart -- constructor. data DescribeEntitiesDetectionJobResponse DescribeEntitiesDetectionJobResponse' :: Maybe EntitiesDetectionJobProperties -> Int -> DescribeEntitiesDetectionJobResponse -- | Create a value of DescribeEntitiesDetectionJobResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:entitiesDetectionJobProperties:DescribeEntitiesDetectionJobResponse', -- describeEntitiesDetectionJobResponse_entitiesDetectionJobProperties -- - An object that contains the properties associated with an entities -- detection job. -- -- $sel:httpStatus:DescribeEntitiesDetectionJobResponse', -- describeEntitiesDetectionJobResponse_httpStatus - The -- response's http status code. newDescribeEntitiesDetectionJobResponse :: Int -> DescribeEntitiesDetectionJobResponse -- | See: newDescribeEntityRecognizer smart constructor. data DescribeEntityRecognizer DescribeEntityRecognizer' :: Text -> DescribeEntityRecognizer -- | Create a value of DescribeEntityRecognizer with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DescribeEntityRecognizer, -- describeEntityRecognizer_entityRecognizerArn - The Amazon -- Resource Name (ARN) that identifies the entity recognizer. newDescribeEntityRecognizer :: Text -> DescribeEntityRecognizer -- | See: newDescribeEntityRecognizerResponse smart -- constructor. data DescribeEntityRecognizerResponse DescribeEntityRecognizerResponse' :: Maybe EntityRecognizerProperties -> Int -> DescribeEntityRecognizerResponse -- | Create a value of DescribeEntityRecognizerResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:entityRecognizerProperties:DescribeEntityRecognizerResponse', -- describeEntityRecognizerResponse_entityRecognizerProperties - -- Describes information associated with an entity recognizer. -- -- $sel:httpStatus:DescribeEntityRecognizerResponse', -- describeEntityRecognizerResponse_httpStatus - The response's -- http status code. newDescribeEntityRecognizerResponse :: Int -> DescribeEntityRecognizerResponse -- | See: newDescribeEventsDetectionJob smart constructor. data DescribeEventsDetectionJob DescribeEventsDetectionJob' :: Text -> DescribeEventsDetectionJob -- | Create a value of DescribeEventsDetectionJob with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DescribeEventsDetectionJob, -- describeEventsDetectionJob_jobId - The identifier of the events -- detection job. newDescribeEventsDetectionJob :: Text -> DescribeEventsDetectionJob -- | See: newDescribeEventsDetectionJobResponse smart -- constructor. data DescribeEventsDetectionJobResponse DescribeEventsDetectionJobResponse' :: Maybe EventsDetectionJobProperties -> Int -> DescribeEventsDetectionJobResponse -- | Create a value of DescribeEventsDetectionJobResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:eventsDetectionJobProperties:DescribeEventsDetectionJobResponse', -- describeEventsDetectionJobResponse_eventsDetectionJobProperties -- - An object that contains the properties associated with an event -- detection job. -- -- $sel:httpStatus:DescribeEventsDetectionJobResponse', -- describeEventsDetectionJobResponse_httpStatus - The response's -- http status code. newDescribeEventsDetectionJobResponse :: Int -> DescribeEventsDetectionJobResponse -- | See: newDescribeKeyPhrasesDetectionJob smart -- constructor. data DescribeKeyPhrasesDetectionJob DescribeKeyPhrasesDetectionJob' :: Text -> DescribeKeyPhrasesDetectionJob -- | Create a value of DescribeKeyPhrasesDetectionJob with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DescribeKeyPhrasesDetectionJob, -- describeKeyPhrasesDetectionJob_jobId - The identifier that -- Amazon Comprehend generated for the job. The operation returns this -- identifier in its response. newDescribeKeyPhrasesDetectionJob :: Text -> DescribeKeyPhrasesDetectionJob -- | See: newDescribeKeyPhrasesDetectionJobResponse smart -- constructor. data DescribeKeyPhrasesDetectionJobResponse DescribeKeyPhrasesDetectionJobResponse' :: Maybe KeyPhrasesDetectionJobProperties -> Int -> DescribeKeyPhrasesDetectionJobResponse -- | Create a value of DescribeKeyPhrasesDetectionJobResponse with -- all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:keyPhrasesDetectionJobProperties:DescribeKeyPhrasesDetectionJobResponse', -- describeKeyPhrasesDetectionJobResponse_keyPhrasesDetectionJobProperties -- - An object that contains the properties associated with a key phrases -- detection job. -- -- $sel:httpStatus:DescribeKeyPhrasesDetectionJobResponse', -- describeKeyPhrasesDetectionJobResponse_httpStatus - The -- response's http status code. newDescribeKeyPhrasesDetectionJobResponse :: Int -> DescribeKeyPhrasesDetectionJobResponse -- | See: newDescribePiiEntitiesDetectionJob smart -- constructor. data DescribePiiEntitiesDetectionJob DescribePiiEntitiesDetectionJob' :: Text -> DescribePiiEntitiesDetectionJob -- | Create a value of DescribePiiEntitiesDetectionJob with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DescribePiiEntitiesDetectionJob, -- describePiiEntitiesDetectionJob_jobId - The identifier that -- Amazon Comprehend generated for the job. The operation returns this -- identifier in its response. newDescribePiiEntitiesDetectionJob :: Text -> DescribePiiEntitiesDetectionJob -- | See: newDescribePiiEntitiesDetectionJobResponse smart -- constructor. data DescribePiiEntitiesDetectionJobResponse DescribePiiEntitiesDetectionJobResponse' :: Maybe PiiEntitiesDetectionJobProperties -> Int -> DescribePiiEntitiesDetectionJobResponse -- | Create a value of DescribePiiEntitiesDetectionJobResponse with -- all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:piiEntitiesDetectionJobProperties:DescribePiiEntitiesDetectionJobResponse', -- describePiiEntitiesDetectionJobResponse_piiEntitiesDetectionJobProperties -- - Undocumented member. -- -- $sel:httpStatus:DescribePiiEntitiesDetectionJobResponse', -- describePiiEntitiesDetectionJobResponse_httpStatus - The -- response's http status code. newDescribePiiEntitiesDetectionJobResponse :: Int -> DescribePiiEntitiesDetectionJobResponse -- | See: newDescribeResourcePolicy smart constructor. data DescribeResourcePolicy DescribeResourcePolicy' :: Text -> DescribeResourcePolicy -- | Create a value of DescribeResourcePolicy with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:resourceArn:DescribeResourcePolicy', -- describeResourcePolicy_resourceArn - The Amazon Resource Name -- (ARN) of the custom model version that has the resource policy. newDescribeResourcePolicy :: Text -> DescribeResourcePolicy -- | See: newDescribeResourcePolicyResponse smart -- constructor. data DescribeResourcePolicyResponse DescribeResourcePolicyResponse' :: Maybe POSIX -> Maybe POSIX -> Maybe Text -> Maybe Text -> Int -> DescribeResourcePolicyResponse -- | Create a value of DescribeResourcePolicyResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DescribeResourcePolicyResponse, -- describeResourcePolicyResponse_creationTime - The time at which -- the policy was created. -- -- DescribeResourcePolicyResponse, -- describeResourcePolicyResponse_lastModifiedTime - The time at -- which the policy was last modified. -- -- $sel:policyRevisionId:DescribeResourcePolicyResponse', -- describeResourcePolicyResponse_policyRevisionId - The revision -- ID of the policy. Each time you modify a policy, Amazon Comprehend -- assigns a new revision ID, and it deletes the prior version of the -- policy. -- -- $sel:resourcePolicy:DescribeResourcePolicyResponse', -- describeResourcePolicyResponse_resourcePolicy - The JSON body -- of the resource-based policy. -- -- $sel:httpStatus:DescribeResourcePolicyResponse', -- describeResourcePolicyResponse_httpStatus - The response's http -- status code. newDescribeResourcePolicyResponse :: Int -> DescribeResourcePolicyResponse -- | See: newDescribeSentimentDetectionJob smart constructor. data DescribeSentimentDetectionJob DescribeSentimentDetectionJob' :: Text -> DescribeSentimentDetectionJob -- | Create a value of DescribeSentimentDetectionJob with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DescribeSentimentDetectionJob, -- describeSentimentDetectionJob_jobId - The identifier that -- Amazon Comprehend generated for the job. The operation returns this -- identifier in its response. newDescribeSentimentDetectionJob :: Text -> DescribeSentimentDetectionJob -- | See: newDescribeSentimentDetectionJobResponse smart -- constructor. data DescribeSentimentDetectionJobResponse DescribeSentimentDetectionJobResponse' :: Maybe SentimentDetectionJobProperties -> Int -> DescribeSentimentDetectionJobResponse -- | Create a value of DescribeSentimentDetectionJobResponse with -- all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:sentimentDetectionJobProperties:DescribeSentimentDetectionJobResponse', -- describeSentimentDetectionJobResponse_sentimentDetectionJobProperties -- - An object that contains the properties associated with a sentiment -- detection job. -- -- $sel:httpStatus:DescribeSentimentDetectionJobResponse', -- describeSentimentDetectionJobResponse_httpStatus - The -- response's http status code. newDescribeSentimentDetectionJobResponse :: Int -> DescribeSentimentDetectionJobResponse -- | See: newDescribeTargetedSentimentDetectionJob smart -- constructor. data DescribeTargetedSentimentDetectionJob DescribeTargetedSentimentDetectionJob' :: Text -> DescribeTargetedSentimentDetectionJob -- | Create a value of DescribeTargetedSentimentDetectionJob with -- all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DescribeTargetedSentimentDetectionJob, -- describeTargetedSentimentDetectionJob_jobId - The identifier -- that Amazon Comprehend generated for the job. The operation returns -- this identifier in its response. newDescribeTargetedSentimentDetectionJob :: Text -> DescribeTargetedSentimentDetectionJob -- | See: newDescribeTargetedSentimentDetectionJobResponse -- smart constructor. data DescribeTargetedSentimentDetectionJobResponse DescribeTargetedSentimentDetectionJobResponse' :: Maybe TargetedSentimentDetectionJobProperties -> Int -> DescribeTargetedSentimentDetectionJobResponse -- | Create a value of DescribeTargetedSentimentDetectionJobResponse -- with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:targetedSentimentDetectionJobProperties:DescribeTargetedSentimentDetectionJobResponse', -- describeTargetedSentimentDetectionJobResponse_targetedSentimentDetectionJobProperties -- - An object that contains the properties associated with a targeted -- sentiment detection job. -- -- $sel:httpStatus:DescribeTargetedSentimentDetectionJobResponse', -- describeTargetedSentimentDetectionJobResponse_httpStatus - The -- response's http status code. newDescribeTargetedSentimentDetectionJobResponse :: Int -> DescribeTargetedSentimentDetectionJobResponse -- | See: newDescribeTopicsDetectionJob smart constructor. data DescribeTopicsDetectionJob DescribeTopicsDetectionJob' :: Text -> DescribeTopicsDetectionJob -- | Create a value of DescribeTopicsDetectionJob with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DescribeTopicsDetectionJob, -- describeTopicsDetectionJob_jobId - The identifier assigned by -- the user to the detection job. newDescribeTopicsDetectionJob :: Text -> DescribeTopicsDetectionJob -- | See: newDescribeTopicsDetectionJobResponse smart -- constructor. data DescribeTopicsDetectionJobResponse DescribeTopicsDetectionJobResponse' :: Maybe TopicsDetectionJobProperties -> Int -> DescribeTopicsDetectionJobResponse -- | Create a value of DescribeTopicsDetectionJobResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:topicsDetectionJobProperties:DescribeTopicsDetectionJobResponse', -- describeTopicsDetectionJobResponse_topicsDetectionJobProperties -- - The list of properties for the requested job. -- -- $sel:httpStatus:DescribeTopicsDetectionJobResponse', -- describeTopicsDetectionJobResponse_httpStatus - The response's -- http status code. newDescribeTopicsDetectionJobResponse :: Int -> DescribeTopicsDetectionJobResponse -- | See: newDetectDominantLanguage smart constructor. data DetectDominantLanguage DetectDominantLanguage' :: Sensitive Text -> DetectDominantLanguage -- | Create a value of DetectDominantLanguage with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DetectDominantLanguage, detectDominantLanguage_text - A -- UTF-8 text string. The string must contain at least 20 characters. The -- maximum string size is 100 KB. newDetectDominantLanguage :: Text -> DetectDominantLanguage -- | See: newDetectDominantLanguageResponse smart -- constructor. data DetectDominantLanguageResponse DetectDominantLanguageResponse' :: Maybe [DominantLanguage] -> Int -> DetectDominantLanguageResponse -- | Create a value of DetectDominantLanguageResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DetectDominantLanguageResponse, -- detectDominantLanguageResponse_languages - The languages that -- Amazon Comprehend detected in the input text. For each language, the -- response returns the RFC 5646 language code and the level of -- confidence that Amazon Comprehend has in the accuracy of its -- inference. For more information about RFC 5646, see Tags for -- Identifying Languages on the IETF Tools web site. -- -- $sel:httpStatus:DetectDominantLanguageResponse', -- detectDominantLanguageResponse_httpStatus - The response's http -- status code. newDetectDominantLanguageResponse :: Int -> DetectDominantLanguageResponse -- | See: newDetectEntities smart constructor. data DetectEntities DetectEntities' :: Maybe Base64 -> Maybe DocumentReaderConfig -> Maybe Text -> Maybe LanguageCode -> Maybe (Sensitive Text) -> DetectEntities -- | Create a value of DetectEntities with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:bytes:DetectEntities', detectEntities_bytes - This -- field applies only when you use a custom entity recognition model that -- was trained with PDF annotations. For other cases, enter your text -- input in the Text field. -- -- Use the Bytes parameter to input a text, PDF, Word or image -- file. Using a plain-text file in the Bytes parameter is -- equivelent to using the Text parameter (the Entities -- field in the response is identical). -- -- You can also use the Bytes parameter to input an Amazon -- Textract DetectDocumentText or AnalyzeDocument -- output file. -- -- Provide the input document as a sequence of base64-encoded bytes. If -- your code uses an Amazon Web Services SDK to detect entities, the SDK -- may encode the document file bytes for you. -- -- The maximum length of this field depends on the input document type. -- For details, see Inputs for real-time custom analysis in the -- Comprehend Developer Guide. -- -- If you use the Bytes parameter, do not use the Text -- parameter.-- -- Note: This Lens automatically encodes -- and decodes Base64 data. -- The underlying isomorphism will encode to -- Base64 representation during -- serialisation, and decode from Base64 -- representation during deserialisation. -- This Lens accepts -- and returns only raw unencoded data. -- -- DetectEntities, detectEntities_documentReaderConfig - -- Provides configuration parameters to override the default actions for -- extracting text from PDF documents and image files. -- -- DetectEntities, detectEntities_endpointArn - The Amazon -- Resource Name of an endpoint that is associated with a custom entity -- recognition model. Provide an endpoint if you want to detect entities -- by using your own custom model instead of the default model that is -- used by Amazon Comprehend. -- -- If you specify an endpoint, Amazon Comprehend uses the language of -- your custom model, and it ignores any language code that you provide -- in your request. -- -- For information about endpoints, see Managing endpoints. -- -- DetectEntities, detectEntities_languageCode - The -- language of the input documents. You can specify any of the primary -- languages supported by Amazon Comprehend. If your request includes the -- endpoint for a custom entity recognition model, Amazon Comprehend uses -- the language of your custom model, and it ignores any language code -- that you specify here. -- -- All input documents must be in the same language. -- -- DetectEntities, detectEntities_text - A UTF-8 text -- string. The maximum string size is 100 KB. If you enter text using -- this parameter, do not use the Bytes parameter. newDetectEntities :: DetectEntities -- | See: newDetectEntitiesResponse smart constructor. data DetectEntitiesResponse DetectEntitiesResponse' :: Maybe [Block] -> Maybe DocumentMetadata -> Maybe [DocumentTypeListItem] -> Maybe [Entity] -> Maybe [ErrorsListItem] -> Int -> DetectEntitiesResponse -- | Create a value of DetectEntitiesResponse with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:blocks:DetectEntitiesResponse', -- detectEntitiesResponse_blocks - Information about each block of -- text in the input document. Blocks are nested. A page block contains a -- block for each line of text, which contains a block for each word. -- -- The Block content for a Word input document does not include -- a Geometry field. -- -- The Block field is not present in the response for plain-text -- inputs. -- -- $sel:documentMetadata:DetectEntitiesResponse', -- detectEntitiesResponse_documentMetadata - Information about the -- document, discovered during text extraction. This field is present in -- the response only if your request used the Byte parameter. -- -- DetectEntitiesResponse, -- detectEntitiesResponse_documentType - The document type for -- each page in the input document. This field is present in the response -- only if your request used the Byte parameter. -- -- DetectEntitiesResponse, detectEntitiesResponse_entities -- - A collection of entities identified in the input text. For each -- entity, the response provides the entity text, entity type, where the -- entity text begins and ends, and the level of confidence that Amazon -- Comprehend has in the detection. -- -- If your request uses a custom entity recognition model, Amazon -- Comprehend detects the entities that the model is trained to -- recognize. Otherwise, it detects the default entity types. For a list -- of default entity types, see Entities in the Comprehend -- Developer Guide. -- -- $sel:errors:DetectEntitiesResponse', -- detectEntitiesResponse_errors - Page-level errors that the -- system detected while processing the input document. The field is -- empty if the system encountered no errors. -- -- $sel:httpStatus:DetectEntitiesResponse', -- detectEntitiesResponse_httpStatus - The response's http status -- code. newDetectEntitiesResponse :: Int -> DetectEntitiesResponse -- | See: newDetectKeyPhrases smart constructor. data DetectKeyPhrases DetectKeyPhrases' :: Sensitive Text -> LanguageCode -> DetectKeyPhrases -- | Create a value of DetectKeyPhrases with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DetectKeyPhrases, detectKeyPhrases_text - A UTF-8 text -- string. The string must contain less than 100 KB of UTF-8 encoded -- characters. -- -- DetectKeyPhrases, detectKeyPhrases_languageCode - The -- language of the input documents. You can specify any of the primary -- languages supported by Amazon Comprehend. All documents must be in the -- same language. newDetectKeyPhrases :: Text -> LanguageCode -> DetectKeyPhrases -- | See: newDetectKeyPhrasesResponse smart constructor. data DetectKeyPhrasesResponse DetectKeyPhrasesResponse' :: Maybe [KeyPhrase] -> Int -> DetectKeyPhrasesResponse -- | Create a value of DetectKeyPhrasesResponse with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DetectKeyPhrasesResponse, -- detectKeyPhrasesResponse_keyPhrases - A collection of key -- phrases that Amazon Comprehend identified in the input text. For each -- key phrase, the response provides the text of the key phrase, where -- the key phrase begins and ends, and the level of confidence that -- Amazon Comprehend has in the accuracy of the detection. -- -- $sel:httpStatus:DetectKeyPhrasesResponse', -- detectKeyPhrasesResponse_httpStatus - The response's http -- status code. newDetectKeyPhrasesResponse :: Int -> DetectKeyPhrasesResponse -- | See: newDetectPiiEntities smart constructor. data DetectPiiEntities DetectPiiEntities' :: Text -> LanguageCode -> DetectPiiEntities -- | Create a value of DetectPiiEntities with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DetectPiiEntities, detectPiiEntities_text - A UTF-8 text -- string. The maximum string size is 100 KB. -- -- DetectPiiEntities, detectPiiEntities_languageCode - The -- language of the input documents. Currently, English is the only valid -- language. newDetectPiiEntities :: Text -> LanguageCode -> DetectPiiEntities -- | See: newDetectPiiEntitiesResponse smart constructor. data DetectPiiEntitiesResponse DetectPiiEntitiesResponse' :: Maybe [PiiEntity] -> Int -> DetectPiiEntitiesResponse -- | Create a value of DetectPiiEntitiesResponse with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DetectPiiEntitiesResponse, -- detectPiiEntitiesResponse_entities - A collection of PII -- entities identified in the input text. For each entity, the response -- provides the entity type, where the entity text begins and ends, and -- the level of confidence that Amazon Comprehend has in the detection. -- -- $sel:httpStatus:DetectPiiEntitiesResponse', -- detectPiiEntitiesResponse_httpStatus - The response's http -- status code. newDetectPiiEntitiesResponse :: Int -> DetectPiiEntitiesResponse -- | See: newDetectSentiment smart constructor. data DetectSentiment DetectSentiment' :: Sensitive Text -> LanguageCode -> DetectSentiment -- | Create a value of DetectSentiment with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DetectSentiment, detectSentiment_text - A UTF-8 text -- string. The maximum string size is 5 KB. -- -- Amazon Comprehend performs real-time sentiment analysis on the first -- 500 characters of the input text and ignores any additional text in -- the input. -- -- DetectSentiment, detectSentiment_languageCode - The -- language of the input documents. You can specify any of the primary -- languages supported by Amazon Comprehend. All documents must be in the -- same language. newDetectSentiment :: Text -> LanguageCode -> DetectSentiment -- | See: newDetectSentimentResponse smart constructor. data DetectSentimentResponse DetectSentimentResponse' :: Maybe SentimentType -> Maybe SentimentScore -> Int -> DetectSentimentResponse -- | Create a value of DetectSentimentResponse with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DetectSentimentResponse, -- detectSentimentResponse_sentiment - The inferred sentiment that -- Amazon Comprehend has the highest level of confidence in. -- -- DetectSentimentResponse, -- detectSentimentResponse_sentimentScore - An object that lists -- the sentiments, and their corresponding confidence levels. -- -- $sel:httpStatus:DetectSentimentResponse', -- detectSentimentResponse_httpStatus - The response's http status -- code. newDetectSentimentResponse :: Int -> DetectSentimentResponse -- | See: newDetectSyntax smart constructor. data DetectSyntax DetectSyntax' :: Sensitive Text -> SyntaxLanguageCode -> DetectSyntax -- | Create a value of DetectSyntax with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DetectSyntax, detectSyntax_text - A UTF-8 string. The -- maximum string size is 5 KB. -- -- DetectSyntax, detectSyntax_languageCode - The language -- code of the input documents. You can specify any of the following -- languages supported by Amazon Comprehend: German ("de"), English -- ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese -- ("pt"). newDetectSyntax :: Text -> SyntaxLanguageCode -> DetectSyntax -- | See: newDetectSyntaxResponse smart constructor. data DetectSyntaxResponse DetectSyntaxResponse' :: Maybe [SyntaxToken] -> Int -> DetectSyntaxResponse -- | Create a value of DetectSyntaxResponse with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DetectSyntaxResponse, detectSyntaxResponse_syntaxTokens -- - A collection of syntax tokens describing the text. For each token, -- the response provides the text, the token type, where the text begins -- and ends, and the level of confidence that Amazon Comprehend has that -- the token is correct. For a list of token types, see Syntax in -- the Comprehend Developer Guide. -- -- $sel:httpStatus:DetectSyntaxResponse', -- detectSyntaxResponse_httpStatus - The response's http status -- code. newDetectSyntaxResponse :: Int -> DetectSyntaxResponse -- | See: newDetectTargetedSentiment smart constructor. data DetectTargetedSentiment DetectTargetedSentiment' :: Sensitive Text -> LanguageCode -> DetectTargetedSentiment -- | Create a value of DetectTargetedSentiment with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DetectTargetedSentiment, detectTargetedSentiment_text - -- A UTF-8 text string. The maximum string length is 5 KB. -- -- DetectTargetedSentiment, -- detectTargetedSentiment_languageCode - The language of the -- input documents. Currently, English is the only supported language. newDetectTargetedSentiment :: Text -> LanguageCode -> DetectTargetedSentiment -- | See: newDetectTargetedSentimentResponse smart -- constructor. data DetectTargetedSentimentResponse DetectTargetedSentimentResponse' :: Maybe [TargetedSentimentEntity] -> Int -> DetectTargetedSentimentResponse -- | Create a value of DetectTargetedSentimentResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- DetectTargetedSentimentResponse, -- detectTargetedSentimentResponse_entities - Targeted sentiment -- analysis for each of the entities identified in the input text. -- -- $sel:httpStatus:DetectTargetedSentimentResponse', -- detectTargetedSentimentResponse_httpStatus - The response's -- http status code. newDetectTargetedSentimentResponse :: Int -> DetectTargetedSentimentResponse -- | See: newImportModel smart constructor. data ImportModel ImportModel' :: Maybe Text -> Maybe Text -> Maybe Text -> Maybe [Tag] -> Maybe Text -> Text -> ImportModel -- | Create a value of ImportModel with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- ImportModel, importModel_dataAccessRoleArn - The Amazon -- Resource Name (ARN) of the AWS Identity and Management (IAM) role that -- allows Amazon Comprehend to use Amazon Key Management Service (KMS) to -- encrypt or decrypt the custom model. -- -- ImportModel, importModel_modelKmsKeyId - ID for the AWS -- Key Management Service (KMS) key that Amazon Comprehend uses to -- encrypt trained custom models. The ModelKmsKeyId can be either of the -- following formats: -- -- -- -- $sel:modelName:ImportModel', importModel_modelName - The -- name to assign to the custom model that is created in Amazon -- Comprehend by this import. -- -- $sel:tags:ImportModel', importModel_tags - Tags to be -- associated with the custom model that is created by this import. A tag -- is a key-value pair that adds as a metadata to a resource used by -- Amazon Comprehend. For example, a tag with "Sales" as the key might be -- added to a resource to indicate its use by the sales department. -- -- ImportModel, importModel_versionName - The version name -- given to the custom model that is created by this import. Version -- names can have a maximum of 256 characters. Alphanumeric characters, -- hyphens (-) and underscores (_) are allowed. The version name must be -- unique among all models with the same classifier name in the -- account/AWS Region. -- -- ImportModel, importModel_sourceModelArn - The Amazon -- Resource Name (ARN) of the custom model to import. newImportModel :: Text -> ImportModel -- | See: newImportModelResponse smart constructor. data ImportModelResponse ImportModelResponse' :: Maybe Text -> Int -> ImportModelResponse -- | Create a value of ImportModelResponse with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- ImportModelResponse, importModelResponse_modelArn - The -- Amazon Resource Name (ARN) of the custom model being imported. -- -- $sel:httpStatus:ImportModelResponse', -- importModelResponse_httpStatus - The response's http status -- code. newImportModelResponse :: Int -> ImportModelResponse -- | See: newListDocumentClassificationJobs smart -- constructor. data ListDocumentClassificationJobs ListDocumentClassificationJobs' :: Maybe DocumentClassificationJobFilter -> Maybe Natural -> Maybe Text -> ListDocumentClassificationJobs -- | Create a value of ListDocumentClassificationJobs with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:filter':ListDocumentClassificationJobs', -- listDocumentClassificationJobs_filter - Filters the jobs that -- are returned. You can filter jobs on their names, status, or the date -- and time that they were submitted. You can only set one filter at a -- time. -- -- $sel:maxResults:ListDocumentClassificationJobs', -- listDocumentClassificationJobs_maxResults - The maximum number -- of results to return in each page. The default is 100. -- -- ListDocumentClassificationJobs, -- listDocumentClassificationJobs_nextToken - Identifies the next -- page of results to return. newListDocumentClassificationJobs :: ListDocumentClassificationJobs -- | See: newListDocumentClassificationJobsResponse smart -- constructor. data ListDocumentClassificationJobsResponse ListDocumentClassificationJobsResponse' :: Maybe [DocumentClassificationJobProperties] -> Maybe Text -> Int -> ListDocumentClassificationJobsResponse -- | Create a value of ListDocumentClassificationJobsResponse with -- all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:documentClassificationJobPropertiesList:ListDocumentClassificationJobsResponse', -- listDocumentClassificationJobsResponse_documentClassificationJobPropertiesList -- - A list containing the properties of each job returned. -- -- ListDocumentClassificationJobs, -- listDocumentClassificationJobsResponse_nextToken - Identifies -- the next page of results to return. -- -- $sel:httpStatus:ListDocumentClassificationJobsResponse', -- listDocumentClassificationJobsResponse_httpStatus - The -- response's http status code. newListDocumentClassificationJobsResponse :: Int -> ListDocumentClassificationJobsResponse -- | See: newListDocumentClassifierSummaries smart -- constructor. data ListDocumentClassifierSummaries ListDocumentClassifierSummaries' :: Maybe Natural -> Maybe Text -> ListDocumentClassifierSummaries -- | Create a value of ListDocumentClassifierSummaries with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:maxResults:ListDocumentClassifierSummaries', -- listDocumentClassifierSummaries_maxResults - The maximum number -- of results to return on each page. The default is 100. -- -- ListDocumentClassifierSummaries, -- listDocumentClassifierSummaries_nextToken - Identifies the next -- page of results to return. newListDocumentClassifierSummaries :: ListDocumentClassifierSummaries -- | See: newListDocumentClassifierSummariesResponse smart -- constructor. data ListDocumentClassifierSummariesResponse ListDocumentClassifierSummariesResponse' :: Maybe [DocumentClassifierSummary] -> Maybe Text -> Int -> ListDocumentClassifierSummariesResponse -- | Create a value of ListDocumentClassifierSummariesResponse with -- all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:documentClassifierSummariesList:ListDocumentClassifierSummariesResponse', -- listDocumentClassifierSummariesResponse_documentClassifierSummariesList -- - The list of summaries of document classifiers. -- -- ListDocumentClassifierSummaries, -- listDocumentClassifierSummariesResponse_nextToken - Identifies -- the next page of results to return. -- -- $sel:httpStatus:ListDocumentClassifierSummariesResponse', -- listDocumentClassifierSummariesResponse_httpStatus - The -- response's http status code. newListDocumentClassifierSummariesResponse :: Int -> ListDocumentClassifierSummariesResponse -- | See: newListDocumentClassifiers smart constructor. data ListDocumentClassifiers ListDocumentClassifiers' :: Maybe DocumentClassifierFilter -> Maybe Natural -> Maybe Text -> ListDocumentClassifiers -- | Create a value of ListDocumentClassifiers with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:filter':ListDocumentClassifiers', -- listDocumentClassifiers_filter - Filters the jobs that are -- returned. You can filter jobs on their name, status, or the date and -- time that they were submitted. You can only set one filter at a time. -- -- $sel:maxResults:ListDocumentClassifiers', -- listDocumentClassifiers_maxResults - The maximum number of -- results to return in each page. The default is 100. -- -- ListDocumentClassifiers, -- listDocumentClassifiers_nextToken - Identifies the next page of -- results to return. newListDocumentClassifiers :: ListDocumentClassifiers -- | See: newListDocumentClassifiersResponse smart -- constructor. data ListDocumentClassifiersResponse ListDocumentClassifiersResponse' :: Maybe [DocumentClassifierProperties] -> Maybe Text -> Int -> ListDocumentClassifiersResponse -- | Create a value of ListDocumentClassifiersResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:documentClassifierPropertiesList:ListDocumentClassifiersResponse', -- listDocumentClassifiersResponse_documentClassifierPropertiesList -- - A list containing the properties of each job returned. -- -- ListDocumentClassifiers, -- listDocumentClassifiersResponse_nextToken - Identifies the next -- page of results to return. -- -- $sel:httpStatus:ListDocumentClassifiersResponse', -- listDocumentClassifiersResponse_httpStatus - The response's -- http status code. newListDocumentClassifiersResponse :: Int -> ListDocumentClassifiersResponse -- | See: newListDominantLanguageDetectionJobs smart -- constructor. data ListDominantLanguageDetectionJobs ListDominantLanguageDetectionJobs' :: Maybe DominantLanguageDetectionJobFilter -> Maybe Natural -> Maybe Text -> ListDominantLanguageDetectionJobs -- | Create a value of ListDominantLanguageDetectionJobs with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:filter':ListDominantLanguageDetectionJobs', -- listDominantLanguageDetectionJobs_filter - Filters that jobs -- that are returned. You can filter jobs on their name, status, or the -- date and time that they were submitted. You can only set one filter at -- a time. -- -- $sel:maxResults:ListDominantLanguageDetectionJobs', -- listDominantLanguageDetectionJobs_maxResults - The maximum -- number of results to return in each page. The default is 100. -- -- ListDominantLanguageDetectionJobs, -- listDominantLanguageDetectionJobs_nextToken - Identifies the -- next page of results to return. newListDominantLanguageDetectionJobs :: ListDominantLanguageDetectionJobs -- | See: newListDominantLanguageDetectionJobsResponse smart -- constructor. data ListDominantLanguageDetectionJobsResponse ListDominantLanguageDetectionJobsResponse' :: Maybe [DominantLanguageDetectionJobProperties] -> Maybe Text -> Int -> ListDominantLanguageDetectionJobsResponse -- | Create a value of ListDominantLanguageDetectionJobsResponse -- with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:dominantLanguageDetectionJobPropertiesList:ListDominantLanguageDetectionJobsResponse', -- listDominantLanguageDetectionJobsResponse_dominantLanguageDetectionJobPropertiesList -- - A list containing the properties of each job that is returned. -- -- ListDominantLanguageDetectionJobs, -- listDominantLanguageDetectionJobsResponse_nextToken - -- Identifies the next page of results to return. -- -- $sel:httpStatus:ListDominantLanguageDetectionJobsResponse', -- listDominantLanguageDetectionJobsResponse_httpStatus - The -- response's http status code. newListDominantLanguageDetectionJobsResponse :: Int -> ListDominantLanguageDetectionJobsResponse -- | See: newListEndpoints smart constructor. data ListEndpoints ListEndpoints' :: Maybe EndpointFilter -> Maybe Natural -> Maybe Text -> ListEndpoints -- | Create a value of ListEndpoints with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:filter':ListEndpoints', listEndpoints_filter - -- Filters the endpoints that are returned. You can filter endpoints on -- their name, model, status, or the date and time that they were -- created. You can only set one filter at a time. -- -- $sel:maxResults:ListEndpoints', listEndpoints_maxResults -- - The maximum number of results to return in each page. The default is -- 100. -- -- ListEndpoints, listEndpoints_nextToken - Identifies the -- next page of results to return. newListEndpoints :: ListEndpoints -- | See: newListEndpointsResponse smart constructor. data ListEndpointsResponse ListEndpointsResponse' :: Maybe [EndpointProperties] -> Maybe Text -> Int -> ListEndpointsResponse -- | Create a value of ListEndpointsResponse with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:endpointPropertiesList:ListEndpointsResponse', -- listEndpointsResponse_endpointPropertiesList - Displays a list -- of endpoint properties being retrieved by the service in response to -- the request. -- -- ListEndpoints, listEndpointsResponse_nextToken - -- Identifies the next page of results to return. -- -- $sel:httpStatus:ListEndpointsResponse', -- listEndpointsResponse_httpStatus - The response's http status -- code. newListEndpointsResponse :: Int -> ListEndpointsResponse -- | See: newListEntitiesDetectionJobs smart constructor. data ListEntitiesDetectionJobs ListEntitiesDetectionJobs' :: Maybe EntitiesDetectionJobFilter -> Maybe Natural -> Maybe Text -> ListEntitiesDetectionJobs -- | Create a value of ListEntitiesDetectionJobs with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:filter':ListEntitiesDetectionJobs', -- listEntitiesDetectionJobs_filter - Filters the jobs that are -- returned. You can filter jobs on their name, status, or the date and -- time that they were submitted. You can only set one filter at a time. -- -- $sel:maxResults:ListEntitiesDetectionJobs', -- listEntitiesDetectionJobs_maxResults - The maximum number of -- results to return in each page. The default is 100. -- -- ListEntitiesDetectionJobs, -- listEntitiesDetectionJobs_nextToken - Identifies the next page -- of results to return. newListEntitiesDetectionJobs :: ListEntitiesDetectionJobs -- | See: newListEntitiesDetectionJobsResponse smart -- constructor. data ListEntitiesDetectionJobsResponse ListEntitiesDetectionJobsResponse' :: Maybe [EntitiesDetectionJobProperties] -> Maybe Text -> Int -> ListEntitiesDetectionJobsResponse -- | Create a value of ListEntitiesDetectionJobsResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:entitiesDetectionJobPropertiesList:ListEntitiesDetectionJobsResponse', -- listEntitiesDetectionJobsResponse_entitiesDetectionJobPropertiesList -- - A list containing the properties of each job that is returned. -- -- ListEntitiesDetectionJobs, -- listEntitiesDetectionJobsResponse_nextToken - Identifies the -- next page of results to return. -- -- $sel:httpStatus:ListEntitiesDetectionJobsResponse', -- listEntitiesDetectionJobsResponse_httpStatus - The response's -- http status code. newListEntitiesDetectionJobsResponse :: Int -> ListEntitiesDetectionJobsResponse -- | See: newListEntityRecognizerSummaries smart constructor. data ListEntityRecognizerSummaries ListEntityRecognizerSummaries' :: Maybe Natural -> Maybe Text -> ListEntityRecognizerSummaries -- | Create a value of ListEntityRecognizerSummaries with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:maxResults:ListEntityRecognizerSummaries', -- listEntityRecognizerSummaries_maxResults - The maximum number -- of results to return on each page. The default is 100. -- -- ListEntityRecognizerSummaries, -- listEntityRecognizerSummaries_nextToken - Identifies the next -- page of results to return. newListEntityRecognizerSummaries :: ListEntityRecognizerSummaries -- | See: newListEntityRecognizerSummariesResponse smart -- constructor. data ListEntityRecognizerSummariesResponse ListEntityRecognizerSummariesResponse' :: Maybe [EntityRecognizerSummary] -> Maybe Text -> Int -> ListEntityRecognizerSummariesResponse -- | Create a value of ListEntityRecognizerSummariesResponse with -- all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:entityRecognizerSummariesList:ListEntityRecognizerSummariesResponse', -- listEntityRecognizerSummariesResponse_entityRecognizerSummariesList -- - The list entity recognizer summaries. -- -- ListEntityRecognizerSummaries, -- listEntityRecognizerSummariesResponse_nextToken - The list -- entity recognizer summaries. -- -- $sel:httpStatus:ListEntityRecognizerSummariesResponse', -- listEntityRecognizerSummariesResponse_httpStatus - The -- response's http status code. newListEntityRecognizerSummariesResponse :: Int -> ListEntityRecognizerSummariesResponse -- | See: newListEntityRecognizers smart constructor. data ListEntityRecognizers ListEntityRecognizers' :: Maybe EntityRecognizerFilter -> Maybe Natural -> Maybe Text -> ListEntityRecognizers -- | Create a value of ListEntityRecognizers with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:filter':ListEntityRecognizers', -- listEntityRecognizers_filter - Filters the list of entities -- returned. You can filter on Status, -- SubmitTimeBefore, or SubmitTimeAfter. You can only -- set one filter at a time. -- -- $sel:maxResults:ListEntityRecognizers', -- listEntityRecognizers_maxResults - The maximum number of -- results to return on each page. The default is 100. -- -- ListEntityRecognizers, listEntityRecognizers_nextToken - -- Identifies the next page of results to return. newListEntityRecognizers :: ListEntityRecognizers -- | See: newListEntityRecognizersResponse smart constructor. data ListEntityRecognizersResponse ListEntityRecognizersResponse' :: Maybe [EntityRecognizerProperties] -> Maybe Text -> Int -> ListEntityRecognizersResponse -- | Create a value of ListEntityRecognizersResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:entityRecognizerPropertiesList:ListEntityRecognizersResponse', -- listEntityRecognizersResponse_entityRecognizerPropertiesList - -- The list of properties of an entity recognizer. -- -- ListEntityRecognizers, -- listEntityRecognizersResponse_nextToken - Identifies the next -- page of results to return. -- -- $sel:httpStatus:ListEntityRecognizersResponse', -- listEntityRecognizersResponse_httpStatus - The response's http -- status code. newListEntityRecognizersResponse :: Int -> ListEntityRecognizersResponse -- | See: newListEventsDetectionJobs smart constructor. data ListEventsDetectionJobs ListEventsDetectionJobs' :: Maybe EventsDetectionJobFilter -> Maybe Natural -> Maybe Text -> ListEventsDetectionJobs -- | Create a value of ListEventsDetectionJobs with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:filter':ListEventsDetectionJobs', -- listEventsDetectionJobs_filter - Filters the jobs that are -- returned. You can filter jobs on their name, status, or the date and -- time that they were submitted. You can only set one filter at a time. -- -- $sel:maxResults:ListEventsDetectionJobs', -- listEventsDetectionJobs_maxResults - The maximum number of -- results to return in each page. -- -- ListEventsDetectionJobs, -- listEventsDetectionJobs_nextToken - Identifies the next page of -- results to return. newListEventsDetectionJobs :: ListEventsDetectionJobs -- | See: newListEventsDetectionJobsResponse smart -- constructor. data ListEventsDetectionJobsResponse ListEventsDetectionJobsResponse' :: Maybe [EventsDetectionJobProperties] -> Maybe Text -> Int -> ListEventsDetectionJobsResponse -- | Create a value of ListEventsDetectionJobsResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:eventsDetectionJobPropertiesList:ListEventsDetectionJobsResponse', -- listEventsDetectionJobsResponse_eventsDetectionJobPropertiesList -- - A list containing the properties of each job that is returned. -- -- ListEventsDetectionJobs, -- listEventsDetectionJobsResponse_nextToken - Identifies the next -- page of results to return. -- -- $sel:httpStatus:ListEventsDetectionJobsResponse', -- listEventsDetectionJobsResponse_httpStatus - The response's -- http status code. newListEventsDetectionJobsResponse :: Int -> ListEventsDetectionJobsResponse -- | See: newListKeyPhrasesDetectionJobs smart constructor. data ListKeyPhrasesDetectionJobs ListKeyPhrasesDetectionJobs' :: Maybe KeyPhrasesDetectionJobFilter -> Maybe Natural -> Maybe Text -> ListKeyPhrasesDetectionJobs -- | Create a value of ListKeyPhrasesDetectionJobs with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:filter':ListKeyPhrasesDetectionJobs', -- listKeyPhrasesDetectionJobs_filter - Filters the jobs that are -- returned. You can filter jobs on their name, status, or the date and -- time that they were submitted. You can only set one filter at a time. -- -- $sel:maxResults:ListKeyPhrasesDetectionJobs', -- listKeyPhrasesDetectionJobs_maxResults - The maximum number of -- results to return in each page. The default is 100. -- -- ListKeyPhrasesDetectionJobs, -- listKeyPhrasesDetectionJobs_nextToken - Identifies the next -- page of results to return. newListKeyPhrasesDetectionJobs :: ListKeyPhrasesDetectionJobs -- | See: newListKeyPhrasesDetectionJobsResponse smart -- constructor. data ListKeyPhrasesDetectionJobsResponse ListKeyPhrasesDetectionJobsResponse' :: Maybe [KeyPhrasesDetectionJobProperties] -> Maybe Text -> Int -> ListKeyPhrasesDetectionJobsResponse -- | Create a value of ListKeyPhrasesDetectionJobsResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:keyPhrasesDetectionJobPropertiesList:ListKeyPhrasesDetectionJobsResponse', -- listKeyPhrasesDetectionJobsResponse_keyPhrasesDetectionJobPropertiesList -- - A list containing the properties of each job that is returned. -- -- ListKeyPhrasesDetectionJobs, -- listKeyPhrasesDetectionJobsResponse_nextToken - Identifies the -- next page of results to return. -- -- $sel:httpStatus:ListKeyPhrasesDetectionJobsResponse', -- listKeyPhrasesDetectionJobsResponse_httpStatus - The response's -- http status code. newListKeyPhrasesDetectionJobsResponse :: Int -> ListKeyPhrasesDetectionJobsResponse -- | See: newListPiiEntitiesDetectionJobs smart constructor. data ListPiiEntitiesDetectionJobs ListPiiEntitiesDetectionJobs' :: Maybe PiiEntitiesDetectionJobFilter -> Maybe Natural -> Maybe Text -> ListPiiEntitiesDetectionJobs -- | Create a value of ListPiiEntitiesDetectionJobs with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:filter':ListPiiEntitiesDetectionJobs', -- listPiiEntitiesDetectionJobs_filter - Filters the jobs that are -- returned. You can filter jobs on their name, status, or the date and -- time that they were submitted. You can only set one filter at a time. -- -- $sel:maxResults:ListPiiEntitiesDetectionJobs', -- listPiiEntitiesDetectionJobs_maxResults - The maximum number of -- results to return in each page. -- -- ListPiiEntitiesDetectionJobs, -- listPiiEntitiesDetectionJobs_nextToken - Identifies the next -- page of results to return. newListPiiEntitiesDetectionJobs :: ListPiiEntitiesDetectionJobs -- | See: newListPiiEntitiesDetectionJobsResponse smart -- constructor. data ListPiiEntitiesDetectionJobsResponse ListPiiEntitiesDetectionJobsResponse' :: Maybe Text -> Maybe [PiiEntitiesDetectionJobProperties] -> Int -> ListPiiEntitiesDetectionJobsResponse -- | Create a value of ListPiiEntitiesDetectionJobsResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- ListPiiEntitiesDetectionJobs, -- listPiiEntitiesDetectionJobsResponse_nextToken - Identifies the -- next page of results to return. -- -- -- $sel:piiEntitiesDetectionJobPropertiesList:ListPiiEntitiesDetectionJobsResponse', -- listPiiEntitiesDetectionJobsResponse_piiEntitiesDetectionJobPropertiesList -- - A list containing the properties of each job that is returned. -- -- $sel:httpStatus:ListPiiEntitiesDetectionJobsResponse', -- listPiiEntitiesDetectionJobsResponse_httpStatus - The -- response's http status code. newListPiiEntitiesDetectionJobsResponse :: Int -> ListPiiEntitiesDetectionJobsResponse -- | See: newListSentimentDetectionJobs smart constructor. data ListSentimentDetectionJobs ListSentimentDetectionJobs' :: Maybe SentimentDetectionJobFilter -> Maybe Natural -> Maybe Text -> ListSentimentDetectionJobs -- | Create a value of ListSentimentDetectionJobs with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:filter':ListSentimentDetectionJobs', -- listSentimentDetectionJobs_filter - Filters the jobs that are -- returned. You can filter jobs on their name, status, or the date and -- time that they were submitted. You can only set one filter at a time. -- -- $sel:maxResults:ListSentimentDetectionJobs', -- listSentimentDetectionJobs_maxResults - The maximum number of -- results to return in each page. The default is 100. -- -- ListSentimentDetectionJobs, -- listSentimentDetectionJobs_nextToken - Identifies the next page -- of results to return. newListSentimentDetectionJobs :: ListSentimentDetectionJobs -- | See: newListSentimentDetectionJobsResponse smart -- constructor. data ListSentimentDetectionJobsResponse ListSentimentDetectionJobsResponse' :: Maybe Text -> Maybe [SentimentDetectionJobProperties] -> Int -> ListSentimentDetectionJobsResponse -- | Create a value of ListSentimentDetectionJobsResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- ListSentimentDetectionJobs, -- listSentimentDetectionJobsResponse_nextToken - Identifies the -- next page of results to return. -- -- -- $sel:sentimentDetectionJobPropertiesList:ListSentimentDetectionJobsResponse', -- listSentimentDetectionJobsResponse_sentimentDetectionJobPropertiesList -- - A list containing the properties of each job that is returned. -- -- $sel:httpStatus:ListSentimentDetectionJobsResponse', -- listSentimentDetectionJobsResponse_httpStatus - The response's -- http status code. newListSentimentDetectionJobsResponse :: Int -> ListSentimentDetectionJobsResponse -- | See: newListTagsForResource smart constructor. data ListTagsForResource ListTagsForResource' :: Text -> ListTagsForResource -- | Create a value of ListTagsForResource with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- ListTagsForResource, listTagsForResource_resourceArn - -- The Amazon Resource Name (ARN) of the given Amazon Comprehend resource -- you are querying. newListTagsForResource :: Text -> ListTagsForResource -- | See: newListTagsForResourceResponse smart constructor. data ListTagsForResourceResponse ListTagsForResourceResponse' :: Maybe Text -> Maybe [Tag] -> Int -> ListTagsForResourceResponse -- | Create a value of ListTagsForResourceResponse with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- ListTagsForResource, -- listTagsForResourceResponse_resourceArn - The Amazon Resource -- Name (ARN) of the given Amazon Comprehend resource you are querying. -- -- $sel:tags:ListTagsForResourceResponse', -- listTagsForResourceResponse_tags - Tags associated with the -- Amazon Comprehend resource being queried. A tag is a key-value pair -- that adds as a metadata to a resource used by Amazon Comprehend. For -- example, a tag with "Sales" as the key might be added to a resource to -- indicate its use by the sales department. -- -- $sel:httpStatus:ListTagsForResourceResponse', -- listTagsForResourceResponse_httpStatus - The response's http -- status code. newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse -- | See: newListTargetedSentimentDetectionJobs smart -- constructor. data ListTargetedSentimentDetectionJobs ListTargetedSentimentDetectionJobs' :: Maybe TargetedSentimentDetectionJobFilter -> Maybe Natural -> Maybe Text -> ListTargetedSentimentDetectionJobs -- | Create a value of ListTargetedSentimentDetectionJobs with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:filter':ListTargetedSentimentDetectionJobs', -- listTargetedSentimentDetectionJobs_filter - Filters the jobs -- that are returned. You can filter jobs on their name, status, or the -- date and time that they were submitted. You can only set one filter at -- a time. -- -- $sel:maxResults:ListTargetedSentimentDetectionJobs', -- listTargetedSentimentDetectionJobs_maxResults - The maximum -- number of results to return in each page. The default is 100. -- -- ListTargetedSentimentDetectionJobs, -- listTargetedSentimentDetectionJobs_nextToken - Identifies the -- next page of results to return. newListTargetedSentimentDetectionJobs :: ListTargetedSentimentDetectionJobs -- | See: newListTargetedSentimentDetectionJobsResponse smart -- constructor. data ListTargetedSentimentDetectionJobsResponse ListTargetedSentimentDetectionJobsResponse' :: Maybe Text -> Maybe [TargetedSentimentDetectionJobProperties] -> Int -> ListTargetedSentimentDetectionJobsResponse -- | Create a value of ListTargetedSentimentDetectionJobsResponse -- with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- ListTargetedSentimentDetectionJobs, -- listTargetedSentimentDetectionJobsResponse_nextToken - -- Identifies the next page of results to return. -- -- -- $sel:targetedSentimentDetectionJobPropertiesList:ListTargetedSentimentDetectionJobsResponse', -- listTargetedSentimentDetectionJobsResponse_targetedSentimentDetectionJobPropertiesList -- - A list containing the properties of each job that is returned. -- -- $sel:httpStatus:ListTargetedSentimentDetectionJobsResponse', -- listTargetedSentimentDetectionJobsResponse_httpStatus - The -- response's http status code. newListTargetedSentimentDetectionJobsResponse :: Int -> ListTargetedSentimentDetectionJobsResponse -- | See: newListTopicsDetectionJobs smart constructor. data ListTopicsDetectionJobs ListTopicsDetectionJobs' :: Maybe TopicsDetectionJobFilter -> Maybe Natural -> Maybe Text -> ListTopicsDetectionJobs -- | Create a value of ListTopicsDetectionJobs with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:filter':ListTopicsDetectionJobs', -- listTopicsDetectionJobs_filter - Filters the jobs that are -- returned. Jobs can be filtered on their name, status, or the date and -- time that they were submitted. You can set only one filter at a time. -- -- $sel:maxResults:ListTopicsDetectionJobs', -- listTopicsDetectionJobs_maxResults - The maximum number of -- results to return in each page. The default is 100. -- -- ListTopicsDetectionJobs, -- listTopicsDetectionJobs_nextToken - Identifies the next page of -- results to return. newListTopicsDetectionJobs :: ListTopicsDetectionJobs -- | See: newListTopicsDetectionJobsResponse smart -- constructor. data ListTopicsDetectionJobsResponse ListTopicsDetectionJobsResponse' :: Maybe Text -> Maybe [TopicsDetectionJobProperties] -> Int -> ListTopicsDetectionJobsResponse -- | Create a value of ListTopicsDetectionJobsResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- ListTopicsDetectionJobs, -- listTopicsDetectionJobsResponse_nextToken - Identifies the next -- page of results to return. -- -- -- $sel:topicsDetectionJobPropertiesList:ListTopicsDetectionJobsResponse', -- listTopicsDetectionJobsResponse_topicsDetectionJobPropertiesList -- - A list containing the properties of each job that is returned. -- -- $sel:httpStatus:ListTopicsDetectionJobsResponse', -- listTopicsDetectionJobsResponse_httpStatus - The response's -- http status code. newListTopicsDetectionJobsResponse :: Int -> ListTopicsDetectionJobsResponse -- | See: newPutResourcePolicy smart constructor. data PutResourcePolicy PutResourcePolicy' :: Maybe Text -> Text -> Text -> PutResourcePolicy -- | Create a value of PutResourcePolicy with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- PutResourcePolicy, putResourcePolicy_policyRevisionId - -- The revision ID that Amazon Comprehend assigned to the policy that you -- are updating. If you are creating a new policy that has no prior -- version, don't use this parameter. Amazon Comprehend creates the -- revision ID for you. -- -- $sel:resourceArn:PutResourcePolicy', -- putResourcePolicy_resourceArn - The Amazon Resource Name (ARN) -- of the custom model to attach the policy to. -- -- $sel:resourcePolicy:PutResourcePolicy', -- putResourcePolicy_resourcePolicy - The JSON resource-based -- policy to attach to your custom model. Provide your JSON as a UTF-8 -- encoded string without line breaks. To provide valid JSON for your -- policy, enclose the attribute names and values in double quotes. If -- the JSON body is also enclosed in double quotes, then you must escape -- the double quotes that are inside the policy: -- -- 
--   "{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
--
-- -- To avoid escaping quotes, you can use single quotes to enclose the -- policy and double quotes to enclose the JSON names and values: -- -- 
--   '{"attribute": "value", "attribute": ["value"]}'
--
newPutResourcePolicy :: Text -> Text -> PutResourcePolicy -- | See: newPutResourcePolicyResponse smart constructor. data PutResourcePolicyResponse PutResourcePolicyResponse' :: Maybe Text -> Int -> PutResourcePolicyResponse -- | Create a value of PutResourcePolicyResponse with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- PutResourcePolicy, -- putResourcePolicyResponse_policyRevisionId - The revision ID of -- the policy. Each time you modify a policy, Amazon Comprehend assigns a -- new revision ID, and it deletes the prior version of the policy. -- -- $sel:httpStatus:PutResourcePolicyResponse', -- putResourcePolicyResponse_httpStatus - The response's http -- status code. newPutResourcePolicyResponse :: Int -> PutResourcePolicyResponse -- | See: newStartDocumentClassificationJob smart -- constructor. data StartDocumentClassificationJob StartDocumentClassificationJob' :: Maybe Text -> Maybe Text -> Maybe [Tag] -> Maybe Text -> Maybe VpcConfig -> Text -> InputDataConfig -> OutputDataConfig -> Text -> StartDocumentClassificationJob -- | Create a value of StartDocumentClassificationJob with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:clientRequestToken:StartDocumentClassificationJob', -- startDocumentClassificationJob_clientRequestToken - A unique -- identifier for the request. If you do not set the client request -- token, Amazon Comprehend generates one. -- -- StartDocumentClassificationJob, -- startDocumentClassificationJob_jobName - The identifier of the -- job. -- -- $sel:tags:StartDocumentClassificationJob', -- startDocumentClassificationJob_tags - Tags to be associated -- with the document classification job. A tag is a key-value pair that -- adds metadata to a resource used by Amazon Comprehend. For example, a -- tag with "Sales" as the key might be added to a resource to indicate -- its use by the sales department. -- -- StartDocumentClassificationJob, -- startDocumentClassificationJob_volumeKmsKeyId - ID for the AWS -- Key Management Service (KMS) key that Amazon Comprehend uses to -- encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- -- -- StartDocumentClassificationJob, -- startDocumentClassificationJob_vpcConfig - Configuration -- parameters for an optional private Virtual Private Cloud (VPC) -- containing the resources you are using for your document -- classification job. For more information, see Amazon VPC. -- -- StartDocumentClassificationJob, -- startDocumentClassificationJob_documentClassifierArn - The -- Amazon Resource Name (ARN) of the document classifier to use to -- process the job. -- -- StartDocumentClassificationJob, -- startDocumentClassificationJob_inputDataConfig - Specifies the -- format and location of the input data for the job. -- -- StartDocumentClassificationJob, -- startDocumentClassificationJob_outputDataConfig - Specifies -- where to send the output files. -- -- StartDocumentClassificationJob, -- startDocumentClassificationJob_dataAccessRoleArn - The Amazon -- Resource Name (ARN) of the AWS Identity and Access Management (IAM) -- role that grants Amazon Comprehend read access to your input data. newStartDocumentClassificationJob :: Text -> InputDataConfig -> OutputDataConfig -> Text -> StartDocumentClassificationJob -- | See: newStartDocumentClassificationJobResponse smart -- constructor. data StartDocumentClassificationJobResponse StartDocumentClassificationJobResponse' :: Maybe Text -> Maybe Text -> Maybe JobStatus -> Int -> StartDocumentClassificationJobResponse -- | Create a value of StartDocumentClassificationJobResponse with -- all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StartDocumentClassificationJobResponse, -- startDocumentClassificationJobResponse_jobArn - The Amazon -- Resource Name (ARN) of the document classification job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- StartDocumentClassificationJobResponse, -- startDocumentClassificationJobResponse_jobId - The identifier -- generated for the job. To get the status of the job, use this -- identifier with the operation. -- -- StartDocumentClassificationJobResponse, -- startDocumentClassificationJobResponse_jobStatus - The status -- of the job: -- -- -- -- $sel:httpStatus:StartDocumentClassificationJobResponse', -- startDocumentClassificationJobResponse_httpStatus - The -- response's http status code. newStartDocumentClassificationJobResponse :: Int -> StartDocumentClassificationJobResponse -- | See: newStartDominantLanguageDetectionJob smart -- constructor. data StartDominantLanguageDetectionJob StartDominantLanguageDetectionJob' :: Maybe Text -> Maybe Text -> Maybe [Tag] -> Maybe Text -> Maybe VpcConfig -> InputDataConfig -> OutputDataConfig -> Text -> StartDominantLanguageDetectionJob -- | Create a value of StartDominantLanguageDetectionJob with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:clientRequestToken:StartDominantLanguageDetectionJob', -- startDominantLanguageDetectionJob_clientRequestToken - A unique -- identifier for the request. If you do not set the client request -- token, Amazon Comprehend generates one. -- -- StartDominantLanguageDetectionJob, -- startDominantLanguageDetectionJob_jobName - An identifier for -- the job. -- -- $sel:tags:StartDominantLanguageDetectionJob', -- startDominantLanguageDetectionJob_tags - Tags to be associated -- with the dominant language detection job. A tag is a key-value pair -- that adds metadata to a resource used by Amazon Comprehend. For -- example, a tag with "Sales" as the key might be added to a resource to -- indicate its use by the sales department. -- -- StartDominantLanguageDetectionJob, -- startDominantLanguageDetectionJob_volumeKmsKeyId - ID for the -- AWS Key Management Service (KMS) key that Amazon Comprehend uses to -- encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- -- -- StartDominantLanguageDetectionJob, -- startDominantLanguageDetectionJob_vpcConfig - Configuration -- parameters for an optional private Virtual Private Cloud (VPC) -- containing the resources you are using for your dominant language -- detection job. For more information, see Amazon VPC. -- -- StartDominantLanguageDetectionJob, -- startDominantLanguageDetectionJob_inputDataConfig - Specifies -- the format and location of the input data for the job. -- -- StartDominantLanguageDetectionJob, -- startDominantLanguageDetectionJob_outputDataConfig - Specifies -- where to send the output files. -- -- StartDominantLanguageDetectionJob, -- startDominantLanguageDetectionJob_dataAccessRoleArn - The -- Amazon Resource Name (ARN) of the AWS Identity and Access Management -- (IAM) role 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. newStartDominantLanguageDetectionJob :: InputDataConfig -> OutputDataConfig -> Text -> StartDominantLanguageDetectionJob -- | See: newStartDominantLanguageDetectionJobResponse smart -- constructor. data StartDominantLanguageDetectionJobResponse StartDominantLanguageDetectionJobResponse' :: Maybe Text -> Maybe Text -> Maybe JobStatus -> Int -> StartDominantLanguageDetectionJobResponse -- | Create a value of StartDominantLanguageDetectionJobResponse -- with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StartDominantLanguageDetectionJobResponse, -- startDominantLanguageDetectionJobResponse_jobArn - The Amazon -- Resource Name (ARN) of the dominant language detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- StartDominantLanguageDetectionJobResponse, -- startDominantLanguageDetectionJobResponse_jobId - The -- identifier generated for the job. To get the status of a job, use this -- identifier with the operation. -- -- StartDominantLanguageDetectionJobResponse, -- startDominantLanguageDetectionJobResponse_jobStatus - The -- status of the job. -- -- -- -- $sel:httpStatus:StartDominantLanguageDetectionJobResponse', -- startDominantLanguageDetectionJobResponse_httpStatus - The -- response's http status code. newStartDominantLanguageDetectionJobResponse :: Int -> StartDominantLanguageDetectionJobResponse -- | See: newStartEntitiesDetectionJob smart constructor. data StartEntitiesDetectionJob StartEntitiesDetectionJob' :: Maybe Text -> Maybe Text -> Maybe Text -> Maybe [Tag] -> Maybe Text -> Maybe VpcConfig -> InputDataConfig -> OutputDataConfig -> Text -> LanguageCode -> StartEntitiesDetectionJob -- | Create a value of StartEntitiesDetectionJob with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:clientRequestToken:StartEntitiesDetectionJob', -- startEntitiesDetectionJob_clientRequestToken - A unique -- identifier for the request. If you don't set the client request token, -- Amazon Comprehend generates one. -- -- StartEntitiesDetectionJob, -- startEntitiesDetectionJob_entityRecognizerArn - The Amazon -- Resource Name (ARN) that identifies the specific entity recognizer to -- be used by the StartEntitiesDetectionJob. This ARN is -- optional and is only used for a custom entity recognition job. -- -- StartEntitiesDetectionJob, -- startEntitiesDetectionJob_jobName - The identifier of the job. -- -- $sel:tags:StartEntitiesDetectionJob', -- startEntitiesDetectionJob_tags - Tags to be associated with the -- entities detection job. A tag is a key-value pair that adds metadata -- to a resource used by Amazon Comprehend. For example, a tag with -- "Sales" as the key might be added to a resource to indicate its use by -- the sales department. -- -- StartEntitiesDetectionJob, -- startEntitiesDetectionJob_volumeKmsKeyId - ID for the AWS Key -- Management Service (KMS) key that Amazon Comprehend uses to encrypt -- data on the storage volume attached to the ML compute instance(s) that -- process the analysis job. The VolumeKmsKeyId can be either of the -- following formats: -- -- -- -- StartEntitiesDetectionJob, -- startEntitiesDetectionJob_vpcConfig - Configuration parameters -- for an optional private Virtual Private Cloud (VPC) containing the -- resources you are using for your entity detection job. For more -- information, see Amazon VPC. -- -- StartEntitiesDetectionJob, -- startEntitiesDetectionJob_inputDataConfig - Specifies the -- format and location of the input data for the job. -- -- StartEntitiesDetectionJob, -- startEntitiesDetectionJob_outputDataConfig - Specifies where to -- send the output files. -- -- StartEntitiesDetectionJob, -- startEntitiesDetectionJob_dataAccessRoleArn - The Amazon -- Resource Name (ARN) of the AWS Identity and Access Management (IAM) -- role 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. -- -- StartEntitiesDetectionJob, -- startEntitiesDetectionJob_languageCode - The language of the -- input documents. All documents must be in the same language. You can -- specify any of the languages supported by Amazon Comprehend. If custom -- entities recognition is used, this parameter is ignored and the -- language used for training the model is used instead. newStartEntitiesDetectionJob :: InputDataConfig -> OutputDataConfig -> Text -> LanguageCode -> StartEntitiesDetectionJob -- | See: newStartEntitiesDetectionJobResponse smart -- constructor. data StartEntitiesDetectionJobResponse StartEntitiesDetectionJobResponse' :: Maybe Text -> Maybe Text -> Maybe JobStatus -> Int -> StartEntitiesDetectionJobResponse -- | Create a value of StartEntitiesDetectionJobResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StartEntitiesDetectionJobResponse, -- startEntitiesDetectionJobResponse_jobArn - The Amazon Resource -- Name (ARN) of the entities detection job. It is a unique, fully -- qualified identifier for the job. It includes the AWS account, Region, -- and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- StartEntitiesDetectionJobResponse, -- startEntitiesDetectionJobResponse_jobId - The identifier -- generated for the job. To get the status of job, use this identifier -- with the operation. -- -- StartEntitiesDetectionJobResponse, -- startEntitiesDetectionJobResponse_jobStatus - The status of the -- job. -- -- -- -- $sel:httpStatus:StartEntitiesDetectionJobResponse', -- startEntitiesDetectionJobResponse_httpStatus - The response's -- http status code. newStartEntitiesDetectionJobResponse :: Int -> StartEntitiesDetectionJobResponse -- | See: newStartEventsDetectionJob smart constructor. data StartEventsDetectionJob StartEventsDetectionJob' :: Maybe Text -> Maybe Text -> Maybe [Tag] -> InputDataConfig -> OutputDataConfig -> Text -> LanguageCode -> NonEmpty Text -> StartEventsDetectionJob -- | Create a value of StartEventsDetectionJob with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:clientRequestToken:StartEventsDetectionJob', -- startEventsDetectionJob_clientRequestToken - An unique -- identifier for the request. If you don't set the client request token, -- Amazon Comprehend generates one. -- -- StartEventsDetectionJob, startEventsDetectionJob_jobName -- - The identifier of the events detection job. -- -- $sel:tags:StartEventsDetectionJob', -- startEventsDetectionJob_tags - Tags to be associated with the -- events detection job. A tag is a key-value pair that adds metadata to -- a resource used by Amazon Comprehend. For example, a tag with "Sales" -- as the key might be added to a resource to indicate its use by the -- sales department. -- -- StartEventsDetectionJob, -- startEventsDetectionJob_inputDataConfig - Specifies the format -- and location of the input data for the job. -- -- StartEventsDetectionJob, -- startEventsDetectionJob_outputDataConfig - Specifies where to -- send the output files. -- -- StartEventsDetectionJob, -- startEventsDetectionJob_dataAccessRoleArn - The Amazon Resource -- Name (ARN) of the AWS Identity and Access Management (IAM) role that -- grants Amazon Comprehend read access to your input data. -- -- StartEventsDetectionJob, -- startEventsDetectionJob_languageCode - The language code of the -- input documents. -- -- StartEventsDetectionJob, -- startEventsDetectionJob_targetEventTypes - The types of events -- to detect in the input documents. newStartEventsDetectionJob :: InputDataConfig -> OutputDataConfig -> Text -> LanguageCode -> NonEmpty Text -> StartEventsDetectionJob -- | See: newStartEventsDetectionJobResponse smart -- constructor. data StartEventsDetectionJobResponse StartEventsDetectionJobResponse' :: Maybe Text -> Maybe Text -> Maybe JobStatus -> Int -> StartEventsDetectionJobResponse -- | Create a value of StartEventsDetectionJobResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StartEventsDetectionJobResponse, -- startEventsDetectionJobResponse_jobArn - The Amazon Resource -- Name (ARN) of the events detection job. It is a unique, fully -- qualified identifier for the job. It includes the AWS account, Region, -- and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- StartEventsDetectionJobResponse, -- startEventsDetectionJobResponse_jobId - An unique identifier -- for the request. If you don't set the client request token, Amazon -- Comprehend generates one. -- -- StartEventsDetectionJobResponse, -- startEventsDetectionJobResponse_jobStatus - The status of the -- events detection job. -- -- $sel:httpStatus:StartEventsDetectionJobResponse', -- startEventsDetectionJobResponse_httpStatus - The response's -- http status code. newStartEventsDetectionJobResponse :: Int -> StartEventsDetectionJobResponse -- | See: newStartKeyPhrasesDetectionJob smart constructor. data StartKeyPhrasesDetectionJob StartKeyPhrasesDetectionJob' :: Maybe Text -> Maybe Text -> Maybe [Tag] -> Maybe Text -> Maybe VpcConfig -> InputDataConfig -> OutputDataConfig -> Text -> LanguageCode -> StartKeyPhrasesDetectionJob -- | Create a value of StartKeyPhrasesDetectionJob with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:clientRequestToken:StartKeyPhrasesDetectionJob', -- startKeyPhrasesDetectionJob_clientRequestToken - A unique -- identifier for the request. If you don't set the client request token, -- Amazon Comprehend generates one. -- -- StartKeyPhrasesDetectionJob, -- startKeyPhrasesDetectionJob_jobName - The identifier of the -- job. -- -- $sel:tags:StartKeyPhrasesDetectionJob', -- startKeyPhrasesDetectionJob_tags - Tags to be associated with -- the key phrases detection job. A tag is a key-value pair that adds -- metadata to a resource used by Amazon Comprehend. For example, a tag -- with "Sales" as the key might be added to a resource to indicate its -- use by the sales department. -- -- StartKeyPhrasesDetectionJob, -- startKeyPhrasesDetectionJob_volumeKmsKeyId - ID for the AWS Key -- Management Service (KMS) key that Amazon Comprehend uses to encrypt -- data on the storage volume attached to the ML compute instance(s) that -- process the analysis job. The VolumeKmsKeyId can be either of the -- following formats: -- -- -- -- StartKeyPhrasesDetectionJob, -- startKeyPhrasesDetectionJob_vpcConfig - Configuration -- parameters for an optional private Virtual Private Cloud (VPC) -- containing the resources you are using for your key phrases detection -- job. For more information, see Amazon VPC. -- -- StartKeyPhrasesDetectionJob, -- startKeyPhrasesDetectionJob_inputDataConfig - Specifies the -- format and location of the input data for the job. -- -- StartKeyPhrasesDetectionJob, -- startKeyPhrasesDetectionJob_outputDataConfig - Specifies where -- to send the output files. -- -- StartKeyPhrasesDetectionJob, -- startKeyPhrasesDetectionJob_dataAccessRoleArn - The Amazon -- Resource Name (ARN) of the AWS Identity and Access Management (IAM) -- role 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. -- -- StartKeyPhrasesDetectionJob, -- startKeyPhrasesDetectionJob_languageCode - The language of the -- input documents. You can specify any of the primary languages -- supported by Amazon Comprehend. All documents must be in the same -- language. newStartKeyPhrasesDetectionJob :: InputDataConfig -> OutputDataConfig -> Text -> LanguageCode -> StartKeyPhrasesDetectionJob -- | See: newStartKeyPhrasesDetectionJobResponse smart -- constructor. data StartKeyPhrasesDetectionJobResponse StartKeyPhrasesDetectionJobResponse' :: Maybe Text -> Maybe Text -> Maybe JobStatus -> Int -> StartKeyPhrasesDetectionJobResponse -- | Create a value of StartKeyPhrasesDetectionJobResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StartKeyPhrasesDetectionJobResponse, -- startKeyPhrasesDetectionJobResponse_jobArn - The Amazon -- Resource Name (ARN) of the key phrase detection job. It is a unique, -- fully qualified identifier for the job. It includes the AWS account, -- Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- StartKeyPhrasesDetectionJobResponse, -- startKeyPhrasesDetectionJobResponse_jobId - The identifier -- generated for the job. To get the status of a job, use this identifier -- with the operation. -- -- StartKeyPhrasesDetectionJobResponse, -- startKeyPhrasesDetectionJobResponse_jobStatus - The status of -- the job. -- -- -- -- $sel:httpStatus:StartKeyPhrasesDetectionJobResponse', -- startKeyPhrasesDetectionJobResponse_httpStatus - The response's -- http status code. newStartKeyPhrasesDetectionJobResponse :: Int -> StartKeyPhrasesDetectionJobResponse -- | See: newStartPiiEntitiesDetectionJob smart constructor. data StartPiiEntitiesDetectionJob StartPiiEntitiesDetectionJob' :: Maybe Text -> Maybe Text -> Maybe RedactionConfig -> Maybe [Tag] -> InputDataConfig -> OutputDataConfig -> PiiEntitiesDetectionMode -> Text -> LanguageCode -> StartPiiEntitiesDetectionJob -- | Create a value of StartPiiEntitiesDetectionJob with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:clientRequestToken:StartPiiEntitiesDetectionJob', -- startPiiEntitiesDetectionJob_clientRequestToken - A unique -- identifier for the request. If you don't set the client request token, -- Amazon Comprehend generates one. -- -- StartPiiEntitiesDetectionJob, -- startPiiEntitiesDetectionJob_jobName - The identifier of the -- job. -- -- StartPiiEntitiesDetectionJob, -- startPiiEntitiesDetectionJob_redactionConfig - Provides -- configuration parameters for PII entity redaction. -- -- This parameter is required if you set the Mode parameter to -- ONLY_REDACTION. In that case, you must provide a -- RedactionConfig definition that includes the -- PiiEntityTypes parameter. -- -- $sel:tags:StartPiiEntitiesDetectionJob', -- startPiiEntitiesDetectionJob_tags - Tags to be associated with -- the PII entities detection job. A tag is a key-value pair that adds -- metadata to a resource used by Amazon Comprehend. For example, a tag -- with "Sales" as the key might be added to a resource to indicate its -- use by the sales department. -- -- StartPiiEntitiesDetectionJob, -- startPiiEntitiesDetectionJob_inputDataConfig - The input -- properties for a PII entities detection job. -- -- StartPiiEntitiesDetectionJob, -- startPiiEntitiesDetectionJob_outputDataConfig - Provides -- configuration parameters for the output of PII entity detection jobs. -- -- StartPiiEntitiesDetectionJob, -- startPiiEntitiesDetectionJob_mode - Specifies whether the -- output provides the locations (offsets) of PII entities or a file in -- which PII entities are redacted. -- -- StartPiiEntitiesDetectionJob, -- startPiiEntitiesDetectionJob_dataAccessRoleArn - The Amazon -- Resource Name (ARN) of the AWS Identity and Access Management (IAM) -- role that grants Amazon Comprehend read access to your input data. -- -- StartPiiEntitiesDetectionJob, -- startPiiEntitiesDetectionJob_languageCode - The language of the -- input documents. Currently, English is the only valid language. newStartPiiEntitiesDetectionJob :: InputDataConfig -> OutputDataConfig -> PiiEntitiesDetectionMode -> Text -> LanguageCode -> StartPiiEntitiesDetectionJob -- | See: newStartPiiEntitiesDetectionJobResponse smart -- constructor. data StartPiiEntitiesDetectionJobResponse StartPiiEntitiesDetectionJobResponse' :: Maybe Text -> Maybe Text -> Maybe JobStatus -> Int -> StartPiiEntitiesDetectionJobResponse -- | Create a value of StartPiiEntitiesDetectionJobResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StartPiiEntitiesDetectionJobResponse, -- startPiiEntitiesDetectionJobResponse_jobArn - The Amazon -- Resource Name (ARN) of the PII entity detection job. It is a unique, -- fully qualified identifier for the job. It includes the AWS account, -- Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- StartPiiEntitiesDetectionJobResponse, -- startPiiEntitiesDetectionJobResponse_jobId - The identifier -- generated for the job. -- -- StartPiiEntitiesDetectionJobResponse, -- startPiiEntitiesDetectionJobResponse_jobStatus - The status of -- the job. -- -- $sel:httpStatus:StartPiiEntitiesDetectionJobResponse', -- startPiiEntitiesDetectionJobResponse_httpStatus - The -- response's http status code. newStartPiiEntitiesDetectionJobResponse :: Int -> StartPiiEntitiesDetectionJobResponse -- | See: newStartSentimentDetectionJob smart constructor. data StartSentimentDetectionJob StartSentimentDetectionJob' :: Maybe Text -> Maybe Text -> Maybe [Tag] -> Maybe Text -> Maybe VpcConfig -> InputDataConfig -> OutputDataConfig -> Text -> LanguageCode -> StartSentimentDetectionJob -- | Create a value of StartSentimentDetectionJob with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:clientRequestToken:StartSentimentDetectionJob', -- startSentimentDetectionJob_clientRequestToken - A unique -- identifier for the request. If you don't set the client request token, -- Amazon Comprehend generates one. -- -- StartSentimentDetectionJob, -- startSentimentDetectionJob_jobName - The identifier of the job. -- -- $sel:tags:StartSentimentDetectionJob', -- startSentimentDetectionJob_tags - Tags to be associated with -- the sentiment detection job. A tag is a key-value pair that adds -- metadata to a resource used by Amazon Comprehend. For example, a tag -- with "Sales" as the key might be added to a resource to indicate its -- use by the sales department. -- -- StartSentimentDetectionJob, -- startSentimentDetectionJob_volumeKmsKeyId - ID for the AWS Key -- Management Service (KMS) key that Amazon Comprehend uses to encrypt -- data on the storage volume attached to the ML compute instance(s) that -- process the analysis job. The VolumeKmsKeyId can be either of the -- following formats: -- -- -- -- StartSentimentDetectionJob, -- startSentimentDetectionJob_vpcConfig - Configuration parameters -- for an optional private Virtual Private Cloud (VPC) containing the -- resources you are using for your sentiment detection job. For more -- information, see Amazon VPC. -- -- StartSentimentDetectionJob, -- startSentimentDetectionJob_inputDataConfig - Specifies the -- format and location of the input data for the job. -- -- StartSentimentDetectionJob, -- startSentimentDetectionJob_outputDataConfig - Specifies where -- to send the output files. -- -- StartSentimentDetectionJob, -- startSentimentDetectionJob_dataAccessRoleArn - The Amazon -- Resource Name (ARN) of the AWS Identity and Access Management (IAM) -- role 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. -- -- StartSentimentDetectionJob, -- startSentimentDetectionJob_languageCode - The language of the -- input documents. You can specify any of the primary languages -- supported by Amazon Comprehend. All documents must be in the same -- language. newStartSentimentDetectionJob :: InputDataConfig -> OutputDataConfig -> Text -> LanguageCode -> StartSentimentDetectionJob -- | See: newStartSentimentDetectionJobResponse smart -- constructor. data StartSentimentDetectionJobResponse StartSentimentDetectionJobResponse' :: Maybe Text -> Maybe Text -> Maybe JobStatus -> Int -> StartSentimentDetectionJobResponse -- | Create a value of StartSentimentDetectionJobResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StartSentimentDetectionJobResponse, -- startSentimentDetectionJobResponse_jobArn - The Amazon Resource -- Name (ARN) of the sentiment detection job. It is a unique, fully -- qualified identifier for the job. It includes the AWS account, Region, -- and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- StartSentimentDetectionJobResponse, -- startSentimentDetectionJobResponse_jobId - The identifier -- generated for the job. To get the status of a job, use this identifier -- with the operation. -- -- StartSentimentDetectionJobResponse, -- startSentimentDetectionJobResponse_jobStatus - The status of -- the job. -- -- -- -- $sel:httpStatus:StartSentimentDetectionJobResponse', -- startSentimentDetectionJobResponse_httpStatus - The response's -- http status code. newStartSentimentDetectionJobResponse :: Int -> StartSentimentDetectionJobResponse -- | See: newStartTargetedSentimentDetectionJob smart -- constructor. data StartTargetedSentimentDetectionJob StartTargetedSentimentDetectionJob' :: Maybe Text -> Maybe Text -> Maybe [Tag] -> Maybe Text -> Maybe VpcConfig -> InputDataConfig -> OutputDataConfig -> Text -> LanguageCode -> StartTargetedSentimentDetectionJob -- | Create a value of StartTargetedSentimentDetectionJob with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:clientRequestToken:StartTargetedSentimentDetectionJob', -- startTargetedSentimentDetectionJob_clientRequestToken - A -- unique identifier for the request. If you don't set the client request -- token, Amazon Comprehend generates one. -- -- StartTargetedSentimentDetectionJob, -- startTargetedSentimentDetectionJob_jobName - The identifier of -- the job. -- -- $sel:tags:StartTargetedSentimentDetectionJob', -- startTargetedSentimentDetectionJob_tags - Tags to be associated -- with the targeted sentiment detection job. A tag is a key-value pair -- that adds metadata to a resource used by Amazon Comprehend. For -- example, a tag with "Sales" as the key might be added to a resource to -- indicate its use by the sales department. -- -- StartTargetedSentimentDetectionJob, -- startTargetedSentimentDetectionJob_volumeKmsKeyId - ID for the -- KMS key that Amazon Comprehend uses to encrypt data on the storage -- volume attached to the ML compute instance(s) that process the -- analysis job. The VolumeKmsKeyId can be either of the following -- formats: -- -- -- -- StartTargetedSentimentDetectionJob, -- startTargetedSentimentDetectionJob_vpcConfig - Undocumented -- member. -- -- StartTargetedSentimentDetectionJob, -- startTargetedSentimentDetectionJob_inputDataConfig - -- Undocumented member. -- -- StartTargetedSentimentDetectionJob, -- startTargetedSentimentDetectionJob_outputDataConfig - Specifies -- where to send the output files. -- -- StartTargetedSentimentDetectionJob, -- startTargetedSentimentDetectionJob_dataAccessRoleArn - The -- Amazon Resource Name (ARN) of the AWS Identity and Access Management -- (IAM) role that grants Amazon Comprehend read access to your input -- data. For more information, see Role-based permissions. -- -- StartTargetedSentimentDetectionJob, -- startTargetedSentimentDetectionJob_languageCode - The language -- of the input documents. Currently, English is the only supported -- language. newStartTargetedSentimentDetectionJob :: InputDataConfig -> OutputDataConfig -> Text -> LanguageCode -> StartTargetedSentimentDetectionJob -- | See: newStartTargetedSentimentDetectionJobResponse smart -- constructor. data StartTargetedSentimentDetectionJobResponse StartTargetedSentimentDetectionJobResponse' :: Maybe Text -> Maybe Text -> Maybe JobStatus -> Int -> StartTargetedSentimentDetectionJobResponse -- | Create a value of StartTargetedSentimentDetectionJobResponse -- with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StartTargetedSentimentDetectionJobResponse, -- startTargetedSentimentDetectionJobResponse_jobArn - The Amazon -- Resource Name (ARN) of the targeted sentiment detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- StartTargetedSentimentDetectionJobResponse, -- startTargetedSentimentDetectionJobResponse_jobId - The -- identifier generated for the job. To get the status of a job, use this -- identifier with the operation. -- -- StartTargetedSentimentDetectionJobResponse, -- startTargetedSentimentDetectionJobResponse_jobStatus - The -- status of the job. -- -- -- -- $sel:httpStatus:StartTargetedSentimentDetectionJobResponse', -- startTargetedSentimentDetectionJobResponse_httpStatus - The -- response's http status code. newStartTargetedSentimentDetectionJobResponse :: Int -> StartTargetedSentimentDetectionJobResponse -- | See: newStartTopicsDetectionJob smart constructor. data StartTopicsDetectionJob StartTopicsDetectionJob' :: Maybe Text -> Maybe Text -> Maybe Natural -> Maybe [Tag] -> Maybe Text -> Maybe VpcConfig -> InputDataConfig -> OutputDataConfig -> Text -> StartTopicsDetectionJob -- | Create a value of StartTopicsDetectionJob with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:clientRequestToken:StartTopicsDetectionJob', -- startTopicsDetectionJob_clientRequestToken - A unique -- identifier for the request. If you do not set the client request -- token, Amazon Comprehend generates one. -- -- StartTopicsDetectionJob, startTopicsDetectionJob_jobName -- - The identifier of the job. -- -- StartTopicsDetectionJob, -- startTopicsDetectionJob_numberOfTopics - The number of topics -- to detect. -- -- $sel:tags:StartTopicsDetectionJob', -- startTopicsDetectionJob_tags - Tags to be associated with the -- topics detection job. A tag is a key-value pair that adds metadata to -- a resource used by Amazon Comprehend. For example, a tag with "Sales" -- as the key might be added to a resource to indicate its use by the -- sales department. -- -- StartTopicsDetectionJob, -- startTopicsDetectionJob_volumeKmsKeyId - ID for the AWS Key -- Management Service (KMS) key that Amazon Comprehend uses to encrypt -- data on the storage volume attached to the ML compute instance(s) that -- process the analysis job. The VolumeKmsKeyId can be either of the -- following formats: -- -- -- -- StartTopicsDetectionJob, -- startTopicsDetectionJob_vpcConfig - Configuration parameters -- for an optional private Virtual Private Cloud (VPC) containing the -- resources you are using for your topic detection job. For more -- information, see Amazon VPC. -- -- StartTopicsDetectionJob, -- startTopicsDetectionJob_inputDataConfig - Specifies the format -- and location of the input data for the job. -- -- StartTopicsDetectionJob, -- startTopicsDetectionJob_outputDataConfig - Specifies where to -- send the output files. The output is a compressed archive with two -- files, topic-terms.csv that lists the terms associated with -- each topic, and doc-topics.csv that lists the documents -- associated with each topic -- -- StartTopicsDetectionJob, -- startTopicsDetectionJob_dataAccessRoleArn - The Amazon Resource -- Name (ARN) of the AWS Identity and Access Management (IAM) role 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. newStartTopicsDetectionJob :: InputDataConfig -> OutputDataConfig -> Text -> StartTopicsDetectionJob -- | See: newStartTopicsDetectionJobResponse smart -- constructor. data StartTopicsDetectionJobResponse StartTopicsDetectionJobResponse' :: Maybe Text -> Maybe Text -> Maybe JobStatus -> Int -> StartTopicsDetectionJobResponse -- | Create a value of StartTopicsDetectionJobResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StartTopicsDetectionJobResponse, -- startTopicsDetectionJobResponse_jobArn - The Amazon Resource -- Name (ARN) of the topics detection job. It is a unique, fully -- qualified identifier for the job. It includes the AWS account, Region, -- and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- StartTopicsDetectionJobResponse, -- startTopicsDetectionJobResponse_jobId - The identifier -- generated for the job. To get the status of the job, use this -- identifier with the DescribeTopicDetectionJob operation. -- -- StartTopicsDetectionJobResponse, -- startTopicsDetectionJobResponse_jobStatus - The status of the -- job: -- -- -- -- $sel:httpStatus:StartTopicsDetectionJobResponse', -- startTopicsDetectionJobResponse_httpStatus - The response's -- http status code. newStartTopicsDetectionJobResponse :: Int -> StartTopicsDetectionJobResponse -- | See: newStopDominantLanguageDetectionJob smart -- constructor. data StopDominantLanguageDetectionJob StopDominantLanguageDetectionJob' :: Text -> StopDominantLanguageDetectionJob -- | Create a value of StopDominantLanguageDetectionJob with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StopDominantLanguageDetectionJob, -- stopDominantLanguageDetectionJob_jobId - The identifier of the -- dominant language detection job to stop. newStopDominantLanguageDetectionJob :: Text -> StopDominantLanguageDetectionJob -- | See: newStopDominantLanguageDetectionJobResponse smart -- constructor. data StopDominantLanguageDetectionJobResponse StopDominantLanguageDetectionJobResponse' :: Maybe Text -> Maybe JobStatus -> Int -> StopDominantLanguageDetectionJobResponse -- | Create a value of StopDominantLanguageDetectionJobResponse with -- all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StopDominantLanguageDetectionJob, -- stopDominantLanguageDetectionJobResponse_jobId - The identifier -- of the dominant language detection job to stop. -- -- StopDominantLanguageDetectionJobResponse, -- stopDominantLanguageDetectionJobResponse_jobStatus - Either -- STOP_REQUESTED if the job is currently running, or -- STOPPED if the job was previously stopped with the -- StopDominantLanguageDetectionJob operation. -- -- $sel:httpStatus:StopDominantLanguageDetectionJobResponse', -- stopDominantLanguageDetectionJobResponse_httpStatus - The -- response's http status code. newStopDominantLanguageDetectionJobResponse :: Int -> StopDominantLanguageDetectionJobResponse -- | See: newStopEntitiesDetectionJob smart constructor. data StopEntitiesDetectionJob StopEntitiesDetectionJob' :: Text -> StopEntitiesDetectionJob -- | Create a value of StopEntitiesDetectionJob with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StopEntitiesDetectionJob, stopEntitiesDetectionJob_jobId -- - The identifier of the entities detection job to stop. newStopEntitiesDetectionJob :: Text -> StopEntitiesDetectionJob -- | See: newStopEntitiesDetectionJobResponse smart -- constructor. data StopEntitiesDetectionJobResponse StopEntitiesDetectionJobResponse' :: Maybe Text -> Maybe JobStatus -> Int -> StopEntitiesDetectionJobResponse -- | Create a value of StopEntitiesDetectionJobResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StopEntitiesDetectionJob, -- stopEntitiesDetectionJobResponse_jobId - The identifier of the -- entities detection job to stop. -- -- StopEntitiesDetectionJobResponse, -- stopEntitiesDetectionJobResponse_jobStatus - Either -- STOP_REQUESTED if the job is currently running, or -- STOPPED if the job was previously stopped with the -- StopEntitiesDetectionJob operation. -- -- $sel:httpStatus:StopEntitiesDetectionJobResponse', -- stopEntitiesDetectionJobResponse_httpStatus - The response's -- http status code. newStopEntitiesDetectionJobResponse :: Int -> StopEntitiesDetectionJobResponse -- | See: newStopEventsDetectionJob smart constructor. data StopEventsDetectionJob StopEventsDetectionJob' :: Text -> StopEventsDetectionJob -- | Create a value of StopEventsDetectionJob with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StopEventsDetectionJob, stopEventsDetectionJob_jobId - -- The identifier of the events detection job to stop. newStopEventsDetectionJob :: Text -> StopEventsDetectionJob -- | See: newStopEventsDetectionJobResponse smart -- constructor. data StopEventsDetectionJobResponse StopEventsDetectionJobResponse' :: Maybe Text -> Maybe JobStatus -> Int -> StopEventsDetectionJobResponse -- | Create a value of StopEventsDetectionJobResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StopEventsDetectionJob, -- stopEventsDetectionJobResponse_jobId - The identifier of the -- events detection job to stop. -- -- StopEventsDetectionJobResponse, -- stopEventsDetectionJobResponse_jobStatus - The status of the -- events detection job. -- -- $sel:httpStatus:StopEventsDetectionJobResponse', -- stopEventsDetectionJobResponse_httpStatus - The response's http -- status code. newStopEventsDetectionJobResponse :: Int -> StopEventsDetectionJobResponse -- | See: newStopKeyPhrasesDetectionJob smart constructor. data StopKeyPhrasesDetectionJob StopKeyPhrasesDetectionJob' :: Text -> StopKeyPhrasesDetectionJob -- | Create a value of StopKeyPhrasesDetectionJob with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StopKeyPhrasesDetectionJob, -- stopKeyPhrasesDetectionJob_jobId - The identifier of the key -- phrases detection job to stop. newStopKeyPhrasesDetectionJob :: Text -> StopKeyPhrasesDetectionJob -- | See: newStopKeyPhrasesDetectionJobResponse smart -- constructor. data StopKeyPhrasesDetectionJobResponse StopKeyPhrasesDetectionJobResponse' :: Maybe Text -> Maybe JobStatus -> Int -> StopKeyPhrasesDetectionJobResponse -- | Create a value of StopKeyPhrasesDetectionJobResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StopKeyPhrasesDetectionJob, -- stopKeyPhrasesDetectionJobResponse_jobId - The identifier of -- the key phrases detection job to stop. -- -- StopKeyPhrasesDetectionJobResponse, -- stopKeyPhrasesDetectionJobResponse_jobStatus - Either -- STOP_REQUESTED if the job is currently running, or -- STOPPED if the job was previously stopped with the -- StopKeyPhrasesDetectionJob operation. -- -- $sel:httpStatus:StopKeyPhrasesDetectionJobResponse', -- stopKeyPhrasesDetectionJobResponse_httpStatus - The response's -- http status code. newStopKeyPhrasesDetectionJobResponse :: Int -> StopKeyPhrasesDetectionJobResponse -- | See: newStopPiiEntitiesDetectionJob smart constructor. data StopPiiEntitiesDetectionJob StopPiiEntitiesDetectionJob' :: Text -> StopPiiEntitiesDetectionJob -- | Create a value of StopPiiEntitiesDetectionJob with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StopPiiEntitiesDetectionJob, -- stopPiiEntitiesDetectionJob_jobId - The identifier of the PII -- entities detection job to stop. newStopPiiEntitiesDetectionJob :: Text -> StopPiiEntitiesDetectionJob -- | See: newStopPiiEntitiesDetectionJobResponse smart -- constructor. data StopPiiEntitiesDetectionJobResponse StopPiiEntitiesDetectionJobResponse' :: Maybe Text -> Maybe JobStatus -> Int -> StopPiiEntitiesDetectionJobResponse -- | Create a value of StopPiiEntitiesDetectionJobResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StopPiiEntitiesDetectionJob, -- stopPiiEntitiesDetectionJobResponse_jobId - The identifier of -- the PII entities detection job to stop. -- -- StopPiiEntitiesDetectionJobResponse, -- stopPiiEntitiesDetectionJobResponse_jobStatus - The status of -- the PII entities detection job. -- -- $sel:httpStatus:StopPiiEntitiesDetectionJobResponse', -- stopPiiEntitiesDetectionJobResponse_httpStatus - The response's -- http status code. newStopPiiEntitiesDetectionJobResponse :: Int -> StopPiiEntitiesDetectionJobResponse -- | See: newStopSentimentDetectionJob smart constructor. data StopSentimentDetectionJob StopSentimentDetectionJob' :: Text -> StopSentimentDetectionJob -- | Create a value of StopSentimentDetectionJob with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StopSentimentDetectionJob, -- stopSentimentDetectionJob_jobId - The identifier of the -- sentiment detection job to stop. newStopSentimentDetectionJob :: Text -> StopSentimentDetectionJob -- | See: newStopSentimentDetectionJobResponse smart -- constructor. data StopSentimentDetectionJobResponse StopSentimentDetectionJobResponse' :: Maybe Text -> Maybe JobStatus -> Int -> StopSentimentDetectionJobResponse -- | Create a value of StopSentimentDetectionJobResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StopSentimentDetectionJob, -- stopSentimentDetectionJobResponse_jobId - The identifier of the -- sentiment detection job to stop. -- -- StopSentimentDetectionJobResponse, -- stopSentimentDetectionJobResponse_jobStatus - Either -- STOP_REQUESTED if the job is currently running, or -- STOPPED if the job was previously stopped with the -- StopSentimentDetectionJob operation. -- -- $sel:httpStatus:StopSentimentDetectionJobResponse', -- stopSentimentDetectionJobResponse_httpStatus - The response's -- http status code. newStopSentimentDetectionJobResponse :: Int -> StopSentimentDetectionJobResponse -- | See: newStopTargetedSentimentDetectionJob smart -- constructor. data StopTargetedSentimentDetectionJob StopTargetedSentimentDetectionJob' :: Text -> StopTargetedSentimentDetectionJob -- | Create a value of StopTargetedSentimentDetectionJob with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StopTargetedSentimentDetectionJob, -- stopTargetedSentimentDetectionJob_jobId - The identifier of the -- targeted sentiment detection job to stop. newStopTargetedSentimentDetectionJob :: Text -> StopTargetedSentimentDetectionJob -- | See: newStopTargetedSentimentDetectionJobResponse smart -- constructor. data StopTargetedSentimentDetectionJobResponse StopTargetedSentimentDetectionJobResponse' :: Maybe Text -> Maybe JobStatus -> Int -> StopTargetedSentimentDetectionJobResponse -- | Create a value of StopTargetedSentimentDetectionJobResponse -- with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StopTargetedSentimentDetectionJob, -- stopTargetedSentimentDetectionJobResponse_jobId - The -- identifier of the targeted sentiment detection job to stop. -- -- StopTargetedSentimentDetectionJobResponse, -- stopTargetedSentimentDetectionJobResponse_jobStatus - Either -- STOP_REQUESTED if the job is currently running, or -- STOPPED if the job was previously stopped with the -- StopSentimentDetectionJob operation. -- -- $sel:httpStatus:StopTargetedSentimentDetectionJobResponse', -- stopTargetedSentimentDetectionJobResponse_httpStatus - The -- response's http status code. newStopTargetedSentimentDetectionJobResponse :: Int -> StopTargetedSentimentDetectionJobResponse -- | See: newStopTrainingDocumentClassifier smart -- constructor. data StopTrainingDocumentClassifier StopTrainingDocumentClassifier' :: Text -> StopTrainingDocumentClassifier -- | Create a value of StopTrainingDocumentClassifier with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StopTrainingDocumentClassifier, -- stopTrainingDocumentClassifier_documentClassifierArn - The -- Amazon Resource Name (ARN) that identifies the document classifier -- currently being trained. newStopTrainingDocumentClassifier :: Text -> StopTrainingDocumentClassifier -- | See: newStopTrainingDocumentClassifierResponse smart -- constructor. data StopTrainingDocumentClassifierResponse StopTrainingDocumentClassifierResponse' :: Int -> StopTrainingDocumentClassifierResponse -- | Create a value of StopTrainingDocumentClassifierResponse with -- all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:httpStatus:StopTrainingDocumentClassifierResponse', -- stopTrainingDocumentClassifierResponse_httpStatus - The -- response's http status code. newStopTrainingDocumentClassifierResponse :: Int -> StopTrainingDocumentClassifierResponse -- | See: newStopTrainingEntityRecognizer smart constructor. data StopTrainingEntityRecognizer StopTrainingEntityRecognizer' :: Text -> StopTrainingEntityRecognizer -- | Create a value of StopTrainingEntityRecognizer with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- StopTrainingEntityRecognizer, -- stopTrainingEntityRecognizer_entityRecognizerArn - The Amazon -- Resource Name (ARN) that identifies the entity recognizer currently -- being trained. newStopTrainingEntityRecognizer :: Text -> StopTrainingEntityRecognizer -- | See: newStopTrainingEntityRecognizerResponse smart -- constructor. data StopTrainingEntityRecognizerResponse StopTrainingEntityRecognizerResponse' :: Int -> StopTrainingEntityRecognizerResponse -- | Create a value of StopTrainingEntityRecognizerResponse with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:httpStatus:StopTrainingEntityRecognizerResponse', -- stopTrainingEntityRecognizerResponse_httpStatus - The -- response's http status code. newStopTrainingEntityRecognizerResponse :: Int -> StopTrainingEntityRecognizerResponse -- | See: newTagResource smart constructor. data TagResource TagResource' :: Text -> [Tag] -> TagResource -- | Create a value of TagResource with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:resourceArn:TagResource', tagResource_resourceArn - -- The Amazon Resource Name (ARN) of the given Amazon Comprehend resource -- to which you want to associate the tags. -- -- $sel:tags:TagResource', tagResource_tags - Tags being -- associated with a specific Amazon Comprehend resource. There can be a -- maximum of 50 tags (both existing and pending) associated with a -- specific resource. newTagResource :: Text -> TagResource -- | See: newTagResourceResponse smart constructor. data TagResourceResponse TagResourceResponse' :: Int -> TagResourceResponse -- | Create a value of TagResourceResponse with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:httpStatus:TagResourceResponse', -- tagResourceResponse_httpStatus - The response's http status -- code. newTagResourceResponse :: Int -> TagResourceResponse -- | See: newUntagResource smart constructor. data UntagResource UntagResource' :: Text -> [Text] -> UntagResource -- | Create a value of UntagResource with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:resourceArn:UntagResource', -- untagResource_resourceArn - The Amazon Resource Name (ARN) of -- the given Amazon Comprehend resource from which you want to remove the -- tags. -- -- $sel:tagKeys:UntagResource', untagResource_tagKeys - The -- initial part of a key-value pair that forms a tag being removed from a -- given resource. For example, a tag with "Sales" as the key might be -- added to a resource to indicate its use by the sales department. Keys -- must be unique and cannot be duplicated for a particular resource. newUntagResource :: Text -> UntagResource -- | See: newUntagResourceResponse smart constructor. data UntagResourceResponse UntagResourceResponse' :: Int -> UntagResourceResponse -- | Create a value of UntagResourceResponse with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:httpStatus:UntagResourceResponse', -- untagResourceResponse_httpStatus - The response's http status -- code. newUntagResourceResponse :: Int -> UntagResourceResponse -- | See: newUpdateEndpoint smart constructor. data UpdateEndpoint UpdateEndpoint' :: Maybe Text -> Maybe Natural -> Maybe Text -> Text -> UpdateEndpoint -- | Create a value of UpdateEndpoint with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- UpdateEndpoint, updateEndpoint_desiredDataAccessRoleArn -- - Data access role ARN to use in case the new model is encrypted with -- a customer CMK. -- -- UpdateEndpoint, updateEndpoint_desiredInferenceUnits - -- The desired number of inference units to be used by the model using -- this endpoint. Each inference unit represents of a throughput of 100 -- characters per second. -- -- UpdateEndpoint, updateEndpoint_desiredModelArn - The ARN -- of the new model to use when updating an existing endpoint. -- -- UpdateEndpoint, updateEndpoint_endpointArn - The Amazon -- Resource Number (ARN) of the endpoint being updated. newUpdateEndpoint :: Text -> UpdateEndpoint -- | See: newUpdateEndpointResponse smart constructor. data UpdateEndpointResponse UpdateEndpointResponse' :: Int -> UpdateEndpointResponse -- | Create a value of UpdateEndpointResponse with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:httpStatus:UpdateEndpointResponse', -- updateEndpointResponse_httpStatus - The response's http status -- code. newUpdateEndpointResponse :: Int -> UpdateEndpointResponse newtype AugmentedManifestsDocumentTypeFormat AugmentedManifestsDocumentTypeFormat' :: Text -> AugmentedManifestsDocumentTypeFormat [fromAugmentedManifestsDocumentTypeFormat] :: AugmentedManifestsDocumentTypeFormat -> Text pattern AugmentedManifestsDocumentTypeFormat_PLAIN_TEXT_DOCUMENT :: AugmentedManifestsDocumentTypeFormat pattern AugmentedManifestsDocumentTypeFormat_SEMI_STRUCTURED_DOCUMENT :: AugmentedManifestsDocumentTypeFormat newtype BlockType BlockType' :: Text -> BlockType [fromBlockType] :: BlockType -> Text pattern BlockType_LINE :: BlockType pattern BlockType_WORD :: BlockType newtype DocumentClassifierDataFormat DocumentClassifierDataFormat' :: Text -> DocumentClassifierDataFormat [fromDocumentClassifierDataFormat] :: DocumentClassifierDataFormat -> Text pattern DocumentClassifierDataFormat_AUGMENTED_MANIFEST :: DocumentClassifierDataFormat pattern DocumentClassifierDataFormat_COMPREHEND_CSV :: DocumentClassifierDataFormat newtype DocumentClassifierMode DocumentClassifierMode' :: Text -> DocumentClassifierMode [fromDocumentClassifierMode] :: DocumentClassifierMode -> Text pattern DocumentClassifierMode_MULTI_CLASS :: DocumentClassifierMode pattern DocumentClassifierMode_MULTI_LABEL :: DocumentClassifierMode newtype DocumentReadAction DocumentReadAction' :: Text -> DocumentReadAction [fromDocumentReadAction] :: DocumentReadAction -> Text pattern DocumentReadAction_TEXTRACT_ANALYZE_DOCUMENT :: DocumentReadAction pattern DocumentReadAction_TEXTRACT_DETECT_DOCUMENT_TEXT :: DocumentReadAction -- | Specifies the type of Amazon Textract features to apply. If you chose -- TEXTRACT_ANALYZE_DOCUMENT as the read action, you must -- specify one or both of the following values: -- -- newtype DocumentReadFeatureTypes DocumentReadFeatureTypes' :: Text -> DocumentReadFeatureTypes [fromDocumentReadFeatureTypes] :: DocumentReadFeatureTypes -> Text pattern DocumentReadFeatureTypes_FORMS :: DocumentReadFeatureTypes pattern DocumentReadFeatureTypes_TABLES :: DocumentReadFeatureTypes newtype DocumentReadMode DocumentReadMode' :: Text -> DocumentReadMode [fromDocumentReadMode] :: DocumentReadMode -> Text pattern DocumentReadMode_FORCE_DOCUMENT_READ_ACTION :: DocumentReadMode pattern DocumentReadMode_SERVICE_DEFAULT :: DocumentReadMode newtype DocumentType DocumentType' :: Text -> DocumentType [fromDocumentType] :: DocumentType -> Text pattern DocumentType_IMAGE :: DocumentType pattern DocumentType_MS_WORD :: DocumentType pattern DocumentType_NATIVE_PDF :: DocumentType pattern DocumentType_PLAIN_TEXT :: DocumentType pattern DocumentType_SCANNED_PDF :: DocumentType pattern DocumentType_TEXTRACT_ANALYZE_DOCUMENT_JSON :: DocumentType pattern DocumentType_TEXTRACT_DETECT_DOCUMENT_TEXT_JSON :: DocumentType newtype EndpointStatus EndpointStatus' :: Text -> EndpointStatus [fromEndpointStatus] :: EndpointStatus -> Text pattern EndpointStatus_CREATING :: EndpointStatus pattern EndpointStatus_DELETING :: EndpointStatus pattern EndpointStatus_FAILED :: EndpointStatus pattern EndpointStatus_IN_SERVICE :: EndpointStatus pattern EndpointStatus_UPDATING :: EndpointStatus newtype EntityRecognizerDataFormat EntityRecognizerDataFormat' :: Text -> EntityRecognizerDataFormat [fromEntityRecognizerDataFormat] :: EntityRecognizerDataFormat -> Text pattern EntityRecognizerDataFormat_AUGMENTED_MANIFEST :: EntityRecognizerDataFormat pattern EntityRecognizerDataFormat_COMPREHEND_CSV :: EntityRecognizerDataFormat newtype EntityType EntityType' :: Text -> EntityType [fromEntityType] :: EntityType -> Text pattern EntityType_COMMERCIAL_ITEM :: EntityType pattern EntityType_DATE :: EntityType pattern EntityType_EVENT :: EntityType pattern EntityType_LOCATION :: EntityType pattern EntityType_ORGANIZATION :: EntityType pattern EntityType_OTHER :: EntityType pattern EntityType_PERSON :: EntityType pattern EntityType_QUANTITY :: EntityType pattern EntityType_TITLE :: EntityType newtype InputFormat InputFormat' :: Text -> InputFormat [fromInputFormat] :: InputFormat -> Text pattern InputFormat_ONE_DOC_PER_FILE :: InputFormat pattern InputFormat_ONE_DOC_PER_LINE :: InputFormat newtype JobStatus JobStatus' :: Text -> JobStatus [fromJobStatus] :: JobStatus -> Text pattern JobStatus_COMPLETED :: JobStatus pattern JobStatus_FAILED :: JobStatus pattern JobStatus_IN_PROGRESS :: JobStatus pattern JobStatus_STOPPED :: JobStatus pattern JobStatus_STOP_REQUESTED :: JobStatus pattern JobStatus_SUBMITTED :: JobStatus newtype LanguageCode LanguageCode' :: Text -> LanguageCode [fromLanguageCode] :: LanguageCode -> Text pattern LanguageCode_Ar :: LanguageCode pattern LanguageCode_De :: LanguageCode pattern LanguageCode_En :: LanguageCode pattern LanguageCode_Es :: LanguageCode pattern LanguageCode_Fr :: LanguageCode pattern LanguageCode_Hi :: LanguageCode pattern LanguageCode_It :: LanguageCode pattern LanguageCode_Ja :: LanguageCode pattern LanguageCode_Ko :: LanguageCode pattern LanguageCode_Pt :: LanguageCode pattern LanguageCode_Zh :: LanguageCode pattern LanguageCode_Zh_TW :: LanguageCode newtype ModelStatus ModelStatus' :: Text -> ModelStatus [fromModelStatus] :: ModelStatus -> Text pattern ModelStatus_DELETING :: ModelStatus pattern ModelStatus_IN_ERROR :: ModelStatus pattern ModelStatus_STOPPED :: ModelStatus pattern ModelStatus_STOP_REQUESTED :: ModelStatus pattern ModelStatus_SUBMITTED :: ModelStatus pattern ModelStatus_TRAINED :: ModelStatus pattern ModelStatus_TRAINING :: ModelStatus newtype PageBasedErrorCode PageBasedErrorCode' :: Text -> PageBasedErrorCode [fromPageBasedErrorCode] :: PageBasedErrorCode -> Text pattern PageBasedErrorCode_INTERNAL_SERVER_ERROR :: PageBasedErrorCode pattern PageBasedErrorCode_PAGE_CHARACTERS_EXCEEDED :: PageBasedErrorCode pattern PageBasedErrorCode_PAGE_SIZE_EXCEEDED :: PageBasedErrorCode pattern PageBasedErrorCode_TEXTRACT_BAD_PAGE :: PageBasedErrorCode pattern PageBasedErrorCode_TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED :: PageBasedErrorCode newtype PartOfSpeechTagType PartOfSpeechTagType' :: Text -> PartOfSpeechTagType [fromPartOfSpeechTagType] :: PartOfSpeechTagType -> Text pattern PartOfSpeechTagType_ADJ :: PartOfSpeechTagType pattern PartOfSpeechTagType_ADP :: PartOfSpeechTagType pattern PartOfSpeechTagType_ADV :: PartOfSpeechTagType pattern PartOfSpeechTagType_AUX :: PartOfSpeechTagType pattern PartOfSpeechTagType_CCONJ :: PartOfSpeechTagType pattern PartOfSpeechTagType_CONJ :: PartOfSpeechTagType pattern PartOfSpeechTagType_DET :: PartOfSpeechTagType pattern PartOfSpeechTagType_INTJ :: PartOfSpeechTagType pattern PartOfSpeechTagType_NOUN :: PartOfSpeechTagType pattern PartOfSpeechTagType_NUM :: PartOfSpeechTagType pattern PartOfSpeechTagType_O :: PartOfSpeechTagType pattern PartOfSpeechTagType_PART :: PartOfSpeechTagType pattern PartOfSpeechTagType_PRON :: PartOfSpeechTagType pattern PartOfSpeechTagType_PROPN :: PartOfSpeechTagType pattern PartOfSpeechTagType_PUNCT :: PartOfSpeechTagType pattern PartOfSpeechTagType_SCONJ :: PartOfSpeechTagType pattern PartOfSpeechTagType_SYM :: PartOfSpeechTagType pattern PartOfSpeechTagType_VERB :: PartOfSpeechTagType newtype PiiEntitiesDetectionMaskMode PiiEntitiesDetectionMaskMode' :: Text -> PiiEntitiesDetectionMaskMode [fromPiiEntitiesDetectionMaskMode] :: PiiEntitiesDetectionMaskMode -> Text pattern PiiEntitiesDetectionMaskMode_MASK :: PiiEntitiesDetectionMaskMode pattern PiiEntitiesDetectionMaskMode_REPLACE_WITH_PII_ENTITY_TYPE :: PiiEntitiesDetectionMaskMode newtype PiiEntitiesDetectionMode PiiEntitiesDetectionMode' :: Text -> PiiEntitiesDetectionMode [fromPiiEntitiesDetectionMode] :: PiiEntitiesDetectionMode -> Text pattern PiiEntitiesDetectionMode_ONLY_OFFSETS :: PiiEntitiesDetectionMode pattern PiiEntitiesDetectionMode_ONLY_REDACTION :: PiiEntitiesDetectionMode newtype PiiEntityType PiiEntityType' :: Text -> PiiEntityType [fromPiiEntityType] :: PiiEntityType -> Text pattern PiiEntityType_ADDRESS :: PiiEntityType pattern PiiEntityType_AGE :: PiiEntityType pattern PiiEntityType_ALL :: PiiEntityType pattern PiiEntityType_AWS_ACCESS_KEY :: PiiEntityType pattern PiiEntityType_AWS_SECRET_KEY :: PiiEntityType pattern PiiEntityType_BANK_ACCOUNT_NUMBER :: PiiEntityType pattern PiiEntityType_BANK_ROUTING :: PiiEntityType pattern PiiEntityType_CA_HEALTH_NUMBER :: PiiEntityType pattern PiiEntityType_CA_SOCIAL_INSURANCE_NUMBER :: PiiEntityType pattern PiiEntityType_CREDIT_DEBIT_CVV :: PiiEntityType pattern PiiEntityType_CREDIT_DEBIT_EXPIRY :: PiiEntityType pattern PiiEntityType_CREDIT_DEBIT_NUMBER :: PiiEntityType pattern PiiEntityType_DATE_TIME :: PiiEntityType pattern PiiEntityType_DRIVER_ID :: PiiEntityType pattern PiiEntityType_EMAIL :: PiiEntityType pattern PiiEntityType_INTERNATIONAL_BANK_ACCOUNT_NUMBER :: PiiEntityType pattern PiiEntityType_IN_AADHAAR :: PiiEntityType pattern PiiEntityType_IN_NREGA :: PiiEntityType pattern PiiEntityType_IN_PERMANENT_ACCOUNT_NUMBER :: PiiEntityType pattern PiiEntityType_IN_VOTER_NUMBER :: PiiEntityType pattern PiiEntityType_IP_ADDRESS :: PiiEntityType pattern PiiEntityType_LICENSE_PLATE :: PiiEntityType pattern PiiEntityType_MAC_ADDRESS :: PiiEntityType pattern PiiEntityType_NAME :: PiiEntityType pattern PiiEntityType_PASSPORT_NUMBER :: PiiEntityType pattern PiiEntityType_PASSWORD :: PiiEntityType pattern PiiEntityType_PHONE :: PiiEntityType pattern PiiEntityType_PIN :: PiiEntityType pattern PiiEntityType_SSN :: PiiEntityType pattern PiiEntityType_SWIFT_CODE :: PiiEntityType pattern PiiEntityType_UK_NATIONAL_HEALTH_SERVICE_NUMBER :: PiiEntityType pattern PiiEntityType_UK_NATIONAL_INSURANCE_NUMBER :: PiiEntityType pattern PiiEntityType_UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER :: PiiEntityType pattern PiiEntityType_URL :: PiiEntityType pattern PiiEntityType_USERNAME :: PiiEntityType pattern PiiEntityType_US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER :: PiiEntityType pattern PiiEntityType_VEHICLE_IDENTIFICATION_NUMBER :: PiiEntityType newtype RelationshipType RelationshipType' :: Text -> RelationshipType [fromRelationshipType] :: RelationshipType -> Text pattern RelationshipType_CHILD :: RelationshipType newtype SentimentType SentimentType' :: Text -> SentimentType [fromSentimentType] :: SentimentType -> Text pattern SentimentType_MIXED :: SentimentType pattern SentimentType_NEGATIVE :: SentimentType pattern SentimentType_NEUTRAL :: SentimentType pattern SentimentType_POSITIVE :: SentimentType newtype Split Split' :: Text -> Split [fromSplit] :: Split -> Text pattern Split_TEST :: Split pattern Split_TRAIN :: Split newtype SyntaxLanguageCode SyntaxLanguageCode' :: Text -> SyntaxLanguageCode [fromSyntaxLanguageCode] :: SyntaxLanguageCode -> Text pattern SyntaxLanguageCode_De :: SyntaxLanguageCode pattern SyntaxLanguageCode_En :: SyntaxLanguageCode pattern SyntaxLanguageCode_Es :: SyntaxLanguageCode pattern SyntaxLanguageCode_Fr :: SyntaxLanguageCode pattern SyntaxLanguageCode_It :: SyntaxLanguageCode pattern SyntaxLanguageCode_Pt :: SyntaxLanguageCode newtype TargetedSentimentEntityType TargetedSentimentEntityType' :: Text -> TargetedSentimentEntityType [fromTargetedSentimentEntityType] :: TargetedSentimentEntityType -> Text pattern TargetedSentimentEntityType_ATTRIBUTE :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_BOOK :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_BRAND :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_COMMERCIAL_ITEM :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_DATE :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_EVENT :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_FACILITY :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_GAME :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_LOCATION :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_MOVIE :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_MUSIC :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_ORGANIZATION :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_OTHER :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_PERSON :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_PERSONAL_TITLE :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_QUANTITY :: TargetedSentimentEntityType pattern TargetedSentimentEntityType_SOFTWARE :: TargetedSentimentEntityType -- | An augmented manifest file that provides training data for your custom -- model. An augmented manifest file is a labeled dataset that is -- produced by Amazon SageMaker Ground Truth. -- -- See: newAugmentedManifestsListItem smart constructor. data AugmentedManifestsListItem AugmentedManifestsListItem' :: Maybe Text -> Maybe AugmentedManifestsDocumentTypeFormat -> Maybe Text -> Maybe Split -> Text -> [Text] -> AugmentedManifestsListItem -- | Create a value of AugmentedManifestsListItem with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:annotationDataS3Uri:AugmentedManifestsListItem', -- augmentedManifestsListItem_annotationDataS3Uri - The S3 prefix -- to the annotation files that are referred in the augmented manifest -- file. -- -- $sel:documentType:AugmentedManifestsListItem', -- augmentedManifestsListItem_documentType - The type of augmented -- manifest. PlainTextDocument or SemiStructuredDocument. If you don't -- specify, the default is PlainTextDocument. -- -- -- -- $sel:sourceDocumentsS3Uri:AugmentedManifestsListItem', -- augmentedManifestsListItem_sourceDocumentsS3Uri - The S3 prefix -- to the source files (PDFs) that are referred to in the augmented -- manifest file. -- -- $sel:split:AugmentedManifestsListItem', -- augmentedManifestsListItem_split - The purpose of the data -- you've provided in the augmented manifest. You can either train or -- test this data. If you don't specify, the default is train. -- -- TRAIN - all of the documents in the manifest will be used for -- training. If no test documents are provided, Amazon Comprehend will -- automatically reserve a portion of the training documents for testing. -- -- TEST - all of the documents in the manifest will be used for testing. -- -- $sel:s3Uri:AugmentedManifestsListItem', -- augmentedManifestsListItem_s3Uri - The Amazon S3 location of -- the augmented manifest file. -- -- $sel:attributeNames:AugmentedManifestsListItem', -- augmentedManifestsListItem_attributeNames - The JSON attribute -- that contains the annotations for your training documents. The number -- of attribute names that you specify depends on whether your augmented -- manifest file is the output of a single labeling job or a chained -- labeling job. -- -- If your file is the output of a single labeling job, specify the -- LabelAttributeName key that was used when the job was created in -- Ground Truth. -- -- If your file is the output of a chained labeling job, specify the -- LabelAttributeName key for one or more jobs in the chain. Each -- LabelAttributeName key provides the annotations from an individual -- job. newAugmentedManifestsListItem :: Text -> AugmentedManifestsListItem -- | The result of calling the operation. The operation returns one object -- for each document that is successfully processed by the operation. -- -- See: newBatchDetectDominantLanguageItemResult smart -- constructor. data BatchDetectDominantLanguageItemResult BatchDetectDominantLanguageItemResult' :: Maybe Int -> Maybe [DominantLanguage] -> BatchDetectDominantLanguageItemResult -- | Create a value of BatchDetectDominantLanguageItemResult with -- all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:index:BatchDetectDominantLanguageItemResult', -- batchDetectDominantLanguageItemResult_index - The zero-based -- index of the document in the input list. -- -- $sel:languages:BatchDetectDominantLanguageItemResult', -- batchDetectDominantLanguageItemResult_languages - One or more -- DominantLanguage objects describing the dominant languages in the -- document. newBatchDetectDominantLanguageItemResult :: BatchDetectDominantLanguageItemResult -- | The result of calling the operation. The operation returns one object -- for each document that is successfully processed by the operation. -- -- See: newBatchDetectEntitiesItemResult smart constructor. data BatchDetectEntitiesItemResult BatchDetectEntitiesItemResult' :: Maybe [Entity] -> Maybe Int -> BatchDetectEntitiesItemResult -- | Create a value of BatchDetectEntitiesItemResult with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:entities:BatchDetectEntitiesItemResult', -- batchDetectEntitiesItemResult_entities - One or more Entity -- objects, one for each entity detected in the document. -- -- $sel:index:BatchDetectEntitiesItemResult', -- batchDetectEntitiesItemResult_index - The zero-based index of -- the document in the input list. newBatchDetectEntitiesItemResult :: BatchDetectEntitiesItemResult -- | The result of calling the operation. The operation returns one object -- for each document that is successfully processed by the operation. -- -- See: newBatchDetectKeyPhrasesItemResult smart -- constructor. data BatchDetectKeyPhrasesItemResult BatchDetectKeyPhrasesItemResult' :: Maybe Int -> Maybe [KeyPhrase] -> BatchDetectKeyPhrasesItemResult -- | Create a value of BatchDetectKeyPhrasesItemResult with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:index:BatchDetectKeyPhrasesItemResult', -- batchDetectKeyPhrasesItemResult_index - The zero-based index of -- the document in the input list. -- -- $sel:keyPhrases:BatchDetectKeyPhrasesItemResult', -- batchDetectKeyPhrasesItemResult_keyPhrases - One or more -- KeyPhrase objects, one for each key phrase detected in the document. newBatchDetectKeyPhrasesItemResult :: BatchDetectKeyPhrasesItemResult -- | The result of calling the operation. The operation returns one object -- for each document that is successfully processed by the operation. -- -- See: newBatchDetectSentimentItemResult smart -- constructor. data BatchDetectSentimentItemResult BatchDetectSentimentItemResult' :: Maybe Int -> Maybe SentimentType -> Maybe SentimentScore -> BatchDetectSentimentItemResult -- | Create a value of BatchDetectSentimentItemResult with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:index:BatchDetectSentimentItemResult', -- batchDetectSentimentItemResult_index - The zero-based index of -- the document in the input list. -- -- $sel:sentiment:BatchDetectSentimentItemResult', -- batchDetectSentimentItemResult_sentiment - The sentiment -- detected in the document. -- -- $sel:sentimentScore:BatchDetectSentimentItemResult', -- batchDetectSentimentItemResult_sentimentScore - The level of -- confidence that Amazon Comprehend has in the accuracy of its sentiment -- detection. newBatchDetectSentimentItemResult :: BatchDetectSentimentItemResult -- | The result of calling the operation. The operation returns one object -- that is successfully processed by the operation. -- -- See: newBatchDetectSyntaxItemResult smart constructor. data BatchDetectSyntaxItemResult BatchDetectSyntaxItemResult' :: Maybe Int -> Maybe [SyntaxToken] -> BatchDetectSyntaxItemResult -- | Create a value of BatchDetectSyntaxItemResult with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:index:BatchDetectSyntaxItemResult', -- batchDetectSyntaxItemResult_index - The zero-based index of the -- document in the input list. -- -- $sel:syntaxTokens:BatchDetectSyntaxItemResult', -- batchDetectSyntaxItemResult_syntaxTokens - The syntax tokens -- for the words in the document, one token for each word. newBatchDetectSyntaxItemResult :: BatchDetectSyntaxItemResult -- | Analysis results for one of the documents in the batch. -- -- See: newBatchDetectTargetedSentimentItemResult smart -- constructor. data BatchDetectTargetedSentimentItemResult BatchDetectTargetedSentimentItemResult' :: Maybe [TargetedSentimentEntity] -> Maybe Int -> BatchDetectTargetedSentimentItemResult -- | Create a value of BatchDetectTargetedSentimentItemResult with -- all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:entities:BatchDetectTargetedSentimentItemResult', -- batchDetectTargetedSentimentItemResult_entities - An array of -- targeted sentiment entities. -- -- $sel:index:BatchDetectTargetedSentimentItemResult', -- batchDetectTargetedSentimentItemResult_index - The zero-based -- index of this result in the input list. newBatchDetectTargetedSentimentItemResult :: BatchDetectTargetedSentimentItemResult -- | Describes an error that occurred while processing a document in a -- batch. The operation returns on BatchItemError object for -- each document that contained an error. -- -- See: newBatchItemError smart constructor. data BatchItemError BatchItemError' :: Maybe Text -> Maybe Text -> Maybe Int -> BatchItemError -- | Create a value of BatchItemError with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:errorCode:BatchItemError', batchItemError_errorCode -- - The numeric error code of the error. -- -- $sel:errorMessage:BatchItemError', -- batchItemError_errorMessage - A text description of the error. -- -- $sel:index:BatchItemError', batchItemError_index - The -- zero-based index of the document in the input list. newBatchItemError :: BatchItemError -- | Information about each word or line of text in the input document. -- -- For additional information, see Block in the Amazon Textract -- API reference. -- -- See: newBlock smart constructor. data Block Block' :: Maybe BlockType -> Maybe Geometry -> Maybe Text -> Maybe Int -> Maybe [RelationshipsListItem] -> Maybe Text -> Block -- | Create a value of Block with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:blockType:Block', block_blockType - The block -- represents a line of text or one word of text. -- -- -- -- $sel:geometry:Block', block_geometry - Co-ordinates of -- the rectangle or polygon that contains the text. -- -- $sel:id:Block', block_id - Unique identifier for the -- block. -- -- $sel:page:Block', block_page - Page number where the -- block appears. -- -- $sel:relationships:Block', block_relationships - A list -- of child blocks of the current block. For example, a LINE object has -- child blocks for each WORD block that's part of the line of text. -- -- $sel:text:Block', block_text - The word or line of text -- extracted from the block. newBlock :: Block -- | A reference to a block. -- -- See: newBlockReference smart constructor. data BlockReference BlockReference' :: Maybe Int -> Maybe Text -> Maybe [ChildBlock] -> Maybe Int -> BlockReference -- | Create a value of BlockReference with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- BlockReference, blockReference_beginOffset - Offset of -- the start of the block within its parent block. -- -- $sel:blockId:BlockReference', blockReference_blockId - -- Unique identifier for the block. -- -- $sel:childBlocks:BlockReference', -- blockReference_childBlocks - List of child blocks within this -- block. -- -- BlockReference, blockReference_endOffset - Offset of the -- end of the block within its parent block. newBlockReference :: BlockReference -- | The bounding box around the detected page or around an element on a -- document page. The left (x-coordinate) and top (y-coordinate) are -- coordinates that represent the top and left sides of the bounding box. -- Note that the upper-left corner of the image is the origin (0,0). -- -- For additional information, see BoundingBox in the Amazon -- Textract API reference. -- -- See: newBoundingBox smart constructor. data BoundingBox BoundingBox' :: Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> BoundingBox -- | Create a value of BoundingBox with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:height:BoundingBox', boundingBox_height - The -- height of the bounding box as a ratio of the overall document page -- height. -- -- $sel:left:BoundingBox', boundingBox_left - The left -- coordinate of the bounding box as a ratio of overall document page -- width. -- -- $sel:top:BoundingBox', boundingBox_top - The top -- coordinate of the bounding box as a ratio of overall document page -- height. -- -- $sel:width:BoundingBox', boundingBox_width - The width -- of the bounding box as a ratio of the overall document page width. newBoundingBox :: BoundingBox -- | Nested block contained within a block. -- -- See: newChildBlock smart constructor. data ChildBlock ChildBlock' :: Maybe Int -> Maybe Text -> Maybe Int -> ChildBlock -- | Create a value of ChildBlock with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:beginOffset:ChildBlock', childBlock_beginOffset - -- Offset of the start of the child block within its parent block. -- -- $sel:childBlockId:ChildBlock', childBlock_childBlockId - -- Unique identifier for the child block. -- -- $sel:endOffset:ChildBlock', childBlock_endOffset - -- Offset of the end of the child block within its parent block. newChildBlock :: ChildBlock -- | Describes the result metrics for the test data associated with an -- documentation classifier. -- -- See: newClassifierEvaluationMetrics smart constructor. data ClassifierEvaluationMetrics ClassifierEvaluationMetrics' :: Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> ClassifierEvaluationMetrics -- | Create a value of ClassifierEvaluationMetrics with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:accuracy:ClassifierEvaluationMetrics', -- classifierEvaluationMetrics_accuracy - The fraction of the -- labels that were correct recognized. It is computed by dividing the -- number of labels in the test documents that were correctly recognized -- by the total number of labels in the test documents. -- -- $sel:f1Score:ClassifierEvaluationMetrics', -- classifierEvaluationMetrics_f1Score - A measure of how accurate -- the classifier results are for the test data. It is derived from the -- Precision and Recall values. The F1Score is -- the harmonic average of the two scores. The highest score is 1, and -- the worst score is 0. -- -- $sel:hammingLoss:ClassifierEvaluationMetrics', -- classifierEvaluationMetrics_hammingLoss - Indicates the -- fraction of labels that are incorrectly predicted. Also seen as the -- fraction of wrong labels compared to the total number of labels. -- Scores closer to zero are better. -- -- $sel:microF1Score:ClassifierEvaluationMetrics', -- classifierEvaluationMetrics_microF1Score - A measure of how -- accurate the classifier results are for the test data. It is a -- combination of the Micro Precision and Micro Recall -- values. The Micro F1Score is the harmonic mean of the two -- scores. The highest score is 1, and the worst score is 0. -- -- $sel:microPrecision:ClassifierEvaluationMetrics', -- classifierEvaluationMetrics_microPrecision - A measure of the -- usefulness of the recognizer results in the test data. High precision -- means that the recognizer returned substantially more relevant results -- than irrelevant ones. Unlike the Precision metric which comes from -- averaging the precision of all available labels, this is based on the -- overall score of all precision scores added together. -- -- $sel:microRecall:ClassifierEvaluationMetrics', -- classifierEvaluationMetrics_microRecall - A measure of how -- complete the classifier results are for the test data. High recall -- means that the classifier returned most of the relevant results. -- Specifically, this indicates how many of the correct categories in the -- text that the model can predict. It is a percentage of correct -- categories in the text that can found. Instead of averaging the recall -- scores of all labels (as with Recall), micro Recall is based on the -- overall score of all recall scores added together. -- -- $sel:precision:ClassifierEvaluationMetrics', -- classifierEvaluationMetrics_precision - A measure of the -- usefulness of the classifier results in the test data. High precision -- means that the classifier returned substantially more relevant results -- than irrelevant ones. -- -- $sel:recall:ClassifierEvaluationMetrics', -- classifierEvaluationMetrics_recall - A measure of how complete -- the classifier results are for the test data. High recall means that -- the classifier returned most of the relevant results. newClassifierEvaluationMetrics :: ClassifierEvaluationMetrics -- | Provides information about a document classifier. -- -- See: newClassifierMetadata smart constructor. data ClassifierMetadata ClassifierMetadata' :: Maybe ClassifierEvaluationMetrics -> Maybe Int -> Maybe Int -> Maybe Int -> ClassifierMetadata -- | Create a value of ClassifierMetadata with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:evaluationMetrics:ClassifierMetadata', -- classifierMetadata_evaluationMetrics - Describes the result -- metrics for the test data associated with an documentation classifier. -- -- $sel:numberOfLabels:ClassifierMetadata', -- classifierMetadata_numberOfLabels - The number of labels in the -- input data. -- -- $sel:numberOfTestDocuments:ClassifierMetadata', -- classifierMetadata_numberOfTestDocuments - The number of -- documents in the input data that were used to test the classifier. -- Typically this is 10 to 20 percent of the input documents, up to -- 10,000 documents. -- -- $sel:numberOfTrainedDocuments:ClassifierMetadata', -- classifierMetadata_numberOfTrainedDocuments - The number of -- documents in the input data that were used to train the classifier. -- Typically this is 80 to 90 percent of the input documents. newClassifierMetadata :: ClassifierMetadata -- | Specifies the class that categorizes the document being analyzed -- -- See: newDocumentClass smart constructor. data DocumentClass DocumentClass' :: Maybe Text -> Maybe Int -> Maybe Double -> DocumentClass -- | Create a value of DocumentClass with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:name:DocumentClass', documentClass_name - The name -- of the class. -- -- $sel:page:DocumentClass', documentClass_page - Page -- number in the input document. This field is present in the response -- only if your request includes the Byte parameter. -- -- $sel:score:DocumentClass', documentClass_score - The -- confidence score that Amazon Comprehend has this class correctly -- attributed. newDocumentClass :: DocumentClass -- | Provides information for filtering a list of document classification -- jobs. For more information, see the operation. You can provide only -- one filter parameter in each request. -- -- See: newDocumentClassificationJobFilter smart -- constructor. data DocumentClassificationJobFilter DocumentClassificationJobFilter' :: Maybe Text -> Maybe JobStatus -> Maybe POSIX -> Maybe POSIX -> DocumentClassificationJobFilter -- | Create a value of DocumentClassificationJobFilter with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:jobName:DocumentClassificationJobFilter', -- documentClassificationJobFilter_jobName - Filters on the name -- of the job. -- -- $sel:jobStatus:DocumentClassificationJobFilter', -- documentClassificationJobFilter_jobStatus - Filters the list -- based on job status. Returns only jobs with the specified status. -- -- $sel:submitTimeAfter:DocumentClassificationJobFilter', -- documentClassificationJobFilter_submitTimeAfter - Filters the -- list of jobs based on the time that the job was submitted for -- processing. Returns only jobs submitted after the specified time. Jobs -- are returned in descending order, newest to oldest. -- -- $sel:submitTimeBefore:DocumentClassificationJobFilter', -- documentClassificationJobFilter_submitTimeBefore - Filters the -- list of jobs based on the time that the job was submitted for -- processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. newDocumentClassificationJobFilter :: DocumentClassificationJobFilter -- | Provides information about a document classification job. -- -- See: newDocumentClassificationJobProperties smart -- constructor. data DocumentClassificationJobProperties DocumentClassificationJobProperties' :: Maybe Text -> Maybe Text -> Maybe POSIX -> Maybe InputDataConfig -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe JobStatus -> Maybe Text -> Maybe OutputDataConfig -> Maybe POSIX -> Maybe Text -> Maybe VpcConfig -> DocumentClassificationJobProperties -- | Create a value of DocumentClassificationJobProperties with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:dataAccessRoleArn:DocumentClassificationJobProperties', -- documentClassificationJobProperties_dataAccessRoleArn - The -- Amazon Resource Name (ARN) of the AWS identity and Access Management -- (IAM) role that grants Amazon Comprehend read access to your input -- data. -- -- -- $sel:documentClassifierArn:DocumentClassificationJobProperties', -- documentClassificationJobProperties_documentClassifierArn - The -- Amazon Resource Name (ARN) that identifies the document classifier. -- -- $sel:endTime:DocumentClassificationJobProperties', -- documentClassificationJobProperties_endTime - The time that the -- document classification job completed. -- -- $sel:inputDataConfig:DocumentClassificationJobProperties', -- documentClassificationJobProperties_inputDataConfig - The input -- data configuration that you supplied when you created the document -- classification job. -- -- $sel:jobArn:DocumentClassificationJobProperties', -- documentClassificationJobProperties_jobArn - The Amazon -- Resource Name (ARN) of the document classification job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- $sel:jobId:DocumentClassificationJobProperties', -- documentClassificationJobProperties_jobId - The identifier -- assigned to the document classification job. -- -- $sel:jobName:DocumentClassificationJobProperties', -- documentClassificationJobProperties_jobName - The name that you -- assigned to the document classification job. -- -- $sel:jobStatus:DocumentClassificationJobProperties', -- documentClassificationJobProperties_jobStatus - The current -- status of the document classification job. If the status is -- FAILED, the Message field shows the reason for the -- failure. -- -- $sel:message:DocumentClassificationJobProperties', -- documentClassificationJobProperties_message - A description of -- the status of the job. -- -- $sel:outputDataConfig:DocumentClassificationJobProperties', -- documentClassificationJobProperties_outputDataConfig - The -- output data configuration that you supplied when you created the -- document classification job. -- -- $sel:submitTime:DocumentClassificationJobProperties', -- documentClassificationJobProperties_submitTime - The time that -- the document classification job was submitted for processing. -- -- $sel:volumeKmsKeyId:DocumentClassificationJobProperties', -- documentClassificationJobProperties_volumeKmsKeyId - ID for the -- AWS Key Management Service (KMS) key that Amazon Comprehend uses to -- encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- -- -- $sel:vpcConfig:DocumentClassificationJobProperties', -- documentClassificationJobProperties_vpcConfig - Configuration -- parameters for a private Virtual Private Cloud (VPC) containing the -- resources you are using for your document classification job. For more -- information, see Amazon VPC. newDocumentClassificationJobProperties :: DocumentClassificationJobProperties -- | Provides information for filtering a list of document classifiers. You -- can only specify one filtering parameter in a request. For more -- information, see the operation. -- -- See: newDocumentClassifierFilter smart constructor. data DocumentClassifierFilter DocumentClassifierFilter' :: Maybe Text -> Maybe ModelStatus -> Maybe POSIX -> Maybe POSIX -> DocumentClassifierFilter -- | Create a value of DocumentClassifierFilter with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:documentClassifierName:DocumentClassifierFilter', -- documentClassifierFilter_documentClassifierName - The name that -- you assigned to the document classifier -- -- $sel:status:DocumentClassifierFilter', -- documentClassifierFilter_status - Filters the list of -- classifiers based on status. -- -- $sel:submitTimeAfter:DocumentClassifierFilter', -- documentClassifierFilter_submitTimeAfter - Filters the list of -- classifiers based on the time that the classifier was submitted for -- processing. Returns only classifiers submitted after the specified -- time. Classifiers are returned in descending order, newest to oldest. -- -- $sel:submitTimeBefore:DocumentClassifierFilter', -- documentClassifierFilter_submitTimeBefore - Filters the list of -- classifiers based on the time that the classifier was submitted for -- processing. Returns only classifiers submitted before the specified -- time. Classifiers are returned in ascending order, oldest to newest. newDocumentClassifierFilter :: DocumentClassifierFilter -- | The input properties for training a document classifier. -- -- For more information on how the input file is formatted, see -- Preparing training data in the Comprehend Developer Guide. -- -- See: newDocumentClassifierInputDataConfig smart -- constructor. data DocumentClassifierInputDataConfig DocumentClassifierInputDataConfig' :: Maybe [AugmentedManifestsListItem] -> Maybe DocumentClassifierDataFormat -> Maybe Text -> Maybe Text -> Maybe Text -> DocumentClassifierInputDataConfig -- | Create a value of DocumentClassifierInputDataConfig with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:augmentedManifests:DocumentClassifierInputDataConfig', -- documentClassifierInputDataConfig_augmentedManifests - A list -- of augmented manifest files that provide training data for your custom -- model. An augmented manifest file is a labeled dataset that is -- produced by Amazon SageMaker Ground Truth. -- -- This parameter is required if you set DataFormat to -- AUGMENTED_MANIFEST. -- -- $sel:dataFormat:DocumentClassifierInputDataConfig', -- documentClassifierInputDataConfig_dataFormat - The format of -- your training data: -- -- -- -- If you don't specify a value, Amazon Comprehend uses -- COMPREHEND_CSV as the default. -- -- $sel:labelDelimiter:DocumentClassifierInputDataConfig', -- documentClassifierInputDataConfig_labelDelimiter - Indicates -- the delimiter used to separate each label for training a multi-label -- classifier. The default delimiter between labels is a pipe (|). You -- can use a different character as a delimiter (if it's an allowed -- character) by specifying it under Delimiter for labels. If the -- training documents use a delimiter other than the default or the -- delimiter you specify, the labels on that line will be combined to -- make a single unique label, such as LABELLABELLABEL. -- -- DocumentClassifierInputDataConfig, -- documentClassifierInputDataConfig_s3Uri - The Amazon S3 URI for -- the input data. The S3 bucket must be in the same region as the API -- endpoint that you are calling. The URI can point to a single input -- file or it can provide the prefix for a collection of input files. -- -- For example, if you use the URI S3://bucketName/prefix, if -- the prefix is a single file, Amazon Comprehend uses that file as -- input. If more than one file begins with the prefix, Amazon Comprehend -- uses all of them as input. -- -- This parameter is required if you set DataFormat to -- COMPREHEND_CSV. -- -- $sel:testS3Uri:DocumentClassifierInputDataConfig', -- documentClassifierInputDataConfig_testS3Uri - This specifies -- the Amazon S3 location where the test annotations for an entity -- recognizer are located. The URI must be in the same AWS Region as the -- API endpoint that you are calling. newDocumentClassifierInputDataConfig :: DocumentClassifierInputDataConfig -- | Provides output results configuration parameters for custom classifier -- jobs. -- -- See: newDocumentClassifierOutputDataConfig smart -- constructor. data DocumentClassifierOutputDataConfig DocumentClassifierOutputDataConfig' :: Maybe Text -> Maybe Text -> DocumentClassifierOutputDataConfig -- | Create a value of DocumentClassifierOutputDataConfig with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:kmsKeyId:DocumentClassifierOutputDataConfig', -- documentClassifierOutputDataConfig_kmsKeyId - ID for the AWS -- Key Management Service (KMS) key that Amazon Comprehend uses to -- encrypt the output results from an analysis job. The KmsKeyId can be -- one of the following formats: -- -- -- -- $sel:s3Uri:DocumentClassifierOutputDataConfig', -- documentClassifierOutputDataConfig_s3Uri - When you use the -- OutputDataConfig object while creating a custom classifier, -- you specify the Amazon S3 location where you want to write the -- confusion matrix. The URI must be in the same region as the API -- endpoint that you are calling. The location is 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 directory specific to the job. The S3Uri -- field contains the location of the output file, called -- output.tar.gz. It is a compressed archive that contains the -- confusion matrix. newDocumentClassifierOutputDataConfig :: DocumentClassifierOutputDataConfig -- | Provides information about a document classifier. -- -- See: newDocumentClassifierProperties smart constructor. data DocumentClassifierProperties DocumentClassifierProperties' :: Maybe (Sensitive ClassifierMetadata) -> Maybe Text -> Maybe Text -> Maybe POSIX -> Maybe DocumentClassifierInputDataConfig -> Maybe LanguageCode -> Maybe Text -> Maybe DocumentClassifierMode -> Maybe Text -> Maybe DocumentClassifierOutputDataConfig -> Maybe Text -> Maybe ModelStatus -> Maybe POSIX -> Maybe POSIX -> Maybe POSIX -> Maybe Text -> Maybe Text -> Maybe VpcConfig -> DocumentClassifierProperties -- | Create a value of DocumentClassifierProperties with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:classifierMetadata:DocumentClassifierProperties', -- documentClassifierProperties_classifierMetadata - Information -- about the document classifier, including the number of documents used -- for training the classifier, the number of documents used for test the -- classifier, and an accuracy rating. -- -- $sel:dataAccessRoleArn:DocumentClassifierProperties', -- documentClassifierProperties_dataAccessRoleArn - The Amazon -- Resource Name (ARN) of the AWS Identity and Management (IAM) role that -- grants Amazon Comprehend read access to your input data. -- -- $sel:documentClassifierArn:DocumentClassifierProperties', -- documentClassifierProperties_documentClassifierArn - The Amazon -- Resource Name (ARN) that identifies the document classifier. -- -- $sel:endTime:DocumentClassifierProperties', -- documentClassifierProperties_endTime - The time that training -- the document classifier completed. -- -- $sel:inputDataConfig:DocumentClassifierProperties', -- documentClassifierProperties_inputDataConfig - The input data -- configuration that you supplied when you created the document -- classifier for training. -- -- $sel:languageCode:DocumentClassifierProperties', -- documentClassifierProperties_languageCode - The language code -- for the language of the documents that the classifier was trained on. -- -- $sel:message:DocumentClassifierProperties', -- documentClassifierProperties_message - Additional information -- about the status of the classifier. -- -- $sel:mode:DocumentClassifierProperties', -- documentClassifierProperties_mode - Indicates the mode in which -- the specific classifier was trained. This also indicates the format of -- input documents and the format of the confusion matrix. Each -- classifier can only be trained in one mode and this cannot be changed -- once the classifier is trained. -- -- $sel:modelKmsKeyId:DocumentClassifierProperties', -- documentClassifierProperties_modelKmsKeyId - ID for the AWS Key -- Management Service (KMS) key that Amazon Comprehend uses to encrypt -- trained custom models. The ModelKmsKeyId can be either of the -- following formats: -- -- -- -- $sel:outputDataConfig:DocumentClassifierProperties', -- documentClassifierProperties_outputDataConfig - Provides output -- results configuration parameters for custom classifier jobs. -- -- $sel:sourceModelArn:DocumentClassifierProperties', -- documentClassifierProperties_sourceModelArn - The Amazon -- Resource Name (ARN) of the source model. This model was imported from -- a different AWS account to create the document classifier model in -- your AWS account. -- -- $sel:status:DocumentClassifierProperties', -- documentClassifierProperties_status - The status of the -- document classifier. If the status is TRAINED the classifier -- is ready to use. If the status is FAILED you can see -- additional information about why the classifier wasn't trained in the -- Message field. -- -- $sel:submitTime:DocumentClassifierProperties', -- documentClassifierProperties_submitTime - The time that the -- document classifier was submitted for training. -- -- $sel:trainingEndTime:DocumentClassifierProperties', -- documentClassifierProperties_trainingEndTime - The time that -- training of the document classifier was completed. Indicates the time -- when the training completes on documentation classifiers. You are -- billed for the time interval between this time and the value of -- TrainingStartTime. -- -- $sel:trainingStartTime:DocumentClassifierProperties', -- documentClassifierProperties_trainingStartTime - Indicates the -- time when the training starts on documentation classifiers. You are -- billed for the time interval between this time and the value of -- TrainingEndTime. -- -- $sel:versionName:DocumentClassifierProperties', -- documentClassifierProperties_versionName - The version name -- that you assigned to the document classifier. -- -- $sel:volumeKmsKeyId:DocumentClassifierProperties', -- documentClassifierProperties_volumeKmsKeyId - ID for the AWS -- Key Management Service (KMS) key that Amazon Comprehend uses to -- encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- -- -- $sel:vpcConfig:DocumentClassifierProperties', -- documentClassifierProperties_vpcConfig - Configuration -- parameters for a private Virtual Private Cloud (VPC) containing the -- resources you are using for your custom classifier. For more -- information, see Amazon VPC. newDocumentClassifierProperties :: DocumentClassifierProperties -- | Describes information about a document classifier and its versions. -- -- See: newDocumentClassifierSummary smart constructor. data DocumentClassifierSummary DocumentClassifierSummary' :: Maybe Text -> Maybe POSIX -> Maybe Text -> Maybe ModelStatus -> Maybe Int -> DocumentClassifierSummary -- | Create a value of DocumentClassifierSummary with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:documentClassifierName:DocumentClassifierSummary', -- documentClassifierSummary_documentClassifierName - The name -- that you assigned the document classifier. -- -- $sel:latestVersionCreatedAt:DocumentClassifierSummary', -- documentClassifierSummary_latestVersionCreatedAt - The time -- that the latest document classifier version was submitted for -- processing. -- -- $sel:latestVersionName:DocumentClassifierSummary', -- documentClassifierSummary_latestVersionName - The version name -- you assigned to the latest document classifier version. -- -- $sel:latestVersionStatus:DocumentClassifierSummary', -- documentClassifierSummary_latestVersionStatus - Provides the -- status of the latest document classifier version. -- -- $sel:numberOfVersions:DocumentClassifierSummary', -- documentClassifierSummary_numberOfVersions - The number of -- versions you created. newDocumentClassifierSummary :: DocumentClassifierSummary -- | Specifies one of the label or labels that categorize the document -- being analyzed. -- -- See: newDocumentLabel smart constructor. data DocumentLabel DocumentLabel' :: Maybe Text -> Maybe Int -> Maybe Double -> DocumentLabel -- | Create a value of DocumentLabel with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:name:DocumentLabel', documentLabel_name - The name -- of the label. -- -- $sel:page:DocumentLabel', documentLabel_page - Page -- number where the label occurs. This field is present in the response -- only if your request includes the Byte parameter. -- -- $sel:score:DocumentLabel', documentLabel_score - The -- confidence score that Amazon Comprehend has this label correctly -- attributed. newDocumentLabel :: DocumentLabel -- | Information about the document, discovered during text extraction. -- -- See: newDocumentMetadata smart constructor. data DocumentMetadata DocumentMetadata' :: Maybe [ExtractedCharactersListItem] -> Maybe Int -> DocumentMetadata -- | Create a value of DocumentMetadata with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:extractedCharacters:DocumentMetadata', -- documentMetadata_extractedCharacters - List of pages in the -- document, with the number of characters extracted from each page. -- -- $sel:pages:DocumentMetadata', documentMetadata_pages - -- Number of pages in the document. newDocumentMetadata :: DocumentMetadata -- | Provides configuration parameters to override the default actions for -- extracting text from PDF documents and image files. -- -- By default, Amazon Comprehend performs the following actions to -- extract text from files, based on the input file type: -- -- -- -- DocumentReaderConfig does not apply to plain text files or -- Word files. -- -- For image files and PDF documents, you can override these default -- actions using the fields listed below. For more information, see -- Setting text extraction options. -- -- See: newDocumentReaderConfig smart constructor. data DocumentReaderConfig DocumentReaderConfig' :: Maybe DocumentReadMode -> Maybe (NonEmpty DocumentReadFeatureTypes) -> DocumentReadAction -> DocumentReaderConfig -- | Create a value of DocumentReaderConfig with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:documentReadMode:DocumentReaderConfig', -- documentReaderConfig_documentReadMode - Determines the text -- extraction actions for PDF files. Enter one of the following values: -- -- -- -- $sel:featureTypes:DocumentReaderConfig', -- documentReaderConfig_featureTypes - Specifies the type of -- Amazon Textract features to apply. If you chose -- TEXTRACT_ANALYZE_DOCUMENT as the read action, you must -- specify one or both of the following values: -- -- -- -- $sel:documentReadAction:DocumentReaderConfig', -- documentReaderConfig_documentReadAction - This field defines -- the Amazon Textract API operation that Amazon Comprehend uses to -- extract text from PDF files and image files. Enter one of the -- following values: -- -- newDocumentReaderConfig :: DocumentReadAction -> DocumentReaderConfig -- | Document type for each page in the document. -- -- See: newDocumentTypeListItem smart constructor. data DocumentTypeListItem DocumentTypeListItem' :: Maybe Int -> Maybe DocumentType -> DocumentTypeListItem -- | Create a value of DocumentTypeListItem with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:page:DocumentTypeListItem', -- documentTypeListItem_page - Page number. -- -- $sel:type':DocumentTypeListItem', -- documentTypeListItem_type - Document type. newDocumentTypeListItem :: DocumentTypeListItem -- | Returns the code for the dominant language in the input text and the -- level of confidence that Amazon Comprehend has in the accuracy of the -- detection. -- -- See: newDominantLanguage smart constructor. data DominantLanguage DominantLanguage' :: Maybe Text -> Maybe Double -> DominantLanguage -- | Create a value of DominantLanguage with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:languageCode:DominantLanguage', -- dominantLanguage_languageCode - The RFC 5646 language code for -- the dominant language. For more information about RFC 5646, see -- Tags for Identifying Languages on the IETF Tools web -- site. -- -- $sel:score:DominantLanguage', dominantLanguage_score - -- The level of confidence that Amazon Comprehend has in the accuracy of -- the detection. newDominantLanguage :: DominantLanguage -- | Provides information for filtering a list of dominant language -- detection jobs. For more information, see the operation. -- -- See: newDominantLanguageDetectionJobFilter smart -- constructor. data DominantLanguageDetectionJobFilter DominantLanguageDetectionJobFilter' :: Maybe Text -> Maybe JobStatus -> Maybe POSIX -> Maybe POSIX -> DominantLanguageDetectionJobFilter -- | Create a value of DominantLanguageDetectionJobFilter with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:jobName:DominantLanguageDetectionJobFilter', -- dominantLanguageDetectionJobFilter_jobName - Filters on the -- name of the job. -- -- $sel:jobStatus:DominantLanguageDetectionJobFilter', -- dominantLanguageDetectionJobFilter_jobStatus - Filters the list -- of jobs based on job status. Returns only jobs with the specified -- status. -- -- $sel:submitTimeAfter:DominantLanguageDetectionJobFilter', -- dominantLanguageDetectionJobFilter_submitTimeAfter - Filters -- the list of jobs based on the time that the job was submitted for -- processing. Returns only jobs submitted after the specified time. Jobs -- are returned in descending order, newest to oldest. -- -- $sel:submitTimeBefore:DominantLanguageDetectionJobFilter', -- dominantLanguageDetectionJobFilter_submitTimeBefore - Filters -- the list of jobs based on the time that the job was submitted for -- processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. newDominantLanguageDetectionJobFilter :: DominantLanguageDetectionJobFilter -- | Provides information about a dominant language detection job. -- -- See: newDominantLanguageDetectionJobProperties smart -- constructor. data DominantLanguageDetectionJobProperties DominantLanguageDetectionJobProperties' :: Maybe Text -> Maybe POSIX -> Maybe InputDataConfig -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe JobStatus -> Maybe Text -> Maybe OutputDataConfig -> Maybe POSIX -> Maybe Text -> Maybe VpcConfig -> DominantLanguageDetectionJobProperties -- | Create a value of DominantLanguageDetectionJobProperties with -- all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:dataAccessRoleArn:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_dataAccessRoleArn - The -- Amazon Resource Name (ARN) that gives Amazon Comprehend read access to -- your input data. -- -- $sel:endTime:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_endTime - The time that -- the dominant language detection job completed. -- -- $sel:inputDataConfig:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_inputDataConfig - The -- input data configuration that you supplied when you created the -- dominant language detection job. -- -- $sel:jobArn:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_jobArn - The Amazon -- Resource Name (ARN) of the dominant language detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- $sel:jobId:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_jobId - The identifier -- assigned to the dominant language detection job. -- -- $sel:jobName:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_jobName - The name that -- you assigned to the dominant language detection job. -- -- $sel:jobStatus:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_jobStatus - The current -- status of the dominant language detection job. If the status is -- FAILED, the Message field shows the reason for the -- failure. -- -- $sel:message:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_message - A description -- for the status of a job. -- -- $sel:outputDataConfig:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_outputDataConfig - The -- output data configuration that you supplied when you created the -- dominant language detection job. -- -- $sel:submitTime:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_submitTime - The time -- that the dominant language detection job was submitted for processing. -- -- $sel:volumeKmsKeyId:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_volumeKmsKeyId - ID for -- the AWS Key Management Service (KMS) key that Amazon Comprehend uses -- to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- -- -- $sel:vpcConfig:DominantLanguageDetectionJobProperties', -- dominantLanguageDetectionJobProperties_vpcConfig - -- Configuration parameters for a private Virtual Private Cloud (VPC) -- containing the resources you are using for your dominant language -- detection job. For more information, see Amazon VPC. newDominantLanguageDetectionJobProperties :: DominantLanguageDetectionJobProperties -- | The filter used to determine which endpoints are returned. You can -- filter jobs on their name, model, status, or the date and time that -- they were created. You can only set one filter at a time. -- -- See: newEndpointFilter smart constructor. data EndpointFilter EndpointFilter' :: Maybe POSIX -> Maybe POSIX -> Maybe Text -> Maybe EndpointStatus -> EndpointFilter -- | Create a value of EndpointFilter with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:creationTimeAfter:EndpointFilter', -- endpointFilter_creationTimeAfter - Specifies a date after which -- the returned endpoint or endpoints were created. -- -- $sel:creationTimeBefore:EndpointFilter', -- endpointFilter_creationTimeBefore - Specifies a date before -- which the returned endpoint or endpoints were created. -- -- $sel:modelArn:EndpointFilter', endpointFilter_modelArn - -- The Amazon Resource Number (ARN) of the model to which the endpoint is -- attached. -- -- $sel:status:EndpointFilter', endpointFilter_status - -- Specifies the status of the endpoint being returned. Possible values -- are: Creating, Ready, Updating, Deleting, Failed. newEndpointFilter :: EndpointFilter -- | Specifies information about the specified endpoint. For information -- about endpoints, see Managing endpoints. -- -- See: newEndpointProperties smart constructor. data EndpointProperties EndpointProperties' :: Maybe POSIX -> Maybe Natural -> Maybe Text -> Maybe Text -> Maybe Natural -> Maybe Text -> Maybe Text -> Maybe POSIX -> Maybe Text -> Maybe Text -> Maybe EndpointStatus -> EndpointProperties -- | Create a value of EndpointProperties with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:creationTime:EndpointProperties', -- endpointProperties_creationTime - The creation date and time of -- the endpoint. -- -- $sel:currentInferenceUnits:EndpointProperties', -- endpointProperties_currentInferenceUnits - The number of -- inference units currently used by the model using this endpoint. -- -- $sel:dataAccessRoleArn:EndpointProperties', -- endpointProperties_dataAccessRoleArn - The Amazon Resource Name -- (ARN) of the AWS identity and Access Management (IAM) role that grants -- Amazon Comprehend read access to trained custom models encrypted with -- a customer managed key (ModelKmsKeyId). -- -- $sel:desiredDataAccessRoleArn:EndpointProperties', -- endpointProperties_desiredDataAccessRoleArn - Data access role -- ARN to use in case the new model is encrypted with a customer KMS key. -- -- $sel:desiredInferenceUnits:EndpointProperties', -- endpointProperties_desiredInferenceUnits - The desired number -- of inference units to be used by the model using this endpoint. Each -- inference unit represents of a throughput of 100 characters per -- second. -- -- $sel:desiredModelArn:EndpointProperties', -- endpointProperties_desiredModelArn - ARN of the new model to -- use for updating an existing endpoint. This ARN is going to be -- different from the model ARN when the update is in progress -- -- $sel:endpointArn:EndpointProperties', -- endpointProperties_endpointArn - The Amazon Resource Number -- (ARN) of the endpoint. -- -- $sel:lastModifiedTime:EndpointProperties', -- endpointProperties_lastModifiedTime - The date and time that -- the endpoint was last modified. -- -- $sel:message:EndpointProperties', -- endpointProperties_message - Specifies a reason for failure in -- cases of Failed status. -- -- $sel:modelArn:EndpointProperties', -- endpointProperties_modelArn - The Amazon Resource Number (ARN) -- of the model to which the endpoint is attached. -- -- $sel:status:EndpointProperties', -- endpointProperties_status - Specifies the status of the -- endpoint. Because the endpoint updates and creation are asynchronous, -- so customers will need to wait for the endpoint to be Ready -- status before making inference requests. newEndpointProperties :: EndpointProperties -- | Provides information for filtering a list of dominant language -- detection jobs. For more information, see the operation. -- -- See: newEntitiesDetectionJobFilter smart constructor. data EntitiesDetectionJobFilter EntitiesDetectionJobFilter' :: Maybe Text -> Maybe JobStatus -> Maybe POSIX -> Maybe POSIX -> EntitiesDetectionJobFilter -- | Create a value of EntitiesDetectionJobFilter with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:jobName:EntitiesDetectionJobFilter', -- entitiesDetectionJobFilter_jobName - Filters on the name of the -- job. -- -- $sel:jobStatus:EntitiesDetectionJobFilter', -- entitiesDetectionJobFilter_jobStatus - Filters the list of jobs -- based on job status. Returns only jobs with the specified status. -- -- $sel:submitTimeAfter:EntitiesDetectionJobFilter', -- entitiesDetectionJobFilter_submitTimeAfter - Filters the list -- of jobs based on the time that the job was submitted for processing. -- Returns only jobs submitted after the specified time. Jobs are -- returned in descending order, newest to oldest. -- -- $sel:submitTimeBefore:EntitiesDetectionJobFilter', -- entitiesDetectionJobFilter_submitTimeBefore - Filters the list -- of jobs based on the time that the job was submitted for processing. -- Returns only jobs submitted before the specified time. Jobs are -- returned in ascending order, oldest to newest. newEntitiesDetectionJobFilter :: EntitiesDetectionJobFilter -- | Provides information about an entities detection job. -- -- See: newEntitiesDetectionJobProperties smart -- constructor. data EntitiesDetectionJobProperties EntitiesDetectionJobProperties' :: Maybe Text -> Maybe POSIX -> Maybe Text -> Maybe InputDataConfig -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe JobStatus -> Maybe LanguageCode -> Maybe Text -> Maybe OutputDataConfig -> Maybe POSIX -> Maybe Text -> Maybe VpcConfig -> EntitiesDetectionJobProperties -- | Create a value of EntitiesDetectionJobProperties with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:dataAccessRoleArn:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_dataAccessRoleArn - The Amazon -- Resource Name (ARN) that gives Amazon Comprehend read access to your -- input data. -- -- $sel:endTime:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_endTime - The time that the -- entities detection job completed -- -- $sel:entityRecognizerArn:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_entityRecognizerArn - The Amazon -- Resource Name (ARN) that identifies the entity recognizer. -- -- $sel:inputDataConfig:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_inputDataConfig - The input data -- configuration that you supplied when you created the entities -- detection job. -- -- $sel:jobArn:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_jobArn - The Amazon Resource -- Name (ARN) of the entities detection job. It is a unique, fully -- qualified identifier for the job. It includes the AWS account, Region, -- and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- $sel:jobId:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_jobId - The identifier assigned -- to the entities detection job. -- -- $sel:jobName:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_jobName - The name that you -- assigned the entities detection job. -- -- $sel:jobStatus:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_jobStatus - The current status -- of the entities detection job. If the status is FAILED, the -- Message field shows the reason for the failure. -- -- $sel:languageCode:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_languageCode - The language code -- of the input documents. -- -- $sel:message:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_message - A description of the -- status of a job. -- -- $sel:outputDataConfig:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_outputDataConfig - The output -- data configuration that you supplied when you created the entities -- detection job. -- -- $sel:submitTime:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_submitTime - The time that the -- entities detection job was submitted for processing. -- -- $sel:volumeKmsKeyId:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_volumeKmsKeyId - ID for the AWS -- Key Management Service (KMS) key that Amazon Comprehend uses to -- encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- -- -- $sel:vpcConfig:EntitiesDetectionJobProperties', -- entitiesDetectionJobProperties_vpcConfig - Configuration -- parameters for a private Virtual Private Cloud (VPC) containing the -- resources you are using for your entity detection job. For more -- information, see Amazon VPC. newEntitiesDetectionJobProperties :: EntitiesDetectionJobProperties -- | Provides information about an entity. -- -- See: newEntity smart constructor. data Entity Entity' :: Maybe Int -> Maybe [BlockReference] -> Maybe Int -> Maybe Double -> Maybe Text -> Maybe EntityType -> Entity -- | Create a value of Entity with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- Entity, entity_beginOffset - The zero-based offset from -- the beginning of the source text to the first character in the entity. -- -- This field is empty for non-text input. -- -- $sel:blockReferences:Entity', entity_blockReferences - A -- reference to each block for this entity. This field is empty for -- plain-text input. -- -- Entity, entity_endOffset - The zero-based offset from -- the beginning of the source text to the last character in the entity. -- -- This field is empty for non-text input. -- -- $sel:score:Entity', entity_score - The level of -- confidence that Amazon Comprehend has in the accuracy of the -- detection. -- -- $sel:text:Entity', entity_text - The text of the entity. -- -- $sel:type':Entity', entity_type - The entity type. For -- entity detection using the built-in model, this field contains one of -- the standard entity types listed below. -- -- For custom entity detection, this field contains one of the entity -- types that you specified when you trained your custom model. newEntity :: Entity -- | Specifies one of the label or labels that categorize the personally -- identifiable information (PII) entity being analyzed. -- -- See: newEntityLabel smart constructor. data EntityLabel EntityLabel' :: Maybe PiiEntityType -> Maybe Double -> EntityLabel -- | Create a value of EntityLabel with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:name:EntityLabel', entityLabel_name - The name of -- the label. -- -- $sel:score:EntityLabel', entityLabel_score - The level -- of confidence that Amazon Comprehend has in the accuracy of the -- detection. newEntityLabel :: EntityLabel -- | Describes the annotations associated with a entity recognizer. -- -- See: newEntityRecognizerAnnotations smart constructor. data EntityRecognizerAnnotations EntityRecognizerAnnotations' :: Maybe Text -> Text -> EntityRecognizerAnnotations -- | Create a value of EntityRecognizerAnnotations with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:testS3Uri:EntityRecognizerAnnotations', -- entityRecognizerAnnotations_testS3Uri - Specifies the Amazon S3 -- location where the test annotations for an entity recognizer are -- located. The URI must be in the same region as the API endpoint that -- you are calling. -- -- $sel:s3Uri:EntityRecognizerAnnotations', -- entityRecognizerAnnotations_s3Uri - Specifies the Amazon S3 -- location where the annotations for an entity recognizer are located. -- The URI must be in the same region as the API endpoint that you are -- calling. newEntityRecognizerAnnotations :: Text -> EntityRecognizerAnnotations -- | Describes the training documents submitted with an entity recognizer. -- -- See: newEntityRecognizerDocuments smart constructor. data EntityRecognizerDocuments EntityRecognizerDocuments' :: Maybe InputFormat -> Maybe Text -> Text -> EntityRecognizerDocuments -- | Create a value of EntityRecognizerDocuments with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:inputFormat:EntityRecognizerDocuments', -- entityRecognizerDocuments_inputFormat - Specifies how the text -- in an input file should be processed. This is optional, and the -- default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is -- considered a separate document. Use this option when you are -- processing large documents, such as newspaper articles or scientific -- papers. ONE_DOC_PER_LINE - Each line in a file is considered a -- separate document. Use this option when you are processing many short -- documents, such as text messages. -- -- $sel:testS3Uri:EntityRecognizerDocuments', -- entityRecognizerDocuments_testS3Uri - Specifies the Amazon S3 -- location where the test documents for an entity recognizer are -- located. The URI must be in the same AWS Region as the API endpoint -- that you are calling. -- -- $sel:s3Uri:EntityRecognizerDocuments', -- entityRecognizerDocuments_s3Uri - Specifies the Amazon S3 -- location where the training documents for an entity recognizer are -- located. The URI must be in the same region as the API endpoint that -- you are calling. newEntityRecognizerDocuments :: Text -> EntityRecognizerDocuments -- | Describes the entity recognizer submitted with an entity recognizer. -- -- See: newEntityRecognizerEntityList smart constructor. data EntityRecognizerEntityList EntityRecognizerEntityList' :: Text -> EntityRecognizerEntityList -- | Create a value of EntityRecognizerEntityList with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:s3Uri:EntityRecognizerEntityList', -- entityRecognizerEntityList_s3Uri - Specifies the Amazon S3 -- location where the entity list is located. The URI must be in the same -- region as the API endpoint that you are calling. newEntityRecognizerEntityList :: Text -> EntityRecognizerEntityList -- | Detailed information about the accuracy of an entity recognizer. -- -- See: newEntityRecognizerEvaluationMetrics smart -- constructor. data EntityRecognizerEvaluationMetrics EntityRecognizerEvaluationMetrics' :: Maybe Double -> Maybe Double -> Maybe Double -> EntityRecognizerEvaluationMetrics -- | Create a value of EntityRecognizerEvaluationMetrics with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:f1Score:EntityRecognizerEvaluationMetrics', -- entityRecognizerEvaluationMetrics_f1Score - A measure of how -- accurate the recognizer results are for the test data. It is derived -- from the Precision and Recall values. The -- F1Score is the harmonic average of the two scores. For plain -- text entity recognizer models, the range is 0 to 100, where 100 is the -- best score. For PDF/Word entity recognizer models, the range is 0 to -- 1, where 1 is the best score. -- -- $sel:precision:EntityRecognizerEvaluationMetrics', -- entityRecognizerEvaluationMetrics_precision - A measure of the -- usefulness of the recognizer results in the test data. High precision -- means that the recognizer returned substantially more relevant results -- than irrelevant ones. -- -- $sel:recall:EntityRecognizerEvaluationMetrics', -- entityRecognizerEvaluationMetrics_recall - A measure of how -- complete the recognizer results are for the test data. High recall -- means that the recognizer returned most of the relevant results. newEntityRecognizerEvaluationMetrics :: EntityRecognizerEvaluationMetrics -- | Provides information for filtering a list of entity recognizers. You -- can only specify one filtering parameter in a request. For more -- information, see the operation./> -- -- See: newEntityRecognizerFilter smart constructor. data EntityRecognizerFilter EntityRecognizerFilter' :: Maybe Text -> Maybe ModelStatus -> Maybe POSIX -> Maybe POSIX -> EntityRecognizerFilter -- | Create a value of EntityRecognizerFilter with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:recognizerName:EntityRecognizerFilter', -- entityRecognizerFilter_recognizerName - The name that you -- assigned the entity recognizer. -- -- $sel:status:EntityRecognizerFilter', -- entityRecognizerFilter_status - The status of an entity -- recognizer. -- -- $sel:submitTimeAfter:EntityRecognizerFilter', -- entityRecognizerFilter_submitTimeAfter - Filters the list of -- entities based on the time that the list was submitted for processing. -- Returns only jobs submitted after the specified time. Jobs are -- returned in ascending order, oldest to newest. -- -- $sel:submitTimeBefore:EntityRecognizerFilter', -- entityRecognizerFilter_submitTimeBefore - Filters the list of -- entities based on the time that the list was submitted for processing. -- Returns only jobs submitted before the specified time. Jobs are -- returned in descending order, newest to oldest. newEntityRecognizerFilter :: EntityRecognizerFilter -- | Specifies the format and location of the input data. -- -- See: newEntityRecognizerInputDataConfig smart -- constructor. data EntityRecognizerInputDataConfig EntityRecognizerInputDataConfig' :: Maybe EntityRecognizerAnnotations -> Maybe [AugmentedManifestsListItem] -> Maybe EntityRecognizerDataFormat -> Maybe EntityRecognizerDocuments -> Maybe EntityRecognizerEntityList -> [EntityTypesListItem] -> EntityRecognizerInputDataConfig -- | Create a value of EntityRecognizerInputDataConfig with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:annotations:EntityRecognizerInputDataConfig', -- entityRecognizerInputDataConfig_annotations - The S3 location -- of the CSV file that annotates your training documents. -- -- $sel:augmentedManifests:EntityRecognizerInputDataConfig', -- entityRecognizerInputDataConfig_augmentedManifests - A list of -- augmented manifest files that provide training data for your custom -- model. An augmented manifest file is a labeled dataset that is -- produced by Amazon SageMaker Ground Truth. -- -- This parameter is required if you set DataFormat to -- AUGMENTED_MANIFEST. -- -- $sel:dataFormat:EntityRecognizerInputDataConfig', -- entityRecognizerInputDataConfig_dataFormat - The format of your -- training data: -- -- -- -- If you don't specify a value, Amazon Comprehend uses -- COMPREHEND_CSV as the default. -- -- $sel:documents:EntityRecognizerInputDataConfig', -- entityRecognizerInputDataConfig_documents - The S3 location of -- the folder that contains the training documents for your custom entity -- recognizer. -- -- This parameter is required if you set DataFormat to -- COMPREHEND_CSV. -- -- $sel:entityList:EntityRecognizerInputDataConfig', -- entityRecognizerInputDataConfig_entityList - The S3 location of -- the CSV file that has the entity list for your custom entity -- recognizer. -- -- $sel:entityTypes:EntityRecognizerInputDataConfig', -- entityRecognizerInputDataConfig_entityTypes - The entity types -- in the labeled training data that Amazon Comprehend uses to train the -- custom entity recognizer. Any entity types that you don't specify are -- ignored. -- -- A maximum of 25 entity types can be used at one time to train an -- entity recognizer. Entity types must not contain the following invalid -- characters: \n (line break), \\n (escaped line break), \r (carriage -- return), \\r (escaped carriage return), \t (tab), \\t (escaped tab), -- space, and , (comma). newEntityRecognizerInputDataConfig :: EntityRecognizerInputDataConfig -- | Detailed information about an entity recognizer. -- -- See: newEntityRecognizerMetadata smart constructor. data EntityRecognizerMetadata EntityRecognizerMetadata' :: Maybe [EntityRecognizerMetadataEntityTypesListItem] -> Maybe EntityRecognizerEvaluationMetrics -> Maybe Int -> Maybe Int -> EntityRecognizerMetadata -- | Create a value of EntityRecognizerMetadata with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:entityTypes:EntityRecognizerMetadata', -- entityRecognizerMetadata_entityTypes - Entity types from the -- metadata of an entity recognizer. -- -- EntityRecognizerMetadata, -- entityRecognizerMetadata_evaluationMetrics - Detailed -- information about the accuracy of an entity recognizer. -- -- $sel:numberOfTestDocuments:EntityRecognizerMetadata', -- entityRecognizerMetadata_numberOfTestDocuments - The number of -- documents in the input data that were used to test the entity -- recognizer. Typically this is 10 to 20 percent of the input documents. -- -- $sel:numberOfTrainedDocuments:EntityRecognizerMetadata', -- entityRecognizerMetadata_numberOfTrainedDocuments - The number -- of documents in the input data that were used to train the entity -- recognizer. Typically this is 80 to 90 percent of the input documents. newEntityRecognizerMetadata :: EntityRecognizerMetadata -- | Individual item from the list of entity types in the metadata of an -- entity recognizer. -- -- See: newEntityRecognizerMetadataEntityTypesListItem -- smart constructor. data EntityRecognizerMetadataEntityTypesListItem EntityRecognizerMetadataEntityTypesListItem' :: Maybe EntityTypesEvaluationMetrics -> Maybe Int -> Maybe Text -> EntityRecognizerMetadataEntityTypesListItem -- | Create a value of EntityRecognizerMetadataEntityTypesListItem -- with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:evaluationMetrics:EntityRecognizerMetadataEntityTypesListItem', -- entityRecognizerMetadataEntityTypesListItem_evaluationMetrics - -- Detailed information about the accuracy of the entity recognizer for a -- specific item on the list of entity types. -- -- -- $sel:numberOfTrainMentions:EntityRecognizerMetadataEntityTypesListItem', -- entityRecognizerMetadataEntityTypesListItem_numberOfTrainMentions -- - Indicates the number of times the given entity type was seen in the -- training data. -- -- $sel:type':EntityRecognizerMetadataEntityTypesListItem', -- entityRecognizerMetadataEntityTypesListItem_type - Type of -- entity from the list of entity types in the metadata of an entity -- recognizer. newEntityRecognizerMetadataEntityTypesListItem :: EntityRecognizerMetadataEntityTypesListItem -- | Describes information about an entity recognizer. -- -- See: newEntityRecognizerProperties smart constructor. data EntityRecognizerProperties EntityRecognizerProperties' :: Maybe Text -> Maybe POSIX -> Maybe Text -> Maybe EntityRecognizerInputDataConfig -> Maybe LanguageCode -> Maybe Text -> Maybe Text -> Maybe (Sensitive EntityRecognizerMetadata) -> Maybe Text -> Maybe ModelStatus -> Maybe POSIX -> Maybe POSIX -> Maybe POSIX -> Maybe Text -> Maybe Text -> Maybe VpcConfig -> EntityRecognizerProperties -- | Create a value of EntityRecognizerProperties with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:dataAccessRoleArn:EntityRecognizerProperties', -- entityRecognizerProperties_dataAccessRoleArn - The Amazon -- Resource Name (ARN) of the AWS Identity and Management (IAM) role that -- grants Amazon Comprehend read access to your input data. -- -- $sel:endTime:EntityRecognizerProperties', -- entityRecognizerProperties_endTime - The time that the -- recognizer creation completed. -- -- $sel:entityRecognizerArn:EntityRecognizerProperties', -- entityRecognizerProperties_entityRecognizerArn - The Amazon -- Resource Name (ARN) that identifies the entity recognizer. -- -- $sel:inputDataConfig:EntityRecognizerProperties', -- entityRecognizerProperties_inputDataConfig - The input data -- properties of an entity recognizer. -- -- $sel:languageCode:EntityRecognizerProperties', -- entityRecognizerProperties_languageCode - The language of the -- input documents. All documents must be in the same language. Only -- English ("en") is currently supported. -- -- $sel:message:EntityRecognizerProperties', -- entityRecognizerProperties_message - A description of the -- status of the recognizer. -- -- $sel:modelKmsKeyId:EntityRecognizerProperties', -- entityRecognizerProperties_modelKmsKeyId - ID for the AWS Key -- Management Service (KMS) key that Amazon Comprehend uses to encrypt -- trained custom models. The ModelKmsKeyId can be either of the -- following formats: -- -- -- -- $sel:recognizerMetadata:EntityRecognizerProperties', -- entityRecognizerProperties_recognizerMetadata - Provides -- information about an entity recognizer. -- -- $sel:sourceModelArn:EntityRecognizerProperties', -- entityRecognizerProperties_sourceModelArn - The Amazon Resource -- Name (ARN) of the source model. This model was imported from a -- different AWS account to create the entity recognizer model in your -- AWS account. -- -- $sel:status:EntityRecognizerProperties', -- entityRecognizerProperties_status - Provides the status of the -- entity recognizer. -- -- $sel:submitTime:EntityRecognizerProperties', -- entityRecognizerProperties_submitTime - The time that the -- recognizer was submitted for processing. -- -- $sel:trainingEndTime:EntityRecognizerProperties', -- entityRecognizerProperties_trainingEndTime - The time that -- training of the entity recognizer was completed. -- -- $sel:trainingStartTime:EntityRecognizerProperties', -- entityRecognizerProperties_trainingStartTime - The time that -- training of the entity recognizer started. -- -- $sel:versionName:EntityRecognizerProperties', -- entityRecognizerProperties_versionName - The version name you -- assigned to the entity recognizer. -- -- $sel:volumeKmsKeyId:EntityRecognizerProperties', -- entityRecognizerProperties_volumeKmsKeyId - ID for the AWS Key -- Management Service (KMS) key that Amazon Comprehend uses to encrypt -- data on the storage volume attached to the ML compute instance(s) that -- process the analysis job. The VolumeKmsKeyId can be either of the -- following formats: -- -- -- -- $sel:vpcConfig:EntityRecognizerProperties', -- entityRecognizerProperties_vpcConfig - Configuration parameters -- for a private Virtual Private Cloud (VPC) containing the resources you -- are using for your custom entity recognizer. For more information, see -- Amazon VPC. newEntityRecognizerProperties :: EntityRecognizerProperties -- | Describes the information about an entity recognizer and its versions. -- -- See: newEntityRecognizerSummary smart constructor. data EntityRecognizerSummary EntityRecognizerSummary' :: Maybe POSIX -> Maybe Text -> Maybe ModelStatus -> Maybe Int -> Maybe Text -> EntityRecognizerSummary -- | Create a value of EntityRecognizerSummary with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:latestVersionCreatedAt:EntityRecognizerSummary', -- entityRecognizerSummary_latestVersionCreatedAt - The time that -- the latest entity recognizer version was submitted for processing. -- -- $sel:latestVersionName:EntityRecognizerSummary', -- entityRecognizerSummary_latestVersionName - The version name -- you assigned to the latest entity recognizer version. -- -- $sel:latestVersionStatus:EntityRecognizerSummary', -- entityRecognizerSummary_latestVersionStatus - Provides the -- status of the latest entity recognizer version. -- -- $sel:numberOfVersions:EntityRecognizerSummary', -- entityRecognizerSummary_numberOfVersions - The number of -- versions you created. -- -- $sel:recognizerName:EntityRecognizerSummary', -- entityRecognizerSummary_recognizerName - The name that you -- assigned the entity recognizer. newEntityRecognizerSummary :: EntityRecognizerSummary -- | Detailed information about the accuracy of an entity recognizer for a -- specific entity type. -- -- See: newEntityTypesEvaluationMetrics smart constructor. data EntityTypesEvaluationMetrics EntityTypesEvaluationMetrics' :: Maybe Double -> Maybe Double -> Maybe Double -> EntityTypesEvaluationMetrics -- | Create a value of EntityTypesEvaluationMetrics with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:f1Score:EntityTypesEvaluationMetrics', -- entityTypesEvaluationMetrics_f1Score - A measure of how -- accurate the recognizer results are for a specific entity type in the -- test data. It is derived from the Precision and -- Recall values. The F1Score is the harmonic average -- of the two scores. The highest score is 1, and the worst score is 0. -- -- $sel:precision:EntityTypesEvaluationMetrics', -- entityTypesEvaluationMetrics_precision - A measure of the -- usefulness of the recognizer results for a specific entity type in the -- test data. High precision means that the recognizer returned -- substantially more relevant results than irrelevant ones. -- -- $sel:recall:EntityTypesEvaluationMetrics', -- entityTypesEvaluationMetrics_recall - A measure of how complete -- the recognizer results are for a specific entity type in the test -- data. High recall means that the recognizer returned most of the -- relevant results. newEntityTypesEvaluationMetrics :: EntityTypesEvaluationMetrics -- | An entity type within a labeled training dataset that Amazon -- Comprehend uses to train a custom entity recognizer. -- -- See: newEntityTypesListItem smart constructor. data EntityTypesListItem EntityTypesListItem' :: Text -> EntityTypesListItem -- | Create a value of EntityTypesListItem with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:type':EntityTypesListItem', -- entityTypesListItem_type - An entity type within a labeled -- training dataset that Amazon Comprehend uses to train a custom entity -- recognizer. -- -- Entity types must not contain the following invalid characters: \n -- (line break), \\n (escaped line break, \r (carriage return), \\r -- (escaped carriage return), \t (tab), \\t (escaped tab), space, and , -- (comma). newEntityTypesListItem :: Text -> EntityTypesListItem -- | Text extraction encountered one or more page-level errors in the input -- document. -- -- The ErrorCode contains one of the following values: -- -- -- -- See: newErrorsListItem smart constructor. data ErrorsListItem ErrorsListItem' :: Maybe PageBasedErrorCode -> Maybe Text -> Maybe Int -> ErrorsListItem -- | Create a value of ErrorsListItem with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:errorCode:ErrorsListItem', errorsListItem_errorCode -- - Error code for the cause of the error. -- -- $sel:errorMessage:ErrorsListItem', -- errorsListItem_errorMessage - Text message explaining the -- reason for the error. -- -- $sel:page:ErrorsListItem', errorsListItem_page - Page -- number where the error occurred. newErrorsListItem :: ErrorsListItem -- | Provides information for filtering a list of event detection jobs. -- -- See: newEventsDetectionJobFilter smart constructor. data EventsDetectionJobFilter EventsDetectionJobFilter' :: Maybe Text -> Maybe JobStatus -> Maybe POSIX -> Maybe POSIX -> EventsDetectionJobFilter -- | Create a value of EventsDetectionJobFilter with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:jobName:EventsDetectionJobFilter', -- eventsDetectionJobFilter_jobName - Filters on the name of the -- events detection job. -- -- $sel:jobStatus:EventsDetectionJobFilter', -- eventsDetectionJobFilter_jobStatus - Filters the list of jobs -- based on job status. Returns only jobs with the specified status. -- -- $sel:submitTimeAfter:EventsDetectionJobFilter', -- eventsDetectionJobFilter_submitTimeAfter - Filters the list of -- jobs based on the time that the job was submitted for processing. -- Returns only jobs submitted after the specified time. Jobs are -- returned in descending order, newest to oldest. -- -- $sel:submitTimeBefore:EventsDetectionJobFilter', -- eventsDetectionJobFilter_submitTimeBefore - Filters the list of -- jobs based on the time that the job was submitted for processing. -- Returns only jobs submitted before the specified time. Jobs are -- returned in ascending order, oldest to newest. newEventsDetectionJobFilter :: EventsDetectionJobFilter -- | Provides information about an events detection job. -- -- See: newEventsDetectionJobProperties smart constructor. data EventsDetectionJobProperties EventsDetectionJobProperties' :: Maybe Text -> Maybe POSIX -> Maybe InputDataConfig -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe JobStatus -> Maybe LanguageCode -> Maybe Text -> Maybe OutputDataConfig -> Maybe POSIX -> Maybe (NonEmpty Text) -> EventsDetectionJobProperties -- | Create a value of EventsDetectionJobProperties with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:dataAccessRoleArn:EventsDetectionJobProperties', -- eventsDetectionJobProperties_dataAccessRoleArn - The Amazon -- Resource Name (ARN) of the AWS Identify and Access Management (IAM) -- role that grants Amazon Comprehend read access to your input data. -- -- $sel:endTime:EventsDetectionJobProperties', -- eventsDetectionJobProperties_endTime - The time that the events -- detection job completed. -- -- $sel:inputDataConfig:EventsDetectionJobProperties', -- eventsDetectionJobProperties_inputDataConfig - The input data -- configuration that you supplied when you created the events detection -- job. -- -- $sel:jobArn:EventsDetectionJobProperties', -- eventsDetectionJobProperties_jobArn - The Amazon Resource Name -- (ARN) of the events detection job. It is a unique, fully qualified -- identifier for the job. It includes the AWS account, Region, and the -- job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- $sel:jobId:EventsDetectionJobProperties', -- eventsDetectionJobProperties_jobId - The identifier assigned to -- the events detection job. -- -- $sel:jobName:EventsDetectionJobProperties', -- eventsDetectionJobProperties_jobName - The name you assigned -- the events detection job. -- -- $sel:jobStatus:EventsDetectionJobProperties', -- eventsDetectionJobProperties_jobStatus - The current status of -- the events detection job. -- -- $sel:languageCode:EventsDetectionJobProperties', -- eventsDetectionJobProperties_languageCode - The language code -- of the input documents. -- -- $sel:message:EventsDetectionJobProperties', -- eventsDetectionJobProperties_message - A description of the -- status of the events detection job. -- -- $sel:outputDataConfig:EventsDetectionJobProperties', -- eventsDetectionJobProperties_outputDataConfig - The output data -- configuration that you supplied when you created the events detection -- job. -- -- $sel:submitTime:EventsDetectionJobProperties', -- eventsDetectionJobProperties_submitTime - The time that the -- events detection job was submitted for processing. -- -- $sel:targetEventTypes:EventsDetectionJobProperties', -- eventsDetectionJobProperties_targetEventTypes - The types of -- events that are detected by the job. newEventsDetectionJobProperties :: EventsDetectionJobProperties -- | Array of the number of characters extracted from each page. -- -- See: newExtractedCharactersListItem smart constructor. data ExtractedCharactersListItem ExtractedCharactersListItem' :: Maybe Int -> Maybe Int -> ExtractedCharactersListItem -- | Create a value of ExtractedCharactersListItem with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:count:ExtractedCharactersListItem', -- extractedCharactersListItem_count - Number of characters -- extracted from each page. -- -- $sel:page:ExtractedCharactersListItem', -- extractedCharactersListItem_page - Page number. newExtractedCharactersListItem :: ExtractedCharactersListItem -- | Information about the location of items on a document page. -- -- For additional information, see Geometry in the Amazon Textract -- API reference. -- -- See: newGeometry smart constructor. data Geometry Geometry' :: Maybe BoundingBox -> Maybe [Point] -> Geometry -- | Create a value of Geometry with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:boundingBox:Geometry', geometry_boundingBox - An -- axis-aligned coarse representation of the location of the recognized -- item on the document page. -- -- $sel:polygon:Geometry', geometry_polygon - Within the -- bounding box, a fine-grained polygon around the recognized item. newGeometry :: Geometry -- | The input properties for an inference job. The document reader config -- field applies only to non-text inputs for custom analysis. -- -- See: newInputDataConfig smart constructor. data InputDataConfig InputDataConfig' :: Maybe DocumentReaderConfig -> Maybe InputFormat -> Text -> InputDataConfig -- | Create a value of InputDataConfig with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:documentReaderConfig:InputDataConfig', -- inputDataConfig_documentReaderConfig - Provides configuration -- parameters to override the default actions for extracting text from -- PDF documents and image files. -- -- $sel:inputFormat:InputDataConfig', -- inputDataConfig_inputFormat - Specifies how the text in an -- input file should be processed: -- -- -- -- $sel:s3Uri:InputDataConfig', inputDataConfig_s3Uri - The -- Amazon S3 URI for the input data. The URI must be in same region as -- the API endpoint that you are calling. The URI can point to a single -- input file or it can provide the prefix for a collection of data -- files. -- -- For example, if you use the URI S3://bucketName/prefix, if -- the prefix is a single file, Amazon Comprehend uses that file as -- input. If more than one file begins with the prefix, Amazon Comprehend -- uses all of them as input. newInputDataConfig :: Text -> InputDataConfig -- | Describes a key noun phrase. -- -- See: newKeyPhrase smart constructor. data KeyPhrase KeyPhrase' :: Maybe Int -> Maybe Int -> Maybe Double -> Maybe Text -> KeyPhrase -- | Create a value of KeyPhrase with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:beginOffset:KeyPhrase', keyPhrase_beginOffset - The -- zero-based offset from the beginning of the source text to the first -- character in the key phrase. -- -- $sel:endOffset:KeyPhrase', keyPhrase_endOffset - The -- zero-based offset from the beginning of the source text to the last -- character in the key phrase. -- -- $sel:score:KeyPhrase', keyPhrase_score - The level of -- confidence that Amazon Comprehend has in the accuracy of the -- detection. -- -- $sel:text:KeyPhrase', keyPhrase_text - The text of a key -- noun phrase. newKeyPhrase :: KeyPhrase -- | Provides information for filtering a list of dominant language -- detection jobs. For more information, see the operation. -- -- See: newKeyPhrasesDetectionJobFilter smart constructor. data KeyPhrasesDetectionJobFilter KeyPhrasesDetectionJobFilter' :: Maybe Text -> Maybe JobStatus -> Maybe POSIX -> Maybe POSIX -> KeyPhrasesDetectionJobFilter -- | Create a value of KeyPhrasesDetectionJobFilter with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:jobName:KeyPhrasesDetectionJobFilter', -- keyPhrasesDetectionJobFilter_jobName - Filters on the name of -- the job. -- -- $sel:jobStatus:KeyPhrasesDetectionJobFilter', -- keyPhrasesDetectionJobFilter_jobStatus - Filters the list of -- jobs based on job status. Returns only jobs with the specified status. -- -- $sel:submitTimeAfter:KeyPhrasesDetectionJobFilter', -- keyPhrasesDetectionJobFilter_submitTimeAfter - Filters the list -- of jobs based on the time that the job was submitted for processing. -- Returns only jobs submitted after the specified time. Jobs are -- returned in descending order, newest to oldest. -- -- $sel:submitTimeBefore:KeyPhrasesDetectionJobFilter', -- keyPhrasesDetectionJobFilter_submitTimeBefore - Filters the -- list of jobs based on the time that the job was submitted for -- processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. newKeyPhrasesDetectionJobFilter :: KeyPhrasesDetectionJobFilter -- | Provides information about a key phrases detection job. -- -- See: newKeyPhrasesDetectionJobProperties smart -- constructor. data KeyPhrasesDetectionJobProperties KeyPhrasesDetectionJobProperties' :: Maybe Text -> Maybe POSIX -> Maybe InputDataConfig -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe JobStatus -> Maybe LanguageCode -> Maybe Text -> Maybe OutputDataConfig -> Maybe POSIX -> Maybe Text -> Maybe VpcConfig -> KeyPhrasesDetectionJobProperties -- | Create a value of KeyPhrasesDetectionJobProperties with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:dataAccessRoleArn:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_dataAccessRoleArn - The Amazon -- Resource Name (ARN) that gives Amazon Comprehend read access to your -- input data. -- -- $sel:endTime:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_endTime - The time that the -- key phrases detection job completed. -- -- $sel:inputDataConfig:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_inputDataConfig - The input -- data configuration that you supplied when you created the key phrases -- detection job. -- -- $sel:jobArn:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_jobArn - The Amazon Resource -- Name (ARN) of the key phrases detection job. It is a unique, fully -- qualified identifier for the job. It includes the AWS account, Region, -- and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- $sel:jobId:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_jobId - The identifier -- assigned to the key phrases detection job. -- -- $sel:jobName:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_jobName - The name that you -- assigned the key phrases detection job. -- -- $sel:jobStatus:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_jobStatus - The current status -- of the key phrases detection job. If the status is FAILED, -- the Message field shows the reason for the failure. -- -- $sel:languageCode:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_languageCode - The language -- code of the input documents. -- -- $sel:message:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_message - A description of the -- status of a job. -- -- $sel:outputDataConfig:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_outputDataConfig - The output -- data configuration that you supplied when you created the key phrases -- detection job. -- -- $sel:submitTime:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_submitTime - The time that the -- key phrases detection job was submitted for processing. -- -- $sel:volumeKmsKeyId:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_volumeKmsKeyId - ID for the -- AWS Key Management Service (KMS) key that Amazon Comprehend uses to -- encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- -- -- $sel:vpcConfig:KeyPhrasesDetectionJobProperties', -- keyPhrasesDetectionJobProperties_vpcConfig - Configuration -- parameters for a private Virtual Private Cloud (VPC) containing the -- resources you are using for your key phrases detection job. For more -- information, see Amazon VPC. newKeyPhrasesDetectionJobProperties :: KeyPhrasesDetectionJobProperties -- | Contains the sentiment and sentiment score for one mention of an -- entity. -- -- For more information about targeted sentiment, see Targeted -- sentiment. -- -- See: newMentionSentiment smart constructor. data MentionSentiment MentionSentiment' :: Maybe SentimentType -> Maybe SentimentScore -> MentionSentiment -- | Create a value of MentionSentiment with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:sentiment:MentionSentiment', -- mentionSentiment_sentiment - The sentiment of the mention. -- -- $sel:sentimentScore:MentionSentiment', -- mentionSentiment_sentimentScore - Undocumented member. newMentionSentiment :: MentionSentiment -- | Provides configuration parameters for the output of inference jobs. -- -- See: newOutputDataConfig smart constructor. data OutputDataConfig OutputDataConfig' :: Maybe Text -> Text -> OutputDataConfig -- | Create a value of OutputDataConfig with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:kmsKeyId:OutputDataConfig', -- outputDataConfig_kmsKeyId - ID for the AWS Key Management -- Service (KMS) key that Amazon Comprehend uses to encrypt the output -- results from an analysis job. The KmsKeyId can be one of the following -- formats: -- -- -- -- $sel:s3Uri:OutputDataConfig', outputDataConfig_s3Uri - -- When you use the OutputDataConfig object with asynchronous -- operations, you specify the Amazon S3 location where you want to write -- the output data. The URI must be in the same region as the API -- endpoint that you are calling. The location is used as the prefix for -- the actual location of the output file. -- -- When the topic detection job is finished, the service creates an -- output file in a directory specific to the job. The S3Uri -- field contains the location of the output file, called -- output.tar.gz. It is a compressed archive that contains the -- ouput of the operation. -- -- For a PII entity detection job, the output file is plain text, not a -- compressed archive. The output file name is the same as the input -- file, with .out appended at the end. newOutputDataConfig :: Text -> OutputDataConfig -- | Identifies the part of speech represented by the token and gives the -- confidence that Amazon Comprehend has that the part of speech was -- correctly identified. For more information about the parts of speech -- that Amazon Comprehend can identify, see Syntax in the -- Comprehend Developer Guide. -- -- See: newPartOfSpeechTag smart constructor. data PartOfSpeechTag PartOfSpeechTag' :: Maybe Double -> Maybe PartOfSpeechTagType -> PartOfSpeechTag -- | Create a value of PartOfSpeechTag with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:score:PartOfSpeechTag', partOfSpeechTag_score - The -- confidence that Amazon Comprehend has that the part of speech was -- correctly identified. -- -- $sel:tag:PartOfSpeechTag', partOfSpeechTag_tag - -- Identifies the part of speech that the token represents. newPartOfSpeechTag :: PartOfSpeechTag -- | Provides information for filtering a list of PII entity detection -- jobs. -- -- See: newPiiEntitiesDetectionJobFilter smart constructor. data PiiEntitiesDetectionJobFilter PiiEntitiesDetectionJobFilter' :: Maybe Text -> Maybe JobStatus -> Maybe POSIX -> Maybe POSIX -> PiiEntitiesDetectionJobFilter -- | Create a value of PiiEntitiesDetectionJobFilter with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:jobName:PiiEntitiesDetectionJobFilter', -- piiEntitiesDetectionJobFilter_jobName - Filters on the name of -- the job. -- -- $sel:jobStatus:PiiEntitiesDetectionJobFilter', -- piiEntitiesDetectionJobFilter_jobStatus - Filters the list of -- jobs based on job status. Returns only jobs with the specified status. -- -- $sel:submitTimeAfter:PiiEntitiesDetectionJobFilter', -- piiEntitiesDetectionJobFilter_submitTimeAfter - Filters the -- list of jobs based on the time that the job was submitted for -- processing. Returns only jobs submitted after the specified time. Jobs -- are returned in descending order, newest to oldest. -- -- $sel:submitTimeBefore:PiiEntitiesDetectionJobFilter', -- piiEntitiesDetectionJobFilter_submitTimeBefore - Filters the -- list of jobs based on the time that the job was submitted for -- processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. newPiiEntitiesDetectionJobFilter :: PiiEntitiesDetectionJobFilter -- | Provides information about a PII entities detection job. -- -- See: newPiiEntitiesDetectionJobProperties smart -- constructor. data PiiEntitiesDetectionJobProperties PiiEntitiesDetectionJobProperties' :: Maybe Text -> Maybe POSIX -> Maybe InputDataConfig -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe JobStatus -> Maybe LanguageCode -> Maybe Text -> Maybe PiiEntitiesDetectionMode -> Maybe PiiOutputDataConfig -> Maybe RedactionConfig -> Maybe POSIX -> PiiEntitiesDetectionJobProperties -- | Create a value of PiiEntitiesDetectionJobProperties with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:dataAccessRoleArn:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_dataAccessRoleArn - The -- Amazon Resource Name (ARN) that gives Amazon Comprehend read access to -- your input data. -- -- $sel:endTime:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_endTime - The time that the -- PII entities detection job completed. -- -- $sel:inputDataConfig:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_inputDataConfig - The input -- properties for a PII entities detection job. -- -- $sel:jobArn:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_jobArn - The Amazon Resource -- Name (ARN) of the PII entities detection job. It is a unique, fully -- qualified identifier for the job. It includes the AWS account, Region, -- and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- $sel:jobId:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_jobId - The identifier -- assigned to the PII entities detection job. -- -- $sel:jobName:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_jobName - The name that you -- assigned the PII entities detection job. -- -- $sel:jobStatus:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_jobStatus - The current -- status of the PII entities detection job. If the status is -- FAILED, the Message field shows the reason for the -- failure. -- -- $sel:languageCode:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_languageCode - The language -- code of the input documents -- -- $sel:message:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_message - A description of -- the status of a job. -- -- $sel:mode:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_mode - Specifies whether the -- output provides the locations (offsets) of PII entities or a file in -- which PII entities are redacted. -- -- $sel:outputDataConfig:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_outputDataConfig - The output -- data configuration that you supplied when you created the PII entities -- detection job. -- -- $sel:redactionConfig:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_redactionConfig - Provides -- configuration parameters for PII entity redaction. -- -- This parameter is required if you set the Mode parameter to -- ONLY_REDACTION. In that case, you must provide a -- RedactionConfig definition that includes the -- PiiEntityTypes parameter. -- -- $sel:submitTime:PiiEntitiesDetectionJobProperties', -- piiEntitiesDetectionJobProperties_submitTime - The time that -- the PII entities detection job was submitted for processing. newPiiEntitiesDetectionJobProperties :: PiiEntitiesDetectionJobProperties -- | Provides information about a PII entity. -- -- See: newPiiEntity smart constructor. data PiiEntity PiiEntity' :: Maybe Int -> Maybe Int -> Maybe Double -> Maybe PiiEntityType -> PiiEntity -- | Create a value of PiiEntity with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:beginOffset:PiiEntity', piiEntity_beginOffset - The -- zero-based offset from the beginning of the source text to the first -- character in the entity. -- -- $sel:endOffset:PiiEntity', piiEntity_endOffset - The -- zero-based offset from the beginning of the source text to the last -- character in the entity. -- -- $sel:score:PiiEntity', piiEntity_score - The level of -- confidence that Amazon Comprehend has in the accuracy of the -- detection. -- -- $sel:type':PiiEntity', piiEntity_type - The entity's -- type. newPiiEntity :: PiiEntity -- | Provides configuration parameters for the output of PII entity -- detection jobs. -- -- See: newPiiOutputDataConfig smart constructor. data PiiOutputDataConfig PiiOutputDataConfig' :: Maybe Text -> Text -> PiiOutputDataConfig -- | Create a value of PiiOutputDataConfig with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:kmsKeyId:PiiOutputDataConfig', -- piiOutputDataConfig_kmsKeyId - ID for the AWS Key Management -- Service (KMS) key that Amazon Comprehend uses to encrypt the output -- results from an analysis job. -- -- $sel:s3Uri:PiiOutputDataConfig', -- piiOutputDataConfig_s3Uri - When you use the -- PiiOutputDataConfig object with asynchronous operations, you -- specify the Amazon S3 location where you want to write the output -- data. -- -- For a PII entity detection job, the output file is plain text, not a -- compressed archive. The output file name is the same as the input -- file, with .out appended at the end. newPiiOutputDataConfig :: Text -> PiiOutputDataConfig -- | The X and Y coordinates of a point on a document page. -- -- For additional information, see Point in the Amazon Textract -- API reference. -- -- See: newPoint smart constructor. data Point Point' :: Maybe Double -> Maybe Double -> Point -- | Create a value of Point with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:x:Point', point_x - The value of the X coordinate -- for a point on a polygon -- -- $sel:y:Point', point_y - The value of the Y coordinate -- for a point on a polygon newPoint :: Point -- | Provides configuration parameters for PII entity redaction. -- -- See: newRedactionConfig smart constructor. data RedactionConfig RedactionConfig' :: Maybe Text -> Maybe PiiEntitiesDetectionMaskMode -> Maybe [PiiEntityType] -> RedactionConfig -- | Create a value of RedactionConfig with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:maskCharacter:RedactionConfig', -- redactionConfig_maskCharacter - A character that replaces each -- character in the redacted PII entity. -- -- $sel:maskMode:RedactionConfig', redactionConfig_maskMode -- - Specifies whether the PII entity is redacted with the mask character -- or the entity type. -- -- $sel:piiEntityTypes:RedactionConfig', -- redactionConfig_piiEntityTypes - An array of the types of PII -- entities that Amazon Comprehend detects in the input text for your -- request. newRedactionConfig :: RedactionConfig -- | List of child blocks for the current block. -- -- See: newRelationshipsListItem smart constructor. data RelationshipsListItem RelationshipsListItem' :: Maybe [Text] -> Maybe RelationshipType -> RelationshipsListItem -- | Create a value of RelationshipsListItem with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:ids:RelationshipsListItem', -- relationshipsListItem_ids - Identifers of the child blocks. -- -- $sel:type':RelationshipsListItem', -- relationshipsListItem_type - Only supported relationship is a -- child relationship. newRelationshipsListItem :: RelationshipsListItem -- | Provides information for filtering a list of dominant language -- detection jobs. For more information, see the operation. -- -- See: newSentimentDetectionJobFilter smart constructor. data SentimentDetectionJobFilter SentimentDetectionJobFilter' :: Maybe Text -> Maybe JobStatus -> Maybe POSIX -> Maybe POSIX -> SentimentDetectionJobFilter -- | Create a value of SentimentDetectionJobFilter with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:jobName:SentimentDetectionJobFilter', -- sentimentDetectionJobFilter_jobName - Filters on the name of -- the job. -- -- $sel:jobStatus:SentimentDetectionJobFilter', -- sentimentDetectionJobFilter_jobStatus - Filters the list of -- jobs based on job status. Returns only jobs with the specified status. -- -- $sel:submitTimeAfter:SentimentDetectionJobFilter', -- sentimentDetectionJobFilter_submitTimeAfter - Filters the list -- of jobs based on the time that the job was submitted for processing. -- Returns only jobs submitted after the specified time. Jobs are -- returned in descending order, newest to oldest. -- -- $sel:submitTimeBefore:SentimentDetectionJobFilter', -- sentimentDetectionJobFilter_submitTimeBefore - Filters the list -- of jobs based on the time that the job was submitted for processing. -- Returns only jobs submitted before the specified time. Jobs are -- returned in ascending order, oldest to newest. newSentimentDetectionJobFilter :: SentimentDetectionJobFilter -- | Provides information about a sentiment detection job. -- -- See: newSentimentDetectionJobProperties smart -- constructor. data SentimentDetectionJobProperties SentimentDetectionJobProperties' :: Maybe Text -> Maybe POSIX -> Maybe InputDataConfig -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe JobStatus -> Maybe LanguageCode -> Maybe Text -> Maybe OutputDataConfig -> Maybe POSIX -> Maybe Text -> Maybe VpcConfig -> SentimentDetectionJobProperties -- | Create a value of SentimentDetectionJobProperties with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:dataAccessRoleArn:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_dataAccessRoleArn - The Amazon -- Resource Name (ARN) that gives Amazon Comprehend read access to your -- input data. -- -- $sel:endTime:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_endTime - The time that the -- sentiment detection job ended. -- -- $sel:inputDataConfig:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_inputDataConfig - The input -- data configuration that you supplied when you created the sentiment -- detection job. -- -- $sel:jobArn:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_jobArn - The Amazon Resource -- Name (ARN) of the sentiment detection job. It is a unique, fully -- qualified identifier for the job. It includes the AWS account, Region, -- and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- $sel:jobId:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_jobId - The identifier assigned -- to the sentiment detection job. -- -- $sel:jobName:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_jobName - The name that you -- assigned to the sentiment detection job -- -- $sel:jobStatus:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_jobStatus - The current status -- of the sentiment detection job. If the status is FAILED, the -- Messages field shows the reason for the failure. -- -- $sel:languageCode:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_languageCode - The language -- code of the input documents. -- -- $sel:message:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_message - A description of the -- status of a job. -- -- $sel:outputDataConfig:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_outputDataConfig - The output -- data configuration that you supplied when you created the sentiment -- detection job. -- -- $sel:submitTime:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_submitTime - The time that the -- sentiment detection job was submitted for processing. -- -- $sel:volumeKmsKeyId:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_volumeKmsKeyId - ID for the AWS -- Key Management Service (KMS) key that Amazon Comprehend uses to -- encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- -- -- $sel:vpcConfig:SentimentDetectionJobProperties', -- sentimentDetectionJobProperties_vpcConfig - Configuration -- parameters for a private Virtual Private Cloud (VPC) containing the -- resources you are using for your sentiment detection job. For more -- information, see Amazon VPC. newSentimentDetectionJobProperties :: SentimentDetectionJobProperties -- | Describes the level of confidence that Amazon Comprehend has in the -- accuracy of its detection of sentiments. -- -- See: newSentimentScore smart constructor. data SentimentScore SentimentScore' :: Maybe Double -> Maybe Double -> Maybe Double -> Maybe Double -> SentimentScore -- | Create a value of SentimentScore with all optional fields -- omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:mixed:SentimentScore', sentimentScore_mixed - The -- level of confidence that Amazon Comprehend has in the accuracy of its -- detection of the MIXED sentiment. -- -- $sel:negative:SentimentScore', sentimentScore_negative - -- The level of confidence that Amazon Comprehend has in the accuracy of -- its detection of the NEGATIVE sentiment. -- -- $sel:neutral:SentimentScore', sentimentScore_neutral - -- The level of confidence that Amazon Comprehend has in the accuracy of -- its detection of the NEUTRAL sentiment. -- -- $sel:positive:SentimentScore', sentimentScore_positive - -- The level of confidence that Amazon Comprehend has in the accuracy of -- its detection of the POSITIVE sentiment. newSentimentScore :: SentimentScore -- | Represents a work in the input text that was recognized and assigned a -- part of speech. There is one syntax token record for each word in the -- source text. -- -- See: newSyntaxToken smart constructor. data SyntaxToken SyntaxToken' :: Maybe Int -> Maybe Int -> Maybe PartOfSpeechTag -> Maybe Text -> Maybe Int -> SyntaxToken -- | Create a value of SyntaxToken with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:beginOffset:SyntaxToken', syntaxToken_beginOffset - -- The zero-based offset from the beginning of the source text to the -- first character in the word. -- -- $sel:endOffset:SyntaxToken', syntaxToken_endOffset - The -- zero-based offset from the beginning of the source text to the last -- character in the word. -- -- $sel:partOfSpeech:SyntaxToken', syntaxToken_partOfSpeech -- - Provides the part of speech label and the confidence level that -- Amazon Comprehend has that the part of speech was correctly -- identified. For more information, see Syntax in the Comprehend -- Developer Guide. -- -- $sel:text:SyntaxToken', syntaxToken_text - The word that -- was recognized in the source text. -- -- $sel:tokenId:SyntaxToken', syntaxToken_tokenId - A -- unique identifier for a token. newSyntaxToken :: SyntaxToken -- | A key-value pair that adds as a metadata to a resource used by Amazon -- Comprehend. For example, a tag with the key-value pair -- ‘Department’:’Sales’ might be added to a resource to indicate its use -- by a particular department. -- -- See: newTag smart constructor. data Tag Tag' :: Maybe Text -> Text -> Tag -- | Create a value of Tag with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:value:Tag', tag_value - The second part of a -- key-value pair that forms a tag associated with a given resource. For -- instance, if you want to show which resources are used by which -- departments, you might use “Department” as the initial (key) portion -- of the pair, with a value of “sales” to indicate the sales department. -- -- $sel:key:Tag', tag_key - The initial part of a key-value -- pair that forms a tag associated with a given resource. For instance, -- if you want to show which resources are used by which departments, you -- might use “Department” as the key portion of the pair, with multiple -- possible values such as “sales,” “legal,” and “administration.” newTag :: Text -> Tag -- | Provides information for filtering a list of dominant language -- detection jobs. For more information, see the operation. -- -- See: newTargetedSentimentDetectionJobFilter smart -- constructor. data TargetedSentimentDetectionJobFilter TargetedSentimentDetectionJobFilter' :: Maybe Text -> Maybe JobStatus -> Maybe POSIX -> Maybe POSIX -> TargetedSentimentDetectionJobFilter -- | Create a value of TargetedSentimentDetectionJobFilter with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:jobName:TargetedSentimentDetectionJobFilter', -- targetedSentimentDetectionJobFilter_jobName - Filters on the -- name of the job. -- -- $sel:jobStatus:TargetedSentimentDetectionJobFilter', -- targetedSentimentDetectionJobFilter_jobStatus - Filters the -- list of jobs based on job status. Returns only jobs with the specified -- status. -- -- $sel:submitTimeAfter:TargetedSentimentDetectionJobFilter', -- targetedSentimentDetectionJobFilter_submitTimeAfter - Filters -- the list of jobs based on the time that the job was submitted for -- processing. Returns only jobs submitted after the specified time. Jobs -- are returned in descending order, newest to oldest. -- -- $sel:submitTimeBefore:TargetedSentimentDetectionJobFilter', -- targetedSentimentDetectionJobFilter_submitTimeBefore - Filters -- the list of jobs based on the time that the job was submitted for -- processing. Returns only jobs submitted before the specified time. -- Jobs are returned in ascending order, oldest to newest. newTargetedSentimentDetectionJobFilter :: TargetedSentimentDetectionJobFilter -- | Provides information about a targeted sentiment detection job. -- -- See: newTargetedSentimentDetectionJobProperties smart -- constructor. data TargetedSentimentDetectionJobProperties TargetedSentimentDetectionJobProperties' :: Maybe Text -> Maybe POSIX -> Maybe InputDataConfig -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe JobStatus -> Maybe LanguageCode -> Maybe Text -> Maybe OutputDataConfig -> Maybe POSIX -> Maybe Text -> Maybe VpcConfig -> TargetedSentimentDetectionJobProperties -- | Create a value of TargetedSentimentDetectionJobProperties with -- all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- -- $sel:dataAccessRoleArn:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_dataAccessRoleArn - The -- Amazon Resource Name (ARN) that gives Amazon Comprehend read access to -- your input data. -- -- $sel:endTime:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_endTime - The time that -- the targeted sentiment detection job ended. -- -- $sel:inputDataConfig:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_inputDataConfig - -- Undocumented member. -- -- $sel:jobArn:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_jobArn - The Amazon -- Resource Name (ARN) of the targeted sentiment detection job. It is a -- unique, fully qualified identifier for the job. It includes the AWS -- account, Region, and the job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- $sel:jobId:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_jobId - The identifier -- assigned to the targeted sentiment detection job. -- -- $sel:jobName:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_jobName - The name that -- you assigned to the targeted sentiment detection job. -- -- $sel:jobStatus:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_jobStatus - The current -- status of the targeted sentiment detection job. If the status is -- FAILED, the Messages field shows the reason for the -- failure. -- -- $sel:languageCode:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_languageCode - The -- language code of the input documents. -- -- $sel:message:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_message - A description -- of the status of a job. -- -- $sel:outputDataConfig:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_outputDataConfig - -- Undocumented member. -- -- $sel:submitTime:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_submitTime - The time -- that the targeted sentiment detection job was submitted for -- processing. -- -- $sel:volumeKmsKeyId:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_volumeKmsKeyId - ID for -- the AWS Key Management Service (KMS) key that Amazon Comprehend uses -- to encrypt data on the storage volume attached to the ML compute -- instance(s) that process the targeted sentiment detection job. The -- VolumeKmsKeyId can be either of the following formats: -- -- -- -- $sel:vpcConfig:TargetedSentimentDetectionJobProperties', -- targetedSentimentDetectionJobProperties_vpcConfig - -- Undocumented member. newTargetedSentimentDetectionJobProperties :: TargetedSentimentDetectionJobProperties -- | Information about one of the entities found by targeted sentiment -- analysis. -- -- For more information about targeted sentiment, see Targeted -- sentiment. -- -- See: newTargetedSentimentEntity smart constructor. data TargetedSentimentEntity TargetedSentimentEntity' :: Maybe [Int] -> Maybe [TargetedSentimentMention] -> TargetedSentimentEntity -- | Create a value of TargetedSentimentEntity with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:descriptiveMentionIndex:TargetedSentimentEntity', -- targetedSentimentEntity_descriptiveMentionIndex - One or more -- index into the Mentions array that provides the best name for the -- entity group. -- -- $sel:mentions:TargetedSentimentEntity', -- targetedSentimentEntity_mentions - An array of mentions of the -- entity in the document. The array represents a co-reference group. See -- Co-reference group for an example. newTargetedSentimentEntity :: TargetedSentimentEntity -- | Information about one mention of an entity. The mention information -- includes the location of the mention in the text and the sentiment of -- the mention. -- -- For more information about targeted sentiment, see Targeted -- sentiment. -- -- See: newTargetedSentimentMention smart constructor. data TargetedSentimentMention TargetedSentimentMention' :: Maybe Int -> Maybe Int -> Maybe Double -> Maybe MentionSentiment -> Maybe Double -> Maybe Text -> Maybe TargetedSentimentEntityType -> TargetedSentimentMention -- | Create a value of TargetedSentimentMention with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:beginOffset:TargetedSentimentMention', -- targetedSentimentMention_beginOffset - The offset into the -- document text where the mention begins. -- -- $sel:endOffset:TargetedSentimentMention', -- targetedSentimentMention_endOffset - The offset into the -- document text where the mention ends. -- -- $sel:groupScore:TargetedSentimentMention', -- targetedSentimentMention_groupScore - The confidence that all -- the entities mentioned in the group relate to the same entity. -- -- $sel:mentionSentiment:TargetedSentimentMention', -- targetedSentimentMention_mentionSentiment - Contains the -- sentiment and sentiment score for the mention. -- -- $sel:score:TargetedSentimentMention', -- targetedSentimentMention_score - Model confidence that the -- entity is relevant. Value range is zero to one, where one is highest -- confidence. -- -- $sel:text:TargetedSentimentMention', -- targetedSentimentMention_text - The text in the document that -- identifies the entity. -- -- $sel:type':TargetedSentimentMention', -- targetedSentimentMention_type - The type of the entity. Amazon -- Comprehend supports a variety of entity types. newTargetedSentimentMention :: TargetedSentimentMention -- | Provides information for filtering topic detection jobs. For more -- information, see . -- -- See: newTopicsDetectionJobFilter smart constructor. data TopicsDetectionJobFilter TopicsDetectionJobFilter' :: Maybe Text -> Maybe JobStatus -> Maybe POSIX -> Maybe POSIX -> TopicsDetectionJobFilter -- | Create a value of TopicsDetectionJobFilter with all optional -- fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:jobName:TopicsDetectionJobFilter', -- topicsDetectionJobFilter_jobName - -- -- $sel:jobStatus:TopicsDetectionJobFilter', -- topicsDetectionJobFilter_jobStatus - Filters the list of topic -- detection jobs based on job status. Returns only jobs with the -- specified status. -- -- $sel:submitTimeAfter:TopicsDetectionJobFilter', -- topicsDetectionJobFilter_submitTimeAfter - Filters the list of -- jobs based on the time that the job was submitted for processing. Only -- returns jobs submitted after the specified time. Jobs are returned in -- ascending order, oldest to newest. -- -- $sel:submitTimeBefore:TopicsDetectionJobFilter', -- topicsDetectionJobFilter_submitTimeBefore - Filters the list of -- jobs based on the time that the job was submitted for processing. Only -- returns jobs submitted before the specified time. Jobs are returned in -- descending order, newest to oldest. newTopicsDetectionJobFilter :: TopicsDetectionJobFilter -- | Provides information about a topic detection job. -- -- See: newTopicsDetectionJobProperties smart constructor. data TopicsDetectionJobProperties TopicsDetectionJobProperties' :: Maybe Text -> Maybe POSIX -> Maybe InputDataConfig -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe JobStatus -> Maybe Text -> Maybe Int -> Maybe OutputDataConfig -> Maybe POSIX -> Maybe Text -> Maybe VpcConfig -> TopicsDetectionJobProperties -- | Create a value of TopicsDetectionJobProperties with all -- optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:dataAccessRoleArn:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_dataAccessRoleArn - The Amazon -- Resource Name (ARN) of the AWS Identity and Management (IAM) role that -- grants Amazon Comprehend read access to your job data. -- -- $sel:endTime:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_endTime - The time that the topic -- detection job was completed. -- -- $sel:inputDataConfig:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_inputDataConfig - The input data -- configuration supplied when you created the topic detection job. -- -- $sel:jobArn:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_jobArn - The Amazon Resource Name -- (ARN) of the topics detection job. It is a unique, fully qualified -- identifier for the job. It includes the AWS account, Region, and the -- job ID. The format of the ARN is as follows: -- -- 
--   arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
--
-- -- The following is an example job ARN: -- -- 
--   arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab
--
-- -- $sel:jobId:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_jobId - The identifier assigned to -- the topic detection job. -- -- $sel:jobName:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_jobName - The name of the topic -- detection job. -- -- $sel:jobStatus:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_jobStatus - The current status of -- the topic detection job. If the status is Failed, the reason -- for the failure is shown in the Message field. -- -- $sel:message:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_message - A description for the -- status of a job. -- -- $sel:numberOfTopics:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_numberOfTopics - The number of -- topics to detect supplied when you created the topic detection job. -- The default is 10. -- -- $sel:outputDataConfig:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_outputDataConfig - The output data -- configuration supplied when you created the topic detection job. -- -- $sel:submitTime:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_submitTime - The time that the -- topic detection job was submitted for processing. -- -- $sel:volumeKmsKeyId:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_volumeKmsKeyId - ID for the AWS -- Key Management Service (KMS) key that Amazon Comprehend uses to -- encrypt data on the storage volume attached to the ML compute -- instance(s) that process the analysis job. The VolumeKmsKeyId can be -- either of the following formats: -- -- -- -- $sel:vpcConfig:TopicsDetectionJobProperties', -- topicsDetectionJobProperties_vpcConfig - Configuration -- parameters for a private Virtual Private Cloud (VPC) containing the -- resources you are using for your topic detection job. For more -- information, see Amazon VPC. newTopicsDetectionJobProperties :: TopicsDetectionJobProperties -- | Configuration parameters for an optional private Virtual Private Cloud -- (VPC) containing the resources you are using for the job. For more -- information, see Amazon VPC. -- -- See: newVpcConfig smart constructor. data VpcConfig VpcConfig' :: NonEmpty Text -> NonEmpty Text -> VpcConfig -- | Create a value of VpcConfig with all optional fields omitted. -- -- Use generic-lens or optics to modify other optional -- fields. -- -- The following record fields are available, with the corresponding -- lenses provided for backwards compatibility: -- -- $sel:securityGroupIds:VpcConfig', -- vpcConfig_securityGroupIds - The ID number for a security group -- on an instance of your private VPC. Security groups on your VPC -- function serve as a virtual firewall to control inbound and outbound -- traffic and provides security for the resources that you’ll be -- accessing on the VPC. This ID number is preceded by "sg-", for -- instance: "sg-03b388029b0a285ea". For more information, see -- Security Groups for your VPC. -- -- $sel:subnets:VpcConfig', vpcConfig_subnets - The ID for -- each subnet being used in your private VPC. This subnet is a subset of -- the a range of IPv4 addresses used by the VPC and is specific to a -- given availability zone in the VPC’s region. This ID number is -- preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For -- more information, see VPCs and Subnets. newVpcConfig :: NonEmpty Text -> NonEmpty Text -> VpcConfig