CreateEntityRecognizerRequest

import type { CreateEntityRecognizerRequest } from "https://aws-api.deno.dev/v0.3/services/comprehend.ts?docs=full";

interface CreateEntityRecognizerRequest {

ClientRequestToken?: string | null;

DataAccessRoleArn: string;

InputDataConfig: EntityRecognizerInputDataConfig;

LanguageCode: LanguageCode;

ModelKmsKeyId?: string | null;

RecognizerName: string;

Tags?: Tag[] | null;

VersionName?: string | null;

VolumeKmsKeyId?: string | null;

VpcConfig?: VpcConfig | null;

}

§Properties

ClientRequestToken?: string | null

[src]

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

DataAccessRoleArn: string

[src]

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

InputDataConfig: EntityRecognizerInputDataConfig

[src]

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: LanguageCode

[src]

You can specify any of the following languages supported by Amazon Comprehend: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). All documents must be in the same language.

ModelKmsKeyId?: string | null

[src]

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats

KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

RecognizerName: string

[src]

The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/region.

Tags?: Tag[] | null

[src]

Tags to be associated with the entity recognizer being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

VersionName?: string | null

[src]

The version name given to the newly created recognizer. Version names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same recognizer name in the account/ AWS Region.

VolumeKmsKeyId?: string | null

[src]

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

VpcConfig?: VpcConfig | null

[src]

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see Amazon VPC.