Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Comprehend.CreateEntityRecognizer

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the API.

Synopsis

Creating a Request

data CreateEntityRecognizer Source #

See: newCreateEntityRecognizer smart constructor.

Constructors

CreateEntityRecognizer'

Fields

versionName :: Maybe Text
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.
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"
vpcConfig :: Maybe VpcConfig
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.
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"
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 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.
recognizerName :: Text
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.
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 :: EntityRecognizerInputDataConfig
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
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.

Instances

Instances details

Eq CreateEntityRecognizer Source #
Instance details Defined in Amazonka.Comprehend.CreateEntityRecognizer Methods (==) :: CreateEntityRecognizer -> CreateEntityRecognizer -> Bool # (/=) :: CreateEntityRecognizer -> CreateEntityRecognizer -> Bool #
Read CreateEntityRecognizer Source #
Instance details Defined in Amazonka.Comprehend.CreateEntityRecognizer Methods readsPrec :: Int -> ReadS CreateEntityRecognizer # readList :: ReadS [CreateEntityRecognizer] # readPrec :: ReadPrec CreateEntityRecognizer # readListPrec :: ReadPrec [CreateEntityRecognizer] #
Show CreateEntityRecognizer Source #
Instance details Defined in Amazonka.Comprehend.CreateEntityRecognizer Methods showsPrec :: Int -> CreateEntityRecognizer -> ShowS # show :: CreateEntityRecognizer -> String # showList :: [CreateEntityRecognizer] -> ShowS #
Generic CreateEntityRecognizer Source #
Instance details Defined in Amazonka.Comprehend.CreateEntityRecognizer Associated Types type Rep CreateEntityRecognizer :: Type -> Type # Methods from :: CreateEntityRecognizer -> Rep CreateEntityRecognizer x # to :: Rep CreateEntityRecognizer x -> CreateEntityRecognizer #
NFData CreateEntityRecognizer Source #
Instance details Defined in Amazonka.Comprehend.CreateEntityRecognizer Methods rnf :: CreateEntityRecognizer -> () #
Hashable CreateEntityRecognizer Source #
Instance details Defined in Amazonka.Comprehend.CreateEntityRecognizer Methods hashWithSalt :: Int -> CreateEntityRecognizer -> Int # hash :: CreateEntityRecognizer -> Int #
ToJSON CreateEntityRecognizer Source #
Instance details Defined in Amazonka.Comprehend.CreateEntityRecognizer Methods toJSON :: CreateEntityRecognizer -> Value # toEncoding :: CreateEntityRecognizer -> Encoding # toJSONList :: [CreateEntityRecognizer] -> Value # toEncodingList :: [CreateEntityRecognizer] -> Encoding #
AWSRequest CreateEntityRecognizer Source #
Instance details Defined in Amazonka.Comprehend.CreateEntityRecognizer Associated Types type AWSResponse CreateEntityRecognizer # Methods request :: CreateEntityRecognizer -> Request CreateEntityRecognizer # response :: MonadResource m => Logger -> Service -> Proxy CreateEntityRecognizer -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateEntityRecognizer))) #
ToHeaders CreateEntityRecognizer Source #
Instance details Defined in Amazonka.Comprehend.CreateEntityRecognizer Methods toHeaders :: CreateEntityRecognizer -> [Header] #
ToPath CreateEntityRecognizer Source #
Instance details Defined in Amazonka.Comprehend.CreateEntityRecognizer Methods toPath :: CreateEntityRecognizer -> ByteString #
ToQuery CreateEntityRecognizer Source #
Instance details Defined in Amazonka.Comprehend.CreateEntityRecognizer Methods toQuery :: CreateEntityRecognizer -> QueryString #
type Rep CreateEntityRecognizer Source #
Instance details Defined in Amazonka.Comprehend.CreateEntityRecognizer type Rep CreateEntityRecognizer = D1 ('MetaData "CreateEntityRecognizer" "Amazonka.Comprehend.CreateEntityRecognizer" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "CreateEntityRecognizer'" '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 "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfig)) :: (S1 ('MetaSel ('Just "volumeKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "recognizerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EntityRecognizerInputDataConfig) :*: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LanguageCode))))))
type AWSResponse CreateEntityRecognizer Source #
Instance details Defined in Amazonka.Comprehend.CreateEntityRecognizer type AWSResponse CreateEntityRecognizer = CreateEntityRecognizerResponse

newCreateEntityRecognizer Source #

Arguments

:: Text	`$sel:recognizerName:CreateEntityRecognizer'`
-> Text	`$sel:dataAccessRoleArn:CreateEntityRecognizer'`
-> EntityRecognizerInputDataConfig	`$sel:inputDataConfig:CreateEntityRecognizer'`
-> LanguageCode	`$sel:languageCode:CreateEntityRecognizer'`
-> CreateEntityRecognizer

Create a value of CreateEntityRecognizer 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:CreateEntityRecognizer', createEntityRecognizer_versionName - 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.

$sel:modelKmsKeyId:CreateEntityRecognizer', createEntityRecognizer_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:vpcConfig:CreateEntityRecognizer', createEntityRecognizer_vpcConfig - 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.

