# ListDatasetLabels
<a name="API_ListDatasetLabels"></a>

**Note**  
This operation applies only to Amazon Rekognition Custom Labels.

Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see [Labeling images](https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/md-labeling-images.html). 

This operation requires permissions to perform the `rekognition:ListDatasetLabels` action.

## Request Syntax
<a name="API_ListDatasetLabels_RequestSyntax"></a>

```
{
   "DatasetArn": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListDatasetLabels_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DatasetArn](#API_ListDatasetLabels_RequestSyntax) **   <a name="rekognition-ListDatasetLabels-request-DatasetArn"></a>
 The Amazon Resource Name (ARN) of the dataset that you want to use.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `(^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA-Z0-9_.\-]{1,255}\/dataset\/(train|test)\/[0-9]+$)`   
Required: Yes

 ** [MaxResults](#API_ListDatasetLabels_RequestSyntax) **   <a name="rekognition-ListDatasetLabels-request-MaxResults"></a>
The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListDatasetLabels_RequestSyntax) **   <a name="rekognition-ListDatasetLabels-request-NextToken"></a>
If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.   
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

## Response Syntax
<a name="API_ListDatasetLabels_ResponseSyntax"></a>

```
{
   "DatasetLabelDescriptions": [ 
      { 
         "LabelName": "string",
         "LabelStats": { 
            "BoundingBoxCount": number,
            "EntryCount": number
         }
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListDatasetLabels_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DatasetLabelDescriptions](#API_ListDatasetLabels_ResponseSyntax) **   <a name="rekognition-ListDatasetLabels-response-DatasetLabelDescriptions"></a>
 A list of the labels in the dataset.   
Type: Array of [DatasetLabelDescription](API_DatasetLabelDescription.md) objects

 ** [NextToken](#API_ListDatasetLabels_ResponseSyntax) **   <a name="rekognition-ListDatasetLabels-response-NextToken"></a>
If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.   
Type: String  
Length Constraints: Maximum length of 1024.

## Errors
<a name="API_ListDatasetLabels_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You are not authorized to perform the action.  
HTTP Status Code: 400

 ** InternalServerError **   
Amazon Rekognition experienced a service issue. Try your call again.  
HTTP Status Code: 500

 ** InvalidPaginationTokenException **   
Pagination token in the request is not valid.  
HTTP Status Code: 400

 ** InvalidParameterException **   
Input parameter violated a constraint. Validate your parameter before calling the API operation again.  
HTTP Status Code: 400

 ** ProvisionedThroughputExceededException **   
The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.  
HTTP Status Code: 400

 ** ResourceInUseException **   
The specified resource is already being used.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The resource specified in the request cannot be found.  
HTTP Status Code: 400

 ** ResourceNotReadyException **   
The requested resource isn't ready. For example, this exception occurs when you call `DetectCustomLabels` with a model version that isn't deployed.   
HTTP Status Code: 400

 ** ThrottlingException **   
Amazon Rekognition is temporarily unable to process the request. Try your call again.  
HTTP Status Code: 500

## See Also
<a name="API_ListDatasetLabels_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rekognition-2016-06-27/ListDatasetLabels) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rekognition-2016-06-27/ListDatasetLabels) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/ListDatasetLabels) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rekognition-2016-06-27/ListDatasetLabels) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/ListDatasetLabels) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rekognition-2016-06-27/ListDatasetLabels) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rekognition-2016-06-27/ListDatasetLabels) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rekognition-2016-06-27/ListDatasetLabels) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rekognition-2016-06-27/ListDatasetLabels) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/ListDatasetLabels)