Struct aws_sdk_sagemaker::operation::create_workforce::builders::CreateWorkforceFluentBuilder

pub struct CreateWorkforceFluentBuilder { /* private fields */ }

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 DeleteWorkforce 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

impl CreateWorkforceFluentBuilder

pub fn as_input(&self) -> &CreateWorkforceInputBuilder

Access the CreateWorkforce as a reference.

pub async fn send( self ) -> Result<CreateWorkforceOutput, SdkError<CreateWorkforceError, HttpResponse>>

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.

pub async fn customize( self ) -> Result<CustomizableOperation<CreateWorkforceOutput, CreateWorkforceError>, SdkError<CreateWorkforceError>>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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.

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.

pub fn get_cognito_config(&self) -> &Option<CognitoConfig>

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.

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.

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.

pub fn get_oidc_config(&self) -> &Option<OidcConfig>

Use this parameter to configure a private workforce using your own OIDC Identity Provider.

Do not use CognitoConfig if you specify values for OidcConfig.

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.

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.

pub fn get_source_ip_config(&self) -> &Option<SourceIpConfig>

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.

pub fn workforce_name(self, input: impl Into<String>) -> Self

The name of the private workforce.

pub fn set_workforce_name(self, input: Option<String>) -> Self

The name of the private workforce.

pub fn get_workforce_name(&self) -> &Option<String>

The name of the private workforce.

pub fn tags(self, input: Tag) -> Self

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.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

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.

pub fn get_tags(&self) -> &Option<Vec<Tag>>

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.

pub fn workforce_vpc_config(self, input: WorkforceVpcConfigRequest) -> Self

Use this parameter to configure a workforce using VPC.

pub fn set_workforce_vpc_config( self, input: Option<WorkforceVpcConfigRequest> ) -> Self

Use this parameter to configure a workforce using VPC.

pub fn get_workforce_vpc_config(&self) -> &Option<WorkforceVpcConfigRequest>

Use this parameter to configure a workforce using VPC.

Trait Implementations

impl Clone for CreateWorkforceFluentBuilder

fn clone(&self) -> CreateWorkforceFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateWorkforceFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.