com.amazonaws.services.sagemaker.model

Class CreateWorkteamRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sagemaker.model.CreateWorkteamRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateWorkteamRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateWorkteamRequest()

Method Summary

Modifier and Type	Method and Description
CreateWorkteamRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDescription() A description of the work team.
List<MemberDefinition>	getMemberDefinitions() A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.
NotificationConfiguration	getNotificationConfiguration() Configures notification of workers regarding available or expiring work items.
List<Tag>	getTags() An array of key-value pairs.
WorkerAccessConfiguration	getWorkerAccessConfiguration() Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys.
String	getWorkforceName() The name of the workforce.
String	getWorkteamName() The name of the work team.
int	hashCode()
void	setDescription(String description) A description of the work team.
void	setMemberDefinitions(Collection<MemberDefinition> memberDefinitions) A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.
void	setNotificationConfiguration(NotificationConfiguration notificationConfiguration) Configures notification of workers regarding available or expiring work items.
void	setTags(Collection<Tag> tags) An array of key-value pairs.
void	setWorkerAccessConfiguration(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.
void	setWorkforceName(String workforceName) The name of the workforce.
void	setWorkteamName(String workteamName) The name of the work team.
String	toString() Returns a string representation of this object.
CreateWorkteamRequest	withDescription(String description) A description of the work team.
CreateWorkteamRequest	withMemberDefinitions(Collection<MemberDefinition> memberDefinitions) A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.
CreateWorkteamRequest	withMemberDefinitions(MemberDefinition... memberDefinitions) A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.
CreateWorkteamRequest	withNotificationConfiguration(NotificationConfiguration notificationConfiguration) Configures notification of workers regarding available or expiring work items.
CreateWorkteamRequest	withTags(Collection<Tag> tags) An array of key-value pairs.
CreateWorkteamRequest	withTags(Tag... tags) An array of key-value pairs.
CreateWorkteamRequest	withWorkerAccessConfiguration(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.
CreateWorkteamRequest	withWorkforceName(String workforceName) The name of the workforce.
CreateWorkteamRequest	withWorkteamName(String workteamName) The name of the work team.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateWorkteamRequest

public CreateWorkteamRequest()

Method Detail

setWorkteamName

public void setWorkteamName(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.

getWorkteamName

public String getWorkteamName()

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.

withWorkteamName

public CreateWorkteamRequest withWorkteamName(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.

setWorkforceName

public void setWorkforceName(String workforceName)

The name of the workforce.

Parameters:

workforceName - The name of the workforce.

getWorkforceName

public String getWorkforceName()

The name of the workforce.

Returns:

The name of the workforce.

withWorkforceName

public CreateWorkteamRequest withWorkforceName(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.

getMemberDefinitions

public List<MemberDefinition> getMemberDefinitions()

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:

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.

setMemberDefinitions

public void setMemberDefinitions(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.

withMemberDefinitions

public CreateWorkteamRequest withMemberDefinitions(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.

NOTE: This method appends the values to the existing list (if any). Use setMemberDefinitions(java.util.Collection) or withMemberDefinitions(java.util.Collection) if you want to override the existing values.

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.

withMemberDefinitions

public CreateWorkteamRequest withMemberDefinitions(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.

setDescription

public void setDescription(String description)

A description of the work team.

Parameters:

description - A description of the work team.

getDescription

public String getDescription()

A description of the work team.

Returns:

A description of the work team.

withDescription

public CreateWorkteamRequest withDescription(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.

setNotificationConfiguration

public void setNotificationConfiguration(NotificationConfiguration notificationConfiguration)

Configures notification of workers regarding available or expiring work items.

Parameters:

notificationConfiguration - Configures notification of workers regarding available or expiring work items.

getNotificationConfiguration

public NotificationConfiguration getNotificationConfiguration()

Configures notification of workers regarding available or expiring work items.

Returns:

Configures notification of workers regarding available or expiring work items.

withNotificationConfiguration

public CreateWorkteamRequest withNotificationConfiguration(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.

setWorkerAccessConfiguration

public void setWorkerAccessConfiguration(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.

getWorkerAccessConfiguration

public WorkerAccessConfiguration getWorkerAccessConfiguration()

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:

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.

withWorkerAccessConfiguration

public CreateWorkteamRequest withWorkerAccessConfiguration(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.

getTags

public List<Tag> getTags()

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:

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.

setTags

public void setTags(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.

withTags

public CreateWorkteamRequest withTags(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.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

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.

withTags

public CreateWorkteamRequest withTags(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateWorkteamRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()