Struct aws_sdk_comprehendmedical::model::ComprehendMedicalAsyncJobProperties

#[non_exhaustive]
pub struct ComprehendMedicalAsyncJobProperties {

    pub job_id: Option<String>,
    pub job_name: Option<String>,
    pub job_status: Option<JobStatus>,
    pub message: Option<String>,
    pub submit_time: Option<DateTime>,
    pub end_time: Option<DateTime>,
    pub expiration_time: Option<DateTime>,
    pub input_data_config: Option<InputDataConfig>,
    pub output_data_config: Option<OutputDataConfig>,
    pub language_code: Option<LanguageCode>,
    pub data_access_role_arn: Option<String>,
    pub manifest_file_path: Option<String>,
    pub kms_key: Option<String>,
    pub model_version: Option<String>,
}

Provides information about a detection job.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

job_id: Option<String>

The identifier assigned to the detection job.

job_name: Option<String>

The name that you assigned to the detection job.

job_status: Option<JobStatus>

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

message: Option<String>

A description of the status of a job.

submit_time: Option<DateTime>

The time that the detection job was submitted for processing.

end_time: Option<DateTime>

The time that the detection job completed.

expiration_time: Option<DateTime>

The date and time that job metadata is deleted from the server. Output files in your S3 bucket will not be deleted. After the metadata is deleted, the job will no longer appear in the results of the ListEntitiesDetectionV2Job or the ListPHIDetectionJobs operation.

input_data_config: Option<InputDataConfig>

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

output_data_config: Option<OutputDataConfig>

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

language_code: Option<LanguageCode>

The language code of the input documents.

data_access_role_arn: Option<String>

The Amazon Resource Name (ARN) that gives Comprehend Medical; read access to your input data.

manifest_file_path: Option<String>

The path to the file that describes the results of a batch job.

kms_key: Option<String>

The AWS Key Management Service key, if any, used to encrypt the output files.

model_version: Option<String>

The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.

Implementations

impl ComprehendMedicalAsyncJobProperties

pub fn job_id(&self) -> Option<&str>

The identifier assigned to the detection job.

pub fn job_name(&self) -> Option<&str>

The name that you assigned to the detection job.

pub fn job_status(&self) -> Option<&JobStatus>

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

pub fn message(&self) -> Option<&str>

A description of the status of a job.

pub fn submit_time(&self) -> Option<&DateTime>

The time that the detection job was submitted for processing.

pub fn end_time(&self) -> Option<&DateTime>

The time that the detection job completed.

pub fn expiration_time(&self) -> Option<&DateTime>

The date and time that job metadata is deleted from the server. Output files in your S3 bucket will not be deleted. After the metadata is deleted, the job will no longer appear in the results of the ListEntitiesDetectionV2Job or the ListPHIDetectionJobs operation.

pub fn input_data_config(&self) -> Option<&InputDataConfig>

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

pub fn output_data_config(&self) -> Option<&OutputDataConfig>

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

pub fn language_code(&self) -> Option<&LanguageCode>

The language code of the input documents.

pub fn data_access_role_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) that gives Comprehend Medical; read access to your input data.

pub fn manifest_file_path(&self) -> Option<&str>

The path to the file that describes the results of a batch job.

pub fn kms_key(&self) -> Option<&str>

The AWS Key Management Service key, if any, used to encrypt the output files.

pub fn model_version(&self) -> Option<&str>

The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.

impl ComprehendMedicalAsyncJobProperties

pub fn builder() -> Builder

Creates a new builder-style object to manufacture ComprehendMedicalAsyncJobProperties

Trait Implementations

impl Clone for ComprehendMedicalAsyncJobProperties

fn clone(&self) -> ComprehendMedicalAsyncJobProperties

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ComprehendMedicalAsyncJobProperties

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<ComprehendMedicalAsyncJobProperties> for ComprehendMedicalAsyncJobProperties

fn eq(&self, other: &ComprehendMedicalAsyncJobProperties) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ComprehendMedicalAsyncJobProperties) -> bool

This method tests for !=.

impl StructuralPartialEq for ComprehendMedicalAsyncJobProperties