Struct aws_sdk_comprehend::client::fluent_builders::StartEventsDetectionJob

pub struct StartEventsDetectionJob { /* private fields */ }

Fluent builder constructing a request to StartEventsDetectionJob.

Starts an asynchronous event detection job for a collection of documents.

Implementations

impl StartEventsDetectionJob

pub async fn send(
    self
) -> Result<StartEventsDetectionJobOutput, SdkError<StartEventsDetectionJobError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn input_data_config(self, input: InputDataConfig) -> Self

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

pub fn set_input_data_config(self, input: Option<InputDataConfig>) -> Self

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

pub fn output_data_config(self, input: OutputDataConfig) -> Self

Specifies where to send the output files.

pub fn set_output_data_config(self, input: Option<OutputDataConfig>) -> Self

Specifies where to send the output files.

pub fn data_access_role_arn(self, input: impl Into<String>) -> Self

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

pub fn set_data_access_role_arn(self, input: Option<String>) -> Self

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

pub fn job_name(self, input: impl Into<String>) -> Self

The identifier of the events detection job.

pub fn set_job_name(self, input: Option<String>) -> Self

The identifier of the events detection job.

pub fn language_code(self, input: LanguageCode) -> Self

The language code of the input documents.

pub fn set_language_code(self, input: Option<LanguageCode>) -> Self

The language code of the input documents.

pub fn client_request_token(self, input: impl Into<String>) -> Self

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

pub fn set_client_request_token(self, input: Option<String>) -> Self

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, input: impl Into<String>) -> Self

Appends an item to TargetEventTypes.

To override the contents of this collection use set_target_event_types.

The types of events to detect in the input documents.

pub fn set_target_event_types(self, input: Option<Vec<String>>) -> Self

The types of events to detect in the input documents.

pub fn tags(self, input: Tag) -> Self

Appends an item to Tags.

To override the contents of this collection use set_tags.

Tags to be associated 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.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

Tags to be associated 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.

Trait Implementations

impl Clone for StartEventsDetectionJob

fn clone(&self) -> StartEventsDetectionJob

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartEventsDetectionJob

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

Formats the value using the given formatter.