aws_sdk_rekognition/operation/create_dataset/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_dataset::_create_dataset_output::CreateDatasetOutputBuilder;
3
4pub use crate::operation::create_dataset::_create_dataset_input::CreateDatasetInputBuilder;
5
6impl crate::operation::create_dataset::builders::CreateDatasetInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::create_dataset::CreateDatasetOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_dataset::CreateDatasetError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_dataset();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreateDataset`.
24///
25/// <note>
26/// <p>This operation applies only to Amazon Rekognition Custom Labels.</p>
27/// </note>
28/// <p>Creates a new Amazon Rekognition Custom Labels dataset. You can create a dataset by using an Amazon Sagemaker format manifest file or by copying an existing Amazon Rekognition Custom Labels dataset.</p>
29/// <p>To create a training dataset for a project, specify <code>TRAIN</code> for the value of <code>DatasetType</code>. To create the test dataset for a project, specify <code>TEST</code> for the value of <code>DatasetType</code>.</p>
30/// <p>The response from <code>CreateDataset</code> is the Amazon Resource Name (ARN) for the dataset. Creating a dataset takes a while to complete. Use <code>DescribeDataset</code> to check the current status. The dataset created successfully if the value of <code>Status</code> is <code>CREATE_COMPLETE</code>.</p>
31/// <p>To check if any non-terminal errors occurred, call <code>ListDatasetEntries</code> and check for the presence of <code>errors</code> lists in the JSON Lines.</p>
32/// <p>Dataset creation fails if a terminal error occurs (<code>Status</code> = <code>CREATE_FAILED</code>). Currently, you can't access the terminal error information.</p>
33/// <p>For more information, see Creating dataset in the <i>Amazon Rekognition Custom Labels Developer Guide</i>.</p>
34/// <p>This operation requires permissions to perform the <code>rekognition:CreateDataset</code> action. If you want to copy an existing dataset, you also require permission to perform the <code>rekognition:ListDatasetEntries</code> action.</p>
35#[derive(::std::clone::Clone, ::std::fmt::Debug)]
36pub struct CreateDatasetFluentBuilder {
37    handle: ::std::sync::Arc<crate::client::Handle>,
38    inner: crate::operation::create_dataset::builders::CreateDatasetInputBuilder,
39    config_override: ::std::option::Option<crate::config::Builder>,
40}
41impl
42    crate::client::customize::internal::CustomizableSend<
43        crate::operation::create_dataset::CreateDatasetOutput,
44        crate::operation::create_dataset::CreateDatasetError,
45    > for CreateDatasetFluentBuilder
46{
47    fn send(
48        self,
49        config_override: crate::config::Builder,
50    ) -> crate::client::customize::internal::BoxFuture<
51        crate::client::customize::internal::SendResult<
52            crate::operation::create_dataset::CreateDatasetOutput,
53            crate::operation::create_dataset::CreateDatasetError,
54        >,
55    > {
56        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
57    }
58}
59impl CreateDatasetFluentBuilder {
60    /// Creates a new `CreateDatasetFluentBuilder`.
61    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
62        Self {
63            handle,
64            inner: ::std::default::Default::default(),
65            config_override: ::std::option::Option::None,
66        }
67    }
68    /// Access the CreateDataset as a reference.
69    pub fn as_input(&self) -> &crate::operation::create_dataset::builders::CreateDatasetInputBuilder {
70        &self.inner
71    }
72    /// Sends the request and returns the response.
73    ///
74    /// If an error occurs, an `SdkError` will be returned with additional details that
75    /// can be matched against.
76    ///
77    /// By default, any retryable failures will be retried twice. Retry behavior
78    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
79    /// set when configuring the client.
80    pub async fn send(
81        self,
82    ) -> ::std::result::Result<
83        crate::operation::create_dataset::CreateDatasetOutput,
84        ::aws_smithy_runtime_api::client::result::SdkError<
85            crate::operation::create_dataset::CreateDatasetError,
86            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
87        >,
88    > {
89        let input = self
90            .inner
91            .build()
92            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
93        let runtime_plugins = crate::operation::create_dataset::CreateDataset::operation_runtime_plugins(
94            self.handle.runtime_plugins.clone(),
95            &self.handle.conf,
96            self.config_override,
97        );
98        crate::operation::create_dataset::CreateDataset::orchestrate(&runtime_plugins, input).await
99    }
100
101    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
102    pub fn customize(
103        self,
104    ) -> crate::client::customize::CustomizableOperation<
105        crate::operation::create_dataset::CreateDatasetOutput,
106        crate::operation::create_dataset::CreateDatasetError,
107        Self,
108    > {
109        crate::client::customize::CustomizableOperation::new(self)
110    }
111    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
112        self.set_config_override(::std::option::Option::Some(config_override.into()));
113        self
114    }
115
116    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
117        self.config_override = config_override;
118        self
119    }
120    /// <p>The source files for the dataset. You can specify the ARN of an existing dataset or specify the Amazon S3 bucket location of an Amazon Sagemaker format manifest file. If you don't specify <code>datasetSource</code>, an empty dataset is created. To add labeled images to the dataset, You can use the console or call <code>UpdateDatasetEntries</code>.</p>
121    pub fn dataset_source(mut self, input: crate::types::DatasetSource) -> Self {
122        self.inner = self.inner.dataset_source(input);
123        self
124    }
125    /// <p>The source files for the dataset. You can specify the ARN of an existing dataset or specify the Amazon S3 bucket location of an Amazon Sagemaker format manifest file. If you don't specify <code>datasetSource</code>, an empty dataset is created. To add labeled images to the dataset, You can use the console or call <code>UpdateDatasetEntries</code>.</p>
126    pub fn set_dataset_source(mut self, input: ::std::option::Option<crate::types::DatasetSource>) -> Self {
127        self.inner = self.inner.set_dataset_source(input);
128        self
129    }
130    /// <p>The source files for the dataset. You can specify the ARN of an existing dataset or specify the Amazon S3 bucket location of an Amazon Sagemaker format manifest file. If you don't specify <code>datasetSource</code>, an empty dataset is created. To add labeled images to the dataset, You can use the console or call <code>UpdateDatasetEntries</code>.</p>
131    pub fn get_dataset_source(&self) -> &::std::option::Option<crate::types::DatasetSource> {
132        self.inner.get_dataset_source()
133    }
134    /// <p>The type of the dataset. Specify <code>TRAIN</code> to create a training dataset. Specify <code>TEST</code> to create a test dataset.</p>
135    pub fn dataset_type(mut self, input: crate::types::DatasetType) -> Self {
136        self.inner = self.inner.dataset_type(input);
137        self
138    }
139    /// <p>The type of the dataset. Specify <code>TRAIN</code> to create a training dataset. Specify <code>TEST</code> to create a test dataset.</p>
140    pub fn set_dataset_type(mut self, input: ::std::option::Option<crate::types::DatasetType>) -> Self {
141        self.inner = self.inner.set_dataset_type(input);
142        self
143    }
144    /// <p>The type of the dataset. Specify <code>TRAIN</code> to create a training dataset. Specify <code>TEST</code> to create a test dataset.</p>
145    pub fn get_dataset_type(&self) -> &::std::option::Option<crate::types::DatasetType> {
146        self.inner.get_dataset_type()
147    }
148    /// <p>The ARN of the Amazon Rekognition Custom Labels project to which you want to asssign the dataset.</p>
149    pub fn project_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
150        self.inner = self.inner.project_arn(input.into());
151        self
152    }
153    /// <p>The ARN of the Amazon Rekognition Custom Labels project to which you want to asssign the dataset.</p>
154    pub fn set_project_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
155        self.inner = self.inner.set_project_arn(input);
156        self
157    }
158    /// <p>The ARN of the Amazon Rekognition Custom Labels project to which you want to asssign the dataset.</p>
159    pub fn get_project_arn(&self) -> &::std::option::Option<::std::string::String> {
160        self.inner.get_project_arn()
161    }
162    ///
163    /// Adds a key-value pair to `Tags`.
164    ///
165    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
166    ///
167    /// <p>A set of tags (key-value pairs) that you want to attach to the dataset.</p>
168    pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
169        self.inner = self.inner.tags(k.into(), v.into());
170        self
171    }
172    /// <p>A set of tags (key-value pairs) that you want to attach to the dataset.</p>
173    pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
174        self.inner = self.inner.set_tags(input);
175        self
176    }
177    /// <p>A set of tags (key-value pairs) that you want to attach to the dataset.</p>
178    pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
179        self.inner.get_tags()
180    }
181}