Interface UpdateWorkteamRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<UpdateWorkteamRequest.Builder,
,UpdateWorkteamRequest> SageMakerRequest.Builder
,SdkBuilder<UpdateWorkteamRequest.Builder,
,UpdateWorkteamRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
UpdateWorkteamRequest
-
Method Summary
Modifier and TypeMethodDescriptiondescription
(String description) An updated description for the work team.memberDefinitions
(Collection<MemberDefinition> memberDefinitions) A list ofMemberDefinition
objects that contains objects that identify the workers that make up the work team.memberDefinitions
(Consumer<MemberDefinition.Builder>... memberDefinitions) A list ofMemberDefinition
objects that contains objects that identify the workers that make up the work team.memberDefinitions
(MemberDefinition... memberDefinitions) A list ofMemberDefinition
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 itemsnotificationConfiguration
(NotificationConfiguration notificationConfiguration) Configures SNS topic notifications for available or expiring work itemsoverrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.workteamName
(String workteamName) The name of the work team to update.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.sagemaker.model.SageMakerRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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) useOidcMemberDefinition
. 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 sameClientId
andUserPool
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 inGroups
. Be aware that user groups that are already in the work team must also be listed inGroups
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 ofMemberDefinition
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) useOidcMemberDefinition
. 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 sameClientId
andUserPool
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 inGroups
. Be aware that user groups that are already in the work team must also be listed inGroups
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
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) useOidcMemberDefinition
. 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 sameClientId
andUserPool
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 inGroups
. Be aware that user groups that are already in the work team must also be listed inGroups
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 ofMemberDefinition
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) useOidcMemberDefinition
. 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 sameClientId
andUserPool
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 inGroups
. Be aware that user groups that are already in the work team must also be listed inGroups
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) useOidcMemberDefinition
. 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 sameClientId
andUserPool
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
This is a convenience method that creates an instance of theOidcMemberDefinition
by listing those groups inGroups
. Be aware that user groups that are already in the work team must also be listed inGroups
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.MemberDefinition.Builder
avoiding the need to create one manually viaMemberDefinition.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomemberDefinitions(List<MemberDefinition>)
.- Parameters:
memberDefinitions
- a consumer that will call methods onMemberDefinition.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theNotificationConfiguration.Builder
avoiding the need to create one manually viaNotificationConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tonotificationConfiguration(NotificationConfiguration)
.- Parameters:
notificationConfiguration
- a consumer that will call methods onNotificationConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
UpdateWorkteamRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
UpdateWorkteamRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-