pub struct UpdateWorkteamFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to UpdateWorkteam
.
Updates an existing work team with new member definitions or description.
Implementations§
Source§impl UpdateWorkteamFluentBuilder
impl UpdateWorkteamFluentBuilder
Sourcepub fn as_input(&self) -> &UpdateWorkteamInputBuilder
pub fn as_input(&self) -> &UpdateWorkteamInputBuilder
Access the UpdateWorkteam as a reference.
Sourcepub async fn send(
self,
) -> Result<UpdateWorkteamOutput, SdkError<UpdateWorkteamError, HttpResponse>>
pub async fn send( self, ) -> Result<UpdateWorkteamOutput, SdkError<UpdateWorkteamError, 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<UpdateWorkteamOutput, UpdateWorkteamError, Self>
pub fn customize( self, ) -> CustomizableOperation<UpdateWorkteamOutput, UpdateWorkteamError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn workteam_name(self, input: impl Into<String>) -> Self
pub fn workteam_name(self, input: impl Into<String>) -> Self
The name of the work team to update.
Sourcepub fn set_workteam_name(self, input: Option<String>) -> Self
pub fn set_workteam_name(self, input: Option<String>) -> Self
The name of the work team to update.
Sourcepub fn get_workteam_name(&self) -> &Option<String>
pub fn get_workteam_name(&self) -> &Option<String>
The name of the work team to update.
Sourcepub fn member_definitions(self, input: MemberDefinition) -> Self
pub fn member_definitions(self, input: MemberDefinition) -> Self
Appends an item to MemberDefinitions
.
To override the contents of this collection use set_member_definitions
.
A list of MemberDefinition
objects that contains objects that identify the workers that make up the work team.
Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition
. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition
. You should not provide input for both of these parameters in a single request.
For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito user groups within the user pool used to create a workforce. All of the CognitoMemberDefinition
objects that make up the member definition must have the same ClientId
and UserPool
values. To add a Amazon Cognito user group to an existing worker pool, see Adding groups to a User Pool
. For more information about user pools, see Amazon Cognito User Pools.
For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in OidcMemberDefinition
by listing those groups in Groups
. Be aware that user groups that are already in the work team must also be listed in Groups
when you make this request to remain on the work team. If you do not include these user groups, they will no longer be associated with the work team you update.
Sourcepub fn set_member_definitions(
self,
input: Option<Vec<MemberDefinition>>,
) -> Self
pub fn set_member_definitions( self, input: Option<Vec<MemberDefinition>>, ) -> Self
A list of MemberDefinition
objects that contains objects that identify the workers that make up the work team.
Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition
. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition
. You should not provide input for both of these parameters in a single request.
For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito user groups within the user pool used to create a workforce. All of the CognitoMemberDefinition
objects that make up the member definition must have the same ClientId
and UserPool
values. To add a Amazon Cognito user group to an existing worker pool, see Adding groups to a User Pool
. For more information about user pools, see Amazon Cognito User Pools.
For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in OidcMemberDefinition
by listing those groups in Groups
. Be aware that user groups that are already in the work team must also be listed in Groups
when you make this request to remain on the work team. If you do not include these user groups, they will no longer be associated with the work team you update.
Sourcepub fn get_member_definitions(&self) -> &Option<Vec<MemberDefinition>>
pub fn get_member_definitions(&self) -> &Option<Vec<MemberDefinition>>
A list of MemberDefinition
objects that contains objects that identify the workers that make up the work team.
Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition
. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition
. You should not provide input for both of these parameters in a single request.
For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito user groups within the user pool used to create a workforce. All of the CognitoMemberDefinition
objects that make up the member definition must have the same ClientId
and UserPool
values. To add a Amazon Cognito user group to an existing worker pool, see Adding groups to a User Pool
. For more information about user pools, see Amazon Cognito User Pools.
For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in OidcMemberDefinition
by listing those groups in Groups
. Be aware that user groups that are already in the work team must also be listed in Groups
when you make this request to remain on the work team. If you do not include these user groups, they will no longer be associated with the work team you update.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
An updated description for the work team.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
An updated description for the work team.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
An updated description for the work team.
Sourcepub fn notification_configuration(
self,
input: NotificationConfiguration,
) -> Self
pub fn notification_configuration( self, input: NotificationConfiguration, ) -> Self
Configures SNS topic notifications for available or expiring work items
Sourcepub fn set_notification_configuration(
self,
input: Option<NotificationConfiguration>,
) -> Self
pub fn set_notification_configuration( self, input: Option<NotificationConfiguration>, ) -> Self
Configures SNS topic notifications for available or expiring work items
Sourcepub fn get_notification_configuration(
&self,
) -> &Option<NotificationConfiguration>
pub fn get_notification_configuration( &self, ) -> &Option<NotificationConfiguration>
Configures SNS topic notifications for available or expiring work items
Sourcepub fn worker_access_configuration(
self,
input: WorkerAccessConfiguration,
) -> Self
pub fn worker_access_configuration( self, input: WorkerAccessConfiguration, ) -> Self
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.
Sourcepub fn set_worker_access_configuration(
self,
input: Option<WorkerAccessConfiguration>,
) -> Self
pub fn set_worker_access_configuration( self, input: Option<WorkerAccessConfiguration>, ) -> Self
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.
Sourcepub fn get_worker_access_configuration(
&self,
) -> &Option<WorkerAccessConfiguration>
pub fn get_worker_access_configuration( &self, ) -> &Option<WorkerAccessConfiguration>
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.
Trait Implementations§
Source§impl Clone for UpdateWorkteamFluentBuilder
impl Clone for UpdateWorkteamFluentBuilder
Source§fn clone(&self) -> UpdateWorkteamFluentBuilder
fn clone(&self) -> UpdateWorkteamFluentBuilder
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 UpdateWorkteamFluentBuilder
impl !RefUnwindSafe for UpdateWorkteamFluentBuilder
impl Send for UpdateWorkteamFluentBuilder
impl Sync for UpdateWorkteamFluentBuilder
impl Unpin for UpdateWorkteamFluentBuilder
impl !UnwindSafe for UpdateWorkteamFluentBuilder
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);