1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::start_entities_detection_job::_start_entities_detection_job_output::StartEntitiesDetectionJobOutputBuilder;
pub use crate::operation::start_entities_detection_job::_start_entities_detection_job_input::StartEntitiesDetectionJobInputBuilder;
/// Fluent builder constructing a request to `StartEntitiesDetectionJob`.
///
/// <p>Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.</p>
/// <p>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 <code>EntityRecognizerArn</code> must be used in order to provide access to the recognizer being used to detect the custom entity.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct StartEntitiesDetectionJobFluentBuilder {
handle: std::sync::Arc<crate::client::Handle>,
inner: crate::operation::start_entities_detection_job::builders::StartEntitiesDetectionJobInputBuilder
}
impl StartEntitiesDetectionJobFluentBuilder {
/// Creates a new `StartEntitiesDetectionJob`.
pub(crate) fn new(handle: std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::client::customize::CustomizableOperation<
crate::operation::start_entities_detection_job::StartEntitiesDetectionJob,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<
crate::operation::start_entities_detection_job::StartEntitiesDetectionJobError,
>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::client::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::operation::start_entities_detection_job::StartEntitiesDetectionJobOutput,
aws_smithy_http::result::SdkError<
crate::operation::start_entities_detection_job::StartEntitiesDetectionJobError,
>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>Specifies the format and location of the input data for the job.</p>
pub fn input_data_config(mut self, input: crate::types::InputDataConfig) -> Self {
self.inner = self.inner.input_data_config(input);
self
}
/// <p>Specifies the format and location of the input data for the job.</p>
pub fn set_input_data_config(
mut self,
input: std::option::Option<crate::types::InputDataConfig>,
) -> Self {
self.inner = self.inner.set_input_data_config(input);
self
}
/// <p>Specifies where to send the output files.</p>
pub fn output_data_config(mut self, input: crate::types::OutputDataConfig) -> Self {
self.inner = self.inner.output_data_config(input);
self
}
/// <p>Specifies where to send the output files.</p>
pub fn set_output_data_config(
mut self,
input: std::option::Option<crate::types::OutputDataConfig>,
) -> Self {
self.inner = self.inner.set_output_data_config(input);
self
}
/// <p>The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions">Role-based permissions</a>.</p>
pub fn data_access_role_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.data_access_role_arn(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions">Role-based permissions</a>.</p>
pub fn set_data_access_role_arn(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_data_access_role_arn(input);
self
}
/// <p>The identifier of the job.</p>
pub fn job_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.job_name(input.into());
self
}
/// <p>The identifier of the job.</p>
pub fn set_job_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_job_name(input);
self
}
/// <p>The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the <code>StartEntitiesDetectionJob</code>. This ARN is optional and is only used for a custom entity recognition job.</p>
pub fn entity_recognizer_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.entity_recognizer_arn(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the <code>StartEntitiesDetectionJob</code>. This ARN is optional and is only used for a custom entity recognition job.</p>
pub fn set_entity_recognizer_arn(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_entity_recognizer_arn(input);
self
}
/// <p>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.</p>
pub fn language_code(mut self, input: crate::types::LanguageCode) -> Self {
self.inner = self.inner.language_code(input);
self
}
/// <p>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.</p>
pub fn set_language_code(
mut self,
input: std::option::Option<crate::types::LanguageCode>,
) -> Self {
self.inner = self.inner.set_language_code(input);
self
}
/// <p>A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.</p>
pub fn client_request_token(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.client_request_token(input.into());
self
}
/// <p>A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.</p>
pub fn set_client_request_token(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_client_request_token(input);
self
}
/// <p>ID for the Amazon Web Services 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:</p>
/// <ul>
/// <li> <p>KMS Key ID: <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code> </p> </li>
/// <li> <p>Amazon Resource Name (ARN) of a KMS Key: <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code> </p> </li>
/// </ul>
pub fn volume_kms_key_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.volume_kms_key_id(input.into());
self
}
/// <p>ID for the Amazon Web Services 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:</p>
/// <ul>
/// <li> <p>KMS Key ID: <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code> </p> </li>
/// <li> <p>Amazon Resource Name (ARN) of a KMS Key: <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code> </p> </li>
/// </ul>
pub fn set_volume_kms_key_id(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_volume_kms_key_id(input);
self
}
/// <p>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 <a href="https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html">Amazon VPC</a>. </p>
pub fn vpc_config(mut self, input: crate::types::VpcConfig) -> Self {
self.inner = self.inner.vpc_config(input);
self
}
/// <p>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 <a href="https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html">Amazon VPC</a>. </p>
pub fn set_vpc_config(mut self, input: std::option::Option<crate::types::VpcConfig>) -> Self {
self.inner = self.inner.set_vpc_config(input);
self
}
/// Appends an item to `Tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>Tags to associate 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.</p>
pub fn tags(mut self, input: crate::types::Tag) -> Self {
self.inner = self.inner.tags(input);
self
}
/// <p>Tags to associate 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.</p>
pub fn set_tags(
mut self,
input: std::option::Option<std::vec::Vec<crate::types::Tag>>,
) -> Self {
self.inner = self.inner.set_tags(input);
self
}
/// <p>The Amazon Resource Number (ARN) of the flywheel associated with the model to use.</p>
pub fn flywheel_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.flywheel_arn(input.into());
self
}
/// <p>The Amazon Resource Number (ARN) of the flywheel associated with the model to use.</p>
pub fn set_flywheel_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_flywheel_arn(input);
self
}
}