libZSservicesZSamazonka-comprehendZSamazonka-comprehend
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Comprehend.CreateDocumentClassifier

Description

Creates a new document classifier that you can use to categorize documents. To create a classifier, you provide a set of training documents that labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see how-document-classification.

Synopsis

Creating a Request

data CreateDocumentClassifier Source #

See: newCreateDocumentClassifier smart constructor.

Constructors

CreateDocumentClassifier' 

Fields

  • versionName :: Maybe Text

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

  • modelKmsKeyId :: Maybe Text

    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"
  • mode :: Maybe DocumentClassifierMode

    Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class mode, which identifies one and only one class for each document, or multi-label mode, which identifies one or more labels for each document. In multi-label mode, multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).

  • vpcConfig :: Maybe VpcConfig

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

  • volumeKmsKeyId :: Maybe Text

    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"
  • outputDataConfig :: Maybe DocumentClassifierOutputDataConfig

    Enables the addition of output results configuration parameters for custom classifier jobs.

  • clientRequestToken :: Maybe Text

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

  • tags :: Maybe [Tag]

    Tags to be associated with the document classifier 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.

  • documentClassifierName :: Text

    The name of the document classifier.

  • dataAccessRoleArn :: Text

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

  • inputDataConfig :: DocumentClassifierInputDataConfig

    Specifies the format and location of the input data for the job.

  • languageCode :: LanguageCode

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

Instances

Instances details
Eq CreateDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

Read CreateDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

Show CreateDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

Generic CreateDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

Associated Types

type Rep CreateDocumentClassifier :: Type -> Type #

NFData CreateDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

Hashable CreateDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

ToJSON CreateDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

AWSRequest CreateDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

ToHeaders CreateDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

ToPath CreateDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

ToQuery CreateDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

type Rep CreateDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

type Rep CreateDocumentClassifier = D1 ('MetaData "CreateDocumentClassifier" "Amazonka.Comprehend.CreateDocumentClassifier" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "CreateDocumentClassifier'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "versionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "modelKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "mode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentClassifierMode)))) :*: (S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfig)) :*: (S1 ('MetaSel ('Just "volumeKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "outputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentClassifierOutputDataConfig))))) :*: ((S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "documentClassifierName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DocumentClassifierInputDataConfig) :*: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LanguageCode))))))
type AWSResponse CreateDocumentClassifier Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

newCreateDocumentClassifier Source #

Create a value of CreateDocumentClassifier with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

$sel:modelKmsKeyId:CreateDocumentClassifier', createDocumentClassifier_modelKmsKeyId - 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"

$sel:mode:CreateDocumentClassifier', createDocumentClassifier_mode - Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class mode, which identifies one and only one class for each document, or multi-label mode, which identifies one or more labels for each document. In multi-label mode, multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).

$sel:vpcConfig:CreateDocumentClassifier', createDocumentClassifier_vpcConfig - Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.

$sel:volumeKmsKeyId:CreateDocumentClassifier', createDocumentClassifier_volumeKmsKeyId - 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"

$sel:outputDataConfig:CreateDocumentClassifier', createDocumentClassifier_outputDataConfig - Enables the addition of output results configuration parameters for custom classifier jobs.

$sel:clientRequestToken:CreateDocumentClassifier', createDocumentClassifier_clientRequestToken - A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

$sel:tags:CreateDocumentClassifier', createDocumentClassifier_tags - Tags to be associated with the document classifier 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.

$sel:documentClassifierName:CreateDocumentClassifier', createDocumentClassifier_documentClassifierName - The name of the document classifier.

$sel:dataAccessRoleArn:CreateDocumentClassifier', createDocumentClassifier_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

$sel:inputDataConfig:CreateDocumentClassifier', createDocumentClassifier_inputDataConfig - Specifies the format and location of the input data for the job.

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

Request Lenses

createDocumentClassifier_versionName :: Lens' CreateDocumentClassifier (Maybe Text) Source #

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

createDocumentClassifier_modelKmsKeyId :: Lens' CreateDocumentClassifier (Maybe Text) Source #

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"

createDocumentClassifier_mode :: Lens' CreateDocumentClassifier (Maybe DocumentClassifierMode) Source #

Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class mode, which identifies one and only one class for each document, or multi-label mode, which identifies one or more labels for each document. In multi-label mode, multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).

createDocumentClassifier_vpcConfig :: Lens' CreateDocumentClassifier (Maybe VpcConfig) Source #

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

createDocumentClassifier_volumeKmsKeyId :: Lens' CreateDocumentClassifier (Maybe Text) Source #

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"

createDocumentClassifier_outputDataConfig :: Lens' CreateDocumentClassifier (Maybe DocumentClassifierOutputDataConfig) Source #

Enables the addition of output results configuration parameters for custom classifier jobs.

createDocumentClassifier_clientRequestToken :: Lens' CreateDocumentClassifier (Maybe Text) Source #

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

createDocumentClassifier_tags :: Lens' CreateDocumentClassifier (Maybe [Tag]) Source #

Tags to be associated with the document classifier 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.

createDocumentClassifier_dataAccessRoleArn :: Lens' CreateDocumentClassifier Text Source #

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

createDocumentClassifier_languageCode :: Lens' CreateDocumentClassifier LanguageCode Source #

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

Destructuring the Response

data CreateDocumentClassifierResponse Source #

See: newCreateDocumentClassifierResponse smart constructor.

Constructors

CreateDocumentClassifierResponse' 

Fields

Instances

Instances details
Eq CreateDocumentClassifierResponse Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

Read CreateDocumentClassifierResponse Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

Show CreateDocumentClassifierResponse Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

Generic CreateDocumentClassifierResponse Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

Associated Types

type Rep CreateDocumentClassifierResponse :: Type -> Type #

NFData CreateDocumentClassifierResponse Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

type Rep CreateDocumentClassifierResponse Source # 
Instance details

Defined in Amazonka.Comprehend.CreateDocumentClassifier

type Rep CreateDocumentClassifierResponse = D1 ('MetaData "CreateDocumentClassifierResponse" "Amazonka.Comprehend.CreateDocumentClassifier" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "CreateDocumentClassifierResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentClassifierArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateDocumentClassifierResponse Source #

Create a value of CreateDocumentClassifierResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:documentClassifierArn:CreateDocumentClassifierResponse', createDocumentClassifierResponse_documentClassifierArn - The Amazon Resource Name (ARN) that identifies the document classifier.

$sel:httpStatus:CreateDocumentClassifierResponse', createDocumentClassifierResponse_httpStatus - The response's http status code.

Response Lenses

createDocumentClassifierResponse_documentClassifierArn :: Lens' CreateDocumentClassifierResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) that identifies the document classifier.