aws-native.comprehend.DocumentClassifier

Document Classifier enables training document classifier models.

Create DocumentClassifier Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new DocumentClassifier(name: string, args: DocumentClassifierArgs, opts?: CustomResourceOptions);

@overload
def DocumentClassifier(resource_name: str,
                       args: DocumentClassifierArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def DocumentClassifier(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       data_access_role_arn: Optional[str] = None,
                       input_data_config: Optional[DocumentClassifierInputDataConfigArgs] = None,
                       language_code: Optional[DocumentClassifierLanguageCode] = None,
                       document_classifier_name: Optional[str] = None,
                       mode: Optional[DocumentClassifierMode] = None,
                       model_kms_key_id: Optional[str] = None,
                       model_policy: Optional[str] = None,
                       output_data_config: Optional[DocumentClassifierOutputDataConfigArgs] = None,
                       tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                       version_name: Optional[str] = None,
                       volume_kms_key_id: Optional[str] = None,
                       vpc_config: Optional[DocumentClassifierVpcConfigArgs] = None)

func NewDocumentClassifier(ctx *Context, name string, args DocumentClassifierArgs, opts ...ResourceOption) (*DocumentClassifier, error)

public DocumentClassifier(string name, DocumentClassifierArgs args, CustomResourceOptions? opts = null)

public DocumentClassifier(String name, DocumentClassifierArgs args)
public DocumentClassifier(String name, DocumentClassifierArgs args, CustomResourceOptions options)

type: aws-native:comprehend:DocumentClassifier
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

Example

The following reference example uses placeholder values for all input properties.

Coming soon!

Coming soon!

Coming soon!

Coming soon!

const documentClassifierResource = new aws_native.comprehend.DocumentClassifier("documentClassifierResource", {
    dataAccessRoleArn: "string",
    inputDataConfig: {
        augmentedManifests: [{
            attributeNames: ["string"],
            s3Uri: "string",
            split: aws_native.comprehend.DocumentClassifierAugmentedManifestsListItemSplit.Train,
        }],
        dataFormat: aws_native.comprehend.DocumentClassifierInputDataConfigDataFormat.ComprehendCsv,
        documentReaderConfig: {
            documentReadAction: aws_native.comprehend.DocumentClassifierDocumentReaderConfigDocumentReadAction.TextractDetectDocumentText,
            documentReadMode: aws_native.comprehend.DocumentClassifierDocumentReaderConfigDocumentReadMode.ServiceDefault,
            featureTypes: [aws_native.comprehend.DocumentClassifierDocumentReaderConfigFeatureTypesItem.Tables],
        },
        documentType: aws_native.comprehend.DocumentClassifierInputDataConfigDocumentType.PlainTextDocument,
        documents: {
            s3Uri: "string",
            testS3Uri: "string",
        },
        labelDelimiter: "string",
        s3Uri: "string",
        testS3Uri: "string",
    },
    languageCode: aws_native.comprehend.DocumentClassifierLanguageCode.En,
    documentClassifierName: "string",
    mode: aws_native.comprehend.DocumentClassifierMode.MultiClass,
    modelKmsKeyId: "string",
    modelPolicy: "string",
    outputDataConfig: {
        kmsKeyId: "string",
        s3Uri: "string",
    },
    tags: [{
        key: "string",
        value: "string",
    }],
    versionName: "string",
    volumeKmsKeyId: "string",
    vpcConfig: {
        securityGroupIds: ["string"],
        subnets: ["string"],
    },
});

Coming soon!

DocumentClassifier 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 DocumentClassifier resource accepts the following input properties:

Outputs

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

Supporting Types

DocumentClassifierAugmentedManifestsListItem, DocumentClassifierAugmentedManifestsListItemArgs

DocumentClassifierAugmentedManifestsListItemSplit, DocumentClassifierAugmentedManifestsListItemSplitArgs

DocumentClassifierDocumentReaderConfig, DocumentClassifierDocumentReaderConfigArgs

DocumentClassifierDocumentReaderConfigDocumentReadAction, DocumentClassifierDocumentReaderConfigDocumentReadActionArgs

DocumentClassifierDocumentReaderConfigDocumentReadMode, DocumentClassifierDocumentReaderConfigDocumentReadModeArgs

DocumentClassifierDocumentReaderConfigFeatureTypesItem, DocumentClassifierDocumentReaderConfigFeatureTypesItemArgs

DocumentClassifierDocuments, DocumentClassifierDocumentsArgs

DocumentClassifierInputDataConfig, DocumentClassifierInputDataConfigArgs

DocumentClassifierInputDataConfigDataFormat, DocumentClassifierInputDataConfigDataFormatArgs

DocumentClassifierInputDataConfigDocumentType, DocumentClassifierInputDataConfigDocumentTypeArgs

DocumentClassifierLanguageCode, DocumentClassifierLanguageCodeArgs

DocumentClassifierMode, DocumentClassifierModeArgs

DocumentClassifierOutputDataConfig, DocumentClassifierOutputDataConfigArgs

DocumentClassifierVpcConfig, DocumentClassifierVpcConfigArgs

Tag, TagArgs

Package Details

Repository

AWS Native pulumi/pulumi-aws-native

License

Apache-2.0