Class: Aws::Comprehend::Types::StartDocumentClassificationJobRequest

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

Overview

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)


6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
# File 'lib/aws-sdk-comprehend/types.rb', line 6806

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

#data_access_role_arnString

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

Returns:

  • (String)


6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
# File 'lib/aws-sdk-comprehend/types.rb', line 6806

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

#document_classifier_arnString

The Amazon Resource Name (ARN) of the document classifier to use to process the job.

Returns:

  • (String)


6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
# File 'lib/aws-sdk-comprehend/types.rb', line 6806

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

#flywheel_arnString

The Amazon Resource Number (ARN) of the flywheel associated with the model to use.

Returns:

  • (String)


6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
# File 'lib/aws-sdk-comprehend/types.rb', line 6806

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

#input_data_configTypes::InputDataConfig

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



6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
# File 'lib/aws-sdk-comprehend/types.rb', line 6806

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

#job_nameString

The identifier of the job.

Returns:

  • (String)


6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
# File 'lib/aws-sdk-comprehend/types.rb', line 6806

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

#output_data_configTypes::OutputDataConfig

Specifies where to send the output files.



6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
# File 'lib/aws-sdk-comprehend/types.rb', line 6806

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

#tagsArray<Types::Tag>

Tags to associate with the document classification 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:



6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
# File 'lib/aws-sdk-comprehend/types.rb', line 6806

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

#volume_kms_key_idString

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”`

Returns:

  • (String)


6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
# File 'lib/aws-sdk-comprehend/types.rb', line 6806

class StartDocumentClassificationJobRequest < Struct.new(
  :job_name,
  :document_classifier_arn,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :client_request_token,
  :volume_kms_key_id,
  :vpc_config,
  :tags,
  :flywheel_arn)
  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 document classification job. For more information, see [Amazon VPC].

[1]: docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html

Returns:



6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
# File 'lib/aws-sdk-comprehend/types.rb', line 6806

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