CfnEntityRecognizer

class aws_cdk.aws_comprehend.CfnEntityRecognizer(scope, id, *, data_access_role_arn, input_data_config, language_code, recognizer_name, model_kms_key_id=None, model_policy=None, tags=None, version_name=None, volume_kms_key_id=None, vpc_config=None)

Bases: CfnResource

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-comprehend-entityrecognizer.html

CloudformationResource:

AWS::Comprehend::EntityRecognizer

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_comprehend as comprehend

cfn_entity_recognizer = comprehend.CfnEntityRecognizer(self, "MyCfnEntityRecognizer",
    data_access_role_arn="dataAccessRoleArn",
    input_data_config=comprehend.CfnEntityRecognizer.EntityRecognizerInputDataConfigProperty(
        entity_types=[comprehend.CfnEntityRecognizer.EntityTypesListItemProperty(
            type="type"
        )],

        # the properties below are optional
        annotations=comprehend.CfnEntityRecognizer.EntityRecognizerAnnotationsProperty(
            s3_uri="s3Uri",

            # the properties below are optional
            test_s3_uri="testS3Uri"
        ),
        augmented_manifests=[comprehend.CfnEntityRecognizer.AugmentedManifestsListItemProperty(
            attribute_names=["attributeNames"],
            s3_uri="s3Uri",

            # the properties below are optional
            annotation_data_s3_uri="annotationDataS3Uri",
            document_type="documentType",
            source_documents_s3_uri="sourceDocumentsS3Uri",
            split="split"
        )],
        data_format="dataFormat",
        documents=comprehend.CfnEntityRecognizer.EntityRecognizerDocumentsProperty(
            s3_uri="s3Uri",

            # the properties below are optional
            input_format="inputFormat",
            test_s3_uri="testS3Uri"
        ),
        entity_list=comprehend.CfnEntityRecognizer.EntityRecognizerEntityListProperty(
            s3_uri="s3Uri"
        )
    ),
    language_code="languageCode",
    recognizer_name="recognizerName",

    # the properties below are optional
    model_kms_key_id="modelKmsKeyId",
    model_policy="modelPolicy",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    version_name="versionName",
    volume_kms_key_id="volumeKmsKeyId",
    vpc_config=comprehend.CfnEntityRecognizer.VpcConfigProperty(
        security_group_ids=["securityGroupIds"],
        subnets=["subnets"]
    )
)

Create a new AWS::Comprehend::EntityRecognizer.

Parameters:

  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • 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 (Union[IResolvable, EntityRecognizerInputDataConfigProperty, Dict[str, Any]]) – Specifies the format and location of the input data for an entity recognizer.

  • language_code (str) – The language of the input documents. All documents must be in the same language.

  • recognizer_name (str) – The name given to the entity recognizer.

  • model_kms_key_id (Optional[str]) – ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models.

  • model_policy (Optional[str]) – The JSON resource-based policy to attach to your custom entity recognizer model.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Tags to associate with the entity recognizer.

  • version_name (Optional[str]) – The version name given to the entity recognizer.

  • volume_kms_key_id (Optional[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 (Union[IResolvable, VpcConfigProperty, Dict[str, Any], None]) – Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.

Parameters:

target (CfnResource)

Deprecated:

Use addResourceDependency instead.

Stability:

deprecated

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.

Parameters:

target (CfnResource)

Deprecated:

Use addResourceDependency instead.

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str)

  • value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

add_resource_dependency(target, reason=None)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.

Parameters:
Return type:

None

apply_cross_stack_reference_strength(strength)

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack’s context.

Parameters:

strength (ReferenceStrength) –

  • The reference strength to use for this resource.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

  • policy (Optional[RemovalPolicy])

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

cfn_property_name(cdk_property_name)
Parameters:

cdk_property_name (str)

Return type:

Optional[str]

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str)

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources and stacks this resource depends on.

For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.

Return type:

List[Union[Stack, CfnResource]]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

(deprecated) Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource)

Deprecated:

Use removeResourceDependency instead

Stability:

deprecated

Return type:

None

remove_resource_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource)

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

with_(*mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

mixins (IMixin)

Return type:

IConstruct

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Comprehend::EntityRecognizer'
attr_arn

The Amazon Resource Name (ARN) that identifies the entity recognizer.

CloudformationAttribute:

Arn

cdk_tag_manager

Tag Manager which manages the tags for this resource.

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

data_access_role_arn

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

entity_recognizer_ref

A reference to a EntityRecognizer resource.

env
input_data_config

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

language_code

The language of the input documents.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

model_kms_key_id

ID for the AWS KMS key that Amazon Comprehend uses to encrypt trained custom models.

model_policy

The JSON resource-based policy to attach to your custom entity recognizer model.

node

The tree node.

recognizer_name

The name given to the entity recognizer.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

Tags to associate with the entity recognizer.

version_name

The version name given to the entity recognizer.

volume_kms_key_id

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

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

Static Methods

classmethod arn_for_entity_recognizer(resource)
Parameters:

resource (IEntityRecognizerRef)

Return type:

str

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any)

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_entity_recognizer(x)

