Struct aws_sdk_comprehend::types::EventsDetectionJobProperties

#[non_exhaustive]
pub struct EventsDetectionJobProperties {
    pub job_id: Option<String>,
    pub job_arn: 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 input_data_config: Option<InputDataConfig>,
    pub output_data_config: Option<OutputDataConfig>,
    pub language_code: Option<LanguageCode>,
    pub data_access_role_arn: Option<String>,
    pub target_event_types: Option<Vec<String>>,
}

Provides information about an events 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 events detection job.

job_arn: Option<String>

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

The following is an example job ARN:

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

job_name: Option<String>

The name you assigned the events detection job.

job_status: Option<JobStatus>

The current status of the events detection job.

message: Option<String>

A description of the status of the events detection job.

submit_time: Option<DateTime>

The time that the events detection job was submitted for processing.

end_time: Option<DateTime>

The time that the events detection job completed.

input_data_config: Option<InputDataConfig>

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

output_data_config: Option<OutputDataConfig>

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

language_code: Option<LanguageCode>

The language code of the input documents.

data_access_role_arn: Option<String>

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

target_event_types: Option<Vec<String>>

The types of events that are detected by the job.

Implementations

impl EventsDetectionJobProperties

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

The identifier assigned to the events detection job.

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

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

The following is an example job ARN:

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

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

The name you assigned the events detection job.

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

The current status of the events detection job.

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

A description of the status of the events detection job.

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

The time that the events detection job was submitted for processing.

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

The time that the events detection job completed.

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

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

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

The output data configuration that you supplied when you created the events 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) of the IAM role that grants Amazon Comprehend read access to your input data.

pub fn target_event_types(&self) -> &[String]

The types of events that are detected by the job.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .target_event_types.is_none().

impl EventsDetectionJobProperties

pub fn builder() -> EventsDetectionJobPropertiesBuilder

Creates a new builder-style object to manufacture EventsDetectionJobProperties.

Trait Implementations

impl Clone for EventsDetectionJobProperties

fn clone(&self) -> EventsDetectionJobProperties

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EventsDetectionJobProperties

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

Formats the value using the given formatter.

impl PartialEq for EventsDetectionJobProperties

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for EventsDetectionJobProperties