$sel:volumeKmsKeyId:CreateEntityRecognizer', createEntityRecognizer_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:clientRequestToken:CreateEntityRecognizer', createEntityRecognizer_clientRequestToken - A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

$sel:tags:CreateEntityRecognizer', createEntityRecognizer_tags - 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.

$sel:recognizerName:CreateEntityRecognizer', createEntityRecognizer_recognizerName - 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.

$sel:dataAccessRoleArn:CreateEntityRecognizer', createEntityRecognizer_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:CreateEntityRecognizer', createEntityRecognizer_inputDataConfig - 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.

$sel:languageCode:CreateEntityRecognizer', createEntityRecognizer_languageCode - 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.

Request Lenses

createEntityRecognizer_versionName :: Lens' CreateEntityRecognizer (Maybe Text) Source #

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.

createEntityRecognizer_modelKmsKeyId :: Lens' CreateEntityRecognizer (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"

createEntityRecognizer_vpcConfig :: Lens' CreateEntityRecognizer (Maybe VpcConfig) Source #

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.

createEntityRecognizer_volumeKmsKeyId :: Lens' CreateEntityRecognizer (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"

createEntityRecognizer_clientRequestToken :: Lens' CreateEntityRecognizer (Maybe Text) Source #

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

createEntityRecognizer_tags :: Lens' CreateEntityRecognizer (Maybe [Tag]) Source #

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.

createEntityRecognizer_recognizerName :: Lens' CreateEntityRecognizer Text Source #

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.

createEntityRecognizer_dataAccessRoleArn :: Lens' CreateEntityRecognizer 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.

createEntityRecognizer_inputDataConfig :: Lens' CreateEntityRecognizer EntityRecognizerInputDataConfig Source #

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.

createEntityRecognizer_languageCode :: Lens' CreateEntityRecognizer LanguageCode Source #

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.

Destructuring the Response

data CreateEntityRecognizerResponse Source #

See: newCreateEntityRecognizerResponse smart constructor.

Constructors

CreateEntityRecognizerResponse'
Fields entityRecognizerArn :: Maybe Text The Amazon Resource Name (ARN) that identifies the entity recognizer. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateEntityRecognizerResponse Source #
Instance details Defined in Amazonka.Comprehend.CreateEntityRecognizer Methods (==) :: CreateEntityRecognizerResponse -> CreateEntityRecognizerResponse -> Bool # (/=) :: CreateEntityRecognizerResponse -> CreateEntityRecognizerResponse -> Bool #
Read CreateEntityRecognizerResponse Source #
Instance details Defined in Amazonka.Comprehend.CreateEntityRecognizer Methods readsPrec :: Int -> ReadS CreateEntityRecognizerResponse # readList :: ReadS [CreateEntityRecognizerResponse] # readPrec :: ReadPrec CreateEntityRecognizerResponse # readListPrec :: ReadPrec [CreateEntityRecognizerResponse] #
Show CreateEntityRecognizerResponse Source #
Instance details Defined in Amazonka.Comprehend.CreateEntityRecognizer Methods showsPrec :: Int -> CreateEntityRecognizerResponse -> ShowS # show :: CreateEntityRecognizerResponse -> String # showList :: [CreateEntityRecognizerResponse] -> ShowS #
Generic CreateEntityRecognizerResponse Source #
Instance details Defined in Amazonka.Comprehend.CreateEntityRecognizer Associated Types type Rep CreateEntityRecognizerResponse :: Type -> Type # Methods from :: CreateEntityRecognizerResponse -> Rep CreateEntityRecognizerResponse x # to :: Rep CreateEntityRecognizerResponse x -> CreateEntityRecognizerResponse #
NFData CreateEntityRecognizerResponse Source #
Instance details Defined in Amazonka.Comprehend.CreateEntityRecognizer Methods rnf :: CreateEntityRecognizerResponse -> () #
type Rep CreateEntityRecognizerResponse Source #
Instance details Defined in Amazonka.Comprehend.CreateEntityRecognizer type Rep CreateEntityRecognizerResponse = D1 ('MetaData "CreateEntityRecognizerResponse" "Amazonka.Comprehend.CreateEntityRecognizer" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "CreateEntityRecognizerResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "entityRecognizerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateEntityRecognizerResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateEntityRecognizerResponse'`
-> CreateEntityRecognizerResponse

Create a value of CreateEntityRecognizerResponse 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:entityRecognizerArn:CreateEntityRecognizerResponse', createEntityRecognizerResponse_entityRecognizerArn - The Amazon Resource Name (ARN) that identifies the entity recognizer.

$sel:httpStatus:CreateEntityRecognizerResponse', createEntityRecognizerResponse_httpStatus - The response's http status code.

Response Lenses

createEntityRecognizerResponse_entityRecognizerArn :: Lens' CreateEntityRecognizerResponse (Maybe Text) Source #

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

createEntityRecognizerResponse_httpStatus :: Lens' CreateEntityRecognizerResponse Int Source #

The response's http status code.