Struct aws_sdk_sagemaker::operation::update_workteam::UpdateWorkteamInput

#[non_exhaustive]
pub struct UpdateWorkteamInput {
    pub workteam_name: Option<String>,
    pub member_definitions: Option<Vec<MemberDefinition>>,
    pub description: Option<String>,
    pub notification_configuration: Option<NotificationConfiguration>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

workteam_name: Option<String>

The name of the work team to update.

member_definitions: 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.

description: Option<String>

An updated description for the work team.

notification_configuration: Option<NotificationConfiguration>

Configures SNS topic notifications for available or expiring work items

Implementations

impl UpdateWorkteamInput

pub fn workteam_name(&self) -> Option<&str>

The name of the work team to update.

pub fn member_definitions(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .member_definitions.is_none().

pub fn description(&self) -> Option<&str>

An updated description for the work team.

pub fn notification_configuration(&self) -> Option<&NotificationConfiguration>

Configures SNS topic notifications for available or expiring work items

impl UpdateWorkteamInput

pub fn builder() -> UpdateWorkteamInputBuilder

Creates a new builder-style object to manufacture UpdateWorkteamInput.

Trait Implementations

impl Clone for UpdateWorkteamInput

fn clone(&self) -> UpdateWorkteamInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateWorkteamInput

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

Formats the value using the given formatter.

impl PartialEq for UpdateWorkteamInput

fn eq(&self, other: &UpdateWorkteamInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UpdateWorkteamInput