Struct aws_sdk_sagemaker::client::fluent_builders::CreateWorkforce
source · [−]pub struct CreateWorkforce { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateWorkforce
.
Use this operation to create a workforce. This operation will return an error if a workforce already exists in the Amazon Web Services Region that you specify. You can only create one workforce in each Amazon Web Services Region per Amazon Web Services account.
If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use the API operation to delete the existing workforce and then use CreateWorkforce
to create a new workforce.
To create a private workforce using Amazon Cognito, you must specify a Cognito user pool in CognitoConfig
. You can also create an Amazon Cognito workforce using the Amazon SageMaker console. For more information, see Create a Private Workforce (Amazon Cognito).
To create a private workforce using your own OIDC Identity Provider (IdP), specify your IdP configuration in OidcConfig
. Your OIDC IdP must support groups because groups are used by Ground Truth and Amazon A2I to create work teams. For more information, see Create a Private Workforce (OIDC IdP).
Implementations
sourceimpl CreateWorkforce
impl CreateWorkforce
sourcepub async fn send(
self
) -> Result<CreateWorkforceOutput, SdkError<CreateWorkforceError>>
pub async fn send(
self
) -> Result<CreateWorkforceOutput, SdkError<CreateWorkforceError>>
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, which can be set when configuring the client.
sourcepub fn cognito_config(self, input: CognitoConfig) -> Self
pub fn cognito_config(self, input: CognitoConfig) -> Self
Use this parameter to configure an Amazon Cognito private workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.
Do not use OidcConfig
if you specify values for CognitoConfig
.
sourcepub fn set_cognito_config(self, input: Option<CognitoConfig>) -> Self
pub fn set_cognito_config(self, input: Option<CognitoConfig>) -> Self
Use this parameter to configure an Amazon Cognito private workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.
Do not use OidcConfig
if you specify values for CognitoConfig
.
sourcepub fn oidc_config(self, input: OidcConfig) -> Self
pub fn oidc_config(self, input: OidcConfig) -> Self
Use this parameter to configure a private workforce using your own OIDC Identity Provider.
Do not use CognitoConfig
if you specify values for OidcConfig
.
sourcepub fn set_oidc_config(self, input: Option<OidcConfig>) -> Self
pub fn set_oidc_config(self, input: Option<OidcConfig>) -> Self
Use this parameter to configure a private workforce using your own OIDC Identity Provider.
Do not use CognitoConfig
if you specify values for OidcConfig
.
sourcepub fn source_ip_config(self, input: SourceIpConfig) -> Self
pub fn source_ip_config(self, input: SourceIpConfig) -> Self
A list of IP address ranges (CIDRs). Used to create an allow list of IP addresses for a private workforce. Workers will only be able to login to their worker portal from an IP address within this range. By default, a workforce isn't restricted to specific IP addresses.
sourcepub fn set_source_ip_config(self, input: Option<SourceIpConfig>) -> Self
pub fn set_source_ip_config(self, input: Option<SourceIpConfig>) -> Self
A list of IP address ranges (CIDRs). Used to create an allow list of IP addresses for a private workforce. Workers will only be able to login to their worker portal from an IP address within this range. By default, a workforce isn't restricted to specific IP addresses.
sourcepub fn workforce_name(self, input: impl Into<String>) -> Self
pub fn workforce_name(self, input: impl Into<String>) -> Self
The name of the private workforce.
sourcepub fn set_workforce_name(self, input: Option<String>) -> Self
pub fn set_workforce_name(self, input: Option<String>) -> Self
The name of the private workforce.
Appends an item to Tags
.
To override the contents of this collection use set_tags
.
An array of key-value pairs that contain metadata to help you categorize and organize our workforce. Each tag consists of a key and a value, both of which you define.
An array of key-value pairs that contain metadata to help you categorize and organize our workforce. Each tag consists of a key and a value, both of which you define.
Trait Implementations
sourceimpl Clone for CreateWorkforce
impl Clone for CreateWorkforce
sourcefn clone(&self) -> CreateWorkforce
fn clone(&self) -> CreateWorkforce
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for CreateWorkforce
impl Send for CreateWorkforce
impl Sync for CreateWorkforce
impl Unpin for CreateWorkforce
impl !UnwindSafe for CreateWorkforce
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more