Checks whether the given object is a CfnEntityRecognizer.

Parameters:

x (Any)

Return type:

bool

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any)

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

AugmentedManifestsListItemProperty

class CfnEntityRecognizer.AugmentedManifestsListItemProperty(*, attribute_names, s3_uri, annotation_data_s3_uri=None, document_type=None, source_documents_s3_uri=None, split=None)

Bases: object

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

Parameters:

  • 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 (Optional[str]) – The S3 prefix to the annotation files that are referred in the augmented manifest file.

  • document_type (Optional[str]) – The type of augmented manifest.

  • source_documents_s3_uri (Optional[str]) – The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.

  • split (Optional[str]) – The purpose of the data you’ve provided in the augmented manifest.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-entityrecognizer-augmentedmanifestslistitem.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_comprehend as comprehend

augmented_manifests_list_item_property = comprehend.CfnEntityRecognizer.AugmentedManifestsListItemProperty(
    attribute_names=["attributeNames"],
    s3_uri="s3Uri",

    # the properties below are optional
    annotation_data_s3_uri="annotationDataS3Uri",
    document_type="documentType",
    source_documents_s3_uri="sourceDocumentsS3Uri",
    split="split"
)

Attributes

annotation_data_s3_uri

The S3 prefix to the annotation files that are referred in the augmented manifest file.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-entityrecognizer-augmentedmanifestslistitem.html#cfn-comprehend-entityrecognizer-augmentedmanifestslistitem-annotationdatas3uri

attribute_names

The JSON attribute that contains the annotations for your training documents.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-entityrecognizer-augmentedmanifestslistitem.html#cfn-comprehend-entityrecognizer-augmentedmanifestslistitem-attributenames

document_type

The type of augmented manifest.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-entityrecognizer-augmentedmanifestslistitem.html#cfn-comprehend-entityrecognizer-augmentedmanifestslistitem-documenttype

s3_uri

The Amazon S3 location of the augmented manifest file.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-entityrecognizer-augmentedmanifestslistitem.html#cfn-comprehend-entityrecognizer-augmentedmanifestslistitem-s3uri

source_documents_s3_uri

The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest file.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-entityrecognizer-augmentedmanifestslistitem.html#cfn-comprehend-entityrecognizer-augmentedmanifestslistitem-sourcedocumentss3uri

split

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-entityrecognizer-augmentedmanifestslistitem.html#cfn-comprehend-entityrecognizer-augmentedmanifestslistitem-split

EntityRecognizerAnnotationsProperty

class CfnEntityRecognizer.EntityRecognizerAnnotationsProperty(*, s3_uri, test_s3_uri=None)

Bases: object

Describes the annotations associated with an entity recognizer.

Parameters:

  • s3_uri (str) – Specifies the Amazon S3 location where the annotations are located.

  • test_s3_uri (Optional[str]) – Specifies the Amazon S3 location where the test annotations are located.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-entityrecognizer-entityrecognizerannotations.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_comprehend as comprehend

entity_recognizer_annotations_property = comprehend.CfnEntityRecognizer.EntityRecognizerAnnotationsProperty(
    s3_uri="s3Uri",

    # the properties below are optional
    test_s3_uri="testS3Uri"
)

Attributes

s3_uri

Specifies the Amazon S3 location where the annotations are located.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-entityrecognizer-entityrecognizerannotations.html#cfn-comprehend-entityrecognizer-entityrecognizerannotations-s3uri

test_s3_uri

Specifies the Amazon S3 location where the test annotations are located.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-entityrecognizer-entityrecognizerannotations.html#cfn-comprehend-entityrecognizer-entityrecognizerannotations-tests3uri

EntityRecognizerDocumentsProperty

class CfnEntityRecognizer.EntityRecognizerDocumentsProperty(*, s3_uri, input_format=None, test_s3_uri=None)

Bases: object

Describes the training documents submitted with an entity recognizer.

Parameters:

  • s3_uri (str) – Specifies the Amazon S3 location where the training documents are located.

  • input_format (Optional[str]) – Specifies how the text in an input file should be processed.

  • test_s3_uri (Optional[str]) – Specifies the Amazon S3 location where the test documents are located.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-entityrecognizer-entityrecognizerdocuments.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_comprehend as comprehend

entity_recognizer_documents_property = comprehend.CfnEntityRecognizer.EntityRecognizerDocumentsProperty(
    s3_uri="s3Uri",

    # the properties below are optional
    input_format="inputFormat",
    test_s3_uri="testS3Uri"
)

Attributes

input_format

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-entityrecognizer-entityrecognizerdocuments.html#cfn-comprehend-entityrecognizer-entityrecognizerdocuments-inputformat

s3_uri

Specifies the Amazon S3 location where the training documents are located.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-entityrecognizer-entityrecognizerdocuments.html#cfn-comprehend-entityrecognizer-entityrecognizerdocuments-s3uri

test_s3_uri

Specifies the Amazon S3 location where the test documents are located.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-entityrecognizer-entityrecognizerdocuments.html#cfn-comprehend-entityrecognizer-entityrecognizerdocuments-tests3uri

