Class: Aws::Comprehend::Types::StartTopicsDetectionJobRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb

Overview

Note:

When making an API call, you may pass StartTopicsDetectionJobRequest data as a hash:

{
  input_data_config: { # required
    s3_uri: "S3Uri", # required
    input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
    document_reader_config: {
      document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
      document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
      feature_types: ["TABLES"], # accepts TABLES, FORMS
    },
  },
  output_data_config: { # required
    s3_uri: "S3Uri", # required
    kms_key_id: "KmsKeyId",
  },
  data_access_role_arn: "IamRoleArn", # required
  job_name: "JobName",
  number_of_topics: 1,
  client_request_token: "ClientRequestTokenString",
  volume_kms_key_id: "KmsKeyId",
  vpc_config: {
    security_group_ids: ["SecurityGroupId"], # required
    subnets: ["SubnetId"], # required
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6407

class StartTopicsDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :number_of_topics,
  :client_request_token,
  :volume_kms_key_id,
  :vpc_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#data_access_role_arnString

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.

Returns:

  • (String)


6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6407

class StartTopicsDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :number_of_topics,
  :client_request_token,
  :volume_kms_key_id,
  :vpc_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#input_data_configTypes::InputDataConfig

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



6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6407

class StartTopicsDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :number_of_topics,
  :client_request_token,
  :volume_kms_key_id,
  :vpc_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#job_nameString

The identifier of the job.

Returns:

  • (String)


6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6407

class StartTopicsDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :number_of_topics,
  :client_request_token,
  :volume_kms_key_id,
  :vpc_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#number_of_topicsInteger

The number of topics to detect.

Returns:

  • (Integer)


6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6407

class StartTopicsDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :number_of_topics,
  :client_request_token,
  :volume_kms_key_id,
  :vpc_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#output_data_configTypes::OutputDataConfig

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



6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6407

class StartTopicsDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :number_of_topics,
  :client_request_token,
  :volume_kms_key_id,
  :vpc_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

Tags to be associated with the topics detection job. A tag is a key-value pair that adds 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.

Returns:



6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6407

class StartTopicsDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :number_of_topics,
  :client_request_token,
  :volume_kms_key_id,
  :vpc_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#volume_kms_key_idString

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"

Returns:

  • (String)


6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6407

class StartTopicsDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :number_of_topics,
  :client_request_token,
  :volume_kms_key_id,
  :vpc_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_configTypes::VpcConfig

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.

Returns:



6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6407

class StartTopicsDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :number_of_topics,
  :client_request_token,
  :volume_kms_key_id,
  :vpc_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end