Skip to content
v2.277.0

EntityRecognizerInputDataConfigProperty Struct ​

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

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_comprehend as comprehend } from 'aws-cdk-lib';
const entityRecognizerInputDataConfigProperty: comprehend.CfnEntityRecognizer.EntityRecognizerInputDataConfigProperty = {
  entityTypes: [{
    type: 'type',
  }],

  // the properties below are optional
  annotations: {
    s3Uri: 's3Uri',

    // the properties below are optional
    testS3Uri: 'testS3Uri',
  },
  augmentedManifests: [{
    attributeNames: ['attributeNames'],
    s3Uri: 's3Uri',

    // the properties below are optional
    annotationDataS3Uri: 'annotationDataS3Uri',
    documentType: 'documentType',
    sourceDocumentsS3Uri: 'sourceDocumentsS3Uri',
    split: 'split',
  }],
  dataFormat: 'dataFormat',
  documents: {
    s3Uri: 's3Uri',

    // the properties below are optional
    inputFormat: 'inputFormat',
    testS3Uri: 'testS3Uri',
  },
  entityList: {
    s3Uri: 's3Uri',
  },
};
python
# 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"
    )
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.comprehend.*;

EntityRecognizerInputDataConfigProperty entityRecognizerInputDataConfigProperty = EntityRecognizerInputDataConfigProperty.builder()
        .entityTypes(List.of(EntityTypesListItemProperty.builder()
                .type("type")
                .build()))

        // the properties below are optional
        .annotations(EntityRecognizerAnnotationsProperty.builder()
                .s3Uri("s3Uri")

                // the properties below are optional
                .testS3Uri("testS3Uri")
                .build())
        .augmentedManifests(List.of(AugmentedManifestsListItemProperty.builder()
                .attributeNames(List.of("attributeNames"))
                .s3Uri("s3Uri")

                // the properties below are optional
                .annotationDataS3Uri("annotationDataS3Uri")
                .documentType("documentType")
                .sourceDocumentsS3Uri("sourceDocumentsS3Uri")
                .split("split")
                .build()))
        .dataFormat("dataFormat")
        .documents(EntityRecognizerDocumentsProperty.builder()
                .s3Uri("s3Uri")

                // the properties below are optional
                .inputFormat("inputFormat")
                .testS3Uri("testS3Uri")
                .build())
        .entityList(EntityRecognizerEntityListProperty.builder()
                .s3Uri("s3Uri")
                .build())
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Comprehend;

var entityRecognizerInputDataConfigProperty = new EntityRecognizerInputDataConfigProperty {
    EntityTypes = new [] { new EntityTypesListItemProperty {
        Type = "type"
    } },

    // the properties below are optional
    Annotations = new EntityRecognizerAnnotationsProperty {
        S3Uri = "s3Uri",

        // the properties below are optional
        TestS3Uri = "testS3Uri"
    },
    AugmentedManifests = new [] { new AugmentedManifestsListItemProperty {
        AttributeNames = new [] { "attributeNames" },
        S3Uri = "s3Uri",

        // the properties below are optional
        AnnotationDataS3Uri = "annotationDataS3Uri",
        DocumentType = "documentType",
        SourceDocumentsS3Uri = "sourceDocumentsS3Uri",
        Split = "split"
    } },
    DataFormat = "dataFormat",
    Documents = new EntityRecognizerDocumentsProperty {
        S3Uri = "s3Uri",

        // the properties below are optional
        InputFormat = "inputFormat",
        TestS3Uri = "testS3Uri"
    },
    EntityList = new EntityRecognizerEntityListProperty {
        S3Uri = "s3Uri"
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

entityRecognizerInputDataConfigProperty := &EntityRecognizerInputDataConfigProperty{
	EntityTypes: []interface{}{
		&EntityTypesListItemProperty{
			Type: jsii.String("type"),
		},
	},

	// the properties below are optional
	Annotations: &EntityRecognizerAnnotationsProperty{
		S3Uri: jsii.String("s3Uri"),

		// the properties below are optional
		TestS3Uri: jsii.String("testS3Uri"),
	},
	AugmentedManifests: []interface{}{
		&AugmentedManifestsListItemProperty{
			AttributeNames: []*string{
				jsii.String("attributeNames"),
			},
			S3Uri: jsii.String("s3Uri"),

			// the properties below are optional
			AnnotationDataS3Uri: jsii.String("annotationDataS3Uri"),
			DocumentType: jsii.String("documentType"),
			SourceDocumentsS3Uri: jsii.String("sourceDocumentsS3Uri"),
			Split: jsii.String("split"),
		},
	},
	DataFormat: jsii.String("dataFormat"),
	Documents: &EntityRecognizerDocumentsProperty{
		S3Uri: jsii.String("s3Uri"),

		// the properties below are optional
		InputFormat: jsii.String("inputFormat"),
		TestS3Uri: jsii.String("testS3Uri"),
	},
	EntityList: &EntityRecognizerEntityListProperty{
		S3Uri: jsii.String("s3Uri"),
	},
}

Properties ​

annotationsoptionalIResolvable | CfnEntityRecognizer.EntityRecognizerAnnotationsPropertyannotationsoptionaltyping.Union[IResolvable, EntityRecognizerAnnotationsProperty]annotationsoptionalIResolvableAnnotationsoptionalIResolvableAnnotationsoptionalinterface{} #
Describes the annotations associated with an entity recognizer.
augmentedManifestsoptionalIResolvable | IResolvable | CfnEntityRecognizer.AugmentedManifestsListItemProperty[]augmented_manifestsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AugmentedManifestsListItemProperty]]]augmentedManifestsoptionalIResolvableAugmentedManifestsoptionalIResolvableAugmentedManifestsoptionalinterface{} #
A list of augmented manifest files that provide training data for a custom model.
dataFormatoptionalstringdata_formatoptionalstrdataFormatoptionalStringDataFormatoptionalstringDataFormatoptional*string #
The format of your training data.
documentsoptionalIResolvable | CfnEntityRecognizer.EntityRecognizerDocumentsPropertydocumentsoptionaltyping.Union[IResolvable, EntityRecognizerDocumentsProperty]documentsoptionalIResolvableDocumentsoptionalIResolvableDocumentsoptionalinterface{} #
Describes the training documents submitted with an entity recognizer.
entityListoptionalIResolvable | CfnEntityRecognizer.EntityRecognizerEntityListPropertyentity_listoptionaltyping.Union[IResolvable, EntityRecognizerEntityListProperty]entityListoptionalIResolvableEntityListoptionalIResolvableEntityListoptionalinterface{} #
Describes the entity list submitted with an entity recognizer.
entityTypesIResolvable | IResolvable | CfnEntityRecognizer.EntityTypesListItemProperty[]entity_typestyping.Union[IResolvable, typing.List[typing.Union[IResolvable, EntityTypesListItemProperty]]]entityTypesIResolvableEntityTypesIResolvableEntityTypesinterface{} required #
The entity types in the labeled training data.