Rekognition / Client / delete_dataset

delete_dataset#

Rekognition.Client.delete_dataset(**kwargs)#

Note

This operation applies only to Amazon Rekognition Custom Labels.

Deletes an existing Amazon Rekognition Custom Labels dataset. Deleting a dataset might take while. Use DescribeDataset to check the current status. The dataset is still deleting if the value of Status is DELETE_IN_PROGRESS. If you try to access the dataset after it is deleted, you get a ResourceNotFoundException exception.

You can’t delete a dataset while it is creating ( Status = CREATE_IN_PROGRESS) or if the dataset is updating ( Status = UPDATE_IN_PROGRESS).

This operation requires permissions to perform the rekognition:DeleteDataset action.

See also: AWS API Documentation

Request Syntax

response = client.delete_dataset(
    DatasetArn='string'
)
Parameters:

DatasetArn (string) –

[REQUIRED]

The ARN of the Amazon Rekognition Custom Labels dataset that you want to delete.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • Rekognition.Client.exceptions.InternalServerError

  • Rekognition.Client.exceptions.ThrottlingException

  • Rekognition.Client.exceptions.ProvisionedThroughputExceededException

  • Rekognition.Client.exceptions.InvalidParameterException

  • Rekognition.Client.exceptions.AccessDeniedException

  • Rekognition.Client.exceptions.LimitExceededException

  • Rekognition.Client.exceptions.ResourceInUseException

  • Rekognition.Client.exceptions.ResourceNotFoundException