1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. comprehend
  6. EntityRecognizer

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi
aws-native logo aws-native logo AWS Cloud Control

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi

    An Amazon Comprehend custom entity recognizer: a trained model that identifies custom entity types in text, created via an asynchronous training job.

    Create EntityRecognizer Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new EntityRecognizer(name: string, args: EntityRecognizerArgs, opts?: CustomResourceOptions);
    @overload
    def EntityRecognizer(resource_name: str,
                         args: EntityRecognizerArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def EntityRecognizer(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         data_access_role_arn: Optional[str] = None,
                         input_data_config: Optional[EntityRecognizerInputDataConfigArgs] = None,
                         language_code: Optional[EntityRecognizerLanguageCode] = None,
                         model_kms_key_id: Optional[str] = None,
                         model_policy: Optional[str] = None,
                         recognizer_name: Optional[str] = None,
                         tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                         version_name: Optional[str] = None,
                         volume_kms_key_id: Optional[str] = None,
                         vpc_config: Optional[EntityRecognizerVpcConfigArgs] = None)
    func NewEntityRecognizer(ctx *Context, name string, args EntityRecognizerArgs, opts ...ResourceOption) (*EntityRecognizer, error)
    public EntityRecognizer(string name, EntityRecognizerArgs args, CustomResourceOptions? opts = null)
    public EntityRecognizer(String name, EntityRecognizerArgs args)
    public EntityRecognizer(String name, EntityRecognizerArgs args, CustomResourceOptions options)
    
    type: aws-native:comprehend:EntityRecognizer
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws-native_comprehend_entity_recognizer" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args EntityRecognizerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args EntityRecognizerArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args EntityRecognizerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EntityRecognizerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EntityRecognizerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    EntityRecognizer Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The EntityRecognizer resource accepts the following input properties:

    DataAccessRoleArn string
    The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
    InputDataConfig Pulumi.AwsNative.Comprehend.Inputs.EntityRecognizerInputDataConfig
    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.
    LanguageCode Pulumi.AwsNative.Comprehend.EntityRecognizerLanguageCode
    The language of the input documents. All documents must be in the same language.
    ModelKmsKeyId string
    ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models.
    ModelPolicy string
    The JSON resource-based policy to attach to your custom entity recognizer model.
    RecognizerName string
    The name given to the entity recognizer.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    Tags to associate with the entity recognizer.
    VersionName string
    The version name given to the entity recognizer.
    VolumeKmsKeyId string
    ID for the AWS KMS key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s).
    VpcConfig Pulumi.AwsNative.Comprehend.Inputs.EntityRecognizerVpcConfig
    Configuration parameters for an optional private VPC containing the resources you are using for your custom entity recognizer.
    DataAccessRoleArn string
    The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
    InputDataConfig EntityRecognizerInputDataConfigArgs
    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.
    LanguageCode EntityRecognizerLanguageCode
    The language of the input documents. All documents must be in the same language.
    ModelKmsKeyId string
    ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models.
    ModelPolicy string
    The JSON resource-based policy to attach to your custom entity recognizer model.
    RecognizerName string
    The name given to the entity recognizer.
    Tags TagArgs
    Tags to associate with the entity recognizer.
    VersionName string
    The version name given to the entity recognizer.
    VolumeKmsKeyId string
    ID for the AWS KMS key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s).
    VpcConfig EntityRecognizerVpcConfigArgs
    Configuration parameters for an optional private VPC containing the resources you are using for your custom entity recognizer.
    data_access_role_arn string
    The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
    input_data_config object
    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.
    language_code "en" | "es" | "fr" | "de" | "it" | "pt" | "ar" | "hi" | "ja" | "ko" | "zh" | "zh-TW"
    The language of the input documents. All documents must be in the same language.
    model_kms_key_id string
    ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models.
    model_policy string
    The JSON resource-based policy to attach to your custom entity recognizer model.
    recognizer_name string
    The name given to the entity recognizer.
    tags list(object)
    Tags to associate with the entity recognizer.
    version_name string
    The version name given to the entity recognizer.
    volume_kms_key_id string
    ID for the AWS KMS key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s).
    vpc_config object
    Configuration parameters for an optional private VPC containing the resources you are using for your custom entity recognizer.
    dataAccessRoleArn String
    The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
    inputDataConfig EntityRecognizerInputDataConfig
    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.
    languageCode EntityRecognizerLanguageCode
    The language of the input documents. All documents must be in the same language.
    modelKmsKeyId String
    ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models.
    modelPolicy String
    The JSON resource-based policy to attach to your custom entity recognizer model.
    recognizerName String
    The name given to the entity recognizer.
    tags List<Tag>
    Tags to associate with the entity recognizer.
    versionName String
    The version name given to the entity recognizer.
    volumeKmsKeyId String
    ID for the AWS KMS key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s).
    vpcConfig EntityRecognizerVpcConfig
    Configuration parameters for an optional private VPC containing the resources you are using for your custom entity recognizer.
    dataAccessRoleArn string
    The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
    inputDataConfig EntityRecognizerInputDataConfig
    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.
    languageCode EntityRecognizerLanguageCode
    The language of the input documents. All documents must be in the same language.
    modelKmsKeyId string
    ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models.
    modelPolicy string
    The JSON resource-based policy to attach to your custom entity recognizer model.
    recognizerName string
    The name given to the entity recognizer.
    tags Tag[]
    Tags to associate with the entity recognizer.
    versionName string
    The version name given to the entity recognizer.
    volumeKmsKeyId string
    ID for the AWS KMS key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s).
    vpcConfig EntityRecognizerVpcConfig
    Configuration parameters for an optional private VPC containing the resources you are using for your custom entity recognizer.
    data_access_role_arn str
    The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
    input_data_config EntityRecognizerInputDataConfigArgs
    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.
    language_code EntityRecognizerLanguageCode
    The language of the input documents. All documents must be in the same language.
    model_kms_key_id str
    ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models.
    model_policy str
    The JSON resource-based policy to attach to your custom entity recognizer model.
    recognizer_name str
    The name given to the entity recognizer.
    tags Sequence[TagArgs]
    Tags to associate with the entity recognizer.
    version_name str
    The version name given to the entity recognizer.
    volume_kms_key_id str
    ID for the AWS KMS key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s).
    vpc_config EntityRecognizerVpcConfigArgs
    Configuration parameters for an optional private VPC containing the resources you are using for your custom entity recognizer.
    dataAccessRoleArn String
    The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
    inputDataConfig Property Map
    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.
    languageCode "en" | "es" | "fr" | "de" | "it" | "pt" | "ar" | "hi" | "ja" | "ko" | "zh" | "zh-TW"
    The language of the input documents. All documents must be in the same language.
    modelKmsKeyId String
    ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models.
    modelPolicy String
    The JSON resource-based policy to attach to your custom entity recognizer model.
    recognizerName String
    The name given to the entity recognizer.
    tags List<Property Map>
    Tags to associate with the entity recognizer.
    versionName String
    The version name given to the entity recognizer.
    volumeKmsKeyId String
    ID for the AWS KMS key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s).
    vpcConfig Property Map
    Configuration parameters for an optional private VPC containing the resources you are using for your custom entity recognizer.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EntityRecognizer resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) that identifies the entity recognizer.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    The Amazon Resource Name (ARN) that identifies the entity recognizer.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn string
    The Amazon Resource Name (ARN) that identifies the entity recognizer.
    id string
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) that identifies the entity recognizer.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    The Amazon Resource Name (ARN) that identifies the entity recognizer.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    The Amazon Resource Name (ARN) that identifies the entity recognizer.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) that identifies the entity recognizer.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing EntityRecognizer Resource

    Get an existing EntityRecognizer resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): EntityRecognizer
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None) -> EntityRecognizer
    func GetEntityRecognizer(ctx *Context, name string, id IDInput, state *EntityRecognizerState, opts ...ResourceOption) (*EntityRecognizer, error)
    public static EntityRecognizer Get(string name, Input<string> id, CustomResourceOptions? opts = null)
    public static EntityRecognizer get(String name, Output<String> id, CustomResourceOptions options)
    resources:  existingEntityRecognizer:    type: aws-native:comprehend:EntityRecognizer    get:      id: ${id}
    import {
      to = aws-native_comprehend_entity_recognizer.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state EntityRecognizerState
    Pass nil. This resource has no state arguments.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Supporting Types

    EntityRecognizerAnnotations, EntityRecognizerAnnotationsArgs

    Describes the annotations associated with an entity recognizer.

    S3Uri string
    Specifies the Amazon S3 location where the annotations are located.
    TestS3Uri string
    Specifies the Amazon S3 location where the test annotations are located.
    S3Uri string
    Specifies the Amazon S3 location where the annotations are located.
    TestS3Uri string
    Specifies the Amazon S3 location where the test annotations are located.
    s3_uri string
    Specifies the Amazon S3 location where the annotations are located.
    test_s3_uri string
    Specifies the Amazon S3 location where the test annotations are located.
    s3Uri String
    Specifies the Amazon S3 location where the annotations are located.
    testS3Uri String
    Specifies the Amazon S3 location where the test annotations are located.
    s3Uri string
    Specifies the Amazon S3 location where the annotations are located.
    testS3Uri string
    Specifies the Amazon S3 location where the test annotations are located.
    s3_uri str
    Specifies the Amazon S3 location where the annotations are located.
    test_s3_uri str
    Specifies the Amazon S3 location where the test annotations are located.
    s3Uri String
    Specifies the Amazon S3 location where the annotations are located.
    testS3Uri String
    Specifies the Amazon S3 location where the test annotations are located.

    EntityRecognizerAugmentedManifestsListItem, EntityRecognizerAugmentedManifestsListItemArgs

    An augmented manifest file that provides training data for your custom model.

    AttributeNames List<string>
    The JSON attribute that contains the annotations for your training documents.
    S3Uri string
    The Amazon S3 location of the augmented manifest file.
    AnnotationDataS3Uri string
    The S3 prefix to the annotation files that are referred in the augmented manifest file.
    DocumentType Pulumi.AwsNative.Comprehend.EntityRecognizerAugmentedManifestsListItemDocumentType
    The type of augmented manifest.
    SourceDocumentsS3Uri string
    The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
    Split Pulumi.AwsNative.Comprehend.EntityRecognizerAugmentedManifestsListItemSplit
    The purpose of the data you've provided in the augmented manifest.
    AttributeNames []string
    The JSON attribute that contains the annotations for your training documents.
    S3Uri string
    The Amazon S3 location of the augmented manifest file.
    AnnotationDataS3Uri string
    The S3 prefix to the annotation files that are referred in the augmented manifest file.
    DocumentType EntityRecognizerAugmentedManifestsListItemDocumentType
    The type of augmented manifest.
    SourceDocumentsS3Uri string
    The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
    Split EntityRecognizerAugmentedManifestsListItemSplit
    The purpose of the data you've provided in the augmented manifest.
    attribute_names list(string)
    The JSON attribute that contains the annotations for your training documents.
    s3_uri string
    The Amazon S3 location of the augmented manifest file.
    annotation_data_s3_uri string
    The S3 prefix to the annotation files that are referred in the augmented manifest file.
    document_type "PLAIN_TEXT_DOCUMENT" | "SEMI_STRUCTURED_DOCUMENT"
    The type of augmented manifest.
    source_documents_s3_uri string
    The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
    split "TRAIN" | "TEST"
    The purpose of the data you've provided in the augmented manifest.
    attributeNames List<String>
    The JSON attribute that contains the annotations for your training documents.
    s3Uri String
    The Amazon S3 location of the augmented manifest file.
    annotationDataS3Uri String
    The S3 prefix to the annotation files that are referred in the augmented manifest file.
    documentType EntityRecognizerAugmentedManifestsListItemDocumentType
    The type of augmented manifest.
    sourceDocumentsS3Uri String
    The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
    split EntityRecognizerAugmentedManifestsListItemSplit
    The purpose of the data you've provided in the augmented manifest.
    attributeNames string[]
    The JSON attribute that contains the annotations for your training documents.
    s3Uri string
    The Amazon S3 location of the augmented manifest file.
    annotationDataS3Uri string
    The S3 prefix to the annotation files that are referred in the augmented manifest file.
    documentType EntityRecognizerAugmentedManifestsListItemDocumentType
    The type of augmented manifest.
    sourceDocumentsS3Uri string
    The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
    split EntityRecognizerAugmentedManifestsListItemSplit
    The purpose of the data you've provided in the augmented manifest.
    attribute_names Sequence[str]
    The JSON attribute that contains the annotations for your training documents.
    s3_uri str
    The Amazon S3 location of the augmented manifest file.
    annotation_data_s3_uri str
    The S3 prefix to the annotation files that are referred in the augmented manifest file.
    document_type EntityRecognizerAugmentedManifestsListItemDocumentType
    The type of augmented manifest.
    source_documents_s3_uri str
    The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
    split EntityRecognizerAugmentedManifestsListItemSplit
    The purpose of the data you've provided in the augmented manifest.
    attributeNames List<String>
    The JSON attribute that contains the annotations for your training documents.
    s3Uri String
    The Amazon S3 location of the augmented manifest file.
    annotationDataS3Uri String
    The S3 prefix to the annotation files that are referred in the augmented manifest file.
    documentType "PLAIN_TEXT_DOCUMENT" | "SEMI_STRUCTURED_DOCUMENT"
    The type of augmented manifest.
    sourceDocumentsS3Uri String
    The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.
    split "TRAIN" | "TEST"
    The purpose of the data you've provided in the augmented manifest.

    EntityRecognizerAugmentedManifestsListItemDocumentType

    The type of augmented manifest.

    NameValue
    PlainTextDocumentPLAIN_TEXT_DOCUMENT
    SemiStructuredDocumentSEMI_STRUCTURED_DOCUMENT
    NameValue
    EntityRecognizerAugmentedManifestsListItemDocumentTypePlainTextDocumentPLAIN_TEXT_DOCUMENT
    EntityRecognizerAugmentedManifestsListItemDocumentTypeSemiStructuredDocumentSEMI_STRUCTURED_DOCUMENT
    Value
    PLAIN_TEXT_DOCUMENT
    SEMI_STRUCTURED_DOCUMENT
    NameValue
    PlainTextDocumentPLAIN_TEXT_DOCUMENT
    SemiStructuredDocumentSEMI_STRUCTURED_DOCUMENT
    NameValue
    PlainTextDocumentPLAIN_TEXT_DOCUMENT
    SemiStructuredDocumentSEMI_STRUCTURED_DOCUMENT
    NameValue
    PLAIN_TEXT_DOCUMENTPLAIN_TEXT_DOCUMENT
    SEMI_STRUCTURED_DOCUMENTSEMI_STRUCTURED_DOCUMENT
    Value
    PLAIN_TEXT_DOCUMENT
    SEMI_STRUCTURED_DOCUMENT

    EntityRecognizerAugmentedManifestsListItemSplit

    The purpose of the data you've provided in the augmented manifest.

    NameValue
    TrainTRAIN
    TestTEST
    NameValue
    EntityRecognizerAugmentedManifestsListItemSplitTrainTRAIN
    EntityRecognizerAugmentedManifestsListItemSplitTestTEST
    Value
    TRAIN
    TEST
    NameValue
    TrainTRAIN
    TestTEST
    NameValue
    TrainTRAIN
    TestTEST
    NameValue
    TRAINTRAIN
    TESTTEST
    Value
    TRAIN
    TEST

    EntityRecognizerDocuments, EntityRecognizerDocumentsArgs

    Describes the training documents submitted with an entity recognizer.

    S3Uri string
    Specifies the Amazon S3 location where the training documents are located.
    InputFormat Pulumi.AwsNative.Comprehend.EntityRecognizerDocumentsInputFormat
    Specifies how the text in an input file should be processed.
    TestS3Uri string
    Specifies the Amazon S3 location where the test documents are located.
    S3Uri string
    Specifies the Amazon S3 location where the training documents are located.
    InputFormat EntityRecognizerDocumentsInputFormat
    Specifies how the text in an input file should be processed.
    TestS3Uri string
    Specifies the Amazon S3 location where the test documents are located.
    s3_uri string
    Specifies the Amazon S3 location where the training documents are located.
    input_format "ONE_DOC_PER_FILE" | "ONE_DOC_PER_LINE"
    Specifies how the text in an input file should be processed.
    test_s3_uri string
    Specifies the Amazon S3 location where the test documents are located.
    s3Uri String
    Specifies the Amazon S3 location where the training documents are located.
    inputFormat EntityRecognizerDocumentsInputFormat
    Specifies how the text in an input file should be processed.
    testS3Uri String
    Specifies the Amazon S3 location where the test documents are located.
    s3Uri string
    Specifies the Amazon S3 location where the training documents are located.
    inputFormat EntityRecognizerDocumentsInputFormat
    Specifies how the text in an input file should be processed.
    testS3Uri string
    Specifies the Amazon S3 location where the test documents are located.
    s3_uri str
    Specifies the Amazon S3 location where the training documents are located.
    input_format EntityRecognizerDocumentsInputFormat
    Specifies how the text in an input file should be processed.
    test_s3_uri str
    Specifies the Amazon S3 location where the test documents are located.
    s3Uri String
    Specifies the Amazon S3 location where the training documents are located.
    inputFormat "ONE_DOC_PER_FILE" | "ONE_DOC_PER_LINE"
    Specifies how the text in an input file should be processed.
    testS3Uri String
    Specifies the Amazon S3 location where the test documents are located.

    EntityRecognizerDocumentsInputFormat

    Specifies how the text in an input file should be processed.

    NameValue
    OneDocPerFileONE_DOC_PER_FILE
    OneDocPerLineONE_DOC_PER_LINE
    NameValue
    EntityRecognizerDocumentsInputFormatOneDocPerFileONE_DOC_PER_FILE
    EntityRecognizerDocumentsInputFormatOneDocPerLineONE_DOC_PER_LINE
    Value
    ONE_DOC_PER_FILE
    ONE_DOC_PER_LINE
    NameValue
    OneDocPerFileONE_DOC_PER_FILE
    OneDocPerLineONE_DOC_PER_LINE
    NameValue
    OneDocPerFileONE_DOC_PER_FILE
    OneDocPerLineONE_DOC_PER_LINE
    NameValue
    ONE_DOC_PER_FILEONE_DOC_PER_FILE
    ONE_DOC_PER_LINEONE_DOC_PER_LINE
    Value
    ONE_DOC_PER_FILE
    ONE_DOC_PER_LINE

    EntityRecognizerEntityList, EntityRecognizerEntityListArgs

    Describes the entity list submitted with an entity recognizer.

    S3Uri string
    Specifies the Amazon S3 location where the entity list is located.
    S3Uri string
    Specifies the Amazon S3 location where the entity list is located.
    s3_uri string
    Specifies the Amazon S3 location where the entity list is located.
    s3Uri String
    Specifies the Amazon S3 location where the entity list is located.
    s3Uri string
    Specifies the Amazon S3 location where the entity list is located.
    s3_uri str
    Specifies the Amazon S3 location where the entity list is located.
    s3Uri String
    Specifies the Amazon S3 location where the entity list is located.

    EntityRecognizerEntityTypesListItem, EntityRecognizerEntityTypesListItemArgs

    An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.

    Type string
    An entity type within a labeled training dataset.
    Type string
    An entity type within a labeled training dataset.
    type string
    An entity type within a labeled training dataset.
    type String
    An entity type within a labeled training dataset.
    type string
    An entity type within a labeled training dataset.
    type str
    An entity type within a labeled training dataset.
    type String
    An entity type within a labeled training dataset.

    EntityRecognizerInputDataConfig, EntityRecognizerInputDataConfigArgs

    Specifies the format and location of the input data for an entity recognizer.

    EntityTypes List<Pulumi.AwsNative.Comprehend.Inputs.EntityRecognizerEntityTypesListItem>
    The entity types in the labeled training data.
    Annotations Pulumi.AwsNative.Comprehend.Inputs.EntityRecognizerAnnotations
    The S3 location of the CSV file that annotates your training documents.
    AugmentedManifests List<Pulumi.AwsNative.Comprehend.Inputs.EntityRecognizerAugmentedManifestsListItem>
    A list of augmented manifest files that provide training data for a custom model.
    DataFormat Pulumi.AwsNative.Comprehend.EntityRecognizerInputDataConfigDataFormat
    The format of your training data.
    Documents Pulumi.AwsNative.Comprehend.Inputs.EntityRecognizerDocuments
    The S3 location of the folder that contains the training documents.
    EntityList Pulumi.AwsNative.Comprehend.Inputs.EntityRecognizerEntityList
    The S3 location of the CSV file that has the entity list.
    EntityTypes []EntityRecognizerEntityTypesListItem
    The entity types in the labeled training data.
    Annotations EntityRecognizerAnnotations
    The S3 location of the CSV file that annotates your training documents.
    AugmentedManifests []EntityRecognizerAugmentedManifestsListItem
    A list of augmented manifest files that provide training data for a custom model.
    DataFormat EntityRecognizerInputDataConfigDataFormat
    The format of your training data.
    Documents EntityRecognizerDocuments
    The S3 location of the folder that contains the training documents.
    EntityList EntityRecognizerEntityList
    The S3 location of the CSV file that has the entity list.
    entity_types list(object)
    The entity types in the labeled training data.
    annotations object
    The S3 location of the CSV file that annotates your training documents.
    augmented_manifests list(object)
    A list of augmented manifest files that provide training data for a custom model.
    data_format "COMPREHEND_CSV" | "AUGMENTED_MANIFEST"
    The format of your training data.
    documents object
    The S3 location of the folder that contains the training documents.
    entity_list object
    The S3 location of the CSV file that has the entity list.
    entityTypes List<EntityRecognizerEntityTypesListItem>
    The entity types in the labeled training data.
    annotations EntityRecognizerAnnotations
    The S3 location of the CSV file that annotates your training documents.
    augmentedManifests List<EntityRecognizerAugmentedManifestsListItem>
    A list of augmented manifest files that provide training data for a custom model.
    dataFormat EntityRecognizerInputDataConfigDataFormat
    The format of your training data.
    documents EntityRecognizerDocuments
    The S3 location of the folder that contains the training documents.
    entityList EntityRecognizerEntityList
    The S3 location of the CSV file that has the entity list.
    entityTypes EntityRecognizerEntityTypesListItem[]
    The entity types in the labeled training data.
    annotations EntityRecognizerAnnotations
    The S3 location of the CSV file that annotates your training documents.
    augmentedManifests EntityRecognizerAugmentedManifestsListItem[]
    A list of augmented manifest files that provide training data for a custom model.
    dataFormat EntityRecognizerInputDataConfigDataFormat
    The format of your training data.
    documents EntityRecognizerDocuments
    The S3 location of the folder that contains the training documents.
    entityList EntityRecognizerEntityList
    The S3 location of the CSV file that has the entity list.
    entity_types Sequence[EntityRecognizerEntityTypesListItem]
    The entity types in the labeled training data.
    annotations EntityRecognizerAnnotations
    The S3 location of the CSV file that annotates your training documents.
    augmented_manifests Sequence[EntityRecognizerAugmentedManifestsListItem]
    A list of augmented manifest files that provide training data for a custom model.
    data_format EntityRecognizerInputDataConfigDataFormat
    The format of your training data.
    documents EntityRecognizerDocuments
    The S3 location of the folder that contains the training documents.
    entity_list EntityRecognizerEntityList
    The S3 location of the CSV file that has the entity list.
    entityTypes List<Property Map>
    The entity types in the labeled training data.
    annotations Property Map
    The S3 location of the CSV file that annotates your training documents.
    augmentedManifests List<Property Map>
    A list of augmented manifest files that provide training data for a custom model.
    dataFormat "COMPREHEND_CSV" | "AUGMENTED_MANIFEST"
    The format of your training data.
    documents Property Map
    The S3 location of the folder that contains the training documents.
    entityList Property Map
    The S3 location of the CSV file that has the entity list.

    EntityRecognizerInputDataConfigDataFormat

    The format of your training data.

    NameValue
    ComprehendCsvCOMPREHEND_CSV
    AugmentedManifestAUGMENTED_MANIFEST
    NameValue
    EntityRecognizerInputDataConfigDataFormatComprehendCsvCOMPREHEND_CSV
    EntityRecognizerInputDataConfigDataFormatAugmentedManifestAUGMENTED_MANIFEST
    Value
    COMPREHEND_CSV
    AUGMENTED_MANIFEST
    NameValue
    ComprehendCsvCOMPREHEND_CSV
    AugmentedManifestAUGMENTED_MANIFEST
    NameValue
    ComprehendCsvCOMPREHEND_CSV
    AugmentedManifestAUGMENTED_MANIFEST
    NameValue
    COMPREHEND_CSVCOMPREHEND_CSV
    AUGMENTED_MANIFESTAUGMENTED_MANIFEST
    Value
    COMPREHEND_CSV
    AUGMENTED_MANIFEST

    EntityRecognizerLanguageCode

    The language of the input documents. All documents must be in the same language.

    NameValue
    Enen
    Eses
    Frfr
    Dede
    Itit
    Ptpt
    Arar
    Hihi
    Jaja
    Koko
    Zhzh
    ZhTwzh-TW
    NameValue
    EntityRecognizerLanguageCodeEnen
    EntityRecognizerLanguageCodeEses
    EntityRecognizerLanguageCodeFrfr
    EntityRecognizerLanguageCodeDede
    EntityRecognizerLanguageCodeItit
    EntityRecognizerLanguageCodePtpt
    EntityRecognizerLanguageCodeArar
    EntityRecognizerLanguageCodeHihi
    EntityRecognizerLanguageCodeJaja
    EntityRecognizerLanguageCodeKoko
    EntityRecognizerLanguageCodeZhzh
    EntityRecognizerLanguageCodeZhTwzh-TW
    Value
    en
    es
    fr
    de
    it
    pt
    ar
    hi
    ja
    ko
    zh
    zh-TW
    NameValue
    Enen
    Eses
    Frfr
    Dede
    Itit
    Ptpt
    Arar
    Hihi
    Jaja
    Koko
    Zhzh
    ZhTwzh-TW
    NameValue
    Enen
    Eses
    Frfr
    Dede
    Itit
    Ptpt
    Arar
    Hihi
    Jaja
    Koko
    Zhzh
    ZhTwzh-TW
    NameValue
    ENen
    ESes
    FRfr
    DEde
    ITit
    PTpt
    ARar
    HIhi
    JAja
    KOko
    ZHzh
    ZH_TWzh-TW
    Value
    en
    es
    fr
    de
    it
    pt
    ar
    hi
    ja
    ko
    zh
    zh-TW

    EntityRecognizerVpcConfig, EntityRecognizerVpcConfigArgs

    Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job.

    SecurityGroupIds List<string>
    The ID number for a security group on an instance of your private VPC.
    Subnets List<string>
    The ID for each subnet being used in your private VPC.
    SecurityGroupIds []string
    The ID number for a security group on an instance of your private VPC.
    Subnets []string
    The ID for each subnet being used in your private VPC.
    security_group_ids list(string)
    The ID number for a security group on an instance of your private VPC.
    subnets list(string)
    The ID for each subnet being used in your private VPC.
    securityGroupIds List<String>
    The ID number for a security group on an instance of your private VPC.
    subnets List<String>
    The ID for each subnet being used in your private VPC.
    securityGroupIds string[]
    The ID number for a security group on an instance of your private VPC.
    subnets string[]
    The ID for each subnet being used in your private VPC.
    security_group_ids Sequence[str]
    The ID number for a security group on an instance of your private VPC.
    subnets Sequence[str]
    The ID for each subnet being used in your private VPC.
    securityGroupIds List<String>
    The ID number for a security group on an instance of your private VPC.
    subnets List<String>
    The ID for each subnet being used in your private VPC.

    Tag, TagArgs

    A set of tags to apply to the resource.

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo AWS Cloud Control

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.86.0
    published on Wednesday, Nov 18, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial