Interface CreateWorkteamRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateWorkteamRequest.Builder,
,CreateWorkteamRequest> SageMakerRequest.Builder
,SdkBuilder<CreateWorkteamRequest.Builder,
,CreateWorkteamRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateWorkteamRequest
-
Method Summary
Modifier and TypeMethodDescriptiondescription
(String description) A description of 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 CreateWorkteamRequest.Builder
notificationConfiguration
(Consumer<NotificationConfiguration.Builder> notificationConfiguration) Configures notification of workers regarding available or expiring work items.notificationConfiguration
(NotificationConfiguration notificationConfiguration) Configures notification of workers regarding available or expiring work items.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.tags
(Collection<Tag> tags) An array of key-value pairs.tags
(Consumer<Tag.Builder>... tags) An array of key-value pairs.An array of key-value pairs.workforceName
(String workforceName) The name of the workforce.workteamName
(String workteamName) The name of the work team.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. Use this name to identify the work team.
- Parameters:
workteamName
- The name of the work team. Use this name to identify the work team.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
workforceName
The name of the workforce.
- Parameters:
workforceName
- The name of the workforce.- 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
. Do 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
.- 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
. Do 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
.- 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
. Do 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
.- 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
. Do 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
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
memberDefinitions
CreateWorkteamRequest.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
. Do 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
.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
A description of the work team.
- Parameters:
description
- A description of the work team.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
notificationConfiguration
CreateWorkteamRequest.Builder notificationConfiguration(NotificationConfiguration notificationConfiguration) Configures notification of workers regarding available or expiring work items.
- Parameters:
notificationConfiguration
- Configures notification of workers regarding available or expiring work items.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
notificationConfiguration
default CreateWorkteamRequest.Builder notificationConfiguration(Consumer<NotificationConfiguration.Builder> notificationConfiguration) Configures notification of workers regarding 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:
-
tags
An array of key-value pairs.
For more information, see Resource Tag and Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
- Parameters:
tags
- An array of key-value pairs.For more information, see Resource Tag and Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
An array of key-value pairs.
For more information, see Resource Tag and Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
- Parameters:
tags
- An array of key-value pairs.For more information, see Resource Tag and Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
An array of key-value pairs.
For more information, see Resource Tag and Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreateWorkteamRequest.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
CreateWorkteamRequest.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.
-