1. Packages
  2. AWS Classic
  3. API Docs
  4. comprehend
  5. EntityRecognizer

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.24.0 published on Tuesday, Feb 27, 2024 by Pulumi

aws.comprehend.EntityRecognizer

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.24.0 published on Tuesday, Feb 27, 2024 by Pulumi

    Resource for managing an AWS Comprehend Entity Recognizer.

    Example Usage

    Basic Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var documents = new Aws.S3.BucketObjectv2("documents");
    
        // ...
        var entities = new Aws.S3.BucketObjectv2("entities");
    
        // ...
        var example = new Aws.Comprehend.EntityRecognizer("example", new()
        {
            DataAccessRoleArn = aws_iam_role.Example.Arn,
            LanguageCode = "en",
            InputDataConfig = new Aws.Comprehend.Inputs.EntityRecognizerInputDataConfigArgs
            {
                EntityTypes = new[]
                {
                    new Aws.Comprehend.Inputs.EntityRecognizerInputDataConfigEntityTypeArgs
                    {
                        Type = "ENTITY_1",
                    },
                    new Aws.Comprehend.Inputs.EntityRecognizerInputDataConfigEntityTypeArgs
                    {
                        Type = "ENTITY_2",
                    },
                },
                Documents = new Aws.Comprehend.Inputs.EntityRecognizerInputDataConfigDocumentsArgs
                {
                    S3Uri = documents.Id.Apply(id => $"s3://{aws_s3_bucket.Documents.Bucket}/{id}"),
                },
                EntityList = new Aws.Comprehend.Inputs.EntityRecognizerInputDataConfigEntityListArgs
                {
                    S3Uri = entities.Id.Apply(id => $"s3://{aws_s3_bucket.Entities.Bucket}/{id}"),
                },
            },
        }, new CustomResourceOptions
        {
            DependsOn = new[]
            {
                aws_iam_role_policy.Example,
            },
        });
    
    });
    
    package main
    
    import (
    	"fmt"
    
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/comprehend"
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/s3"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		documents, err := s3.NewBucketObjectv2(ctx, "documents", nil)
    		if err != nil {
    			return err
    		}
    		entities, err := s3.NewBucketObjectv2(ctx, "entities", nil)
    		if err != nil {
    			return err
    		}
    		_, err = comprehend.NewEntityRecognizer(ctx, "example", &comprehend.EntityRecognizerArgs{
    			DataAccessRoleArn: pulumi.Any(aws_iam_role.Example.Arn),
    			LanguageCode:      pulumi.String("en"),
    			InputDataConfig: &comprehend.EntityRecognizerInputDataConfigArgs{
    				EntityTypes: comprehend.EntityRecognizerInputDataConfigEntityTypeArray{
    					&comprehend.EntityRecognizerInputDataConfigEntityTypeArgs{
    						Type: pulumi.String("ENTITY_1"),
    					},
    					&comprehend.EntityRecognizerInputDataConfigEntityTypeArgs{
    						Type: pulumi.String("ENTITY_2"),
    					},
    				},
    				Documents: &comprehend.EntityRecognizerInputDataConfigDocumentsArgs{
    					S3Uri: documents.ID().ApplyT(func(id string) (string, error) {
    						return fmt.Sprintf("s3://%v/%v", aws_s3_bucket.Documents.Bucket, id), nil
    					}).(pulumi.StringOutput),
    				},
    				EntityList: &comprehend.EntityRecognizerInputDataConfigEntityListArgs{
    					S3Uri: entities.ID().ApplyT(func(id string) (string, error) {
    						return fmt.Sprintf("s3://%v/%v", aws_s3_bucket.Entities.Bucket, id), nil
    					}).(pulumi.StringOutput),
    				},
    			},
    		}, pulumi.DependsOn([]pulumi.Resource{
    			aws_iam_role_policy.Example,
    		}))
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.s3.BucketObjectv2;
    import com.pulumi.aws.comprehend.EntityRecognizer;
    import com.pulumi.aws.comprehend.EntityRecognizerArgs;
    import com.pulumi.aws.comprehend.inputs.EntityRecognizerInputDataConfigArgs;
    import com.pulumi.aws.comprehend.inputs.EntityRecognizerInputDataConfigDocumentsArgs;
    import com.pulumi.aws.comprehend.inputs.EntityRecognizerInputDataConfigEntityListArgs;
    import com.pulumi.resources.CustomResourceOptions;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var documents = new BucketObjectv2("documents");
    
            var entities = new BucketObjectv2("entities");
    
            var example = new EntityRecognizer("example", EntityRecognizerArgs.builder()        
                .dataAccessRoleArn(aws_iam_role.example().arn())
                .languageCode("en")
                .inputDataConfig(EntityRecognizerInputDataConfigArgs.builder()
                    .entityTypes(                
                        EntityRecognizerInputDataConfigEntityTypeArgs.builder()
                            .type("ENTITY_1")
                            .build(),
                        EntityRecognizerInputDataConfigEntityTypeArgs.builder()
                            .type("ENTITY_2")
                            .build())
                    .documents(EntityRecognizerInputDataConfigDocumentsArgs.builder()
                        .s3Uri(documents.id().applyValue(id -> String.format("s3://%s/%s", aws_s3_bucket.documents().bucket(),id)))
                        .build())
                    .entityList(EntityRecognizerInputDataConfigEntityListArgs.builder()
                        .s3Uri(entities.id().applyValue(id -> String.format("s3://%s/%s", aws_s3_bucket.entities().bucket(),id)))
                        .build())
                    .build())
                .build(), CustomResourceOptions.builder()
                    .dependsOn(aws_iam_role_policy.example())
                    .build());
    
        }
    }
    
    import pulumi
    import pulumi_aws as aws
    
    documents = aws.s3.BucketObjectv2("documents")
    # ...
    entities = aws.s3.BucketObjectv2("entities")
    # ...
    example = aws.comprehend.EntityRecognizer("example",
        data_access_role_arn=aws_iam_role["example"]["arn"],
        language_code="en",
        input_data_config=aws.comprehend.EntityRecognizerInputDataConfigArgs(
            entity_types=[
                aws.comprehend.EntityRecognizerInputDataConfigEntityTypeArgs(
                    type="ENTITY_1",
                ),
                aws.comprehend.EntityRecognizerInputDataConfigEntityTypeArgs(
                    type="ENTITY_2",
                ),
            ],
            documents=aws.comprehend.EntityRecognizerInputDataConfigDocumentsArgs(
                s3_uri=documents.id.apply(lambda id: f"s3://{aws_s3_bucket['documents']['bucket']}/{id}"),
            ),
            entity_list=aws.comprehend.EntityRecognizerInputDataConfigEntityListArgs(
                s3_uri=entities.id.apply(lambda id: f"s3://{aws_s3_bucket['entities']['bucket']}/{id}"),
            ),
        ),
        opts=pulumi.ResourceOptions(depends_on=[aws_iam_role_policy["example"]]))
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const documents = new aws.s3.BucketObjectv2("documents", {});
    // ...
    const entities = new aws.s3.BucketObjectv2("entities", {});
    // ...
    const example = new aws.comprehend.EntityRecognizer("example", {
        dataAccessRoleArn: aws_iam_role.example.arn,
        languageCode: "en",
        inputDataConfig: {
            entityTypes: [
                {
                    type: "ENTITY_1",
                },
                {
                    type: "ENTITY_2",
                },
            ],
            documents: {
                s3Uri: pulumi.interpolate`s3://${aws_s3_bucket.documents.bucket}/${documents.id}`,
            },
            entityList: {
                s3Uri: pulumi.interpolate`s3://${aws_s3_bucket.entities.bucket}/${entities.id}`,
            },
        },
    }, {
        dependsOn: [aws_iam_role_policy.example],
    });
    
    resources:
      example:
        type: aws:comprehend:EntityRecognizer
        properties:
          dataAccessRoleArn: ${aws_iam_role.example.arn}
          languageCode: en
          inputDataConfig:
            entityTypes:
              - type: ENTITY_1
              - type: ENTITY_2
            documents:
              s3Uri: s3://${aws_s3_bucket.documents.bucket}/${documents.id}
            entityList:
              s3Uri: s3://${aws_s3_bucket.entities.bucket}/${entities.id}
        options:
          dependson:
            - ${aws_iam_role_policy.example}
      documents:
        type: aws:s3:BucketObjectv2
      entities:
        type: aws:s3:BucketObjectv2
    

    Create EntityRecognizer Resource

    new EntityRecognizer(name: string, args: EntityRecognizerArgs, opts?: CustomResourceOptions);
    @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[str] = None,
                         model_kms_key_id: Optional[str] = None,
                         name: Optional[str] = None,
                         tags: Optional[Mapping[str, str]] = None,
                         version_name: Optional[str] = None,
                         version_name_prefix: Optional[str] = None,
                         volume_kms_key_id: Optional[str] = None,
                         vpc_config: Optional[EntityRecognizerVpcConfigArgs] = None)
    @overload
    def EntityRecognizer(resource_name: str,
                         args: EntityRecognizerArgs,
                         opts: Optional[ResourceOptions] = 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:comprehend:EntityRecognizer
    properties: # The arguments to resource properties.
    options: # 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.
    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

    The EntityRecognizer resource accepts the following input properties:

    DataAccessRoleArn string
    The ARN for an IAM Role which allows Comprehend to read the training and testing data.
    InputDataConfig EntityRecognizerInputDataConfig
    Configuration for the training and testing data. See the input_data_config Configuration Block section below.
    LanguageCode string
    Two-letter language code for the language. One of en, es, fr, it, de, or pt.
    ModelKmsKeyId string
    The ID or ARN of a KMS Key used to encrypt trained Entity Recognizers.
    Name string

    Name for the Entity Recognizer. Has a maximum length of 63 characters. Can contain upper- and lower-case letters, numbers, and hypen (-).

    The following arguments are optional:

    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags Configuration Block present, tags with matching keys will overwrite those defined at the provider-level.
    VersionName string
    Name for the version of the Entity Recognizer. Each version must have a unique name within the Entity Recognizer. If omitted, the provider will assign a random, unique version name. If explicitly set to "", no version name will be set. Has a maximum length of 63 characters. Can contain upper- and lower-case letters, numbers, and hypen (-). Conflicts with version_name_prefix.
    VersionNamePrefix string
    Creates a unique version name beginning with the specified prefix. Has a maximum length of 37 characters. Can contain upper- and lower-case letters, numbers, and hypen (-). Conflicts with version_name.
    VolumeKmsKeyId string
    ID or ARN of a KMS Key used to encrypt storage volumes during job processing.
    VpcConfig EntityRecognizerVpcConfig
    Configuration parameters for VPC to contain Entity Recognizer resources. See the vpc_config Configuration Block section below.
    DataAccessRoleArn string
    The ARN for an IAM Role which allows Comprehend to read the training and testing data.
    InputDataConfig EntityRecognizerInputDataConfigArgs
    Configuration for the training and testing data. See the input_data_config Configuration Block section below.
    LanguageCode string
    Two-letter language code for the language. One of en, es, fr, it, de, or pt.
    ModelKmsKeyId string
    The ID or ARN of a KMS Key used to encrypt trained Entity Recognizers.
    Name string

    Name for the Entity Recognizer. Has a maximum length of 63 characters. Can contain upper- and lower-case letters, numbers, and hypen (-).

    The following arguments are optional:

    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags Configuration Block present, tags with matching keys will overwrite those defined at the provider-level.
    VersionName string
    Name for the version of the Entity Recognizer. Each version must have a unique name within the Entity Recognizer. If omitted, the provider will assign a random, unique version name. If explicitly set to "", no version name will be set. Has a maximum length of 63 characters. Can contain upper- and lower-case letters, numbers, and hypen (-). Conflicts with version_name_prefix.
    VersionNamePrefix string
    Creates a unique version name beginning with the specified prefix. Has a maximum length of 37 characters. Can contain upper- and lower-case letters, numbers, and hypen (-). Conflicts with version_name.
    VolumeKmsKeyId string
    ID or ARN of a KMS Key used to encrypt storage volumes during job processing.
    VpcConfig EntityRecognizerVpcConfigArgs
    Configuration parameters for VPC to contain Entity Recognizer resources. See the vpc_config Configuration Block section below.
    dataAccessRoleArn String
    The ARN for an IAM Role which allows Comprehend to read the training and testing data.
    inputDataConfig EntityRecognizerInputDataConfig
    Configuration for the training and testing data. See the input_data_config Configuration Block section below.
    languageCode String
    Two-letter language code for the language. One of en, es, fr, it, de, or pt.
    modelKmsKeyId String
    The ID or ARN of a KMS Key used to encrypt trained Entity Recognizers.
    name String

    Name for the Entity Recognizer. Has a maximum length of 63 characters. Can contain upper- and lower-case letters, numbers, and hypen (-).

    The following arguments are optional:

    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags Configuration Block present, tags with matching keys will overwrite those defined at the provider-level.
    versionName String
    Name for the version of the Entity Recognizer. Each version must have a unique name within the Entity Recognizer. If omitted, the provider will assign a random, unique version name. If explicitly set to "", no version name will be set. Has a maximum length of 63 characters. Can contain upper- and lower-case letters, numbers, and hypen (-). Conflicts with version_name_prefix.
    versionNamePrefix String
    Creates a unique version name beginning with the specified prefix. Has a maximum length of 37 characters. Can contain upper- and lower-case letters, numbers, and hypen (-). Conflicts with version_name.
    volumeKmsKeyId String
    ID or ARN of a KMS Key used to encrypt storage volumes during job processing.
    vpcConfig EntityRecognizerVpcConfig
    Configuration parameters for VPC to contain Entity Recognizer resources. See the vpc_config Configuration Block section below.
    dataAccessRoleArn string
    The ARN for an IAM Role which allows Comprehend to read the training and testing data.
    inputDataConfig EntityRecognizerInputDataConfig
    Configuration for the training and testing data. See the input_data_config Configuration Block section below.
    languageCode string
    Two-letter language code for the language. One of en, es, fr, it, de, or pt.
    modelKmsKeyId string
    The ID or ARN of a KMS Key used to encrypt trained Entity Recognizers.
    name string

    Name for the Entity Recognizer. Has a maximum length of 63 characters. Can contain upper- and lower-case letters, numbers, and hypen (-).

    The following arguments are optional:

    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags Configuration Block present, tags with matching keys will overwrite those defined at the provider-level.
    versionName string
    Name for the version of the Entity Recognizer. Each version must have a unique name within the Entity Recognizer. If omitted, the provider will assign a random, unique version name. If explicitly set to "", no version name will be set. Has a maximum length of 63 characters. Can contain upper- and lower-case letters, numbers, and hypen (-). Conflicts with version_name_prefix.
    versionNamePrefix string
    Creates a unique version name beginning with the specified prefix. Has a maximum length of 37 characters. Can contain upper- and lower-case letters, numbers, and hypen (-). Conflicts with version_name.
    volumeKmsKeyId string
    ID or ARN of a KMS Key used to encrypt storage volumes during job processing.
    vpcConfig EntityRecognizerVpcConfig
    Configuration parameters for VPC to contain Entity Recognizer resources. See the vpc_config Configuration Block section below.
    data_access_role_arn str
    The ARN for an IAM Role which allows Comprehend to read the training and testing data.
    input_data_config EntityRecognizerInputDataConfigArgs
    Configuration for the training and testing data. See the input_data_config Configuration Block section below.
    language_code str
    Two-letter language code for the language. One of en, es, fr, it, de, or pt.
    model_kms_key_id str
    The ID or ARN of a KMS Key used to encrypt trained Entity Recognizers.
    name str

    Name for the Entity Recognizer. Has a maximum length of 63 characters. Can contain upper- and lower-case letters, numbers, and hypen (-).

    The following arguments are optional:

    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags Configuration Block present, tags with matching keys will overwrite those defined at the provider-level.
    version_name str
    Name for the version of the Entity Recognizer. Each version must have a unique name within the Entity Recognizer. If omitted, the provider will assign a random, unique version name. If explicitly set to "", no version name will be set. Has a maximum length of 63 characters. Can contain upper- and lower-case letters, numbers, and hypen (-). Conflicts with version_name_prefix.
    version_name_prefix str
    Creates a unique version name beginning with the specified prefix. Has a maximum length of 37 characters. Can contain upper- and lower-case letters, numbers, and hypen (-). Conflicts with version_name.
    volume_kms_key_id str
    ID or ARN of a KMS Key used to encrypt storage volumes during job processing.
    vpc_config EntityRecognizerVpcConfigArgs
    Configuration parameters for VPC to contain Entity Recognizer resources. See the vpc_config Configuration Block section below.
    dataAccessRoleArn String
    The ARN for an IAM Role which allows Comprehend to read the training and testing data.
    inputDataConfig Property Map
    Configuration for the training and testing data. See the input_data_config Configuration Block section below.
    languageCode String
    Two-letter language code for the language. One of en, es, fr, it, de, or pt.
    modelKmsKeyId String
    The ID or ARN of a KMS Key used to encrypt trained Entity Recognizers.
    name String

    Name for the Entity Recognizer. Has a maximum length of 63 characters. Can contain upper- and lower-case letters, numbers, and hypen (-).

    The following arguments are optional:

    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags Configuration Block present, tags with matching keys will overwrite those defined at the provider-level.
    versionName String
    Name for the version of the Entity Recognizer. Each version must have a unique name within the Entity Recognizer. If omitted, the provider will assign a random, unique version name. If explicitly set to "", no version name will be set. Has a maximum length of 63 characters. Can contain upper- and lower-case letters, numbers, and hypen (-). Conflicts with version_name_prefix.
    versionNamePrefix String
    Creates a unique version name beginning with the specified prefix. Has a maximum length of 37 characters. Can contain upper- and lower-case letters, numbers, and hypen (-). Conflicts with version_name.
    volumeKmsKeyId String
    ID or ARN of a KMS Key used to encrypt storage volumes during job processing.
    vpcConfig Property Map
    Configuration parameters for VPC to contain Entity Recognizer resources. See the vpc_config Configuration Block section below.

    Outputs

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

    Arn string
    ARN of the Entity Recognizer version.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    Arn string
    ARN of the Entity Recognizer version.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    arn String
    ARN of the Entity Recognizer version.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    arn string
    ARN of the Entity Recognizer version.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    arn str
    ARN of the Entity Recognizer version.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    arn String
    ARN of the Entity Recognizer version.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    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>, state?: EntityRecognizerState, opts?: CustomResourceOptions): EntityRecognizer
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            data_access_role_arn: Optional[str] = None,
            input_data_config: Optional[EntityRecognizerInputDataConfigArgs] = None,
            language_code: Optional[str] = None,
            model_kms_key_id: Optional[str] = None,
            name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            version_name: Optional[str] = None,
            version_name_prefix: Optional[str] = None,
            volume_kms_key_id: Optional[str] = None,
            vpc_config: Optional[EntityRecognizerVpcConfigArgs] = 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, EntityRecognizerState? state, CustomResourceOptions? opts = null)
    public static EntityRecognizer get(String name, Output<String> id, EntityRecognizerState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    ARN of the Entity Recognizer version.
    DataAccessRoleArn string
    The ARN for an IAM Role which allows Comprehend to read the training and testing data.
    InputDataConfig EntityRecognizerInputDataConfig
    Configuration for the training and testing data. See the input_data_config Configuration Block section below.
    LanguageCode string
    Two-letter language code for the language. One of en, es, fr, it, de, or pt.
    ModelKmsKeyId string
    The ID or ARN of a KMS Key used to encrypt trained Entity Recognizers.
    Name string

    Name for the Entity Recognizer. Has a maximum length of 63 characters. Can contain upper- and lower-case letters, numbers, and hypen (-).

    The following arguments are optional:

    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags Configuration Block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    VersionName string
    Name for the version of the Entity Recognizer. Each version must have a unique name within the Entity Recognizer. If omitted, the provider will assign a random, unique version name. If explicitly set to "", no version name will be set. Has a maximum length of 63 characters. Can contain upper- and lower-case letters, numbers, and hypen (-). Conflicts with version_name_prefix.
    VersionNamePrefix string
    Creates a unique version name beginning with the specified prefix. Has a maximum length of 37 characters. Can contain upper- and lower-case letters, numbers, and hypen (-). Conflicts with version_name.
    VolumeKmsKeyId string
    ID or ARN of a KMS Key used to encrypt storage volumes during job processing.
    VpcConfig EntityRecognizerVpcConfig
    Configuration parameters for VPC to contain Entity Recognizer resources. See the vpc_config Configuration Block section below.
    Arn string
    ARN of the Entity Recognizer version.
    DataAccessRoleArn string
    The ARN for an IAM Role which allows Comprehend to read the training and testing data.
    InputDataConfig EntityRecognizerInputDataConfigArgs
    Configuration for the training and testing data. See the input_data_config Configuration Block section below.
    LanguageCode string
    Two-letter language code for the language. One of en, es, fr, it, de, or pt.
    ModelKmsKeyId string
    The ID or ARN of a KMS Key used to encrypt trained Entity Recognizers.
    Name string

    Name for the Entity Recognizer. Has a maximum length of 63 characters. Can contain upper- and lower-case letters, numbers, and hypen (-).

    The following arguments are optional:

    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags Configuration Block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    VersionName string
    Name for the version of the Entity Recognizer. Each version must have a unique name within the Entity Recognizer. If omitted, the provider will assign a random, unique version name. If explicitly set to "", no version name will be set. Has a maximum length of 63 characters. Can contain upper- and lower-case letters, numbers, and hypen (-). Conflicts with version_name_prefix.
    VersionNamePrefix string
    Creates a unique version name beginning with the specified prefix. Has a maximum length of 37 characters. Can contain upper- and lower-case letters, numbers, and hypen (-). Conflicts with version_name.
    VolumeKmsKeyId string
    ID or ARN of a KMS Key used to encrypt storage volumes during job processing.
    VpcConfig EntityRecognizerVpcConfigArgs
    Configuration parameters for VPC to contain Entity Recognizer resources. See the vpc_config Configuration Block section below.
    arn String
    ARN of the Entity Recognizer version.
    dataAccessRoleArn String
    The ARN for an IAM Role which allows Comprehend to read the training and testing data.
    inputDataConfig EntityRecognizerInputDataConfig
    Configuration for the training and testing data. See the input_data_config Configuration Block section below.
    languageCode String
    Two-letter language code for the language. One of en, es, fr, it, de, or pt.
    modelKmsKeyId String
    The ID or ARN of a KMS Key used to encrypt trained Entity Recognizers.
    name String

    Name for the Entity Recognizer. Has a maximum length of 63 characters. Can contain upper- and lower-case letters, numbers, and hypen (-).

    The following arguments are optional:

    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags Configuration Block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    versionName String
    Name for the version of the Entity Recognizer. Each version must have a unique name within the Entity Recognizer. If omitted, the provider will assign a random, unique version name. If explicitly set to "", no version name will be set. Has a maximum length of 63 characters. Can contain upper- and lower-case letters, numbers, and hypen (-). Conflicts with version_name_prefix.
    versionNamePrefix String
    Creates a unique version name beginning with the specified prefix. Has a maximum length of 37 characters. Can contain upper- and lower-case letters, numbers, and hypen (-). Conflicts with version_name.
    volumeKmsKeyId String
    ID or ARN of a KMS Key used to encrypt storage volumes during job processing.
    vpcConfig EntityRecognizerVpcConfig
    Configuration parameters for VPC to contain Entity Recognizer resources. See the vpc_config Configuration Block section below.
    arn string
    ARN of the Entity Recognizer version.
    dataAccessRoleArn string
    The ARN for an IAM Role which allows Comprehend to read the training and testing data.
    inputDataConfig EntityRecognizerInputDataConfig
    Configuration for the training and testing data. See the input_data_config Configuration Block section below.
    languageCode string
    Two-letter language code for the language. One of en, es, fr, it, de, or pt.
    modelKmsKeyId string
    The ID or ARN of a KMS Key used to encrypt trained Entity Recognizers.
    name string

    Name for the Entity Recognizer. Has a maximum length of 63 characters. Can contain upper- and lower-case letters, numbers, and hypen (-).

    The following arguments are optional:

    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags Configuration Block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    versionName string
    Name for the version of the Entity Recognizer. Each version must have a unique name within the Entity Recognizer. If omitted, the provider will assign a random, unique version name. If explicitly set to "", no version name will be set. Has a maximum length of 63 characters. Can contain upper- and lower-case letters, numbers, and hypen (-). Conflicts with version_name_prefix.
    versionNamePrefix string
    Creates a unique version name beginning with the specified prefix. Has a maximum length of 37 characters. Can contain upper- and lower-case letters, numbers, and hypen (-). Conflicts with version_name.
    volumeKmsKeyId string
    ID or ARN of a KMS Key used to encrypt storage volumes during job processing.
    vpcConfig EntityRecognizerVpcConfig
    Configuration parameters for VPC to contain Entity Recognizer resources. See the vpc_config Configuration Block section below.
    arn str
    ARN of the Entity Recognizer version.
    data_access_role_arn str
    The ARN for an IAM Role which allows Comprehend to read the training and testing data.
    input_data_config EntityRecognizerInputDataConfigArgs
    Configuration for the training and testing data. See the input_data_config Configuration Block section below.
    language_code str
    Two-letter language code for the language. One of en, es, fr, it, de, or pt.
    model_kms_key_id str
    The ID or ARN of a KMS Key used to encrypt trained Entity Recognizers.
    name str

    Name for the Entity Recognizer. Has a maximum length of 63 characters. Can contain upper- and lower-case letters, numbers, and hypen (-).

    The following arguments are optional:

    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags Configuration Block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    version_name str
    Name for the version of the Entity Recognizer. Each version must have a unique name within the Entity Recognizer. If omitted, the provider will assign a random, unique version name. If explicitly set to "", no version name will be set. Has a maximum length of 63 characters. Can contain upper- and lower-case letters, numbers, and hypen (-). Conflicts with version_name_prefix.
    version_name_prefix str
    Creates a unique version name beginning with the specified prefix. Has a maximum length of 37 characters. Can contain upper- and lower-case letters, numbers, and hypen (-). Conflicts with version_name.
    volume_kms_key_id str
    ID or ARN of a KMS Key used to encrypt storage volumes during job processing.
    vpc_config EntityRecognizerVpcConfigArgs
    Configuration parameters for VPC to contain Entity Recognizer resources. See the vpc_config Configuration Block section below.
    arn String
    ARN of the Entity Recognizer version.
    dataAccessRoleArn String
    The ARN for an IAM Role which allows Comprehend to read the training and testing data.
    inputDataConfig Property Map
    Configuration for the training and testing data. See the input_data_config Configuration Block section below.
    languageCode String
    Two-letter language code for the language. One of en, es, fr, it, de, or pt.
    modelKmsKeyId String
    The ID or ARN of a KMS Key used to encrypt trained Entity Recognizers.
    name String

    Name for the Entity Recognizer. Has a maximum length of 63 characters. Can contain upper- and lower-case letters, numbers, and hypen (-).

    The following arguments are optional:

    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags Configuration Block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:Please use tags instead.

    versionName String
    Name for the version of the Entity Recognizer. Each version must have a unique name within the Entity Recognizer. If omitted, the provider will assign a random, unique version name. If explicitly set to "", no version name will be set. Has a maximum length of 63 characters. Can contain upper- and lower-case letters, numbers, and hypen (-). Conflicts with version_name_prefix.
    versionNamePrefix String
    Creates a unique version name beginning with the specified prefix. Has a maximum length of 37 characters. Can contain upper- and lower-case letters, numbers, and hypen (-). Conflicts with version_name.
    volumeKmsKeyId String
    ID or ARN of a KMS Key used to encrypt storage volumes during job processing.
    vpcConfig Property Map
    Configuration parameters for VPC to contain Entity Recognizer resources. See the vpc_config Configuration Block section below.

    Supporting Types

    EntityRecognizerInputDataConfig, EntityRecognizerInputDataConfigArgs

    EntityTypes List<EntityRecognizerInputDataConfigEntityType>
    Set of entity types to be recognized. Has a maximum of 25 items. See the entity_types Configuration Block section below.
    Annotations EntityRecognizerInputDataConfigAnnotations
    Specifies location of the document annotation data. See the annotations Configuration Block section below. One of annotations or entity_list is required.
    AugmentedManifests List<EntityRecognizerInputDataConfigAugmentedManifest>
    List of training datasets produced by Amazon SageMaker Ground Truth. Used if data_format is AUGMENTED_MANIFEST. See the augmented_manifests Configuration Block section below.
    DataFormat string
    The format for the training data. One of COMPREHEND_CSV or AUGMENTED_MANIFEST.
    Documents EntityRecognizerInputDataConfigDocuments
    Specifies a collection of training documents. Used if data_format is COMPREHEND_CSV. See the documents Configuration Block section below.
    EntityList EntityRecognizerInputDataConfigEntityList
    Specifies location of the entity list data. See the entity_list Configuration Block section below. One of entity_list or annotations is required.
    EntityTypes []EntityRecognizerInputDataConfigEntityType
    Set of entity types to be recognized. Has a maximum of 25 items. See the entity_types Configuration Block section below.
    Annotations EntityRecognizerInputDataConfigAnnotations
    Specifies location of the document annotation data. See the annotations Configuration Block section below. One of annotations or entity_list is required.
    AugmentedManifests []EntityRecognizerInputDataConfigAugmentedManifest
    List of training datasets produced by Amazon SageMaker Ground Truth. Used if data_format is AUGMENTED_MANIFEST. See the augmented_manifests Configuration Block section below.
    DataFormat string
    The format for the training data. One of COMPREHEND_CSV or AUGMENTED_MANIFEST.
    Documents EntityRecognizerInputDataConfigDocuments
    Specifies a collection of training documents. Used if data_format is COMPREHEND_CSV. See the documents Configuration Block section below.
    EntityList EntityRecognizerInputDataConfigEntityList
    Specifies location of the entity list data. See the entity_list Configuration Block section below. One of entity_list or annotations is required.
    entityTypes List<EntityRecognizerInputDataConfigEntityType>
    Set of entity types to be recognized. Has a maximum of 25 items. See the entity_types Configuration Block section below.
    annotations EntityRecognizerInputDataConfigAnnotations
    Specifies location of the document annotation data. See the annotations Configuration Block section below. One of annotations or entity_list is required.
    augmentedManifests List<EntityRecognizerInputDataConfigAugmentedManifest>
    List of training datasets produced by Amazon SageMaker Ground Truth. Used if data_format is AUGMENTED_MANIFEST. See the augmented_manifests Configuration Block section below.
    dataFormat String
    The format for the training data. One of COMPREHEND_CSV or AUGMENTED_MANIFEST.
    documents EntityRecognizerInputDataConfigDocuments
    Specifies a collection of training documents. Used if data_format is COMPREHEND_CSV. See the documents Configuration Block section below.
    entityList EntityRecognizerInputDataConfigEntityList
    Specifies location of the entity list data. See the entity_list Configuration Block section below. One of entity_list or annotations is required.
    entityTypes EntityRecognizerInputDataConfigEntityType[]
    Set of entity types to be recognized. Has a maximum of 25 items. See the entity_types Configuration Block section below.
    annotations EntityRecognizerInputDataConfigAnnotations
    Specifies location of the document annotation data. See the annotations Configuration Block section below. One of annotations or entity_list is required.
    augmentedManifests EntityRecognizerInputDataConfigAugmentedManifest[]
    List of training datasets produced by Amazon SageMaker Ground Truth. Used if data_format is AUGMENTED_MANIFEST. See the augmented_manifests Configuration Block section below.
    dataFormat string
    The format for the training data. One of COMPREHEND_CSV or AUGMENTED_MANIFEST.
    documents EntityRecognizerInputDataConfigDocuments
    Specifies a collection of training documents. Used if data_format is COMPREHEND_CSV. See the documents Configuration Block section below.
    entityList EntityRecognizerInputDataConfigEntityList
    Specifies location of the entity list data. See the entity_list Configuration Block section below. One of entity_list or annotations is required.
    entity_types Sequence[EntityRecognizerInputDataConfigEntityType]
    Set of entity types to be recognized. Has a maximum of 25 items. See the entity_types Configuration Block section below.
    annotations EntityRecognizerInputDataConfigAnnotations
    Specifies location of the document annotation data. See the annotations Configuration Block section below. One of annotations or entity_list is required.
    augmented_manifests Sequence[EntityRecognizerInputDataConfigAugmentedManifest]
    List of training datasets produced by Amazon SageMaker Ground Truth. Used if data_format is AUGMENTED_MANIFEST. See the augmented_manifests Configuration Block section below.
    data_format str
    The format for the training data. One of COMPREHEND_CSV or AUGMENTED_MANIFEST.
    documents EntityRecognizerInputDataConfigDocuments
    Specifies a collection of training documents. Used if data_format is COMPREHEND_CSV. See the documents Configuration Block section below.
    entity_list EntityRecognizerInputDataConfigEntityList
    Specifies location of the entity list data. See the entity_list Configuration Block section below. One of entity_list or annotations is required.
    entityTypes List<Property Map>
    Set of entity types to be recognized. Has a maximum of 25 items. See the entity_types Configuration Block section below.
    annotations Property Map
    Specifies location of the document annotation data. See the annotations Configuration Block section below. One of annotations or entity_list is required.
    augmentedManifests List<Property Map>
    List of training datasets produced by Amazon SageMaker Ground Truth. Used if data_format is AUGMENTED_MANIFEST. See the augmented_manifests Configuration Block section below.
    dataFormat String
    The format for the training data. One of COMPREHEND_CSV or AUGMENTED_MANIFEST.
    documents Property Map
    Specifies a collection of training documents. Used if data_format is COMPREHEND_CSV. See the documents Configuration Block section below.
    entityList Property Map
    Specifies location of the entity list data. See the entity_list Configuration Block section below. One of entity_list or annotations is required.

    EntityRecognizerInputDataConfigAnnotations, EntityRecognizerInputDataConfigAnnotationsArgs

    S3Uri string
    Location of training annotations.
    TestS3Uri string
    S3Uri string
    Location of training annotations.
    TestS3Uri string
    s3Uri String
    Location of training annotations.
    testS3Uri String
    s3Uri string
    Location of training annotations.
    testS3Uri string
    s3_uri str
    Location of training annotations.
    test_s3_uri str
    s3Uri String
    Location of training annotations.
    testS3Uri String

    EntityRecognizerInputDataConfigAugmentedManifest, EntityRecognizerInputDataConfigAugmentedManifestArgs

    AttributeNames List<string>
    The JSON attribute that contains the annotations for the training documents.
    S3Uri string
    Location of augmented manifest file.
    AnnotationDataS3Uri string
    Location of annotation files.
    DocumentType string
    Type of augmented manifest. One of PLAIN_TEXT_DOCUMENT or SEMI_STRUCTURED_DOCUMENT.
    SourceDocumentsS3Uri string
    Location of source PDF files.
    Split string
    Purpose of data in augmented manifest. One of TRAIN or TEST.
    AttributeNames []string
    The JSON attribute that contains the annotations for the training documents.
    S3Uri string
    Location of augmented manifest file.
    AnnotationDataS3Uri string
    Location of annotation files.
    DocumentType string
    Type of augmented manifest. One of PLAIN_TEXT_DOCUMENT or SEMI_STRUCTURED_DOCUMENT.
    SourceDocumentsS3Uri string
    Location of source PDF files.
    Split string
    Purpose of data in augmented manifest. One of TRAIN or TEST.
    attributeNames List<String>
    The JSON attribute that contains the annotations for the training documents.
    s3Uri String
    Location of augmented manifest file.
    annotationDataS3Uri String
    Location of annotation files.
    documentType String
    Type of augmented manifest. One of PLAIN_TEXT_DOCUMENT or SEMI_STRUCTURED_DOCUMENT.
    sourceDocumentsS3Uri String
    Location of source PDF files.
    split String
    Purpose of data in augmented manifest. One of TRAIN or TEST.
    attributeNames string[]
    The JSON attribute that contains the annotations for the training documents.
    s3Uri string
    Location of augmented manifest file.
    annotationDataS3Uri string
    Location of annotation files.
    documentType string
    Type of augmented manifest. One of PLAIN_TEXT_DOCUMENT or SEMI_STRUCTURED_DOCUMENT.
    sourceDocumentsS3Uri string
    Location of source PDF files.
    split string
    Purpose of data in augmented manifest. One of TRAIN or TEST.
    attribute_names Sequence[str]
    The JSON attribute that contains the annotations for the training documents.
    s3_uri str
    Location of augmented manifest file.
    annotation_data_s3_uri str
    Location of annotation files.
    document_type str
    Type of augmented manifest. One of PLAIN_TEXT_DOCUMENT or SEMI_STRUCTURED_DOCUMENT.
    source_documents_s3_uri str
    Location of source PDF files.
    split str
    Purpose of data in augmented manifest. One of TRAIN or TEST.
    attributeNames List<String>
    The JSON attribute that contains the annotations for the training documents.
    s3Uri String
    Location of augmented manifest file.
    annotationDataS3Uri String
    Location of annotation files.
    documentType String
    Type of augmented manifest. One of PLAIN_TEXT_DOCUMENT or SEMI_STRUCTURED_DOCUMENT.
    sourceDocumentsS3Uri String
    Location of source PDF files.
    split String
    Purpose of data in augmented manifest. One of TRAIN or TEST.

    EntityRecognizerInputDataConfigDocuments, EntityRecognizerInputDataConfigDocumentsArgs

    S3Uri string
    Location of training documents.
    InputFormat string
    Specifies how the input files should be processed. One of ONE_DOC_PER_LINE or ONE_DOC_PER_FILE.
    TestS3Uri string
    S3Uri string
    Location of training documents.
    InputFormat string
    Specifies how the input files should be processed. One of ONE_DOC_PER_LINE or ONE_DOC_PER_FILE.
    TestS3Uri string
    s3Uri String
    Location of training documents.
    inputFormat String
    Specifies how the input files should be processed. One of ONE_DOC_PER_LINE or ONE_DOC_PER_FILE.
    testS3Uri String
    s3Uri string
    Location of training documents.
    inputFormat string
    Specifies how the input files should be processed. One of ONE_DOC_PER_LINE or ONE_DOC_PER_FILE.
    testS3Uri string
    s3_uri str
    Location of training documents.
    input_format str
    Specifies how the input files should be processed. One of ONE_DOC_PER_LINE or ONE_DOC_PER_FILE.
    test_s3_uri str
    s3Uri String
    Location of training documents.
    inputFormat String
    Specifies how the input files should be processed. One of ONE_DOC_PER_LINE or ONE_DOC_PER_FILE.
    testS3Uri String

    EntityRecognizerInputDataConfigEntityList, EntityRecognizerInputDataConfigEntityListArgs

    S3Uri string
    Location of entity list.
    S3Uri string
    Location of entity list.
    s3Uri String
    Location of entity list.
    s3Uri string
    Location of entity list.
    s3_uri str
    Location of entity list.
    s3Uri String
    Location of entity list.

    EntityRecognizerInputDataConfigEntityType, EntityRecognizerInputDataConfigEntityTypeArgs

    Type string
    An entity type to be matched by the Entity Recognizer. Cannot contain a newline (\n), carriage return (\r), or tab (\t).
    Type string
    An entity type to be matched by the Entity Recognizer. Cannot contain a newline (\n), carriage return (\r), or tab (\t).
    type String
    An entity type to be matched by the Entity Recognizer. Cannot contain a newline (\n), carriage return (\r), or tab (\t).
    type string
    An entity type to be matched by the Entity Recognizer. Cannot contain a newline (\n), carriage return (\r), or tab (\t).
    type str
    An entity type to be matched by the Entity Recognizer. Cannot contain a newline (\n), carriage return (\r), or tab (\t).
    type String
    An entity type to be matched by the Entity Recognizer. Cannot contain a newline (\n), carriage return (\r), or tab (\t).

    EntityRecognizerVpcConfig, EntityRecognizerVpcConfigArgs

    SecurityGroupIds List<string>
    List of security group IDs.
    Subnets List<string>
    List of VPC subnets.
    SecurityGroupIds []string
    List of security group IDs.
    Subnets []string
    List of VPC subnets.
    securityGroupIds List<String>
    List of security group IDs.
    subnets List<String>
    List of VPC subnets.
    securityGroupIds string[]
    List of security group IDs.
    subnets string[]
    List of VPC subnets.
    security_group_ids Sequence[str]
    List of security group IDs.
    subnets Sequence[str]
    List of VPC subnets.
    securityGroupIds List<String>
    List of security group IDs.
    subnets List<String>
    List of VPC subnets.

    Import

    Using pulumi import, import Comprehend Entity Recognizer using the ARN. For example:

     $ pulumi import aws:comprehend/entityRecognizer:EntityRecognizer example arn:aws:comprehend:us-west-2:123456789012:entity-recognizer/example
    

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.24.0 published on Tuesday, Feb 27, 2024 by Pulumi