AmazonRekognitionClient.DeleteDataset Method (DeleteDatasetRequest)

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to DeleteDatasetAsync.

Namespace: Amazon.Rekognition
Assembly: AWSSDK.Rekognition.dll
Version: 3.x.y.z

Syntax

public virtual DeleteDatasetResponse DeleteDataset(
         DeleteDatasetRequest request
)

Parameters

request: Type: Amazon.Rekognition.Model.DeleteDatasetRequest

Container for the necessary parameters to execute the DeleteDataset service method.

Return Value

Type: DeleteDatasetResponse

The response from the DeleteDataset service method, as returned by Rekognition.

Exceptions

Exception	Condition
AccessDeniedException	You are not authorized to perform the action.
InternalServerErrorException	Amazon Rekognition experienced a service issue. Try your call again.
InvalidParameterException	Input parameter violated a constraint. Validate your parameter before calling the API operation again.
LimitExceededException	An Amazon Rekognition service limit was exceeded. For example, if you start too many jobs concurrently, subsequent calls to start operations (ex: StartLabelDetection) will raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Rekognition service limit.
ProvisionedThroughputExceededException	The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.
ResourceInUseException	The specified resource is already being used.
ResourceNotFoundException	The resource specified in the request cannot be found.
ThrottlingException	Amazon Rekognition is temporarily unable to process the request. Try your call again.

Examples

Deletes an Amazon Rekognition Custom Labels dataset.

To delete an Amazon Rekognition Custom Labels dataset


var client = new AmazonRekognitionClient();
var response = client.DeleteDataset(new DeleteDatasetRequest 
{
    DatasetArn = "arn:aws:rekognition:us-east-1:111122223333:project/my-project/dataset/test/1690556733321"
});

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

AmazonRekognitionClient.DeleteDataset (DeleteDatasetRequest)

Method