Interface CreateWorkteamRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateWorkteamRequest.Builder,CreateWorkteamRequest>, SageMakerRequest.Builder, SdkBuilder<CreateWorkteamRequest.Builder,CreateWorkteamRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateWorkteamRequest
@Mutable @NotThreadSafe public static interface CreateWorkteamRequest.Builder extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<CreateWorkteamRequest.Builder,CreateWorkteamRequest>

  • Method Details

    • workteamName

      CreateWorkteamRequest.Builder workteamName(String 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

      CreateWorkteamRequest.Builder workforceName(String 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

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

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

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

    • memberDefinitions

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

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

      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) use OidcMemberDefinition. 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 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.

      This is a convenience method that creates an instance of the MemberDefinition.Builder avoiding the need to create one manually via MemberDefinition.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to memberDefinitions(List<MemberDefinition>).

      Parameters:
      memberDefinitions - a consumer that will call methods on MemberDefinition.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • description

      CreateWorkteamRequest.Builder description(String 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 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:

    • workerAccessConfiguration

      CreateWorkteamRequest.Builder workerAccessConfiguration(WorkerAccessConfiguration workerAccessConfiguration)

      Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL.

      Parameters:
      workerAccessConfiguration - Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workerAccessConfiguration

      default CreateWorkteamRequest.Builder workerAccessConfiguration(Consumer<WorkerAccessConfiguration.Builder> workerAccessConfiguration)

      Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL.

      This is a convenience method that creates an instance of the WorkerAccessConfiguration.Builder avoiding the need to create one manually via WorkerAccessConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to workerAccessConfiguration(WorkerAccessConfiguration).

      Parameters:
      workerAccessConfiguration - a consumer that will call methods on WorkerAccessConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      CreateWorkteamRequest.Builder tags(Collection<Tag> 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

      CreateWorkteamRequest.Builder tags(Tag... 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

      CreateWorkteamRequest.Builder tags(Consumer<Tag.Builder>... 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 the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.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 interface AwsRequest.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 interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.