AWSComprehendTopicsDetectionJobProperties

Objective-C

@interface AWSComprehendTopicsDetectionJobProperties

Swift

class AWSComprehendTopicsDetectionJobProperties

Provides information about a topic detection job.

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

    Declaration

    Objective-C

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

    Swift

    var dataAccessRoleArn: String? { get set }

  • The time that the topic detection job was completed.

    Declaration

    Objective-C

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

    Swift

    var endTime: Date? { get set }

  • The input data configuration supplied when you created the topic detection job.

    Declaration

    Objective-C

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

    Swift

    var inputDataConfig: AWSComprehendInputDataConfig? { get set }

  • The Amazon Resource Name (ARN) of the topics detection 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>:topics-detection-job/<job-id>

    The following is an example job ARN:

    arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab

    Declaration

    Objective-C

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

    Swift

    var jobArn: String? { get set }

  • The identifier assigned to the topic detection job.

    Declaration

    Objective-C

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

    Swift

    var jobId: String? { get set }

  • The name of the topic detection job.

    Declaration

    Objective-C

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

    Swift

    var jobName: String? { get set }

  • The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.

    Declaration

    Objective-C

    @property (nonatomic) AWSComprehendJobStatus jobStatus;

    Swift

    var jobStatus: AWSComprehendJobStatus { get set }

  • A description for the status of a job.

    Declaration

    Objective-C

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

    Swift

    var message: String? { get set }

  • The number of topics to detect supplied when you created the topic detection job. The default is 10.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable numberOfTopics;

    Swift

    var numberOfTopics: NSNumber? { get set }

  • The output data configuration supplied when you created the topic detection job.

    Declaration

    Objective-C

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

    Swift

    var outputDataConfig: AWSComprehendOutputDataConfig? { get set }

  • The time that the topic detection 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 topic detection job. For more information, see Amazon VPC.

    Declaration

    Objective-C

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

    Swift

    var vpcConfig: AWSComprehendVpcConfig? { get set }