AWS SDK for C++  1.8.74
AWS SDK for C++
Public Member Functions | List of all members
Aws::SageMaker::Model::UpdateWorkteamRequest Class Reference

#include <UpdateWorkteamRequest.h>

+ Inheritance diagram for Aws::SageMaker::Model::UpdateWorkteamRequest:

Public Member Functions

 UpdateWorkteamRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetWorkteamName () const
 
bool WorkteamNameHasBeenSet () const
 
void SetWorkteamName (const Aws::String &value)
 
void SetWorkteamName (Aws::String &&value)
 
void SetWorkteamName (const char *value)
 
UpdateWorkteamRequestWithWorkteamName (const Aws::String &value)
 
UpdateWorkteamRequestWithWorkteamName (Aws::String &&value)
 
UpdateWorkteamRequestWithWorkteamName (const char *value)
 
const Aws::Vector< MemberDefinition > & GetMemberDefinitions () const
 
bool MemberDefinitionsHasBeenSet () const
 
void SetMemberDefinitions (const Aws::Vector< MemberDefinition > &value)
 
void SetMemberDefinitions (Aws::Vector< MemberDefinition > &&value)
 
UpdateWorkteamRequestWithMemberDefinitions (const Aws::Vector< MemberDefinition > &value)
 
UpdateWorkteamRequestWithMemberDefinitions (Aws::Vector< MemberDefinition > &&value)
 
UpdateWorkteamRequestAddMemberDefinitions (const MemberDefinition &value)
 
