| 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 |
Amazonka.Comprehend.ImportModel
Description
Creates a new custom model that replicates a source custom model that you import. The source model can be in your AWS account or another one.
If the source model is in another AWS account, then it must have a resource-based policy that authorizes you to import it.
The source model must be in the same AWS region that you're using when you import. You can't import a model that's in a different region.
Synopsis
- data ImportModel = ImportModel' {
- dataAccessRoleArn :: Maybe Text
- modelKmsKeyId :: Maybe Text
- modelName :: Maybe Text
- tags :: Maybe [Tag]
- versionName :: Maybe Text
- sourceModelArn :: Text
- newImportModel :: Text -> ImportModel
- importModel_dataAccessRoleArn :: Lens' ImportModel (Maybe Text)
- importModel_modelKmsKeyId :: Lens' ImportModel (Maybe Text)
- importModel_modelName :: Lens' ImportModel (Maybe Text)
- importModel_tags :: Lens' ImportModel (Maybe [Tag])
- importModel_versionName :: Lens' ImportModel (Maybe Text)
- importModel_sourceModelArn :: Lens' ImportModel Text
- data ImportModelResponse = ImportModelResponse' {
- modelArn :: Maybe Text
- httpStatus :: Int
- newImportModelResponse :: Int -> ImportModelResponse
- importModelResponse_modelArn :: Lens' ImportModelResponse (Maybe Text)
- importModelResponse_httpStatus :: Lens' ImportModelResponse Int
Creating a Request
data ImportModel Source #
See: newImportModel smart constructor.
Constructors
| ImportModel' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ImportModel |
Create a value of ImportModel 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:
ImportModel, importModel_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM)
role that allows Amazon Comprehend to use Amazon Key Management Service
(KMS) to encrypt or decrypt the custom model.
ImportModel, importModel_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:modelName:ImportModel', importModel_modelName - The name to assign to the custom model that is created in Amazon
Comprehend by this import.
$sel:tags:ImportModel', importModel_tags - Tags to be associated with the custom model that is created by this
import. 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.
ImportModel, importModel_versionName - The version name given to the custom model that is created by this
import. 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.
ImportModel, importModel_sourceModelArn - The Amazon Resource Name (ARN) of the custom model to import.
Request Lenses
importModel_dataAccessRoleArn :: Lens' ImportModel (Maybe Text) Source #
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that allows Amazon Comprehend to use Amazon Key Management Service (KMS) to encrypt or decrypt the custom model.
importModel_modelKmsKeyId :: Lens' ImportModel (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"
importModel_modelName :: Lens' ImportModel (Maybe Text) Source #
The name to assign to the custom model that is created in Amazon Comprehend by this import.
importModel_tags :: Lens' ImportModel (Maybe [Tag]) Source #
Tags to be associated with the custom model that is created by this import. 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.
importModel_versionName :: Lens' ImportModel (Maybe Text) Source #
The version name given to the custom model that is created by this import. 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.
importModel_sourceModelArn :: Lens' ImportModel Text Source #
The Amazon Resource Name (ARN) of the custom model to import.
Destructuring the Response
data ImportModelResponse Source #
See: newImportModelResponse smart constructor.
Constructors
| ImportModelResponse' | |
Fields
| |
Instances
newImportModelResponse Source #
Arguments
| :: Int | |
| -> ImportModelResponse |
Create a value of ImportModelResponse 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:
ImportModelResponse, importModelResponse_modelArn - The Amazon Resource Name (ARN) of the custom model being imported.
$sel:httpStatus:ImportModelResponse', importModelResponse_httpStatus - The response's http status code.
Response Lenses
importModelResponse_modelArn :: Lens' ImportModelResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the custom model being imported.
importModelResponse_httpStatus :: Lens' ImportModelResponse Int Source #
The response's http status code.