EntityRecognizerEntityListProperty

class CfnEntityRecognizer.EntityRecognizerEntityListProperty(*, s3_uri)

Bases: object

Describes the entity list submitted with an entity recognizer.

Parameters:

s3_uri (str) – Specifies the Amazon S3 location where the entity list is located.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-entityrecognizer-entityrecognizerentitylist.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_comprehend as comprehend

entity_recognizer_entity_list_property = comprehend.CfnEntityRecognizer.EntityRecognizerEntityListProperty(
    s3_uri="s3Uri"
)

Attributes

s3_uri

Specifies the Amazon S3 location where the entity list is located.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-entityrecognizer-entityrecognizerentitylist.html#cfn-comprehend-entityrecognizer-entityrecognizerentitylist-s3uri

EntityRecognizerInputDataConfigProperty

class CfnEntityRecognizer.EntityRecognizerInputDataConfigProperty(*, entity_types, annotations=None, augmented_manifests=None, data_format=None, documents=None, entity_list=None)

Bases: object

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

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-entityrecognizer-entityrecognizerinputdataconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_comprehend as comprehend

entity_recognizer_input_data_config_property = comprehend.CfnEntityRecognizer.EntityRecognizerInputDataConfigProperty(
    entity_types=[comprehend.CfnEntityRecognizer.EntityTypesListItemProperty(
        type="type"
    )],

    # the properties below are optional
    annotations=comprehend.CfnEntityRecognizer.EntityRecognizerAnnotationsProperty(
        s3_uri="s3Uri",

        # the properties below are optional
        test_s3_uri="testS3Uri"
    ),
    augmented_manifests=[comprehend.CfnEntityRecognizer.AugmentedManifestsListItemProperty(
        attribute_names=["attributeNames"],
        s3_uri="s3Uri",

        # the properties below are optional
        annotation_data_s3_uri="annotationDataS3Uri",
        document_type="documentType",
        source_documents_s3_uri="sourceDocumentsS3Uri",
        split="split"
    )],
    data_format="dataFormat",
    documents=comprehend.CfnEntityRecognizer.EntityRecognizerDocumentsProperty(
        s3_uri="s3Uri",

        # the properties below are optional
        input_format="inputFormat",
        test_s3_uri="testS3Uri"
    ),
    entity_list=comprehend.CfnEntityRecognizer.EntityRecognizerEntityListProperty(
        s3_uri="s3Uri"
    )
)

Attributes

annotations

Describes the annotations associated with an entity recognizer.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-entityrecognizer-entityrecognizerinputdataconfig.html#cfn-comprehend-entityrecognizer-entityrecognizerinputdataconfig-annotations

augmented_manifests

A list of augmented manifest files that provide training data for a custom model.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-entityrecognizer-entityrecognizerinputdataconfig.html#cfn-comprehend-entityrecognizer-entityrecognizerinputdataconfig-augmentedmanifests

data_format

The format of your training data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-entityrecognizer-entityrecognizerinputdataconfig.html#cfn-comprehend-entityrecognizer-entityrecognizerinputdataconfig-dataformat

documents

Describes the training documents submitted with an entity recognizer.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-entityrecognizer-entityrecognizerinputdataconfig.html#cfn-comprehend-entityrecognizer-entityrecognizerinputdataconfig-documents

entity_list

Describes the entity list submitted with an entity recognizer.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-entityrecognizer-entityrecognizerinputdataconfig.html#cfn-comprehend-entityrecognizer-entityrecognizerinputdataconfig-entitylist

entity_types

The entity types in the labeled training data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-entityrecognizer-entityrecognizerinputdataconfig.html#cfn-comprehend-entityrecognizer-entityrecognizerinputdataconfig-entitytypes

EntityTypesListItemProperty

class CfnEntityRecognizer.EntityTypesListItemProperty(*, type)

Bases: object

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

Parameters:

type (str) – An entity type within a labeled training dataset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-entityrecognizer-entitytypeslistitem.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_comprehend as comprehend

entity_types_list_item_property = comprehend.CfnEntityRecognizer.EntityTypesListItemProperty(
    type="type"
)

Attributes

type

An entity type within a labeled training dataset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-entityrecognizer-entitytypeslistitem.html#cfn-comprehend-entityrecognizer-entitytypeslistitem-type

VpcConfigProperty

class CfnEntityRecognizer.VpcConfigProperty(*, security_group_ids, subnets)

Bases: object

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

Parameters:

  • 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-entityrecognizer-vpcconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_comprehend as comprehend

vpc_config_property = comprehend.CfnEntityRecognizer.VpcConfigProperty(
    security_group_ids=["securityGroupIds"],
    subnets=["subnets"]
)

Attributes

security_group_ids

The ID number for a security group on an instance of your private VPC.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-entityrecognizer-vpcconfig.html#cfn-comprehend-entityrecognizer-vpcconfig-securitygroupids

subnets

The ID for each subnet being used in your private VPC.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-comprehend-entityrecognizer-vpcconfig.html#cfn-comprehend-entityrecognizer-vpcconfig-subnets