UpdateWorkteamRequestAddMemberDefinitions (MemberDefinition &&value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
UpdateWorkteamRequestWithDescription (const Aws::String &value)
 
UpdateWorkteamRequestWithDescription (Aws::String &&value)
 
UpdateWorkteamRequestWithDescription (const char *value)
 
const NotificationConfigurationGetNotificationConfiguration () const
 
bool NotificationConfigurationHasBeenSet () const
 
void SetNotificationConfiguration (const NotificationConfiguration &value)
 
void SetNotificationConfiguration (NotificationConfiguration &&value)
 
UpdateWorkteamRequestWithNotificationConfiguration (const NotificationConfiguration &value)
 
UpdateWorkteamRequestWithNotificationConfiguration (NotificationConfiguration &&value)
 
- Public Member Functions inherited from Aws::SageMaker::SageMakerRequest
virtual ~SageMakerRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 24 of file UpdateWorkteamRequest.h.

Constructor & Destructor Documentation

◆ UpdateWorkteamRequest()

Aws::SageMaker::Model::UpdateWorkteamRequest::UpdateWorkteamRequest ( )

Member Function Documentation

◆ AddMemberDefinitions() [1/2]

UpdateWorkteamRequest& Aws::SageMaker::Model::UpdateWorkteamRequest::AddMemberDefinitions ( const MemberDefinition value)
inline

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.

Definition at line 261 of file UpdateWorkteamRequest.h.

◆ AddMemberDefinitions() [2/2]

UpdateWorkteamRequest& Aws::SageMaker::Model::UpdateWorkteamRequest::AddMemberDefinitions ( MemberDefinition &&  value)
inline

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.

Definition at line 287 of file UpdateWorkteamRequest.h.

◆ DescriptionHasBeenSet()

bool Aws::SageMaker::Model::UpdateWorkteamRequest::DescriptionHasBeenSet ( ) const
inline

An updated description for the work team.

Definition at line 298 of file UpdateWorkteamRequest.h.

◆ GetDescription()

const Aws::String& Aws::SageMaker::Model::UpdateWorkteamRequest::GetDescription ( ) const
inline

An updated description for the work team.

Definition at line 293 of file UpdateWorkteamRequest.h.

◆ GetMemberDefinitions()

const Aws::Vector<MemberDefinition>& Aws::SageMaker::Model::UpdateWorkteamRequest::GetMemberDefinitions ( ) const
inline

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.

Definition at line 105 of file UpdateWorkteamRequest.h.

◆ GetNotificationConfiguration()

const NotificationConfiguration& Aws::SageMaker::Model::UpdateWorkteamRequest::GetNotificationConfiguration ( ) const
inline

Configures SNS topic notifications for available or expiring work items

Definition at line 334 of file UpdateWorkteamRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::SageMaker::Model::UpdateWorkteamRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::SageMaker::SageMakerRequest.

◆ GetServiceRequestName()

virtual const char* Aws::SageMaker::Model::UpdateWorkteamRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file UpdateWorkteamRequest.h.

◆ GetWorkteamName()

const Aws::String& Aws::SageMaker::Model::UpdateWorkteamRequest::GetWorkteamName ( ) const
inline

The name of the work team to update.

Definition at line 43 of file UpdateWorkteamRequest.h.

◆ MemberDefinitionsHasBeenSet()

bool Aws::SageMaker::Model::UpdateWorkteamRequest::MemberDefinitionsHasBeenSet ( ) const
inline

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.

Definition at line 131 of file UpdateWorkteamRequest.h.

◆ NotificationConfigurationHasBeenSet()

bool Aws::SageMaker::Model::UpdateWorkteamRequest::NotificationConfigurationHasBeenSet ( ) const
inline

Configures SNS topic notifications for available or expiring work items

Definition at line 339 of file UpdateWorkteamRequest.h.

◆ SerializePayload()

Aws::String Aws::SageMaker::Model::UpdateWorkteamRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDescription() [1/3]

void Aws::SageMaker::Model::UpdateWorkteamRequest::SetDescription ( const Aws::String value)
inline

An updated description for the work team.

Definition at line 303 of file UpdateWorkteamRequest.h.

◆ SetDescription() [2/3]

void Aws::SageMaker::Model::UpdateWorkteamRequest::SetDescription ( Aws::String &&  value)
inline

An updated description for the work team.

Definition at line 308 of file UpdateWorkteamRequest.h.

◆ SetDescription() [3/3]

void Aws::SageMaker::Model::UpdateWorkteamRequest::SetDescription ( const char *  value)
inline

An updated description for the work team.

Definition at line 313 of file UpdateWorkteamRequest.h.

◆ SetMemberDefinitions() [1/2]

void Aws::SageMaker::Model::UpdateWorkteamRequest::SetMemberDefinitions ( const Aws::Vector< MemberDefinition > &  value)
inline

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.

Definition at line 157 of file UpdateWorkteamRequest.h.

◆ SetMemberDefinitions() [2/2]

void Aws::SageMaker::Model::UpdateWorkteamRequest::SetMemberDefinitions ( Aws::Vector< MemberDefinition > &&  value)
inline

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.

Definition at line 183 of file UpdateWorkteamRequest.h.

◆ SetNotificationConfiguration() [1/2]

void Aws::SageMaker::Model::UpdateWorkteamRequest::SetNotificationConfiguration ( const NotificationConfiguration value)
inline

Configures SNS topic notifications for available or expiring work items

Definition at line 344 of file UpdateWorkteamRequest.h.

◆ SetNotificationConfiguration() [2/2]

void Aws::SageMaker::Model::UpdateWorkteamRequest::SetNotificationConfiguration ( NotificationConfiguration &&  value)
inline

Configures SNS topic notifications for available or expiring work items

Definition at line 349 of file UpdateWorkteamRequest.h.

◆ SetWorkteamName() [1/3]

void Aws::SageMaker::Model::UpdateWorkteamRequest::SetWorkteamName ( const Aws::String value)
inline

The name of the work team to update.

Definition at line 53 of file UpdateWorkteamRequest.h.

◆ SetWorkteamName() [2/3]

void Aws::SageMaker::Model::UpdateWorkteamRequest::SetWorkteamName ( Aws::String &&  value)
inline

The name of the work team to update.

Definition at line 58 of file UpdateWorkteamRequest.h.

◆ SetWorkteamName() [3/3]

void Aws::SageMaker::Model::UpdateWorkteamRequest::SetWorkteamName ( const char *  value)
inline

The name of the work team to update.

Definition at line 63 of file UpdateWorkteamRequest.h.

◆ WithDescription() [1/3]

UpdateWorkteamRequest& Aws::SageMaker::Model::UpdateWorkteamRequest::WithDescription ( const Aws::String value)
inline

An updated description for the work team.

Definition at line 318 of file UpdateWorkteamRequest.h.

◆ WithDescription() [2/3]

UpdateWorkteamRequest& Aws::SageMaker::Model::UpdateWorkteamRequest::WithDescription ( Aws::String &&  value)
inline

An updated description for the work team.

Definition at line 323 of file UpdateWorkteamRequest.h.

◆ WithDescription() [3/3]

UpdateWorkteamRequest& Aws::SageMaker::Model::UpdateWorkteamRequest::WithDescription ( const char *  value)
inline

An updated description for the work team.

Definition at line 328 of file UpdateWorkteamRequest.h.

◆ WithMemberDefinitions() [1/2]

UpdateWorkteamRequest& Aws::SageMaker::Model::UpdateWorkteamRequest::WithMemberDefinitions ( const Aws::Vector< MemberDefinition > &  value)
inline

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.

Definition at line 209 of file UpdateWorkteamRequest.h.

◆ WithMemberDefinitions() [2/2]

UpdateWorkteamRequest& Aws::SageMaker::Model::UpdateWorkteamRequest::WithMemberDefinitions ( Aws::Vector< MemberDefinition > &&  value)
inline

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.

Definition at line 235 of file UpdateWorkteamRequest.h.

◆ WithNotificationConfiguration() [1/2]

UpdateWorkteamRequest& Aws::SageMaker::Model::UpdateWorkteamRequest::WithNotificationConfiguration ( const NotificationConfiguration value)
inline

Configures SNS topic notifications for available or expiring work items

Definition at line 354 of file UpdateWorkteamRequest.h.

◆ WithNotificationConfiguration() [2/2]

UpdateWorkteamRequest& Aws::SageMaker::Model::UpdateWorkteamRequest::WithNotificationConfiguration ( NotificationConfiguration &&  value)
inline

Configures SNS topic notifications for available or expiring work items

Definition at line 359 of file UpdateWorkteamRequest.h.

◆ WithWorkteamName() [1/3]

UpdateWorkteamRequest& Aws::SageMaker::Model::UpdateWorkteamRequest::WithWorkteamName ( const Aws::String value)
inline

The name of the work team to update.

Definition at line 68 of file UpdateWorkteamRequest.h.

◆ WithWorkteamName() [2/3]

UpdateWorkteamRequest& Aws::SageMaker::Model::UpdateWorkteamRequest::WithWorkteamName ( Aws::String &&  value)
inline

The name of the work team to update.

Definition at line 73 of file UpdateWorkteamRequest.h.

◆ WithWorkteamName() [3/3]

UpdateWorkteamRequest& Aws::SageMaker::Model::UpdateWorkteamRequest::WithWorkteamName ( const char *  value)
inline

The name of the work team to update.

Definition at line 78 of file UpdateWorkteamRequest.h.

◆ WorkteamNameHasBeenSet()

bool Aws::SageMaker::Model::UpdateWorkteamRequest::WorkteamNameHasBeenSet ( ) const
inline

The name of the work team to update.

Definition at line 48 of file UpdateWorkteamRequest.h.


The documentation for this class was generated from the following file: