EntityRecognizer class

Resource for managing an AWS Comprehend Entity Recognizer.

Example Usage

Basic Usage

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", {
    inputDataConfig: {
        documents: {
            s3Uri: pulumi.interpolate`s3://${documentsAwsS3Bucket.bucket}/${documents.key}`,
        },
        entityList: {
            s3Uri: pulumi.interpolate`s3://${entitiesAwsS3Bucket.bucket}/${entities.key}`,
        },
        entityTypes: [
            {
                type: "ENTITY_1",
            },
            {
                type: "ENTITY_2",
            },
        ],
    },
    name: "example",
    dataAccessRoleArn: exampleAwsIamRole.arn,
    languageCode: "en",
}, {
    dependsOn: [exampleAwsIamRolePolicy],
});

import pulumi
import pulumi_aws as aws

documents = aws.s3.BucketObjectv2("documents")
entities = aws.s3.BucketObjectv2("entities")
example = aws.comprehend.EntityRecognizer("example",
    input_data_config={
        "documents": {
            "s3_uri": documents.key.apply(lambda key: f"s3://{documents_aws_s3_bucket['bucket']}/{key}"),
        },
        "entity_list": {
            "s3_uri": entities.key.apply(lambda key: f"s3://{entities_aws_s3_bucket['bucket']}/{key}"),
        },
        "entity_types": [
            {
                "type": "ENTITY_1",
            },
            {
                "type": "ENTITY_2",
            },
        ],
    },
    name="example",
    data_access_role_arn=example_aws_iam_role["arn"],
    language_code="en",
    opts = pulumi.ResourceOptions(depends_on=[example_aws_iam_role_policy]))

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()
    {
        InputDataConfig = new Aws.Comprehend.Inputs.EntityRecognizerInputDataConfigArgs
        {
            Documents = new Aws.Comprehend.Inputs.EntityRecognizerInputDataConfigDocumentsArgs
            {
                S3Uri = documents.Key.Apply(key => $"s3://{documentsAwsS3Bucket.Bucket}/{key}"),
            },
            EntityList = new Aws.Comprehend.Inputs.EntityRecognizerInputDataConfigEntityListArgs
            {
                S3Uri = entities.Key.Apply(key => $"s3://{entitiesAwsS3Bucket.Bucket}/{key}"),
            },
            EntityTypes = new[]
            {
                new Aws.Comprehend.Inputs.EntityRecognizerInputDataConfigEntityTypeArgs
                {
                    Type = "ENTITY_1",
                },
                new Aws.Comprehend.Inputs.EntityRecognizerInputDataConfigEntityTypeArgs
                {
                    Type = "ENTITY_2",
                },
            },
        },
        Name = "example",
        DataAccessRoleArn = exampleAwsIamRole.Arn,
        LanguageCode = "en",
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            exampleAwsIamRolePolicy,
        },
    });

});

package main

import (
	"fmt"

	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/comprehend"
	"github.com/pulumi/pulumi-aws/sdk/v7/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{
			InputDataConfig: &comprehend.EntityRecognizerInputDataConfigArgs{
				Documents: &comprehend.EntityRecognizerInputDataConfigDocumentsArgs{
					S3Uri: documents.Key.ApplyT(func(key string) (string, error) {
						return fmt.Sprintf("s3://%v/%v", documentsAwsS3Bucket.Bucket, key), nil
					}).(pulumi.StringOutput),
				},
				EntityList: &comprehend.EntityRecognizerInputDataConfigEntityListArgs{
					S3Uri: entities.Key.ApplyT(func(key string) (string, error) {
						return fmt.Sprintf("s3://%v/%v", entitiesAwsS3Bucket.Bucket, key), nil
					}).(pulumi.StringOutput),
				},
				EntityTypes: comprehend.EntityRecognizerInputDataConfigEntityTypeArray{
					&comprehend.EntityRecognizerInputDataConfigEntityTypeArgs{
						Type: pulumi.String("ENTITY_1"),
					},
					&comprehend.EntityRecognizerInputDataConfigEntityTypeArgs{
						Type: pulumi.String("ENTITY_2"),
					},
				},
			},
			Name:              pulumi.String("example"),
			DataAccessRoleArn: pulumi.Any(exampleAwsIamRole.Arn),
			LanguageCode:      pulumi.String("en"),
		}, pulumi.DependsOn([]pulumi.Resource{
			exampleAwsIamRolePolicy,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_comprehend_entityrecognizer" "example" {
  depends_on = [exampleAwsIamRolePolicy]
  input_data_config = {
    documents = {
      s3_uri ="s3://${documentsAwsS3Bucket.bucket}/${aws_s3_bucketobjectv2.documents.key}"
    }
    entity_list = {
      s3_uri ="s3://${entitiesAwsS3Bucket.bucket}/${aws_s3_bucketobjectv2.entities.key}"
    }
    entity_types = [{
      "type" = "ENTITY_1"
      }, {
      "type" = "ENTITY_2"
    }]
  }
  name                 = "example"
  data_access_role_arn = exampleAwsIamRole.arn
  language_code        = "en"
}
resource "aws_s3_bucketobjectv2" "documents" {
}
resource "aws_s3_bucketobjectv2" "entities" {
}

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.aws.comprehend.inputs.EntityRecognizerInputDataConfigEntityTypeArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.ArrayList;
import java.util.Arrays;
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()
            .inputDataConfig(EntityRecognizerInputDataConfigArgs.builder()
                .documents(EntityRecognizerInputDataConfigDocumentsArgs.builder()
                    .s3Uri(documents.key().applyValue(_key -> String.format("s3://%s/%s", documentsAwsS3Bucket.bucket(),_key)))
                    .build())
                .entityList(EntityRecognizerInputDataConfigEntityListArgs.builder()
                    .s3Uri(entities.key().applyValue(_key -> String.format("s3://%s/%s", entitiesAwsS3Bucket.bucket(),_key)))
                    .build())
                .entityTypes(
                    EntityRecognizerInputDataConfigEntityTypeArgs.builder()
                        .type("ENTITY_1")
                        .build(),
                    EntityRecognizerInputDataConfigEntityTypeArgs.builder()
                        .type("ENTITY_2")
                        .build())
                .build())
            .name("example")
            .dataAccessRoleArn(exampleAwsIamRole.arn())
            .languageCode("en")
            .build(), CustomResourceOptions.builder()
                .dependsOn(exampleAwsIamRolePolicy)
                .build());

    }
}

resources:
  example:
    type: aws:comprehend:EntityRecognizer
    properties:
      inputDataConfig:
        documents:
          s3Uri: s3://${documentsAwsS3Bucket.bucket}/${documents.key}
        entityList:
          s3Uri: s3://${entitiesAwsS3Bucket.bucket}/${entities.key}
        entityTypes:
          - type: ENTITY_1
          - type: ENTITY_2
      name: example
      dataAccessRoleArn: ${exampleAwsIamRole.arn}
      languageCode: en
    options:
      dependsOn:
        - ${exampleAwsIamRolePolicy}
  documents:
    type: aws:s3:BucketObjectv2
  entities:
    type: aws:s3:BucketObjectv2

Import

Identity Schema

Required

• arn (String) ARN of the Comprehend entity recognizer.

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