SageMaker / Client / delete_workforce

delete_workforce#

SageMaker.Client.delete_workforce(**kwargs)#

Use this operation to delete a workforce.

If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use this operation to delete the existing workforce and then use CreateWorkforce to create a new workforce.

Warning

If a private workforce contains one or more work teams, you must use the DeleteWorkteam operation to delete all work teams before you delete the workforce. If you try to delete a workforce that contains one or more work teams, you will recieve a ResourceInUse error.

Request Syntax

response = client.delete_workforce(
    WorkforceName='string'
)

Parameters:

WorkforceName (string) –

[REQUIRED]

The name of the workforce.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –