aws_sdk_sagemaker/operation/create_workteam/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_workteam::_create_workteam_output::CreateWorkteamOutputBuilder;
3
4pub use crate::operation::create_workteam::_create_workteam_input::CreateWorkteamInputBuilder;
5
6impl crate::operation::create_workteam::builders::CreateWorkteamInputBuilder {
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_workteam::CreateWorkteamOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::create_workteam::CreateWorkteamError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.create_workteam();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `CreateWorkteam`.
24///
25/// <p>Creates a new work team for labeling your data. A work team is defined by one or more Amazon Cognito user pools. You must first create the user pools before you can create a work team.</p>
26/// <p>You cannot create more than 25 work teams in an account and region.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct CreateWorkteamFluentBuilder {
29 handle: ::std::sync::Arc<crate::client::Handle>,
30 inner: crate::operation::create_workteam::builders::CreateWorkteamInputBuilder,
31 config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34 crate::client::customize::internal::CustomizableSend<
35 crate::operation::create_workteam::CreateWorkteamOutput,
36 crate::operation::create_workteam::CreateWorkteamError,
37 > for CreateWorkteamFluentBuilder
38{
39 fn send(
40 self,
41 config_override: crate::config::Builder,
42 ) -> crate::client::customize::internal::BoxFuture<
43 crate::client::customize::internal::SendResult<
44 crate::operation::create_workteam::CreateWorkteamOutput,
45 crate::operation::create_workteam::CreateWorkteamError,
46 >,
47 > {
48 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49 }
50}
51impl CreateWorkteamFluentBuilder {
52 /// Creates a new `CreateWorkteamFluentBuilder`.
53 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
54 Self {
55 handle,
56 inner: ::std::default::Default::default(),
57 config_override: ::std::option::Option::None,
58 }
59 }
60 /// Access the CreateWorkteam as a reference.
61 pub fn as_input(&self) -> &crate::operation::create_workteam::builders::CreateWorkteamInputBuilder {
62 &self.inner
63 }
64 /// Sends the request and returns the response.
65 ///
66 /// If an error occurs, an `SdkError` will be returned with additional details that
67 /// can be matched against.
68 ///
69 /// By default, any retryable failures will be retried twice. Retry behavior
70 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
71 /// set when configuring the client.
72 pub async fn send(
73 self,
74 ) -> ::std::result::Result<
75 crate::operation::create_workteam::CreateWorkteamOutput,
76 ::aws_smithy_runtime_api::client::result::SdkError<
77 crate::operation::create_workteam::CreateWorkteamError,
78 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
79 >,
80 > {
81 let input = self
82 .inner
83 .build()
84 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
85 let runtime_plugins = crate::operation::create_workteam::CreateWorkteam::operation_runtime_plugins(
86 self.handle.runtime_plugins.clone(),
87 &self.handle.conf,
88 self.config_override,
89 );
90 crate::operation::create_workteam::CreateWorkteam::orchestrate(&runtime_plugins, input).await
91 }
92
93 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
94 pub fn customize(
95 self,
96 ) -> crate::client::customize::CustomizableOperation<
97 crate::operation::create_workteam::CreateWorkteamOutput,
98 crate::operation::create_workteam::CreateWorkteamError,
99 Self,
100 > {
101 crate::client::customize::CustomizableOperation::new(self)
102 }
103 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
104 self.set_config_override(::std::option::Option::Some(config_override.into()));
105 self
106 }
107
108 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
109 self.config_override = config_override;
110 self
111 }
112 /// <p>The name of the work team. Use this name to identify the work team.</p>
113 pub fn workteam_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
114 self.inner = self.inner.workteam_name(input.into());
115 self
116 }
117 /// <p>The name of the work team. Use this name to identify the work team.</p>
118 pub fn set_workteam_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
119 self.inner = self.inner.set_workteam_name(input);
120 self
121 }
122 /// <p>The name of the work team. Use this name to identify the work team.</p>
123 pub fn get_workteam_name(&self) -> &::std::option::Option<::std::string::String> {
124 self.inner.get_workteam_name()
125 }
126 /// <p>The name of the workforce.</p>
127 pub fn workforce_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
128 self.inner = self.inner.workforce_name(input.into());
129 self
130 }
131 /// <p>The name of the workforce.</p>
132 pub fn set_workforce_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
133 self.inner = self.inner.set_workforce_name(input);
134 self
135 }
136 /// <p>The name of the workforce.</p>
137 pub fn get_workforce_name(&self) -> &::std::option::Option<::std::string::String> {
138 self.inner.get_workforce_name()
139 }
140 ///
141 /// Appends an item to `MemberDefinitions`.
142 ///
143 /// To override the contents of this collection use [`set_member_definitions`](Self::set_member_definitions).
144 ///
145 /// <p>A list of <code>MemberDefinition</code> objects that contains objects that identify the workers that make up the work team.</p>
146 /// <p>Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use <code>CognitoMemberDefinition</code>. For workforces created using your own OIDC identity provider (IdP) use <code>OidcMemberDefinition</code>. Do not provide input for both of these parameters in a single request.</p>
147 /// <p>For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito <i>user groups</i> within the user pool used to create a workforce. All of the <code>CognitoMemberDefinition</code> objects that make up the member definition must have the same <code>ClientId</code> and <code>UserPool</code> values. To add a Amazon Cognito user group to an existing worker pool, see <code>Adding groups to a User Pool</code>. For more information about user pools, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html">Amazon Cognito User Pools</a>.</p>
148 /// <p>For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in <code>OidcMemberDefinition</code> by listing those groups in <code>Groups</code>.</p>
149 pub fn member_definitions(mut self, input: crate::types::MemberDefinition) -> Self {
150 self.inner = self.inner.member_definitions(input);
151 self
152 }
153 /// <p>A list of <code>MemberDefinition</code> objects that contains objects that identify the workers that make up the work team.</p>
154 /// <p>Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use <code>CognitoMemberDefinition</code>. For workforces created using your own OIDC identity provider (IdP) use <code>OidcMemberDefinition</code>. Do not provide input for both of these parameters in a single request.</p>
155 /// <p>For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito <i>user groups</i> within the user pool used to create a workforce. All of the <code>CognitoMemberDefinition</code> objects that make up the member definition must have the same <code>ClientId</code> and <code>UserPool</code> values. To add a Amazon Cognito user group to an existing worker pool, see <code>Adding groups to a User Pool</code>. For more information about user pools, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html">Amazon Cognito User Pools</a>.</p>
156 /// <p>For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in <code>OidcMemberDefinition</code> by listing those groups in <code>Groups</code>.</p>
157 pub fn set_member_definitions(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::MemberDefinition>>) -> Self {
158 self.inner = self.inner.set_member_definitions(input);
159 self
160 }
161 /// <p>A list of <code>MemberDefinition</code> objects that contains objects that identify the workers that make up the work team.</p>
162 /// <p>Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use <code>CognitoMemberDefinition</code>. For workforces created using your own OIDC identity provider (IdP) use <code>OidcMemberDefinition</code>. Do not provide input for both of these parameters in a single request.</p>
163 /// <p>For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito <i>user groups</i> within the user pool used to create a workforce. All of the <code>CognitoMemberDefinition</code> objects that make up the member definition must have the same <code>ClientId</code> and <code>UserPool</code> values. To add a Amazon Cognito user group to an existing worker pool, see <code>Adding groups to a User Pool</code>. For more information about user pools, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html">Amazon Cognito User Pools</a>.</p>
164 /// <p>For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in <code>OidcMemberDefinition</code> by listing those groups in <code>Groups</code>.</p>
165 pub fn get_member_definitions(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::MemberDefinition>> {
166 self.inner.get_member_definitions()
167 }
168 /// <p>A description of the work team.</p>
169 pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
170 self.inner = self.inner.description(input.into());
171 self
172 }
173 /// <p>A description of the work team.</p>
174 pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
175 self.inner = self.inner.set_description(input);
176 self
177 }
178 /// <p>A description of the work team.</p>
179 pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
180 self.inner.get_description()
181 }
182 /// <p>Configures notification of workers regarding available or expiring work items.</p>
183 pub fn notification_configuration(mut self, input: crate::types::NotificationConfiguration) -> Self {
184 self.inner = self.inner.notification_configuration(input);
185 self
186 }
187 /// <p>Configures notification of workers regarding available or expiring work items.</p>
188 pub fn set_notification_configuration(mut self, input: ::std::option::Option<crate::types::NotificationConfiguration>) -> Self {
189 self.inner = self.inner.set_notification_configuration(input);
190 self
191 }
192 /// <p>Configures notification of workers regarding available or expiring work items.</p>
193 pub fn get_notification_configuration(&self) -> &::std::option::Option<crate::types::NotificationConfiguration> {
194 self.inner.get_notification_configuration()
195 }
196 /// <p>Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL.</p>
197 pub fn worker_access_configuration(mut self, input: crate::types::WorkerAccessConfiguration) -> Self {
198 self.inner = self.inner.worker_access_configuration(input);
199 self
200 }
201 /// <p>Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL.</p>
202 pub fn set_worker_access_configuration(mut self, input: ::std::option::Option<crate::types::WorkerAccessConfiguration>) -> Self {
203 self.inner = self.inner.set_worker_access_configuration(input);
204 self
205 }
206 /// <p>Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL.</p>
207 pub fn get_worker_access_configuration(&self) -> &::std::option::Option<crate::types::WorkerAccessConfiguration> {
208 self.inner.get_worker_access_configuration()
209 }
210 ///
211 /// Appends an item to `Tags`.
212 ///
213 /// To override the contents of this collection use [`set_tags`](Self::set_tags).
214 ///
215 /// <p>An array of key-value pairs.</p>
216 /// <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html">Resource Tag</a> and <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what">Using Cost Allocation Tags</a> in the <i> Amazon Web Services Billing and Cost Management User Guide</i>.</p>
217 pub fn tags(mut self, input: crate::types::Tag) -> Self {
218 self.inner = self.inner.tags(input);
219 self
220 }
221 /// <p>An array of key-value pairs.</p>
222 /// <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html">Resource Tag</a> and <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what">Using Cost Allocation Tags</a> in the <i> Amazon Web Services Billing and Cost Management User Guide</i>.</p>
223 pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
224 self.inner = self.inner.set_tags(input);
225 self
226 }
227 /// <p>An array of key-value pairs.</p>
228 /// <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html">Resource Tag</a> and <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what">Using Cost Allocation Tags</a> in the <i> Amazon Web Services Billing and Cost Management User Guide</i>.</p>
229 pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
230 self.inner.get_tags()
231 }
232}