Struct StartEventsDetectionJobInput

#[non_exhaustive]
pub struct StartEventsDetectionJobInput {
    pub input_data_config: Option<InputDataConfig>,
    pub output_data_config: Option<OutputDataConfig>,
    pub data_access_role_arn: Option<String>,
    pub job_name: Option<String>,
    pub language_code: Option<LanguageCode>,
    pub client_request_token: Option<String>,
    pub target_event_types: Option<Vec<String>>,
    pub tags: Option<Vec<Tag>>,
}

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.

input_data_config: Option<InputDataConfig>

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

output_data_config: Option<OutputDataConfig>

Specifies where to send the output files.

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.

job_name: Option<String>

The identifier of the events detection job.

language_code: Option<LanguageCode>

The language code of the input documents.

client_request_token: Option<String>

An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

target_event_types: Option<Vec<String>>

The types of events to detect in the input documents.

tags: Option<Vec<Tag>>

Tags to associate with the events 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.

Implementations

impl StartEventsDetectionJobInput

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

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

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

Specifies where to send the output files.

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 job_name(&self) -> Option<&str>

The identifier of the events detection job.

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

The language code of the input documents.

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

An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

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

The types of events to detect in the input documents.

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().

pub fn tags(&self) -> &[Tag]

Tags to associate with the events 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.

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

impl StartEventsDetectionJobInput

pub fn builder() -> StartEventsDetectionJobInputBuilder

Creates a new builder-style object to manufacture StartEventsDetectionJobInput.

Trait Implementations

impl Clone for StartEventsDetectionJobInput

fn clone(&self) -> StartEventsDetectionJobInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartEventsDetectionJobInput

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

Formats the value using the given formatter.

impl PartialEq for StartEventsDetectionJobInput

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for StartEventsDetectionJobInput