/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.sagemaker.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class UpdateWorkteamRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* The name of the work team to update. *
*/ private String workteamName; /** *
* 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.
*
* An updated description for the work team. *
*/ private String description; /** ** Configures SNS topic notifications for available or expiring work items *
*/ private NotificationConfiguration notificationConfiguration; /** ** The name of the work team to update. *
* * @param workteamName * The name of the work team to update. */ public void setWorkteamName(String workteamName) { this.workteamName = workteamName; } /** ** The name of the work team to update. *
* * @return The name of the work team to update. */ public String getWorkteamName() { return this.workteamName; } /** ** The name of the work team to update. *
* * @param workteamName * The name of the work team to update. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateWorkteamRequest withWorkteamName(String workteamName) { setWorkteamName(workteamName); return this; } /** *
* 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.
*
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
* A list of
* Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces
* created using Amazon Cognito use
* 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
* 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.
*/
public java.util.ListMemberDefinition
objects that contains objects that identify the workers that make up the
* work team.
* 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.
* 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.
* 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.
* 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
* A list of
* Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces
* created using Amazon Cognito use
* 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
* For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private
* work team in
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setMemberDefinitions(java.util.Collection)} or {@link #withMemberDefinitions(java.util.Collection)} if
* you want to override the existing values.
* 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.
*/
public void setMemberDefinitions(java.util.CollectionMemberDefinition
objects that contains objects that identify the workers that make up the
* work team.
* 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.
* 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.
* 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.
* 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
* A list of
* Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces
* created using Amazon Cognito use
* 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
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateWorkteamRequest withMemberDefinitions(MemberDefinition... memberDefinitions) {
if (this.memberDefinitions == null) {
setMemberDefinitions(new java.util.ArrayListMemberDefinition
objects that contains objects that identify the workers that make up the
* work team.
* 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.
* 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.
* 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.
* 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
* An updated description for the work team.
*
* An updated description for the work team.
*
* An updated description for the work team.
*
* Configures SNS topic notifications for available or expiring work items
*
* Configures SNS topic notifications for available or expiring work items
*
* Configures SNS topic notifications for available or expiring work items
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateWorkteamRequest withMemberDefinitions(java.util.Collection