StartEntitiesDetectionJobRequest

public struct StartEntitiesDetectionJobRequest : 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 Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

    Declaration

    Swift

    public let dataAccessRoleArn: String

  • The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the StartEntitiesDetectionJob. This ARN is optional and is only used for a custom entity recognition job.

    Declaration

    Swift

    public let entityRecognizerArn: String?

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

    Declaration

    Swift

    public let inputDataConfig: InputDataConfig

  • The identifier of the job.

    Declaration

    Swift

    public let jobName: String?

  • The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.

    Declaration

    Swift

    public let languageCode: LanguageCode

  • Specifies where to send the output files.

    Declaration

    Swift

    public let outputDataConfig: OutputDataConfig

  • 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 entity detection job. For more information, see Amazon VPC.

    Declaration

    Swift

    public let vpcConfig: VpcConfig?

  • Undocumented

    Declaration

    Swift

    public init(clientRequestToken: String? = StartEntitiesDetectionJobRequest.idempotencyToken(), dataAccessRoleArn: String, entityRecognizerArn: String? = nil, inputDataConfig: InputDataConfig, jobName: String? = nil, languageCode: LanguageCode, outputDataConfig: OutputDataConfig, volumeKmsKeyId: String? = nil, vpcConfig: VpcConfig? = nil)

  • Declaration

    Swift

    public func validate(name: String) throws