pub struct CreateWorkforceFluentBuilder { /* 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 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§
Source§impl CreateWorkforceFluentBuilder
impl CreateWorkforceFluentBuilder
Sourcepub fn as_input(&self) -> &CreateWorkforceInputBuilder
pub fn as_input(&self) -> &CreateWorkforceInputBuilder
Access the CreateWorkforce as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateWorkforceOutput, SdkError<CreateWorkforceError, HttpResponse>>
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.
Sourcepub fn customize(
self,
) -> CustomizableOperation<CreateWorkforceOutput, CreateWorkforceError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateWorkforceOutput, CreateWorkforceError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
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 get_cognito_config(&self) -> &Option<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
.
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 get_oidc_config(&self) -> &Option<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
.
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 log in 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 log in to their worker portal from an IP address within this range. By default, a workforce isn't restricted to specific IP addresses.
Sourcepub fn get_source_ip_config(&self) -> &Option<SourceIpConfig>
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 log in 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.
Sourcepub fn get_workforce_name(&self) -> &Option<String>
pub fn get_workforce_name(&self) -> &Option<String>
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.
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.
Sourcepub fn workforce_vpc_config(self, input: WorkforceVpcConfigRequest) -> Self
pub fn workforce_vpc_config(self, input: WorkforceVpcConfigRequest) -> Self
Use this parameter to configure a workforce using VPC.
Sourcepub fn set_workforce_vpc_config(
self,
input: Option<WorkforceVpcConfigRequest>,
) -> Self
pub fn set_workforce_vpc_config( self, input: Option<WorkforceVpcConfigRequest>, ) -> Self
Use this parameter to configure a workforce using VPC.
Sourcepub fn get_workforce_vpc_config(&self) -> &Option<WorkforceVpcConfigRequest>
pub fn get_workforce_vpc_config(&self) -> &Option<WorkforceVpcConfigRequest>
Use this parameter to configure a workforce using VPC.
Trait Implementations§
Source§impl Clone for CreateWorkforceFluentBuilder
impl Clone for CreateWorkforceFluentBuilder
Source§fn clone(&self) -> CreateWorkforceFluentBuilder
fn clone(&self) -> CreateWorkforceFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for CreateWorkforceFluentBuilder
impl !RefUnwindSafe for CreateWorkforceFluentBuilder
impl Send for CreateWorkforceFluentBuilder
impl Sync for CreateWorkforceFluentBuilder
impl Unpin for CreateWorkforceFluentBuilder
impl !UnwindSafe for CreateWorkforceFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);