Struct aws_sdk_sagemaker::client::fluent_builders::UpdateWorkteam

pub struct UpdateWorkteam { /* private fields */ }

Fluent builder constructing a request to UpdateWorkteam.

Updates an existing work team with new member definitions or description.

Implementations

impl UpdateWorkteam

pub async fn send(
    self
) -> Result<UpdateWorkteamOutput, SdkError<UpdateWorkteamError>>

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 fn workteam_name(self, input: impl Into<String>) -> Self

The name of the work team to update.

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

The name of the work team to update.

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.

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.

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

An updated description for the work team.

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

An updated description for the work team.

pub fn notification_configuration(
    self,
    input: NotificationConfiguration
) -> Self

Configures SNS topic notifications for available or expiring work items

pub fn set_notification_configuration(
    self,
    input: Option<NotificationConfiguration>
) -> Self

Configures SNS topic notifications for available or expiring work items

Trait Implementations

impl Clone for UpdateWorkteam

fn clone(&self) -> UpdateWorkteam

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateWorkteam

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

Formats the value using the given formatter.