AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the DeleteCollection operation. Deletes the specified collection. Note that this operation removes all faces in the collection. For an example, see example1.

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

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Rekognition.AmazonRekognitionRequest
      Amazon.Rekognition.Model.DeleteCollectionRequest

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

Syntax

C#
public class DeleteCollectionRequest : AmazonRekognitionRequest
         IAmazonWebServiceRequest

The DeleteCollectionRequest type exposes the following members

Constructors

NameDescription
Public Method DeleteCollectionRequest()

Properties

NameTypeDescription
Public Property CollectionId System.String

Gets and sets the property CollectionId.

ID of the collection to delete.

Examples

This operation deletes a Rekognition collection.

To delete a collection


var response = client.DeleteCollection(new DeleteCollectionRequest 
{
    CollectionId = "myphotos"
});

integer statusCode = response.StatusCode;

            

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms