pub struct StartEntitiesDetectionJob { /* private fields */ }Expand description
Fluent builder constructing a request to StartEntitiesDetectionJob.
Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.
This API can be used for either standard entity detection or custom entity recognition. In order to be used for custom entity recognition, the optional EntityRecognizerArn must be used in order to provide access to the recognizer being used to detect the custom entity.
Implementations
sourceimpl StartEntitiesDetectionJob
impl StartEntitiesDetectionJob
sourcepub async fn send(
self
) -> Result<StartEntitiesDetectionJobOutput, SdkError<StartEntitiesDetectionJobError>>
pub async fn send(
self
) -> Result<StartEntitiesDetectionJobOutput, SdkError<StartEntitiesDetectionJobError>>
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.
sourcepub fn input_data_config(self, input: InputDataConfig) -> Self
pub fn input_data_config(self, input: InputDataConfig) -> Self
Specifies the format and location of the input data for the job.
sourcepub fn set_input_data_config(self, input: Option<InputDataConfig>) -> Self
pub fn set_input_data_config(self, input: Option<InputDataConfig>) -> Self
Specifies the format and location of the input data for the job.
sourcepub fn output_data_config(self, input: OutputDataConfig) -> Self
pub fn output_data_config(self, input: OutputDataConfig) -> Self
Specifies where to send the output files.
sourcepub fn set_output_data_config(self, input: Option<OutputDataConfig>) -> Self
pub fn set_output_data_config(self, input: Option<OutputDataConfig>) -> Self
Specifies where to send the output files.
sourcepub fn data_access_role_arn(self, input: impl Into<String>) -> Self
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. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
sourcepub fn set_data_access_role_arn(self, input: Option<String>) -> Self
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. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.
sourcepub fn set_job_name(self, input: Option<String>) -> Self
pub fn set_job_name(self, input: Option<String>) -> Self
The identifier of the job.
sourcepub fn entity_recognizer_arn(self, input: impl Into<String>) -> Self
pub fn entity_recognizer_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the StartEntitiesDetectionJob. This ARN is optional and is only used for a custom entity recognition job.
sourcepub fn set_entity_recognizer_arn(self, input: Option<String>) -> Self
pub fn set_entity_recognizer_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the StartEntitiesDetectionJob. This ARN is optional and is only used for a custom entity recognition job.
sourcepub fn language_code(self, input: LanguageCode) -> Self
pub fn language_code(self, input: LanguageCode) -> Self
The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.
sourcepub fn set_language_code(self, input: Option<LanguageCode>) -> Self
pub fn set_language_code(self, input: Option<LanguageCode>) -> Self
The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.
sourcepub fn client_request_token(self, input: impl Into<String>) -> Self
pub fn client_request_token(self, input: impl Into<String>) -> Self
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
sourcepub fn set_client_request_token(self, input: Option<String>) -> Self
pub fn set_client_request_token(self, input: Option<String>) -> Self
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
sourcepub fn volume_kms_key_id(self, input: impl Into<String>) -> Self
pub fn volume_kms_key_id(self, input: impl Into<String>) -> Self
ID for the AWS 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"
sourcepub fn set_volume_kms_key_id(self, input: Option<String>) -> Self
pub fn set_volume_kms_key_id(self, input: Option<String>) -> Self
ID for the AWS 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"
sourcepub fn vpc_config(self, input: VpcConfig) -> Self
pub fn vpc_config(self, input: VpcConfig) -> Self
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.
sourcepub fn set_vpc_config(self, input: Option<VpcConfig>) -> Self
pub fn set_vpc_config(self, input: Option<VpcConfig>) -> Self
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.
Appends an item to Tags.
To override the contents of this collection use set_tags.
Tags to be associated with the entities 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.
Tags to be associated with the entities 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
sourceimpl Clone for StartEntitiesDetectionJob
impl Clone for StartEntitiesDetectionJob
sourcefn clone(&self) -> StartEntitiesDetectionJob
fn clone(&self) -> StartEntitiesDetectionJob
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
Auto Trait Implementations
impl !RefUnwindSafe for StartEntitiesDetectionJob
impl Send for StartEntitiesDetectionJob
impl Sync for StartEntitiesDetectionJob
impl Unpin for StartEntitiesDetectionJob
impl !UnwindSafe for StartEntitiesDetectionJob
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber to this type, returning a
WithDispatch wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
WithDispatch wrapper. Read more