software.amazon.awssdk.services.sagemaker.model

Interface UpdateWorkteamRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateWorkteamRequest.Builder,UpdateWorkteamRequest>, SageMakerRequest.Builder, SdkBuilder<UpdateWorkteamRequest.Builder,UpdateWorkteamRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateWorkteamRequest

public static interface UpdateWorkteamRequest.Builder
extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<UpdateWorkteamRequest.Builder,UpdateWorkteamRequest>

Method Summary

Modifier and Type	Method and Description
UpdateWorkteamRequest.Builder	description(String description) An updated description for the work team.
UpdateWorkteamRequest.Builder	memberDefinitions(Collection<MemberDefinition> memberDefinitions) A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.
UpdateWorkteamRequest.Builder	memberDefinitions(Consumer<MemberDefinition.Builder>... memberDefinitions) A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.
UpdateWorkteamRequest.Builder	memberDefinitions(MemberDefinition... memberDefinitions) A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.
default UpdateWorkteamRequest.Builder	notificationConfiguration(Consumer<NotificationConfiguration.Builder> notificationConfiguration) Configures SNS topic notifications for available or expiring work items
UpdateWorkteamRequest.Builder	notificationConfiguration(NotificationConfiguration notificationConfiguration) Configures SNS topic notifications for available or expiring work items
UpdateWorkteamRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UpdateWorkteamRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdateWorkteamRequest.Builder	workteamName(String workteamName) The name of the work team to update.

Methods inherited from interface software.amazon.awssdk.services.sagemaker.model.SageMakerRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

workteamName

UpdateWorkteamRequest.Builder workteamName(String workteamName)

The name of the work team to update.

Parameters:

workteamName - The name of the work team to update.

Returns:

Returns a reference to this object so that method calls can be chained together.

memberDefinitions

UpdateWorkteamRequest.Builder memberDefinitions(Collection<MemberDefinition> memberDefinitions)

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.

Parameters:

memberDefinitions - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

memberDefinitions

UpdateWorkteamRequest.Builder memberDefinitions(MemberDefinition... memberDefinitions)

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.

Parameters:

memberDefinitions - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

memberDefinitions

UpdateWorkteamRequest.Builder memberDefinitions(Consumer<MemberDefinition.Builder>... memberDefinitions)

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.

This is a convenience method that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #memberDefinitions(List).

Parameters:

memberDefinitions - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#memberDefinitions(List)

description

UpdateWorkteamRequest.Builder description(String description)

An updated description for the work team.

Parameters:

description - An updated description for the work team.

Returns:

Returns a reference to this object so that method calls can be chained together.

notificationConfiguration

UpdateWorkteamRequest.Builder notificationConfiguration(NotificationConfiguration notificationConfiguration)

Configures SNS topic notifications for available or expiring work items

Parameters:

notificationConfiguration - Configures SNS topic notifications for available or expiring work items

Returns:

Returns a reference to this object so that method calls can be chained together.

notificationConfiguration

default UpdateWorkteamRequest.Builder notificationConfiguration(Consumer<NotificationConfiguration.Builder> notificationConfiguration)

Configures SNS topic notifications for available or expiring work items

This is a convenience method that creates an instance of the NotificationConfiguration.Builder avoiding the need to create one manually via NotificationConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to notificationConfiguration(NotificationConfiguration).

Parameters:

notificationConfiguration - a consumer that will call methods on NotificationConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

notificationConfiguration(NotificationConfiguration)

overrideConfiguration

UpdateWorkteamRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

UpdateWorkteamRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder