Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Creates an entity recognizer using submitted files. After your
CreateEntityRecognizer
request is submitted, you can check job status
using the API.
Synopsis
- data CreateEntityRecognizer = CreateEntityRecognizer' {
- clientRequestToken :: Maybe Text
- modelKmsKeyId :: Maybe Text
- modelPolicy :: Maybe Text
- tags :: Maybe [Tag]
- versionName :: Maybe Text
- volumeKmsKeyId :: Maybe Text
- vpcConfig :: Maybe VpcConfig
- recognizerName :: Text
- dataAccessRoleArn :: Text
- inputDataConfig :: EntityRecognizerInputDataConfig
- languageCode :: LanguageCode
- newCreateEntityRecognizer :: Text -> Text -> EntityRecognizerInputDataConfig -> LanguageCode -> CreateEntityRecognizer
- createEntityRecognizer_clientRequestToken :: Lens' CreateEntityRecognizer (Maybe Text)
- createEntityRecognizer_modelKmsKeyId :: Lens' CreateEntityRecognizer (Maybe Text)
- createEntityRecognizer_modelPolicy :: Lens' CreateEntityRecognizer (Maybe Text)
- createEntityRecognizer_tags :: Lens' CreateEntityRecognizer (Maybe [Tag])
- createEntityRecognizer_versionName :: Lens' CreateEntityRecognizer (Maybe Text)
- createEntityRecognizer_volumeKmsKeyId :: Lens' CreateEntityRecognizer (Maybe Text)
- createEntityRecognizer_vpcConfig :: Lens' CreateEntityRecognizer (Maybe VpcConfig)
- createEntityRecognizer_recognizerName :: Lens' CreateEntityRecognizer Text
- createEntityRecognizer_dataAccessRoleArn :: Lens' CreateEntityRecognizer Text
- createEntityRecognizer_inputDataConfig :: Lens' CreateEntityRecognizer EntityRecognizerInputDataConfig
- createEntityRecognizer_languageCode :: Lens' CreateEntityRecognizer LanguageCode
- data CreateEntityRecognizerResponse = CreateEntityRecognizerResponse' {}
- newCreateEntityRecognizerResponse :: Int -> CreateEntityRecognizerResponse
- createEntityRecognizerResponse_entityRecognizerArn :: Lens' CreateEntityRecognizerResponse (Maybe Text)
- createEntityRecognizerResponse_httpStatus :: Lens' CreateEntityRecognizerResponse Int
Creating a Request
data CreateEntityRecognizer Source #
See: newCreateEntityRecognizer
smart constructor.
CreateEntityRecognizer' | |
|
Instances
newCreateEntityRecognizer Source #
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:clientRequestToken:CreateEntityRecognizer'
, createEntityRecognizer_clientRequestToken
- A unique identifier for the request. If you don't set the client
request token, Amazon Comprehend generates one.
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:modelPolicy:CreateEntityRecognizer'
, createEntityRecognizer_modelPolicy
- The JSON resource-based policy to attach to your custom entity
recognizer model. You can use this policy to allow another AWS account
to import your custom model.
Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for your policy, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:
"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:
'{"attribute": "value", "attribute": ["value"]}'
$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.
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.
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"
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.
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.
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.
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.
CreateEntityRecognizer
, createEntityRecognizer_languageCode
- You can specify any of the following languages: English ("en"),
Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or
Portuguese ("pt"). If you plan to use this entity recognizer with PDF,
Word, or image input files, you must specify English as the language.
All training documents must be in the same language.
Request Lenses
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_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_modelPolicy :: Lens' CreateEntityRecognizer (Maybe Text) Source #
The JSON resource-based policy to attach to your custom entity recognizer model. You can use this policy to allow another AWS account to import your custom model.
Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for your policy, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:
"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:
'{"attribute": "value", "attribute": ["value"]}'
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_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_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_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_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: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). If you plan to use this entity recognizer with PDF, Word, or image input files, you must specify English as the language. All training documents must be in the same language.
Destructuring the Response
data CreateEntityRecognizerResponse Source #
See: newCreateEntityRecognizerResponse
smart constructor.
CreateEntityRecognizerResponse' | |
|
Instances
Generic CreateEntityRecognizerResponse Source # | |
Read CreateEntityRecognizerResponse Source # | |
Show CreateEntityRecognizerResponse Source # | |
Defined in Amazonka.Comprehend.CreateEntityRecognizer | |
NFData CreateEntityRecognizerResponse Source # | |
Defined in Amazonka.Comprehend.CreateEntityRecognizer rnf :: CreateEntityRecognizerResponse -> () # | |
Eq CreateEntityRecognizerResponse Source # | |
type Rep CreateEntityRecognizerResponse Source # | |
Defined in Amazonka.Comprehend.CreateEntityRecognizer type Rep CreateEntityRecognizerResponse = D1 ('MetaData "CreateEntityRecognizerResponse" "Amazonka.Comprehend.CreateEntityRecognizer" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" '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 #
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:
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.