StartTopicsDetectionJobRequest

public struct StartTopicsDetectionJobRequest : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • A unique identifier for the request. If you do not 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

  • 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 number of topics to detect.

    Declaration

    Swift

    public let numberOfTopics: Int?

  • Specifies where to send the output files. The output is a compressed archive with two files, topic-terms.csv that lists the terms associated with each topic, and doc-topics.csv that lists the documents associated with each topic

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

    Declaration

    Swift

    public let vpcConfig: VpcConfig?

  • Undocumented

    Declaration

    Swift

    public init(clientRequestToken: String? = StartTopicsDetectionJobRequest.idempotencyToken(), dataAccessRoleArn: String, inputDataConfig: InputDataConfig, jobName: String? = nil, numberOfTopics: Int? = nil, outputDataConfig: OutputDataConfig, volumeKmsKeyId: String? = nil, vpcConfig: VpcConfig? = nil)

  • Declaration

    Swift

    public func validate(name: String) throws