com.amazonaws.services.sagemaker.model

Class UpdateWorkteamRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sagemaker.model.UpdateWorkteamRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateWorkteamRequest
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
UpdateWorkteamRequest()

Method Summary

Modifier and Type	Method and Description
UpdateWorkteamRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDescription() An updated description for 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 SNS topic notifications for available or expiring work items
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	getWorkteamName() The name of the work team to update.
int	hashCode()
void	setDescription(String description) An updated description for 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 SNS topic notifications for available or expiring work items
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	setWorkteamName(String workteamName) The name of the work team to update.
String	toString() Returns a string representation of this object.
UpdateWorkteamRequest	withDescription(String description) An updated description for the work team.
UpdateWorkteamRequest	withMemberDefinitions(Collection<MemberDefinition> memberDefinitions) A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.
UpdateWorkteamRequest	withMemberDefinitions(MemberDefinition... memberDefinitions) A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.
UpdateWorkteamRequest	withNotificationConfiguration(NotificationConfiguration notificationConfiguration) Configures SNS topic notifications for available or expiring work items
UpdateWorkteamRequest	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.
UpdateWorkteamRequest	withWorkteamName(String workteamName) The name of the work team to update.

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

UpdateWorkteamRequest

public UpdateWorkteamRequest()

Method Detail

setWorkteamName

public void setWorkteamName(String workteamName)

The name of the work team to update.

Parameters:

workteamName - The name of the work team to update.

getWorkteamName

public String getWorkteamName()

The name of the work team to update.

Returns:

The name of the work team to update.

withWorkteamName

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

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. 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 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. Be aware that user groups that are already in the work team must also be listed in Groups 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:

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. 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 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. Be aware that user groups that are already in the work team must also be listed in Groups 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.

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. 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 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. Be aware that user groups that are already in the work team must also be listed in Groups 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 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. 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 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. Be aware that user groups that are already in the work team must also be listed in Groups 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.

withMemberDefinitions

public UpdateWorkteamRequest 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. 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 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. Be aware that user groups that are already in the work team must also be listed in Groups 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.

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. 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 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. Be aware that user groups that are already in the work team must also be listed in Groups 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.

withMemberDefinitions

public UpdateWorkteamRequest 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. 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 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. Be aware that user groups that are already in the work team must also be listed in Groups 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 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. 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 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. Be aware that user groups that are already in the work team must also be listed in Groups 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.

setDescription

public void setDescription(String description)

An updated description for the work team.

Parameters:

description - An updated description for the work team.

getDescription

public String getDescription()

An updated description for the work team.

Returns:

An updated description for the work team.

withDescription

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

setNotificationConfiguration

public void setNotificationConfiguration(NotificationConfiguration notificationConfiguration)

Configures SNS topic notifications for available or expiring work items

Parameters:

notificationConfiguration - Configures SNS topic notifications for available or expiring work items

getNotificationConfiguration

public NotificationConfiguration getNotificationConfiguration()

Configures SNS topic notifications for available or expiring work items

Returns:

Configures SNS topic notifications for available or expiring work items

withNotificationConfiguration

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

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

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 UpdateWorkteamRequest 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()