CreateEntityRecognizerRequest

public struct CreateEntityRecognizerRequest : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

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

    Declaration

    Swift

    public let clientRequestToken: String?

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

    Declaration

    Swift

    public let dataAccessRoleArn: String

  • 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.

    Declaration

    Swift

    public let inputDataConfig: EntityRecognizerInputDataConfig

  • 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.

    Declaration

    Swift

    public let languageCode: LanguageCode

  • 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.

    Declaration

    Swift

    public let recognizerName: String

  • 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.

    Declaration

    Swift

    public let tags: [Tag]?

  • 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”

    Declaration

    Swift

    public let volumeKmsKeyId: String?

  • 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.

    Declaration

    Swift

    public let vpcConfig: VpcConfig?

  • Undocumented

    Declaration

    Swift

    public init(clientRequestToken: String? = CreateEntityRecognizerRequest.idempotencyToken(), dataAccessRoleArn: String, inputDataConfig: EntityRecognizerInputDataConfig, languageCode: LanguageCode, recognizerName: String, tags: [Tag]? = nil, volumeKmsKeyId: String? = nil, vpcConfig: VpcConfig? = nil)

  • Declaration

    Swift

    public func validate(name: String) throws