aws_sdk_comprehend/client/create_endpoint.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`CreateEndpoint`](crate::operation::create_endpoint::builders::CreateEndpointFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`endpoint_name(impl Into<String>)`](crate::operation::create_endpoint::builders::CreateEndpointFluentBuilder::endpoint_name) / [`set_endpoint_name(Option<String>)`](crate::operation::create_endpoint::builders::CreateEndpointFluentBuilder::set_endpoint_name):<br>required: **true**<br><p>This is the descriptive suffix that becomes part of the <code>EndpointArn</code> used for all subsequent requests to this resource.</p><br>
7 /// - [`model_arn(impl Into<String>)`](crate::operation::create_endpoint::builders::CreateEndpointFluentBuilder::model_arn) / [`set_model_arn(Option<String>)`](crate::operation::create_endpoint::builders::CreateEndpointFluentBuilder::set_model_arn):<br>required: **false**<br><p>The Amazon Resource Number (ARN) of the model to which the endpoint will be attached.</p><br>
8 /// - [`desired_inference_units(i32)`](crate::operation::create_endpoint::builders::CreateEndpointFluentBuilder::desired_inference_units) / [`set_desired_inference_units(Option<i32>)`](crate::operation::create_endpoint::builders::CreateEndpointFluentBuilder::set_desired_inference_units):<br>required: **true**<br><p>The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.</p><br>
9 /// - [`client_request_token(impl Into<String>)`](crate::operation::create_endpoint::builders::CreateEndpointFluentBuilder::client_request_token) / [`set_client_request_token(Option<String>)`](crate::operation::create_endpoint::builders::CreateEndpointFluentBuilder::set_client_request_token):<br>required: **false**<br><p>An idempotency token provided by the customer. If this token matches a previous endpoint creation request, Amazon Comprehend will not return a <code>ResourceInUseException</code>.</p><br>
10 /// - [`tags(Tag)`](crate::operation::create_endpoint::builders::CreateEndpointFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_endpoint::builders::CreateEndpointFluentBuilder::set_tags):<br>required: **false**<br><p>Tags to associate with the endpoint. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with "Sales" as the key might be added to an endpoint to indicate its use by the sales department.</p><br>
11 /// - [`data_access_role_arn(impl Into<String>)`](crate::operation::create_endpoint::builders::CreateEndpointFluentBuilder::data_access_role_arn) / [`set_data_access_role_arn(Option<String>)`](crate::operation::create_endpoint::builders::CreateEndpointFluentBuilder::set_data_access_role_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).</p><br>
12 /// - [`flywheel_arn(impl Into<String>)`](crate::operation::create_endpoint::builders::CreateEndpointFluentBuilder::flywheel_arn) / [`set_flywheel_arn(Option<String>)`](crate::operation::create_endpoint::builders::CreateEndpointFluentBuilder::set_flywheel_arn):<br>required: **false**<br><p>The Amazon Resource Number (ARN) of the flywheel to which the endpoint will be attached.</p><br>
13 /// - On success, responds with [`CreateEndpointOutput`](crate::operation::create_endpoint::CreateEndpointOutput) with field(s):
14 /// - [`endpoint_arn(Option<String>)`](crate::operation::create_endpoint::CreateEndpointOutput::endpoint_arn): <p>The Amazon Resource Number (ARN) of the endpoint being created.</p>
15 /// - [`model_arn(Option<String>)`](crate::operation::create_endpoint::CreateEndpointOutput::model_arn): <p>The Amazon Resource Number (ARN) of the model to which the endpoint is attached.</p>
16 /// - On failure, responds with [`SdkError<CreateEndpointError>`](crate::operation::create_endpoint::CreateEndpointError)
17 pub fn create_endpoint(&self) -> crate::operation::create_endpoint::builders::CreateEndpointFluentBuilder {
18 crate::operation::create_endpoint::builders::CreateEndpointFluentBuilder::new(self.handle.clone())
19 }
20}