Struct aws_sdk_comprehend::input::StartEntitiesDetectionJobInput

source · [−]

#[non_exhaustive]
pub struct StartEntitiesDetectionJobInput { /* private fields */ }

Implementations

source

impl StartEntitiesDetectionJobInput

source

pub async fn make_operation(
self,
_config: &Config
) -> Result<Operation<StartEntitiesDetectionJob, AwsResponseRetryClassifier>, BuildError>

Consumes the builder and constructs an Operation<StartEntitiesDetectionJob>

source

pub fn builder() -> Builder

Creates a new builder-style object to manufacture StartEntitiesDetectionJobInput.

source

impl StartEntitiesDetectionJobInput

source

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

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

source

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

Specifies where to send the output files.

source

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

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.

source

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

The identifier of the job.

source

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

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.

source

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

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.

source

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

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

source

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

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"

source

pub fn vpc_config(&self) -> Option<&VpcConfig>

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.

source

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

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.