software.amazon.awssdk.services.sagemaker.model

Class CreateWorkteamRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sagemaker.model.SageMakerRequest

software.amazon.awssdk.services.sagemaker.model.CreateWorkteamRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateWorkteamRequest.Builder,CreateWorkteamRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateWorkteamRequest
extends SageMakerRequest
implements ToCopyableBuilder<CreateWorkteamRequest.Builder,CreateWorkteamRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateWorkteamRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateWorkteamRequest.Builder	builder()
String	description() A description of the work team.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMemberDefinitions() For responses, this returns true if the service returned a value for the MemberDefinitions property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
List<MemberDefinition>	memberDefinitions() A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.
NotificationConfiguration	notificationConfiguration() Configures notification of workers regarding available or expiring work items.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateWorkteamRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() An array of key-value pairs.
CreateWorkteamRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	workforceName() The name of the workforce.
String	workteamName() The name of the work team.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

workteamName

public final String workteamName()

The name of the work team. Use this name to identify the work team.

Returns:

The name of the work team. Use this name to identify the work team.

workforceName

public final String workforceName()

The name of the workforce.

Returns:

The name of the workforce.

hasMemberDefinitions

public final boolean hasMemberDefinitions()

For responses, this returns true if the service returned a value for the MemberDefinitions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

memberDefinitions

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMemberDefinitions() method.

Returns:

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.

description

public final String description()

A description of the work team.

Returns:

A description of the work team.

notificationConfiguration

public final NotificationConfiguration notificationConfiguration()

Configures notification of workers regarding available or expiring work items.

Returns:

Configures notification of workers regarding available or expiring work items.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

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.

toBuilder

public CreateWorkteamRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateWorkteamRequest.Builder,CreateWorkteamRequest>

Specified by:

toBuilder in class SageMakerRequest

builder

public static CreateWorkteamRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateWorkteamRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo