AWSComprehendDocumentClassificationJobProperties

Objective-C

@interface AWSComprehendDocumentClassificationJobProperties

Swift

class AWSComprehendDocumentClassificationJobProperties

Provides information about a document classification job.

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable dataAccessRoleArn;

    Swift

    var dataAccessRoleArn: String? { get set }

  • The Amazon Resource Name (ARN) that identifies the document classifier.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable documentClassifierArn;

    Swift

    var documentClassifierArn: String? { get set }

  • The time that the document classification job completed.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable endTime;

    Swift

    var endTime: Date? { get set }

  • The Amazon Resource Number (ARN) of the flywheel

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable flywheelArn;

    Swift

    var flywheelArn: String? { get set }

  • The input data configuration that you supplied when you created the document classification job.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSComprehendInputDataConfig *_Nullable inputDataConfig;

    Swift

    var inputDataConfig: AWSComprehendInputDataConfig? { get set }

  • The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

    arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>

    The following is an example job ARN:

    arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable jobArn;

    Swift

    var jobArn: String? { get set }

  • The identifier assigned to the document classification job.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable jobId;

    Swift

    var jobId: String? { get set }

  • The name that you assigned to the document classification job.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable jobName;

    Swift

    var jobName: String? { get set }

  • The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure.

    Declaration

    Objective-C

    @property (nonatomic) AWSComprehendJobStatus jobStatus;

    Swift

    var jobStatus: AWSComprehendJobStatus { get set }

  • A description of the status of the job.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable message;

    Swift

    var message: String? { get set }

  • The output data configuration that you supplied when you created the document classification job.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSComprehendOutputDataConfig *_Nullable outputDataConfig;

    Swift

    var outputDataConfig: AWSComprehendOutputDataConfig? { get set }

  • The time that the document classification job was submitted for processing.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable submitTime;

    Swift

    var submitTime: Date? { get set }

  • ID for the Amazon Web Services 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

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable volumeKmsKeyId;

    Swift

    var volumeKmsKeyId: String? { get set }

  • Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSComprehendVpcConfig *_Nullable vpcConfig;

    Swift

    var vpcConfig: AWSComprehendVpcConfig? { get set }